From 7ca2709f134cb9734f6b07c221de942243573302 Mon Sep 17 00:00:00 2001 From: Marko Lindqvist Date: Sat, 17 Sep 2022 17:37:15 +0300 Subject: [PATCH 28/28] Man pages: Document log levels by names See osdn #45589 Signed-off-by: Marko Lindqvist --- doc/man/freeciv-client.6.in | 18 +++++++++--------- doc/man/freeciv-manual.6.in | 4 ++-- doc/man/freeciv-modpack.6.in | 16 ++++++++-------- doc/man/freeciv-server.6.in | 36 ++++++++++++++++++------------------ 4 files changed, 37 insertions(+), 37 deletions(-) diff --git a/doc/man/freeciv-client.6.in b/doc/man/freeciv-client.6.in index 889ac62798..92a7c607f9 100644 --- a/doc/man/freeciv-client.6.in +++ b/doc/man/freeciv-client.6.in @@ -17,7 +17,7 @@ freeciv-gtk3, freeciv-gtk3.22, freeciv-sdl2, freeciv-qt \ .B freeciv-gtk3|freeciv-gtk3.22|freeciv-sdl2|freeciv-qt \ [ \-A|\-\-Announce \fIprotocol\fP ] \ [ \-a|\-\-autoconnect ] \ -[ \-d|\-\-debug \fIlevel_number\fP ] \ +[ \-d|\-\-debug \fIlevel\fP ] \ [ \-F|\-\-Fatal [ \fIsignal_number\fP ] ] \ [ \-f|\-\-file \fIfilename\fP ] \ [ \-h|\-\-help ] \ @@ -103,20 +103,20 @@ Possible values for \fIprotocol\fP are: Skips the connect dialog, automatically inserting the default values. This is quite convenient when all has been set up properly. .TP -.BI "\-d \fIlevel_number\fP, \-\-debug \fIlevel_number\fP" +.BI "\-d \fIlevel\fP, \-\-debug \fIlevel\fP" Sets the amount of debugging information to be logged in the file named by the .I \-l -option. Acceptable values for the \fIlevel_number\fP are: +option. Acceptable values for the \fIlevel\fP are: -\fB0\fP for fatal messages only. +\fBfatal\fP for fatal messages only. -\fB1\fP for fatal and error messages. +\fBerror\fP for fatal and error messages. -\fB2\fP for fatal, error and warning messages +\fBwarning\fP for fatal, error and warning messages -\fB3\fP for fatal, error, warning and normal messages (default). +\fBnormal\fP for fatal, error, warning and normal messages (default). -\fB4\fP for fatal, error, warning, normal, and verbose messages. +\fBverbose\fP for fatal, error, warning, normal, and verbose messages. .TP .BI "\-F [ \fIsignal_number\fP ], \-\-Fatal [ \fIsignal_number\fP ]" @@ -133,7 +133,7 @@ Prints a short summary of the standard command line options. .BI "\-l \fIfilename\fP, \-\-log \fIfilename\fP" Defines a log file, \fIfilename\fP, to be produced during processing. Use the .I \-d -option to set how much is logged. By default, fatal, error, and normal +option to set how much is logged. By default, fatal, error, warning, and normal messages are printed to standard output. With a log file, such messages go to the log instead. If \fIfilename\fP already exists, it is appended to. .TP diff --git a/doc/man/freeciv-manual.6.in b/doc/man/freeciv-manual.6.in index 4f6a83268e..e3e91612a5 100644 --- a/doc/man/freeciv-manual.6.in +++ b/doc/man/freeciv-manual.6.in @@ -6,8 +6,8 @@ freeciv-manual - Generate HTML or wiki manual for .B freeciv-manual [\fIoption \fR...] .TP -\fB\-d\fR, \fB\-\-debug\fR NUM -Set debug log level (0 to 4) +\fB\-d\fR, \fB\-\-debug\fR LEVEL +Set debug log level (one of f,e,w,n,v) .TP \fB\-h\fR, \fB\-\-help\fR Print a summary of the options diff --git a/doc/man/freeciv-modpack.6.in b/doc/man/freeciv-modpack.6.in index f6dea942e1..52b8e6682f 100644 --- a/doc/man/freeciv-modpack.6.in +++ b/doc/man/freeciv-modpack.6.in @@ -15,7 +15,7 @@ freeciv-mp-gtk4, freeciv-mp-gtk3, freeciv-mp-qt, freeciv-mp-cli \ \- Custom content installers for the Freeciv game .SH SYNOPSIS .B freeciv-mp-XXX \ -[ \-d|\-\-debug \fIlevel_number\fP ] \ +[ \-d|\-\-debug \fIlevel\fP ] \ [ \-h|\-\-help ] \ [ \-i|\-\-install \fIURL\fP ] \ [ \-L|\-\-List \fIURL\fP ] \ @@ -65,19 +65,19 @@ All options have a short form (single hyphen and single letter) and a long form (double hyphen and a complete word); their effects are identical. .TP -.BI "\-d \fIlevel_number\fP, \-\-debug \fIlevel_number\fP" +.BI "\-d \fIlevel\fP, \-\-debug \fIlevel\fP" Sets the amount of debugging information to be logged. -Acceptable values for the \fIlevel_number\fP are: +Acceptable values for the \fIlevel\fP are: -\fB0\fP for fatal messages only. +\fBfatal\fP for fatal messages only. -\fB1\fP for fatal and error messages. +\fBerror\fP for fatal and error messages. -\fB2\fP for fatal, error and warning messages +\fBwarning\fP for fatal, error and warning messages -\fB3\fP for fatal, error, warning and normal messages (default). +\fBnormal\fP for fatal, error, warning and normal messages (default). -\fB4\fP for fatal, error, warning, normal, and verbose messages. +\fBverbose\fP for fatal, error, warning, normal, and verbose messages. .TP .BI "\-h, \-\-help" diff --git a/doc/man/freeciv-server.6.in b/doc/man/freeciv-server.6.in index fa45c1182b..1c8ae03999 100644 --- a/doc/man/freeciv-server.6.in +++ b/doc/man/freeciv-server.6.in @@ -17,7 +17,7 @@ freeciv-server \- The server for the Freeciv game [ \-A|\-\-Announce \fIprotocol\fP ] \ [ \-b|\-\-bind \fIaddress\fP ] \ [ \-B|\-\-Bind\-meta \fIaddress\fP ] \ -[ \-d|\-\-debug \fIlevel_number\fP ] \ +[ \-d|\-\-debug \fIlevel\fP ] \ [ \-e|\-\-exit\-on\-end ] \ [ \-F|\-\-Fatal [ \fIsignal_number\fP ] ] \ [ \-f|\-\-file \fIfilename\fP ] \ @@ -101,20 +101,20 @@ address given by .I \-b option. .TP -.BI "\-d \fIlevel_number\fP, \-\-debug \fIlevel_number\fP" +.BI "\-d \fIlevel\fP, \-\-debug \fIlevel\fP" Sets the amount of debugging information to be logged in the file named by the .I \-l -option. Acceptable values for the \fIlevel_number\fP are: +option. Acceptable values for the \fIlevel\fP are: -\fB0\fP for fatal messages only. +\fBfatal\fP for fatal messages only. -\fB1\fP for fatal and error messages. +\fBerror\fP for fatal and error messages. -\fB2\fP for fatal, error and warning messages +\fBwarning\fP for fatal, error and warning messages -\fB3\fP for fatal, error, warning and normal messages (default). +\fBnormal\fP for fatal, error, warning and normal messages (default). -\fB4\fP for fatal, error, warning, normal, and verbose messages. +\fBverbose\fP for fatal, error, warning, normal, and verbose messages. .TP .BI "\-D \fIfilename\fP, \-\-Database \fIfilename\fP" @@ -175,7 +175,7 @@ modules. .BI "\-l \fIfilename\fP, \-\-log \fIfilename\fP" Defines a log file, \fIfilename\fP, to be produced during processing. Use the .I \-d -option to set how much is logged. By default, fatal, error, and normal +option to set how much is logged. By default, fatal, error, warning, and normal messages are printed to standard output. With a log file, such messages go to the log instead. If \fIfilename\fP already exists, it is appended to. .TP @@ -250,21 +250,21 @@ Starts a server on port \fI2244\fP, loading the save game file \fIoldgame.sav\fP. .TP .B freeciv-server \-R ranklog \-l logfile \-r script \-f oldgame.sav.gz -p 2244 -Starts a server on port \fI2244\fP, loading the save game file -\fIoldgame.sav.gz\fP. Ranking related events are written to \fIranklog\fP, other -logging information is written to \fIlogfile\fP. When the server starts, it +Starts a server on port \fI2244\fP, loading the save game file +\fIoldgame.sav.gz\fP. Ranking related events are written to \fIranklog\fP, other +logging information is written to \fIlogfile\fP. When the server starts, it immediately executes the commands contained in \fIscript\fP. .TP -.B freeciv-server -m -a -D fc_auth.conf -q 60 -p 2244 -d 2 -l logfile -r script -s ~/saves -Starts a server on port \fI2244\fP with authentication enabled and communicates -its existence to the standard Freeciv metaserver. Fatal, error, and normal -messages are written to \fIlogfile\fP. When the server starts it immediately -executes the commands contained in \fIscript\fP. Save game files are stored in +.B freeciv-server -m -a -D fc_auth.conf -q 60 -p 2244 -d normal -l logfile -r script -s ~/saves +Starts a server on port \fI2244\fP with authentication enabled and communicates +its existence to the standard Freeciv metaserver. Fatal, error, warning, and normal +messages are written to \fIlogfile\fP. When the server starts it immediately +executes the commands contained in \fIscript\fP. Save game files are stored in the \fI~/saves\fP directory. When there are no users on the server for \fI60\fP seconds, the server will restart. .SH COMMANDS You may enter commands into the server at any time, either before or during the -running of a game. +running of a game. Type "help" or "help help" for starters. .SH FILES -- 2.35.1