]> 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:22:01 +0000 (00:22 -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_list_write/data/documentation/man/man1/fss_basic_list_write.1
level_3/fss_basic_read/data/documentation/man/man1/fss_basic_read.1
level_3/fss_basic_write/data/documentation/man/man1/fss_basic_write.1
level_3/fss_embedded_list_read/data/documentation/man/man1/fss_embedded_list_read.1
level_3/fss_embedded_list_write/data/documentation/man/man1/fss_embedded_list_write.1
level_3/fss_extended_list_read/data/documentation/man/man1/fss_extended_list_read.1
level_3/fss_extended_list_write/data/documentation/man/man1/fss_extended_list_write.1
level_3/fss_extended_read/data/documentation/man/man1/fss_extended_read.1
level_3/fss_extended_write/data/documentation/man/man1/fss_extended_write.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_payload_write/data/documentation/man/man1/fss_payload_write.1
level_3/fss_status_code/data/documentation/man/man1/fss_status_code.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/status_code.1
level_3/utf8/data/documentation/man/man1/utf8.1

index acb022718e625a17d76fe6945048d8f761482e81..1dec25273ac3b61c6494e2b90ce18bfc2b45ce63 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 39f7ecb30be34efc293f16e62f43245640fdb355..3bc78866e3736eda56e46c90cf08ade91600e5a6 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 cd382231c3ef1a0d6cea08e5890e83c412906723..d44ee1e3c58f33f571de37e7e2125dcda1e8927b 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 a5a007084409d1df25caae36b46685dc885a6059..374f5ae13a55f8b18af486706207d46b226ce7cd 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 ea9c290a394a132aed2031bafa1ba237f7783efb..186b8f3b864c2a4ac183fbc148cae5ef5dc9cef2 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 76769f7aa5a9eb3258a6d2a8bb4bcba74d0b8237..82d1306699532dff67152105f47c1e3c2c501249 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 b6a0f95cead2f3b559d7022dbc3e0a068d91b127..d7608a72bc9f9fc871d8c852c382b7e6ef34ad48 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 85caeeb6a4cce4bf9147293ee0830a414614c79f..309c884c07e363c41ff87c360c6f227d665628a6 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 1530c7d7c4aa3d96140876aafd868b887840819a..ed683c63e2a4d08de5ce0fa9903fa40967bee447 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 efda5dd409b1326953a022a37b336a57575711a3..d6c476db5dba71872d411d12a942232595bb637d 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 2b99dd93e370af941203522f4d1b25b137dcd554..a89786207b3c79ca7ce0809b4d46a0544b438380 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 de3e9b57857f4accb23dd724fe5511b41624c315..eb8463387c05c98ad603482ffc36ca105083d30b 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 d78de661feb1ce81f79f07c2c5884d37030688dd..5d946c7bf65203f85b9f2a821378bb55805b43f8 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 9b3e669f1fae5f650dc8d2eac210294987434070..8972e64cfc789fd14c7b84541e3ef506a1fc34e4 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 306d5f7f1fbe2c668101741758c9bb932dc45657..716ff1dc6f3e297fc3a3e8d80409062e8bcb65c4 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 ce204c558d408e5bce25e8101f54147accde87a5..4c423a8fb4d777bb500d3732720c30fee4ff04d7 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 dbb13ea2490a5b6805ca16282e2b7df6c283c784..08aac33c4c857b457818b96decc36b4b13722792 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 82ba8e6ff42c0457559dec5664faeb0a6431cb88..2bd7cc0cd95a3d4176bf46e1502fd4607cc6c212 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 a027f0fab64a80772b150632e01cd2561b5dc5c3..19e470ff5ba4277409dadd2ef365562e529aca60 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 f8819ad503a8f6fb16eaf0aa9ab50004c090c412..754871d6d0eef90ed5ddd7449dba76833b13fdab 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 d01515327439f1172c216ec323cbe4a0172dec0d..0568f872b233ea41c85f99d69b2dcb7c4d4b6207 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 1ebb730baa9c73545427fbf194cf565bccfb48c3..23934abeca886853457dfd762e7101b4ee911c65 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 3f9bf27e7c21d4e1e6105deb0ae5ef859e100ea3..83f6607687395c4800265f1893b2a0fe17d0e6df 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.