]> Kevux Git Server - fll/commitdiff
Update: Program man pages, adding copyright, fixing help, and adding missing period.
authorKevin Day <kevin@kevux.org>
Wed, 1 Feb 2023 06:20:48 +0000 (00:20 -0600)
committerKevin Day <kevin@kevux.org>
Wed, 1 Feb 2023 06:20:48 +0000 (00:20 -0600)
Document the copyright parameter.
The help uses dashes rather than pluses for compatibility with common GNU behavior.

23 files changed:
level_3/byte_dump/data/documentation/man/man1/byte_dump.1
level_3/control/data/documentation/man/man1/control.1
level_3/controller/data/documentation/man/man1/controller.1
level_3/fake/data/documentation/man/man1/fake.1
level_3/firewall/data/documentation/man/man1/firewall.1
level_3/fss_basic_list_read/data/documentation/man/man1/fss_basic_list_read.1
level_3/fss_basic_read/data/documentation/man/man1/fss_basic_read.1
level_3/fss_embedded_list_read/data/documentation/man/man1/fss_embedded_list_read.1
level_3/fss_extended_list_read/data/documentation/man/man1/fss_extended_list_read.1
level_3/fss_extended_read/data/documentation/man/man1/fss_extended_read.1
level_3/fss_identify/data/documentation/man/man1/fss_identify.1
level_3/fss_payload_read/data/documentation/man/man1/fss_payload_read.1
level_3/fss_write/data/documentation/man/man1/fss_basic_list_write.1
level_3/fss_write/data/documentation/man/man1/fss_basic_write.1
level_3/fss_write/data/documentation/man/man1/fss_embedded_list_write.1
level_3/fss_write/data/documentation/man/man1/fss_extended_list_write.1
level_3/fss_write/data/documentation/man/man1/fss_extended_write.1
level_3/fss_write/data/documentation/man/man1/fss_payload_write.1
level_3/iki_read/data/documentation/man/man1/iki_read.1
level_3/iki_write/data/documentation/man/man1/iki_write.1
level_3/status_code/data/documentation/man/man1/fss_status_code.1
level_3/status_code/data/documentation/man/man1/status_code.1
level_3/utf8/data/documentation/man/man1/utf8.1

index 3f429dcfcedef32b1182d233f9059b9e46ef1314..cce939ea48acd2fe1c57406cafc48500e29ea138 100644 (file)
@@ -17,11 +17,14 @@ When \fB\-\-last\fR is used, any UTF-8 sequences will still be printed in full s
 When using the \fB\-\-unicode\fR option, invalid Unicode will fallback to being displayed using one of the other modes.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 1f98d680391591859b07fd34d665ea7fa45ce53e..27cabcd65787c182305c6d3e056c8385a39feeb2 100644 (file)
@@ -15,11 +15,14 @@ Be sure to use the \fB++quiet\fR parameter to suppress output when using this in
 No response is returned on program errors, especially those errors that prevent communicating to the controller.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 1c1df0146fd2e89e1eeb573c6cd8fa69b194726a..80c49e5df8cabc6cc49abeb65c20671c748b500f 100644 (file)
@@ -22,11 +22,14 @@ The default interrupt behavior is to operate as if the \fB\-\-interruptible\fR p
 Specify an empty string for the \fB\-\-pid\fR parameter to disable pid file creation for this program.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 85782ae15a7b562c362088137f360f81ef7a3248..24651b974c603d0e93eb6086f1060e87a09d44cb 100644 (file)
@@ -29,11 +29,14 @@ When piping data to this program, the piped data is treated as if it were prepen
 A section name from the fakefile that does not conflict with an operation name may be specified when performing the make operation.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 0c6ded52445850b1b2cbae4e500c5d0a4903b2fe..97be099fe6d8ef52ba7a4266654648e9b7d14061 100644 (file)
@@ -8,11 +8,13 @@ firewall \- A basic iptables based firewall manager for the Kevux distribution.
 .PP
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index a67e4967c55447a50119fd0ef87333eb338cca8d..42ecc1ae6bcb3be97b6152cb072488fd4dba0a0f 100644 (file)
@@ -55,11 +55,14 @@ The word '\fBcolumn\fR' is being loosely defined to refer to a specific Content.
 This is not to be confused with a depth.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index db0635e57faca74d11090e08d9579fe85cdf180f..d5710d7e207dd888d8cd34aa280337c7e6867818 100644 (file)
@@ -55,11 +55,14 @@ The word '\fBcolumn\fR' is being loosely defined to refer to a specific Content.
 This is not to be confused with a depth.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 329ac6b9d6e00cdb714e510800f19ab7954a269c..644554a2521b385d6eaf54cf836c9d571f0883fe 100644 (file)
@@ -54,11 +54,14 @@ The word '\fBcolumn\fR' is being loosely defined to refer to a specific Content.
 This is not to be confused with a depth.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index fda074cabedc4ba7d22f3ec5ece87cc162b95afd..5cb10212fbcc7b34e2a3637051cef8b93c5fc628 100644 (file)
@@ -55,11 +55,14 @@ The word '\fBcolumn\fR' is being loosely defined to refer to a specific Content.
 This is not to be confused with a depth.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index a91e64b3e36fac7adc30e07ae453048891d967b7..e7bb499c7eba86c997e4256a6aaafa8ed7128290 100644 (file)
