From e67ebffaff50bb8e1d39b522d062424d576ea6bf Mon Sep 17 00:00:00 2001 From: Markus Makela Date: Tue, 19 Jan 2016 18:36:01 +0200 Subject: [PATCH] Updated help messages and manpage The manpage was out of date and was missing a BUGS section. The `--help` output of MaxScale wrongly stated that the default is to log to shared memory as did the documentation. --- .../Tutorials/Administration-Tutorial.md | 4 +-- Documentation/maxscale.1 | 29 ++++++++++++++----- server/core/gateway.c | 25 +++++++--------- 3 files changed, 35 insertions(+), 23 deletions(-) diff --git a/Documentation/Tutorials/Administration-Tutorial.md b/Documentation/Tutorials/Administration-Tutorial.md index bb05eb68d..1a9351775 100644 --- a/Documentation/Tutorials/Administration-Tutorial.md +++ b/Documentation/Tutorials/Administration-Tutorial.md @@ -33,7 +33,7 @@ Switch|Long Option|Description ------|-----------|----------- `-d`|`--nodaemon`|enable running in terminal process (default:disabled) `-f FILE`|`--config=FILE`|relative or absolute pathname of MaxScale configuration file (default:/etc/maxscale.cnf) -`-l[file shm]`|`--log=[file shm]`|log to file or shared memory (default: shm) +`-l[file shm]`|`--log=[file shm]`|log to file or shared memory (default: file) `-L PATH`|`--logdir=PATH`|path to log file directory (default: /var/log/maxscale) `-D PATH`|`--datadir=PATH`|path to data directory, stored embedded mysql tables (default: /var/cache/maxscale) `-C PATH`|`--configdir=PATH`|path to configuration file directory (default: /etc/) @@ -42,7 +42,7 @@ Switch|Long Option|Description `P PATH`|`--piddir=PATH`|PID file directory `-U USER`|`--user=USER`|run MaxScale as another user. The user ID and group ID of this user are used to run MaxScale. `-s [yes no]`|`--syslog=[yes no]`|log messages to syslog (default:yes) -`-S [yes no]`|`--maxscalelog=[yes no]`|log messages to MaxScale log (default: yes) +`-S [yes no]`|`--maxlog=[yes no]`|log messages to MaxScale log (default: yes) `-G [0 1]`|`--log_augmentation=[0 1]`|augment messages with the name of the function where the message was logged (default: 0). Primarily for development purposes. `-v`|`--version`|print version info and exit `-V`|`--version-full`|print version info and the commit ID the binary was built from diff --git a/Documentation/maxscale.1 b/Documentation/maxscale.1 index d24b3b47e..c835ad265 100644 --- a/Documentation/maxscale.1 +++ b/Documentation/maxscale.1 @@ -24,7 +24,7 @@ Run MaxScale in the terminal process Relative or absolute pathname of MaxScale configuration file to load. .TP .BR -l "[\fIfile|shm\fB], --log=[\fIfile|shm\fB]" -Log trace and debug logs to file or shared memory. The debug and trace logs are disabled by default and if enabled, will log to shared memory. +Log to file or shared memory. The default is to log to file. .TP .BR -L " \fIPATH\fB, --logdir=\fIPATH\fB" Path to log file directory. @@ -50,7 +50,7 @@ Run MaxScale as another user. The user ID and group ID of this user are used to .BR -s " [\fIyes\fB|\fIno\fB], --syslog=[\fIyes\fB|\fIno\fB]" Log messages to syslog. .TP -.BR -S " [\fIyes\fB|\fIno\fB], \fB--maxscalelog=[\fIyes\fB|\fIno\fB]" +.BR -S " [\fIyes\fB|\fIno\fB], \fB--maxlog=[\fIyes\fB|\fIno\fB]" Log messages to MaxScale's own log files. .TP .BR "-v, --version" @@ -61,12 +61,27 @@ Print full version information including the Git commit the binary was built fro .TP .BR "-?, --help" Show the help information for MaxScale and exit. - .SH EXAMPLES Tutorials on GitHub: -.UR https://github.com/mariadb-corporation/MaxScale/blob/master/Documentation/Documentation-Contents.md#tutorials -.UE + +.RS +.I https://github.com/mariadb-corporation/MaxScale/blob/master/Documentation/Documentation-Contents.md#tutorials +.RE .SH SEE ALSO +The MaxScale documentation on the MariaDB Knowledge Base: + +.RS +.I https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale/ +.RE + The MaxScale documentation on GitHub: -.UR https://github.com/mariadb-corporation/MaxScale/blob/master/Documentation/Documentation-Contents.md -.UE + +.RS +.I https://github.com/mariadb-corporation/MaxScale/blob/master/Documentation/Documentation-Contents.md +.RE +.SH BUGS +You can see a list of known bugs and report new bugs at: + +.RS +.I https://mariadb.atlassian.net/browse/MXS +.RE diff --git a/server/core/gateway.c b/server/core/gateway.c index 5aadda73f..0b6fadd6a 100644 --- a/server/core/gateway.c +++ b/server/core/gateway.c @@ -955,27 +955,24 @@ static void usage(void) fprintf(stderr, "\nUsage : %s [OPTION]...\n\n" " -d, --nodaemon enable running in terminal process (default:disabled)\n" - " -f, --config=FILE relative|absolute pathname of MaxScale configuration file\n" + " -f, --config=FILE relative or absolute pathname of MaxScale configuration file\n" " (default:/etc/maxscale.cnf)\n" - " -l, --log=[file|shm] log to file or shared memory (default: shm)\n" - " -L, --logdir=PATH path to log file directory\n" - " (default: /var/log/maxscale)\n" - " -A, --cachedir=PATH path to cache directory\n" - " (default: /var/cache/maxscale)\n" - " -B, --libdir=PATH path to module directory\n" - " (default: /usr/lib64/maxscale)\n" - " -C, --configdir=PATH path to configuration file directory\n" - " (default: /etc/)\n" + " -l, --log=[file|shm] log to file or shared memory (default: file)\n" + " -L, --logdir=PATH path to log file directory (default: /var/log/maxscale)\n" + " -A, --cachedir=PATH path to cache directory (default: /var/cache/maxscale)\n" + " -B, --libdir=PATH path to module directory (default: /usr/lib64/maxscale)\n" + " -C, --configdir=PATH path to configuration file directory (default: /etc/)\n" " -D, --datadir=PATH path to data directory, stored embedded mysql tables\n" " (default: /var/cache/maxscale)\n" - " -N, --language=PATH path to errmsg.sys file\n" - " (default: /var/lib/maxscale)\n" - " -P, --piddir=PATH path to PID file directory\n" - " (default: /var/run/maxscale)\n" + " -N, --language=PATH path to errmsg.sys file (default: /var/lib/maxscale)\n" + " -P, --piddir=PATH path to PID file directory (default: /var/run/maxscale)\n" " -U, --user=USER run MaxScale as another user.\n" " The user ID and group ID of this user are used to run MaxScale.\n" " -s, --syslog=[yes|no] log messages to syslog (default:yes)\n" " -S, --maxlog=[yes|no] log messages to MaxScale log (default: yes)\n" + " -G, --log_augmentation=0|1 augment messages with the name of the function where\n" + " the message was logged (default: 0). Primarily for \n" + " development purposes.\n" " -v, --version print version info and exit\n" " -V, --version-full print full version info and exit\n" " -?, --help show this help\n"