From 316e9a18636ac6a771b145e49db9889c0617ae5a Mon Sep 17 00:00:00 2001 From: Yves Rutschle Date: Wed, 10 Jul 2024 15:41:49 +0200 Subject: [PATCH] fix documentation on verboseness (#452) --- doc/FAQ.md | 19 ++++++++++--------- echosrv-conf.c | 2 +- echosrv-conf.h | 2 +- sslh-conf.c | 4 ++-- sslh-conf.h | 2 +- sslh.pod | 7 ++++--- 6 files changed, 19 insertions(+), 17 deletions(-) diff --git a/doc/FAQ.md b/doc/FAQ.md index 528c9d94..5d08db34 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -12,19 +12,20 @@ GitHub. Getting more info ================= -In general, if something doesn't work, you'll want to run -`sslh` with lots of logging, and the logging directly in -the terminal (Otherwise, logs are sent to `syslog`, and -usually end up in `/var/log/auth.log`). You will achieve -this by running `sslh` in foreground with verbose: +There are several `verbose` options that each enable a set +of messages, each related to some event type. See +`example.cfg` for a list of them. + +If something doesn't work, you'll want to run `sslh` with +lots of logging, and the logging directly in the terminal +(Otherwise, logs are sent to `syslog`, and usually end up in +`/var/log/auth.log`). There is a general `--verbose` option +that will allow you to enable all messages: ``` -sslh -v 1 -f -F myconfig.cfg +sslh -v 3 -f -F myconfig.cfg ``` -Higher values of `verbose` produce more information. 1 is -usually sufficient. 2 will also print incoming packets used -for probing. forward to [PROBE] failed:connect: Connection refused ===================================================== diff --git a/echosrv-conf.c b/echosrv-conf.c index 4b26e3a1..b1db5420 100644 --- a/echosrv-conf.c +++ b/echosrv-conf.c @@ -1,5 +1,5 @@ /* Generated by conf2struct (https://www.rutschle.net/tech/conf2struct/README) - * on Wed Jul 10 15:27:23 2024. + * on Wed Jul 10 15:35:54 2024. # conf2struct: generate libconf parsers that read to structs # Copyright (C) 2018-2021 Yves Rutschle diff --git a/echosrv-conf.h b/echosrv-conf.h index 087a632e..976e8e8b 100644 --- a/echosrv-conf.h +++ b/echosrv-conf.h @@ -1,5 +1,5 @@ /* Generated by conf2struct (https://www.rutschle.net/tech/conf2struct/README) - * on Wed Jul 10 15:27:23 2024. + * on Wed Jul 10 15:35:54 2024. # conf2struct: generate libconf parsers that read to structs # Copyright (C) 2018-2021 Yves Rutschle diff --git a/sslh-conf.c b/sslh-conf.c index 5937fb8d..331147f2 100644 --- a/sslh-conf.c +++ b/sslh-conf.c @@ -1,5 +1,5 @@ /* Generated by conf2struct (https://www.rutschle.net/tech/conf2struct/README) - * on Wed Jul 10 15:27:23 2024. + * on Wed Jul 10 15:35:54 2024. # conf2struct: generate libconf parsers that read to structs # Copyright (C) 2018-2021 Yves Rutschle @@ -2210,7 +2210,7 @@ int sslhcfg_cl_parse(int argc, char* argv[], struct sslhcfg_item* cfg) #ifdef LIBCONFIG sslhcfg_conffile = arg_filen("F", "config", "", 0, 1, "Specify configuration file"), #endif - sslhcfg_verbose = arg_intn(NULL, "verbose", "", 0, 1, "Override all verbosness options"), + sslhcfg_verbose = arg_intn("v", "verbose", "", 0, 1, "Override all verbosness options"), sslhcfg_verbose_config = arg_intn(NULL, "verbose-config", "", 0, 1, "Print configuration at startup"), sslhcfg_verbose_config_error = arg_intn(NULL, "verbose-config-error", "", 0, 1, "Print configuration errors"), sslhcfg_verbose_connections = arg_intn(NULL, "verbose-connections", "", 0, 1, "Trace established incoming address to forward address"), diff --git a/sslh-conf.h b/sslh-conf.h index 95fa94fc..f5b90050 100644 --- a/sslh-conf.h +++ b/sslh-conf.h @@ -1,5 +1,5 @@ /* Generated by conf2struct (https://www.rutschle.net/tech/conf2struct/README) - * on Wed Jul 10 15:27:23 2024. + * on Wed Jul 10 15:35:54 2024. # conf2struct: generate libconf parsers that read to structs # Copyright (C) 2018-2021 Yves Rutschle diff --git a/sslh.pod b/sslh.pod index 449248a1..e8cf43ad 100644 --- a/sslh.pod +++ b/sslh.pod @@ -6,7 +6,7 @@ =head1 SYNOPSIS -sslh [B<-F>I] [B<-t> I] [B<--transparent>] [B<-p> I [B<-p> I ...] [B<--tls> I] [B<--ssh> I] [B<--openvpn> I] [B<--http> I] [B<--xmpp> I] [B<--tinc> I] [B<--anyprot> I] [B<--on-timeout> I] [B<-u> I] [B<-C> I] [B<-P> I] [-v] [-i] [-V] [-f] [-n] +sslh [B<-F>I] [B<-t> I] [B<--transparent>] [B<-p> I [B<-p> I ...] [B<--tls> I] [B<--ssh> I] [B<--openvpn> I] [B<--http> I] [B<--xmpp> I] [B<--tinc> I] [B<--anyprot> I] [B<--on-timeout> I] [B<-u> I] [B<-C> I] [B<-P> I] [B<-v> I] [-i] [-V] [-f] [-n] =head1 DESCRIPTION @@ -164,9 +164,10 @@ specified on the command line, this should be specified last. If no default is specified, B will forward unknown protocols to the first protocol specified. -=item B<-v>, B<--verbose> +=item B<-v>, B<--verbose> I -Increase verboseness. +Override all verboseness. Refer to B for all +verbose sub-options. =item B<-n>, B<--numeric>