@@ -55,11 +55,14 @@ The word '\fBcolumn\fR' is being loosely defined to refer to a specific Content.
 This is not to be confused with a depth.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 5ea423341d6bbd1af55d9678e04b014b5b16b1f9..ef9c16f6b8ef87e908d76595f16082b2f0538f62 100644 (file)
@@ -18,11 +18,14 @@ Whitespace must follow this pound character.
 There may be multiple Object and Content pairs, separated by white space, such as: '\fB# fss-0002 fss-0000 iki-0002\fR'.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 587009e959be09bf45e844dac7f4fecfad8b433c..47c7e6cdf5f096d76d12276418d704608651007b 100644 (file)
@@ -60,11 +60,14 @@ Content at this depth is processed as \fBFSS-0001 Extended\fR.
 The Content of the explicit Object of 'payload' will not contain any Content close pipe control codes when using \fB\-\-pipe\fR.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 893e48ae0f748a8a2dceef82f9b6497199186b4f..9a1e0f87a1da5cdc1bea75db6c1c21be46b2530b 100644 (file)
@@ -18,11 +18,14 @@ This program does not use the parameter '\fB\-\-ignore\fR', which therefore does
 This parameter requires two values.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 00311f810f07eb186a4def765c55d854330fc453..c498f54fe5c0d6adde3256723ce8a26faf2a573d 100644 (file)
@@ -17,11 +17,14 @@ The \fBFSS-0000 (Basic)\fR specification does not support multi-line Content, th
 This program does not use the parameter '\fB\-\-ignore\fR', which therefore does nothing.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 94fe49368c5d23cc53373da2f74e7e599debbcfd..35b8a80f1e3ec1e89acc1e85d7439685fc716241 100644 (file)
@@ -20,11 +20,14 @@ This parameter is not used for ignoring anything from the input pipe.
 This parameter must be specified after a '\fB\-\-content\fR' parameter and this applies only to the Content represented by that specific '\fB\-\-content\fR' parameter.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 6d903f513e2b25401185b8b45136bd805d701c9a..8d5cc374a15c885a4121f18c9b03106fed749ee9 100644 (file)
@@ -20,11 +20,14 @@ This parameter is not used for ignoring anything from the input pipe.
 This parameter must be specified after a '\fB\-\-content\fR' parameter and this applies only to the Content represented by that specific '\fB\-\-content\fR' parameter.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 7cf702c0244d6b15e6256861876aedc3eec060d7..0f2aa0223c407ba9d7b18ef8ee2148928f166783 100644 (file)
@@ -18,11 +18,14 @@ This program does not use the parameter '\fB\-\-ignore\fR', which therefore does
 This parameter requires two values.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index e2693517f5a6d22715d09af02456368506373362..c8112dffab07554825ffa8170d41330e7130dbfe 100644 (file)
@@ -18,11 +18,14 @@ This program does not use the parameter '\fB\-\-ignore\fR', which therefore does
 This parameter requires two values.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 389291e9e345e2ce4fc85d31b8993ca33b2ded1e..d7f23f9e0aceb12b8084e280d0994197f0e0cb54 100644 (file)
@@ -37,11 +37,14 @@ The \fB\-\-substitute\fR option takes priority over the \fB\-\-replace\fR option
 The default behavior is to only display \fBContent\fR portion of the IKI \fBVariable\fR.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 478cbadb0970935bc35f3d6f7328f1e875c8f23f..753b0d7951c04d8ca29a80fe822a8f7b75bae815 100644 (file)
@@ -16,11 +16,14 @@ When piping main to this program, a single form-feed character (\fB\\f\fR) (\fBU
 Furthermore, each \fBObject\fR must be followed by a \fBContent\fR.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 646d29e771dfd502a872b2482709c83e305a832f..fa497adf906f3b2d102942d1f08dcc98b7ed833b 100644 (file)
@@ -22,11 +22,14 @@ Each code will be printed on its own line.
 Errors regarding each code may be printed on its own line.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 8793b9a2eff8f7b6aa31502eaf5b4e73b39787c6..f032556813cb22999f35b2ea018d55e1b87faf8e 100644 (file)
@@ -20,11 +20,14 @@ Each code will be printed on its own line.
 Errors regarding each code may be printed on its own line.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.
index 83f5d4f5b71f56fa8d3bb6d8e1a99fedd330654b..157dc031174b1922c0e3d121de088c8b634861f0 100644 (file)
@@ -16,11 +16,14 @@ When using the parameter '\fB\-\-to_combining\fR' with the parameter '\fB\-\-to_
 The combining characters should be considered 1-width by themselves or 0-width when combined.
 .SH OPTIONS
 .TP
-\fB\{+h, ++help\fR
+\fB\{\-h, \-\-help\fR
 Print the help message.
 .TP
+\fB+C, ++copyright\fR
+Print the copyright.
+.TP
 \fB+d, ++dark\fR
-Output using colors that show up better on dark backgrounds
+Output using colors that show up better on dark backgrounds.
 .TP
 \fB+l, ++light\fR
 Output using colors that show up better on light backgrounds.