From: Kevin Day Date: Sun, 8 Jan 2023 01:17:53 +0000 (-0600) Subject: Update: Documentation for several programs. X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=a050a45409b21cdd0bb99d2fdff9f8e1ad9a883a;p=kevux.org-website Update: Documentation for several programs. --- diff --git a/documentation/fss_status_code.html b/documentation/fss_status_code.html index 962cb3f..042ac6a 100644 --- a/documentation/fss_status_code.html +++ b/documentation/fss_status_code.html @@ -210,6 +210,27 @@ +

+ The FLL programs use a 16-bit unsigned integer to represent the return status of programs and functions. +

+

+ Programs may print a generic error with one of these codes. + This is a tool for converting to or converting from these codes. +

+

+ The 16-bit unsigned integer also has the first two high-order bits used to represent flags. + These flags are the error bit and the warning bit. + When neither of these flags are set, then the status is considered fine. +

+

+ This operates identical to the status_codes program except that this program handles additional codes regarding FSS. + These special codes numericaly appear after the F_status_code_last code. + These codes stop at the F_fss_status_code_last code. +

+

+ Each code will be printed on its own line. + Errors regarding each code may be printed on its own line. +

diff --git a/documentation/iki_read.html b/documentation/iki_read.html index 728b1fb..48bd866 100644 --- a/documentation/iki_read.html +++ b/documentation/iki_read.html @@ -257,39 +257,45 @@

+ This program will find and print Variables, Vocabularies, or Content following the IKI standard, without focusing on any particular Vocabulary specification. +

+

The -r/--replace option requires 2 additional parameters: <vocabulary> <with>.

-
vocabulary
The name of the vocabulary whose content is to be substituted.
+
vocabulary
The name of the Vocabulary whose Content is to be substituted.
with
The new string to use as the substitute.

- The -R/--reassign and the -s/--substitute options require 3 additional parameters: <vocabulary> <replace> <with>. + The Vocabulary is case-sensitive and must exactly match. +

+

+ The -R/--reassign option and the -s/--substitute options require 3 additional parameters:: <vocabulary> <replace> <with>.

-
vocabulary
The name of the vocabulary whose content is to be substituted.
+
vocabulary
The name of the Vocabulary whose Content is to be substituted.
-
replace
The content matching this exact string will be substituted.
+
replace
The Content matching this exact string will be substituted.
with
The new string to use as the substitute.

- The vocabulary and replacement are case-sensitive and must exactly match. + The Vocabulary and replacement are case-sensitive and must exactly match.

The -W/--wrap option requires 3 additional parameters: <vocabulary> <before> <after>.

-
vocabulary
The name of the vocabulary whose content is to be wrapped.
+
vocabulary
The name of the vocabulary whose Content is to be wrapped.
before
The string to prepend.
@@ -299,19 +305,19 @@

- The difference between -r/--replace and -s/--substitute is that the -r/--replace option substitutes all matching vocabulary names and the -s/--substitute option substitutes all matching vocabulary names that must also have the given matching content. + The Vocabulary is case-sensitive and must exactly match.

- The -R/--reassign option is identical to the -s/--substitute option except that the -w/--wrap option is ignored (not applied). + The difference between -r/--replace and -s/--substitute is that the -r/--replace option substitutes all matching Vocabulary names and the -s/--substitute option substitutes all matching Vocabulary names that must also have the given matching Content.

- The -s/--substitute option takes priority over the -r/--replace option when matching the same variable. + The -s/--reassign option is identical to the -s/--substitute option except that the -W/--wrap option is ignored (not applied).

- The -W/--wrap option is ignored when the -s/--substitute option is matching the same variable. + The -s/--substitute option takes priority over the -r/--replace option when matching the same Variable.

- The default behavior is to only display content portion of the IKI variable. + The default behavior is to only display Content portion of the IKI variable.

diff --git a/documentation/iki_write.html b/documentation/iki_write.html index 760f7c2..b2971fe 100644 --- a/documentation/iki_write.html +++ b/documentation/iki_write.html @@ -187,11 +187,6 @@ - -f - --file - Specify a file to send data to. - - -c --content The Content to write. @@ -202,6 +197,11 @@ Use double quotes (default). + -f + --file + Specify a file to send data to. + + -o --object The Object to write. @@ -215,7 +215,16 @@

- This special piped input format uses the ASCII form-feed character '\f' (U+000C) as a separator. + This program will accept Object and Content strings to generate an IKI string, such as object:"content". + Each Object must have a Content (and each Content must have an Object). +

+

+ The Object is also called the Vocabulary. + A complete Object and Content set is also called a Variable. +

+

+ When piping main to this program, a single form-feed character (\f) (U+000C) must be used to separate each Object from each Content. + Furthermore, each Object must be followed by a Content.

diff --git a/documentation/status_code.html b/documentation/status_code.html index e76b564..51b633b 100644 --- a/documentation/status_code.html +++ b/documentation/status_code.html @@ -210,6 +210,25 @@ +

+ The FLL programs use a 16-bit unsigned integer to represent the return status of programs and functions. +

+

+ Programs may print a generic error with one of these codes. + This is a tool for converting to or converting from these codes. +

+

+ The 16-bit unsigned integer also has the first two high-order bits used to represent flags. + These flags are the error bit and the warning bit. + When neither of these flags are set, then the status is considered fine. +

+

+ These codes stop at the F_status_code_last code. +

+

+ Each code will be printed on its own line. + Errors regarding each code may be printed on its own line. +

diff --git a/documentation/utf8.html b/documentation/utf8.html index c10e968..2af84c2 100644 --- a/documentation/utf8.html +++ b/documentation/utf8.html @@ -263,7 +263,7 @@ This program establishes a pattern for some of the parameters. The parameters that represent a "from" use lower case short characters and the parameters that represent a "to" use upper case short characters. For short parameters that have both a "from" and a "to", they use the same character with their case being different.

- The default behavior is to assume the expected input is byte sequence from the command line to be output to the screen as codepoints. + The default behavior is to assume the expected input is byte sequences from the command line to be output to the screen as codepoints.

Multiple input sources are allowed but only a single output destination is allowed.