Update: Documentation for several programs.

diff --git a/documentation/fss_status_code.html b/documentation/fss_status_code.html
index 962cb3f245aa03008835a81ec03404520803dc89..042ac6acca63c4700d2ac130cdbb29071d17ce48 100644 (file)
--- a/documentation/fss_status_code.html
+++ b/documentation/fss_status_code.html
@@ -210,6 +210,27 @@
                   </tbody>
                 </table>
               </div>
+              <p class="p">
+                The <abbr title="Featureless Linux Library">FLL</abbr> programs use a <strong class="strong">16-bit unsigned integer</strong> to represent the return status of programs and functions.
+              </p>
+              <p class="p">
+                Programs may print a generic error with one of these codes.
+                This is a tool for converting to or converting from these codes.
+              </p>
+              <p class="p">
+                The <strong class="strong">16-bit unsigned integer</strong> also has the first two high-order bits used to represent flags.
+                These flags are the <strong class="strong">error</strong> bit and the <strong class="strong">warning</strong> bit.
+                When neither of these flags are set, then the status is considered <strong class="strong">fine</strong>.
+              </p>
+              <p class="p">
+                This operates identical to the status_codes program except that this program handles additional codes regarding FSS.
+                These special codes numericaly appear after the <code class="code">F_status_code_last</code> code.
+                These codes stop at the <code class="code">F_fss_status_code_last</code> code.
+              </p>
+              <p class="p">
+                Each code will be printed on its own line.
+                Errors regarding each code may be printed on its own line.
+              </p>
             </div>
           </section>
         </main>

diff --git a/documentation/iki_read.html b/documentation/iki_read.html
index 728b1fb6bebb9a5773d420fe2d5ed45ba1bc37d4..48bd8662e4b9c5baa56a5b8787110f378cd4a845 100644 (file)
--- a/documentation/iki_read.html
+++ b/documentation/iki_read.html
@@ -257,39 +257,45 @@
                 </table>
               </div>
               <p class="p">
+                This program will find and print Variables, Vocabularies, or Content following the IKI standard, without focusing on any particular Vocabulary specification.
+              </p>
+              <p class="p">
                 The <code class="code">-r/--replace</code> option requires 2 additional parameters: <code class="code">&lt;vocabulary&gt; &lt;with&gt;</code>.
               </p>
               <dl class="dl">
                 <div class="di">
-                  <dt class="dt">vocabulary</dt><dd class="dd">The name of the vocabulary whose content is to be substituted.</dd>
+                  <dt class="dt">vocabulary</dt><dd class="dd">The name of the Vocabulary whose Content is to be substituted.</dd>
                 </div>
                 <div class="di">
                   <dt class="dt">with</dt><dd class="dd">The new string to use as the substitute.</dd>
                 </div>
               </dl>
               <p class="p">
-                The <code class="code">-R/--reassign</code> and the <code class="code">-s/--substitute</code> options require 3 additional parameters: <code class="code">&lt;vocabulary&gt; &lt;replace&gt; &lt;with&gt;</code>.
+                The Vocabulary is case-sensitive and must exactly match.
+              </p>
+              <p class="p">
+                The <code class="code">-R/--reassign</code> option and the <code class="code">-s/--substitute</code> options require 3 additional parameters:: <code class="code">&lt;vocabulary&gt; &lt;replace&gt; &lt;with&gt;</code>.
               </p>
               <dl class="dl">
                 <div class="di">
-                  <dt class="dt">vocabulary</dt><dd class="dd">The name of the vocabulary whose content is to be substituted.</dd>
+                  <dt class="dt">vocabulary</dt><dd class="dd">The name of the Vocabulary whose Content is to be substituted.</dd>
                 </div>
                 <div class="di">
-                  <dt class="dt">replace</dt><dd class="dd">The content matching this exact string will be substituted.</dd>
+                  <dt class="dt">replace</dt><dd class="dd">The Content matching this exact string will be substituted.</dd>
                 </div>
                 <div class="di">
                   <dt class="dt">with</dt><dd class="dd">The new string to use as the substitute.</dd>
                 </div>
               </dl>
               <p class="p">
-                The <em class="em">vocabulary</em> and <em class="em">replacement</em> are case-sensitive and must exactly match.
+                The Vocabulary and replacement are case-sensitive and must exactly match.
               </p>
               <p class="p">
                 The <code class="code">-W/--wrap</code> option requires 3 additional parameters: <code class="code">&lt;vocabulary&gt; &lt;before&gt; &lt;after&gt;</code>.
               </p>
               <dl class="dl">
                 <div class="di">
-                  <dt class="dt">vocabulary</dt><dd class="dd">The name of the vocabulary whose content is to be wrapped.</dd>
+                  <dt class="dt">vocabulary</dt><dd class="dd">The name of the vocabulary whose Content is to be wrapped.</dd>
                 </div>
                 <div class="di">
                   <dt class="dt">before</dt><dd class="dd">The string to prepend.</dd>
@@ -299,19 +305,19 @@
                 </div>
               </dl>
               <p class="p">
-                The difference between <code class="code">-r/--replace</code> and <code class="code">-s/--substitute</code> is that the <code class="code">-r/--replace</code> option substitutes all matching vocabulary names and the <code class="code">-s/--substitute</code> option substitutes all matching vocabulary names that must also have the given matching content.
+                The Vocabulary is case-sensitive and must exactly match.
               </p>
               <p class="p">
