From 0f4d458a5951691ff1b80b36101e612f5fb6a9e5 Mon Sep 17 00:00:00 2001 From: Joachim Nilsson Date: Fri, 3 Aug 2018 08:10:38 +0200 Subject: [PATCH] Prop up usage text and launch on -? for both klogd and syslogd Also, avoid returning error when user actually requests help. Signed-off-by: Joachim Nilsson --- src/klogd.c | 35 ++++++++++++++++++++++++++++++++++- src/syslogd.c | 43 ++++++++++++++++++++++++++++++++++--------- 2 files changed, 68 insertions(+), 10 deletions(-) diff --git a/src/klogd.c b/src/klogd.c index f80bba1..1c82be1 100644 --- a/src/klogd.c +++ b/src/klogd.c @@ -962,6 +962,33 @@ static void LogProcLine(void) } +int usage(int code) +{ + fprintf(stdout, + "Usage:\n" + " klogd [-2diInopsvx?] [-c NUM] [-f FILE] [-k FILE]\n" + "\n" + "Options:\n" + " -? Show this help text\n" + " -2 Print line twice if symbols are successfully expanded\n" + " -c NUM Set default log level of console messages to NUM (1-8)\n" + " -d Enable debug mode\n" + " -f FILE Log messages to FILE rather than the syslog facility\n" + " -i Signal klogd to reload kernel module symbols\n" + " -I Signal klogd to reload kernel module *and* static kernel symbols\n" + " -k FILE Kernel symbols file, e.g. System.map, default: none\n" + " -n Run in foreground, required when run from a modern init/supervisor\n" + " -o Run once, read kernel log messages and syslog them, then exit\n" + " -p Paranoia mode, forces klogd to reload all kernel symbols on Ooops\n" + " -s Force use of system call interface to kernel message buffers\n" + " -v Show program version and exit\n" + " -x Omit EIP translation, i.e. do not read System.map file\n" + "\n" + "Bug report address: %s\n", PACKAGE_BUGREPORT); + exit(code); +} + + int main(argc, argv) int argc; @@ -980,7 +1007,7 @@ int main(argc, argv) chdir ("/"); #endif /* Parse the command-line. */ - while ((ch = getopt(argc, argv, "c:df:iIk:nopsvx2")) != EOF) + while ((ch = getopt(argc, argv, "c:df:iIk:nopsvx2?")) != EOF) switch((char)ch) { case '2': /* Print lines with symbols twice. */ @@ -1023,6 +1050,12 @@ int main(argc, argv) case 'x': symbol_lookup = 0; break; + case '?': + usage(0); + break; + default: + usage(1); + break; } diff --git a/src/syslogd.c b/src/syslogd.c index a8a93d9..85d0aeb 100644 --- a/src/syslogd.c +++ b/src/syslogd.c @@ -823,7 +823,7 @@ extern int errno; /* Function prototypes. */ int main(int argc, char **argv); char **crunch_list(char *list); -int usage(void); +int usage(int code); void untty(void); void printchopped(const char *hname, char *msg, size_t len, int fd); void printline(const char *hname, char *msg); @@ -912,7 +912,7 @@ int main(argc, argv) funix[i] = -1; } - while ((ch = getopt(argc, argv, "46Aa:b:c:dhf:l:m:np:rs:v")) != EOF) + while ((ch = getopt(argc, argv, "46Aa:b:c:dhf:l:m:np:rs:v?")) != EOF) switch((char)ch) { case '4': family = PF_INET; @@ -978,11 +978,14 @@ int main(argc, argv) printf("syslogd v%s\n", VERSION); exit (0); case '?': + usage(0); + break; default: - usage(); + usage(1); + break; } if ((argc -= optind)) - usage(); + usage(1); #ifndef TESTING if ( !(Debug || NoFork) ) @@ -1260,12 +1263,34 @@ int main(argc, argv) } } -int usage() +int usage(int code) { - fprintf(stderr, "usage: syslogd [-46Adrvh] [-l hostlist] [-m markinterval] [-n] [-p path]\n" - " [-b maxlogfilesize] [-c maxrotatecount]" - " [-s domainlist] [-f conffile]\n"); - exit(1); + fprintf(stdout, + "Usage:\n" + " syslogd [-46Adnrvh?] [-a SOCK] [-b SIZE] [-c COUNT] [-f FILE] [-l HOST]\n" + " [-m SEC] [-p PATH] [-s LIST]\n" + "\n" + "Options:\n" + " -? Show this help text\n" + " -4 Force IPv4 only\n" + " -6 Force IPv6 only\n" + " -a SOCK Additional socket (max 19) to listen to, used with chroots\n" + " -A Send to all addresses in DNS A, or AAAA record\n" + " -b SIZE Log file rotation, rotate at SIZE bytes, default: disabled\n" + " -c COUNT Number of rotated log files kept\n" + " -d Enable debug mode\n" + " -f FILE Alternate .conf file, default: /etc/syslog.conf\n" + " -h Forward messages from other hosts also to remote syslog host(s)\n" + " -l HOST Host name to log without its FQDN, use ':' for multiple hosts\n" + " -m INTV Interval between MARK messages in log, 0 to disable, default: 20\n" + " -n Run in foreground, required when run from a modern init/supervisor\n" + " -p PATH Alternate path to UNIX domain socket, default: /dev/log\n" + " -r Act as remote syslog sink for other hosts\n" + " -s NAME Strip domain name before logging, use ':' for multiple domains\n" + " -v Show program version and exit\n" + "\n" + "Bug report address: %s\n", PACKAGE_BUGREPORT); + exit(code); } /*