diff options
Diffstat (limited to 'cliapp.5')
| -rw-r--r-- | cliapp.5 | 57 |
1 files changed, 57 insertions, 0 deletions
@@ -130,6 +130,20 @@ attack-kittens = no .PP This turns the verbose setting on, but does not launch attack kittens. +.PP +For every boolean setting, +two command line options are added. +If the setting is called +.IR foo , +the option +.I \-\-foo +will turn the setting on, +and +.I \-\-no\-foo +will turn it off. +The negation is only usable on the command line: +its purpose is to allow the command line to override a setting from the +configuration file. .SS "Logging and log files" Programs using .B cliapp @@ -171,6 +185,49 @@ as set by the application code or determined by automatically. The value of the environment variable is the name of the file to which the resulting profile is to be written. +.SS "Manual page generation" +.B cliapp +can generate parts of a manual page: +the +.I SYNOPSIS +and +.I OPTIONS +sections. +It fills these in automatically based on the subcommand and settings +that a program supports. +Use the +.BR \-\-generate\-manpage =\fIFILE +option, +which is added automatically by +.BR cliapp . +The +.I FILE +is a manual page marked up using +the +.B -man +macros for +.BR troff (1). +It should have empty +.I SYNOPSIS +and +.I OPTIONS +sections, +and +.B cliapp +will fill them in. +The output it to the standard output. +.PP +For example: +.PP +.RS +foo --generate-manpage=foo.1.in > foo.1 +.RE +.PP +You would keep the source code for the manual page in +.I foo.1.in +and have your Makefile produce +.I foo.1 +as shown above. .SH FILES .B cliapp reads a list of configuration files at startup, |