From 1fc6d2ee0b056ce0725a5e88308f2314d39846c7 Mon Sep 17 00:00:00 2001 From: Marko Lindqvist Date: Sat, 29 Oct 2022 07:46:10 +0300 Subject: [PATCH 37/37] Update freeciv-ruledit man page Mainly adding all the commandline options See osdn #45534 Signed-off-by: Marko Lindqvist --- doc/man/freeciv-ruledit.6.in | 53 ++++++++++++++++++++++++++++++------ 1 file changed, 44 insertions(+), 9 deletions(-) diff --git a/doc/man/freeciv-ruledit.6.in b/doc/man/freeciv-ruledit.6.in index bdaaa62044..2b9d4867dd 100644 --- a/doc/man/freeciv-ruledit.6.in +++ b/doc/man/freeciv-ruledit.6.in @@ -1,18 +1,53 @@ -.TH FREECIV 6 "September 21st 2014" +.TH FREECIV 6 "October 29th 2022" .SH NAME freeciv-ruledit - Freeciv Ruleset Editor .SH SYNOPSIS -.B freeciv-ruledit -[\fIoption \fR...] -.TP -\fB\-h\fR, \fB\-\-help\fR -Print a summary of the options -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version number +.B freeciv-ruledit \ +[ \-d|\-\-debug \fIlevel\fP ] \ +[ \-F|\-\-Fatal [ \fIsignal_number\fP ] ] \ +[ \-h|\-\-help ] \ +[ \-r|\-\-ruleset \fIruleset\fP ] \ +[ \-v|\-\-version ] + .SH DESCRIPTION This tool can be used to edit freeciv rulesets. +.SH OPTIONS +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\fP, \-\-debug \fIlevel\fP" +Sets the amount of debugging information to be logged. +Acceptable values for the \fIlevel\fP are: + +\fBfatal\fP for fatal messages only. + +\fBerror\fP for fatal and error messages. + +\fBwarning\fP for fatal, error and warning messages + +\fBnormal\fP for fatal, error, warning and normal messages (default). + +\fBverbose\fP for fatal, error, warning, normal, and verbose messages. + +.TP +.BI "\-F [ \fIsignal_number\fP ], \-\-Fatal [ \fIsignal_number\fP ]" +Raise a custom signal on failed assertion. If \fIsignal_number\fP is not +specified, then the ABRT signal will be used. + +.TP +.BI "\-h, \-\-help" +Prints a short summary of the standard command line options. + +.TP +.BI "\-r \fIruleset\fP, \-\-ruleset \fIruleset\fP" +Load specified ruleset as the starting point to edit. + +.TP +.BI "\-v, \-\-version" +Prints the version number and exits. + .SH "REPORTING BUGS" Report bugs at @BUG_URL@ .SH "SEE ALSO" -- 2.35.1