-                The <code class="code">-R/--reassign</code> option is identical to the <code class="code">-s/--substitute</code> option except that the <code class="code">-w/--wrap</code> option is ignored (not applied).
+                The difference between <code class="code">-r/--replace</code> and <code class="code">-s/--substitute</code> is that the <code class="code">-r/--replace</code> option substitutes all matching Vocabulary names and the <code class="code">-s/--substitute</code> option substitutes all matching Vocabulary names that must also have the given matching Content.
               </p>
               <p class="p">
-                The <code class="code">-s/--substitute</code> option takes priority over the <code class="code">-r/--replace</code> option when matching the same variable.
+                The <code class="code">-s/--reassign</code> option is identical to the <code class="code">-s/--substitute</code> option except that the <code class="code">-W/--wrap</code> option is ignored (not applied).
               </p>
               <p class="p">
-                The <code class="code">-W/--wrap</code> option is ignored when the <code class="code">-s/--substitute</code> option is matching the same variable.
+                The <code class="code">-s/--substitute</code> option takes priority over the <code class="code">-r/--replace</code> option when matching the same Variable.
               </p>
               <p class="p">
-                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.
               </p>
             </div>
           </section>

diff --git a/documentation/iki_write.html b/documentation/iki_write.html
index 760f7c2152c817f350ee1d9e10aebaa3b8b35c68..b2971fe27593697679f59295db6fa0e7001aaa90 100644 (file)
--- a/documentation/iki_write.html
+++ b/documentation/iki_write.html
@@ -187,11 +187,6 @@
 
                   <tbody class="body set">
                     <tr class="row">
-                      <td class="column"><code class="code">-f</code></td>
-                      <td class="column"><code class="code">--file</code></td>
-                      <td class="column">Specify a file to send data to.</td>
-                    </tr>
-                    <tr class="row">
                       <td class="column"><code class="code">-c</code></td>
                       <td class="column"><code class="code">--content</code></td>
                       <td class="column">The Content to write.</td>
@@ -202,6 +197,11 @@
                       <td class="column">Use double quotes (default).</td>
                     </tr>
                     <tr class="row">
+                      <td class="column"><code class="code">-f</code></td>
+                      <td class="column"><code class="code">--file</code></td>
+                      <td class="column">Specify a file to send data to.</td>
+                    </tr>
+                    <tr class="row">
                       <td class="column"><code class="code">-o</code></td>
                       <td class="column"><code class="code">--object</code></td>
                       <td class="column">The Object to write.</td>
@@ -215,7 +215,16 @@
                 </table>
               </div>
               <p class="p">
-                This special piped input format uses the <abbr title="American Standard Code for Information Interchange">ASCII</abbr> form-feed character '<kbd>\f</kbd>' (U+000C) as a separator.
+                This program will accept Object and Content strings to generate an IKI string, such as <code class="code">object:"content"</code>.
+                Each Object must have a Content (and each Content must have an Object).
+              </p>
+              <p class="p">
+                The Object is also called the Vocabulary.
+                A complete Object and Content set is also called a Variable.
+              </p>
+              <p class="p">
+                When piping main to this program, a single form-feed character (<kbd>\f</kbd>) (U+000C) must be used to separate each Object from each Content.
+                Furthermore, each Object must be followed by a Content.
               </p>
             </div>
           </section>

diff --git a/documentation/status_code.html b/documentation/status_code.html
index e76b56497cf53cfd12180ef33666fe03254bd338..51b633bc2090988674e6b7e5ffacbbd0f02308be 100644 (file)
--- a/documentation/status_code.html
+++ b/documentation/status_code.html
@@ -210,6 +210,25 @@
                   </tbody>
                 </table>
               </div>
+              <p class="p">
+                The <abbr title="Featureless Linux Library">FLL</abbr> programs use a <strong class="strong">16-bit unsigned integer</strong> to represent the return status of programs and functions.
+              </p>
+              <p class="p">
+                Programs may print a generic error with one of these codes.
+                This is a tool for converting to or converting from these codes.
+              </p>
+              <p class="p">
+                The <strong class="strong">16-bit unsigned integer</strong> also has the first two high-order bits used to represent flags.
+                These flags are the <strong class="strong">error</strong> bit and the <strong class="strong">warning</strong> bit.
+                When neither of these flags are set, then the status is considered <strong class="strong">fine</strong>.
+              </p>
+              <p class="p">
+                These codes stop at the <code class="code">F_status_code_last</code> code.
+              </p>
+              <p class="p">
+                Each code will be printed on its own line.
+                Errors regarding each code may be printed on its own line.
+              </p>
             </div>
           </section>
         </main>

diff --git a/documentation/utf8.html b/documentation/utf8.html
index c10e968ba16ee0ce0664781f86738741197d7af3..2af84c294842a5e09f163d83f6967902dd2b0b97 100644 (file)
--- 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 <em class="em">"from"</em> use lower case short characters and the parameters that represent a <em class="em">"to"</em> use upper case short characters. For short parameters that have both a <em class="em">"from"</em> and a <em class="em">"to"</em>, they use the same character with their case being different.
               </p>
               <p class="p">
-                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.
               </p>
               <p class="p">
                 Multiple input sources are allowed but only a single output destination is allowed.