From a34f0b5461469585d2e13e13c8554eab10b535f9 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Wed, 1 Feb 2023 00:20:48 -0600 Subject: [PATCH] Update: Program man pages, adding copyright, fixing help, and adding missing period. Document the copyright parameter. The help uses dashes rather than pluses for compatibility with common GNU behavior. --- level_3/byte_dump/data/documentation/man/man1/byte_dump.1 | 7 +++++-- level_3/control/data/documentation/man/man1/control.1 | 7 +++++-- level_3/controller/data/documentation/man/man1/controller.1 | 7 +++++-- level_3/fake/data/documentation/man/man1/fake.1 | 7 +++++-- level_3/firewall/data/documentation/man/man1/firewall.1 | 6 ++++-- .../data/documentation/man/man1/fss_basic_list_read.1 | 7 +++++-- .../data/documentation/man/man1/fss_basic_list_write.1 | 7 +++++-- .../fss_basic_read/data/documentation/man/man1/fss_basic_read.1 | 7 +++++-- .../fss_basic_write/data/documentation/man/man1/fss_basic_write.1 | 7 +++++-- .../data/documentation/man/man1/fss_embedded_list_read.1 | 7 +++++-- .../data/documentation/man/man1/fss_embedded_list_write.1 | 7 +++++-- .../data/documentation/man/man1/fss_extended_list_read.1 | 7 +++++-- .../data/documentation/man/man1/fss_extended_list_write.1 | 7 +++++-- .../data/documentation/man/man1/fss_extended_read.1 | 7 +++++-- .../data/documentation/man/man1/fss_extended_write.1 | 7 +++++-- level_3/fss_identify/data/documentation/man/man1/fss_identify.1 | 7 +++++-- .../data/documentation/man/man1/fss_payload_read.1 | 7 +++++-- .../data/documentation/man/man1/fss_payload_write.1 | 7 +++++-- .../fss_status_code/data/documentation/man/man1/fss_status_code.1 | 7 +++++-- level_3/iki_read/data/documentation/man/man1/iki_read.1 | 7 +++++-- level_3/iki_write/data/documentation/man/man1/iki_write.1 | 7 +++++-- level_3/status_code/data/documentation/man/man1/status_code.1 | 7 +++++-- level_3/utf8/data/documentation/man/man1/utf8.1 | 7 +++++-- 23 files changed, 114 insertions(+), 46 deletions(-) diff --git a/level_3/byte_dump/data/documentation/man/man1/byte_dump.1 b/level_3/byte_dump/data/documentation/man/man1/byte_dump.1 index acb0227..1dec252 100644 --- a/level_3/byte_dump/data/documentation/man/man1/byte_dump.1 +++ b/level_3/byte_dump/data/documentation/man/man1/byte_dump.1 @@ -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. diff --git a/level_3/control/data/documentation/man/man1/control.1 b/level_3/control/data/documentation/man/man1/control.1 index 39f7ecb..3bc7886 100644 --- a/level_3/control/data/documentation/man/man1/control.1 +++ b/level_3/control/data/documentation/man/man1/control.1 @@ -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. diff --git a/level_3/controller/data/documentation/man/man1/controller.1 b/level_3/controller/data/documentation/man/man1/controller.1 index cd38223..d44ee1e 100644 --- a/level_3/controller/data/documentation/man/man1/controller.1 +++ b/level_3/controller/data/documentation/man/man1/controller.1 @@ -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. diff --git a/level_3/fake/data/documentation/man/man1/fake.1 b/level_3/fake/data/documentation/man/man1/fake.1 index a5a0070..374f5ae 100644 --- a/level_3/fake/data/documentation/man/man1/fake.1 +++ b/level_3/fake/data/documentation/man/man1/fake.1 @@ -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. diff --git a/level_3/firewall/data/documentation/man/man1/firewall.1 b/level_3/firewall/data/documentation/man/man1/firewall.1 index ea9c290..186b8f3 100644 --- a/level_3/firewall/data/documentation/man/man1/firewall.1 +++ b/level_3/firewall/data/documentation/man/man1/firewall.1 @@ -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. diff --git a/level_3/fss_basic_list_read/data/documentation/man/man1/fss_basic_list_read.1 b/level_3/fss_basic_list_read/data/documentation/man/man1/fss_basic_list_read.1 index 76769f7..82d1306 100644 --- a/level_3/fss_basic_list_read/data/documentation/man/man1/fss_basic_list_read.1 +++ b/level_3/fss_basic_list_read/data/documentation/man/man1/fss_basic_list_read.1 @@ -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. diff --git a/level_3/fss_basic_list_write/data/documentation/man/man1/fss_basic_list_write.1 b/level_3/fss_basic_list_write/data/documentation/man/man1/fss_basic_list_write.1 index b6a0f95..d7608a7 100644 --- a/level_3/fss_basic_list_write/data/documentation/man/man1/fss_basic_list_write.1 +++ b/level_3/fss_basic_list_write/data/documentation/man/man1/fss_basic_list_write.1 @@ -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. diff --git a/level_3/fss_basic_read/data/documentation/man/man1/fss_basic_read.1 b/level_3/fss_basic_read/data/documentation/man/man1/fss_basic_read.1 index 85caeeb..309c884 100644 --- a/level_3/fss_basic_read/data/documentation/man/man1/fss_basic_read.1 +++ b/level_3/fss_basic_read/data/documentation/man/man1/fss_basic_read.1 @@ -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. diff --git a/level_3/fss_basic_write/data/documentation/man/man1/fss_basic_write.1 b/level_3/fss_basic_write/data/documentation/man/man1/fss_basic_write.1 index 1530c7d..ed683c6 100644 --- a/level_3/fss_basic_write/data/documentation/man/man1/fss_basic_write.1 +++ b/level_3/fss_basic_write/data/documentation/man/man1/fss_basic_write.1 @@ -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. diff --git a/level_3/fss_embedded_list_read/data/documentation/man/man1/fss_embedded_list_read.1 b/level_3/fss_embedded_list_read/data/documentation/man/man1/fss_embedded_list_read.1 index efda5dd..d6c476d 100644 --- a/level_3/fss_embedded_list_read/data/documentation/man/man1/fss_embedded_list_read.1 +++ b/level_3/fss_embedded_list_read/data/documentation/man/man1/fss_embedded_list_read.1 @@ -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. diff --git a/level_3/fss_embedded_list_write/data/documentation/man/man1/fss_embedded_list_write.1 b/level_3/fss_embedded_list_write/data/documentation/man/man1/fss_embedded_list_write.1 index 2b99dd9..a897862 100644 --- a/level_3/fss_embedded_list_write/data/documentation/man/man1/fss_embedded_list_write.1 +++ b/level_3/fss_embedded_list_write/data/documentation/man/man1/fss_embedded_list_write.1 @@ -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. diff --git a/level_3/fss_extended_list_read/data/documentation/man/man1/fss_extended_list_read.1 b/level_3/fss_extended_list_read/data/documentation/man/man1/fss_extended_list_read.1 index de3e9b5..eb84633 100644 --- a/level_3/fss_extended_list_read/data/documentation/man/man1/fss_extended_list_read.1 +++ b/level_3/fss_extended_list_read/data/documentation/man/man1/fss_extended_list_read.1 @@ -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. diff --git a/level_3/fss_extended_list_write/data/documentation/man/man1/fss_extended_list_write.1 b/level_3/fss_extended_list_write/data/documentation/man/man1/fss_extended_list_write.1 index d78de66..5d946c7 100644 --- a/level_3/fss_extended_list_write/data/documentation/man/man1/fss_extended_list_write.1 +++ b/level_3/fss_extended_list_write/data/documentation/man/man1/fss_extended_list_write.1 @@ -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. diff --git a/level_3/fss_extended_read/data/documentation/man/man1/fss_extended_read.1 b/level_3/fss_extended_read/data/documentation/man/man1/fss_extended_read.1 index 9b3e669..8972e64 100644 --- a/level_3/fss_extended_read/data/documentation/man/man1/fss_extended_read.1 +++ b/level_3/fss_extended_read/data/documentation/man/man1/fss_extended_read.1 @@ -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. diff --git a/level_3/fss_extended_write/data/documentation/man/man1/fss_extended_write.1 b/level_3/fss_extended_write/data/documentation/man/man1/fss_extended_write.1 index 306d5f7..716ff1d 100644 --- a/level_3/fss_extended_write/data/documentation/man/man1/fss_extended_write.1 +++ b/level_3/fss_extended_write/data/documentation/man/man1/fss_extended_write.1 @@ -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. diff --git a/level_3/fss_identify/data/documentation/man/man1/fss_identify.1 b/level_3/fss_identify/data/documentation/man/man1/fss_identify.1 index ce204c5..4c423a8 100644 --- a/level_3/fss_identify/data/documentation/man/man1/fss_identify.1 +++ b/level_3/fss_identify/data/documentation/man/man1/fss_identify.1 @@ -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. diff --git a/level_3/fss_payload_read/data/documentation/man/man1/fss_payload_read.1 b/level_3/fss_payload_read/data/documentation/man/man1/fss_payload_read.1 index dbb13ea..08aac33 100644 --- a/level_3/fss_payload_read/data/documentation/man/man1/fss_payload_read.1 +++ b/level_3/fss_payload_read/data/documentation/man/man1/fss_payload_read.1 @@ -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. diff --git a/level_3/fss_payload_write/data/documentation/man/man1/fss_payload_write.1 b/level_3/fss_payload_write/data/documentation/man/man1/fss_payload_write.1 index 82ba8e6..2bd7cc0 100644 --- a/level_3/fss_payload_write/data/documentation/man/man1/fss_payload_write.1 +++ b/level_3/fss_payload_write/data/documentation/man/man1/fss_payload_write.1 @@ -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. diff --git a/level_3/fss_status_code/data/documentation/man/man1/fss_status_code.1 b/level_3/fss_status_code/data/documentation/man/man1/fss_status_code.1 index a027f0f..19e470f 100644 --- a/level_3/fss_status_code/data/documentation/man/man1/fss_status_code.1 +++ b/level_3/fss_status_code/data/documentation/man/man1/fss_status_code.1 @@ -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. diff --git a/level_3/iki_read/data/documentation/man/man1/iki_read.1 b/level_3/iki_read/data/documentation/man/man1/iki_read.1 index f8819ad..754871d 100644 --- a/level_3/iki_read/data/documentation/man/man1/iki_read.1 +++ b/level_3/iki_read/data/documentation/man/man1/iki_read.1 @@ -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. diff --git a/level_3/iki_write/data/documentation/man/man1/iki_write.1 b/level_3/iki_write/data/documentation/man/man1/iki_write.1 index d015153..0568f87 100644 --- a/level_3/iki_write/data/documentation/man/man1/iki_write.1 +++ b/level_3/iki_write/data/documentation/man/man1/iki_write.1 @@ -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. diff --git a/level_3/status_code/data/documentation/man/man1/status_code.1 b/level_3/status_code/data/documentation/man/man1/status_code.1 index 1ebb730..23934ab 100644 --- a/level_3/status_code/data/documentation/man/man1/status_code.1 +++ b/level_3/status_code/data/documentation/man/man1/status_code.1 @@ -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. diff --git a/level_3/utf8/data/documentation/man/man1/utf8.1 b/level_3/utf8/data/documentation/man/man1/utf8.1 index 3f9bf27..83f6607 100644 --- a/level_3/utf8/data/documentation/man/man1/utf8.1 +++ b/level_3/utf8/data/documentation/man/man1/utf8.1 @@ -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. -- 1.8.3.1