changeset 1094:958740284209

Use <emphasis> instead of CAPITALS
author roug
date Tue, 08 Apr 2003 17:49:14 +0000
parents 4dae346c4969
children 4ba28d8a35be
files docs/basic09/basic09.docbook docs/nitros9guide/chap2.chapter docs/nitros9guide/chap4.chapter docs/nitros9guide/chap7.chapter docs/nitros9guide/errorcodes.appendix docs/nitros9guide/help.refentry docs/nitros9guide/mdir.refentry docs/nitros9guide/setime.refentry docs/nitros9guide/unlink.refentry docs/os9sysprog/errorcodes.appendix
diffstat 10 files changed, 81 insertions(+), 71 deletions(-) [+]
line wrap: on
line diff
--- a/docs/basic09/basic09.docbook	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/basic09/basic09.docbook	Tue Apr 08 17:49:14 2003 +0000
@@ -21,7 +21,7 @@
 <year>1983</year>
 <holder>Microware Systems Corporation.
 All Rights Reserved.
-Basic 09 is a trademark of Microware Systems Corporation and Motorola Inc.
+Basic09 is a trademark of Microware Systems Corporation and Motorola Inc.
 </holder>
 
 </copyright>
@@ -60,7 +60,7 @@
 has the best of both kinds of language system: it gives
 the fast execution speed typical of compiler languages plus the ease of use
 and memory space efficiency typical of interpreter languages.
-&b09; is a complete PROGRAMMING SYSTEM that
+&b09; is a complete <emphasis>programming system</emphasis> that
 includes a powerful text editor, multi-pass compiler,
 run-time interpreter, high-level interactive debugger, and a system
 executive. Each of these components was carefully integrated
@@ -313,9 +313,9 @@
 <para>
 When &b09; responds with the edit prompt "E:", it is in the
 edit mode. Now you can enter "edit commands" which help us enter
-the computer program. While in edit mode, &b09; ALWAYS TAKES THE
-FIRST CHARACTER OF EVERY LINE AS AN EDIT COMMAND. Some of the basic
-edit commands are:
+the computer program. While in edit mode, <emphasis>&b09; always takes the
+first character of every line as an edit command.</emphasis>
+Some of the basic edit commands are:
 <programlisting>
 &lt;space> &lt;program statement> &lt;cr>  insert line
 ? &lt;cr>  go to next line down (just &lt;cr> also does the same)
@@ -998,7 +998,6 @@
 <command>E [&lt;procname>]</command>
 </cmdsynopsis>
 <para>
-
 Exits command mode and enters the text editor/compiler mode. If the specified
 procedure does not exist, a new one is created. See the Chapter 4 for a
 complete description of how edit mode works.
@@ -1132,16 +1131,16 @@
 </cmdsynopsis>
 <para>
 This command
- causes an extra compiler pass on the procedure(s) specified, which
+causes an extra compiler pass on the procedure(s) specified, which
 removes names, line numbers, non-executable statements, etc. The result is
-a smaller, faster procedure(s) that CANNOT be edited or debugged but can be
+a smaller, faster procedure(s) that <emphasis>cannot</emphasis> be edited or debugged but can be
 executed by &b09; or by the &b09; run-time-only program called "RunB".
 If a pathlist is not given, the name of the first procedure in the list will be
 used as a default pathname.
 The procedure is written to the file/device specified in OS-9 memory
 module format suitable for loading in ROM or RAM outside the
 workspace.
-THE RESULTING FILE CANNOT BE LOADED INTO THE WORKSPACE LATER ON,
+<emphasis>The resulting file cannot be loaded into the workspace later on,</emphasis>
 so you should always perform a regular SAVE before PACKing a procedure!
 </para>
 <para>
@@ -1534,8 +1533,6 @@
 </para></sect1>
 <sect1><title>String-Oriented Editing</title>
 <para>
-
-
 Most editor commands are string-oriented. This means that you can enter or
 change whole or partial lines without using line numbers at all.  You will
 find that string-oriented editing is generally faster and more convenient.
@@ -1623,14 +1620,12 @@
 The second form deletes ALL lines in the procedure (caution!).
 The editor accepts
 "+*" and "-*" to mean to the end, or to the beginning of the procedure
-respectively. If the number is negative, that many lines BEFORE the
+respectively. If the number is negative, that many lines <emphasis>before</emphasis> the
 current line is deleted.
 If a line number is omitted, only the current line is deleted.
 </para></sect2>
 <sect2><title>Listing Lines</title>
 <para>
-
-
 The "l" command is used to display one or more lines.
 It also has the forms:
 <programlisting>
@@ -1638,7 +1633,7 @@
 l*
 </programlisting>
 The first form will display the &lt;number> of lines starting at the current
-edit pointer position. If the number is NEGATIVE, previous lines
+edit pointer position. If the number is <emphasis>negative</emphasis>, previous lines
 will be listed.
 
 The second form displays the entire procedure. Neither change the
@@ -2369,7 +2364,7 @@
 be stored there.  When a STRING value is assigned to a STRING variable,
 the bytes composing the string are copied into the variable storage
 byte-by-byte. The beginning of a string is always character number one,
-and this is NOT affected by the BASE0 or BASE1 statements. Operations
+and this is <emphasis>not</emphasis> affected by the BASE0 or BASE1 statements. Operations
 which result in strings too long to fit in the dimensioned storage
 truncate the string on the right and no error is generated.
 </para>
@@ -2415,7 +2410,7 @@
 b AND c ).
 
 Do not confuse BOOLEAN operations AND, OR, XOR, and NOT (which operate
-on the Boolean values TRUA end FALSE) with the logical functions LAND,
+on the Boolean values TRUE end FALSE) with the logical functions LAND,
 LOR, LXOR, and LNOT (which use integer values to produce results on a
 bit-by-bit basis).  Attempting to store a non-BOOLEAN value in a BOOLEAN
 variable (or the reverse) will cause a run-time error.
@@ -3173,7 +3168,7 @@
 </informaltable>
 
 The following functions perform bit-by-bit logical operations on integer
-or byte data types and return integer results. They should NOT be confused
+or byte data types and return integer results. They should <emphasis>not</emphasis> be confused
 with the BOOLEAN-type operators.
 
 <informaltable frame="none">
@@ -3421,7 +3416,7 @@
 <para>
 This class of statements affect the (usually) sequential execution of
 program statements.  They are used to construct loops or make decisions
-that alter program flow.  &b09; provides a selection of looping statements
+that alter program flow. &b09; provides a selection of looping statements
 that allow you to create any kind of loop using sound structured
 programming style.
 </para>
@@ -3628,7 +3623,7 @@
 <para>
 The EXITIF clause evaluates an expression to a boolean result. If the
 result is FALSE, the statement following the ENDEXIT is executed next.
-Otherwise, the statement(s) between the EXITIF AND ENDEXIT are
+Otherwise, the statement(s) between the EXITIF and ENDEXIT are
 executed, then control is transferred to the statement following 
 the body of the loop.  This exit clause
 is often used to perform some specific function upon termination of the
@@ -3890,7 +3885,7 @@
 used for other purposes.
 <figure>
 <title>Stack Frame Passed to Machine Language Procedures</title>
-<literallayout>
+<screen>
 +----------------------+         ^
 |                      |         |
                           higher addresses
@@ -3914,14 +3909,14 @@
 |                      |         |
 +----------------------+        ---  &lt;- &CPU; Stack Pointer
                                         Register value
-</literallayout>
+</screen>
 </figure>
 </para>
 <para>
 Machine language modules return error status by setting the "C"
 bit of the MPU condition codes register, and by setting the B
 register to the appropiate error code. For an example of a machine
-language subroutine ("INKEY"), See Appendix A.
+language subroutine ("INKEY"), See <xref linkend="sample-programs"/>.
 </para>
 <para>
 Example of use of the RUN statement:
@@ -3968,7 +3963,7 @@
 </listitem>
 <listitem>
 <para>
-When KILL is used together with a RUN statement, the RUN statement MUST use the
+When KILL is used together with a RUN statement, the RUN statement <emphasis>must</emphasis> use the
 same string variable which contains the name of the procedure.
 See the first example below:
 </para>
@@ -4438,7 +4433,7 @@
 specified by the PARAM statement.
 &b09; checks the size of each parameter (to prevent
 accidental access to storage other than the parameter)
-but DOES NOT CHECK TYPE. However, in most cases the programmer
+but <emphasis>does not check type</emphasis>. However, in most cases the programmer
 should ensure that the parameters evaluated in the RUN statement and
 sent to the called procedure agree exactly with the PARAM statement
 specification with respect to: the number of parameters, their order, size,
@@ -4755,7 +4750,7 @@
 </informalexample>
 For a function to test if data is available from the keyboard without
 "hanging" the program, see the "INKEY" assembly language program included
-in Appendix A.
+in <xref linkend="sample-programs"/>.
 </para></sect2>
 <sect2><title>PRINT Statement</title>
 <para>
@@ -4848,7 +4843,7 @@
 can be READ, WRITE, UPDATE, EXEC, or DIR. This defines which direction I/O
 transfers will occur. If no access mode is specified, UPDATE is assumed
 and both reading and writing are permitted. The DIR mode allows OS-9
-directory type-files to be accessed but should NOT be used in combination
+directory type-files to be accessed but should <emphasis>not</emphasis> be used in combination
 with WRITE or UPDATE modes. The EXEC mode causes the current execution
 directory to be used instead of the current data directory.  Refer to the
 "OS-9 User's Guide" for more information on how files access modes.
@@ -5351,7 +5346,7 @@
 The string expression is evaluated and used as a "format specification"
 which contains specific formatting directives for each item in the "output
 list".  The items in the output list can be constants, variables, or
-expressions of any atomic type. BLANKS ARE NOT ALLOWED IN FORMAT STRINGS!
+expressions of any atomic type. <emphasis>Blanks are not allowed in format strings!</emphasis>
 As each output item is processed, it is matched up with a specification
 in the format list. The type of each expression result must be compatible
 with the corresponding format specification. If there are fewer format
@@ -5399,7 +5394,7 @@
 </informaltable>
 The identifier letter is followed by a constant number called the "field
 width". This number indicates the exact number of print columns the
-output is to occupy and must allow for the data AND "overhead" character
+output is to occupy and must allow for the data <emphasis>and</emphasis> "overhead" character
 positions such as sign characters, decimal points, exponents, etc.
 Some formats have additional mandatory or optional parameters that
 control subfields or select editing options. One of these options is
@@ -5715,7 +5710,7 @@
 </tgroup>
 </informaltable>
 Warning: Control specifications at the end of the format
-specification list will NOT be processed if all output items have
+specification list will <emphasis>not</emphasis> be processed if all output items have
 been exhausted.
 </para>
 <para>
@@ -5892,7 +5887,7 @@
 This table can be used to deduce some interesting points. For
 example, "value*2" is not optimum - "value+value" can produce the
 same result in less time because multiplication takes longer than
-addition. Similarly, "value*value" or "SQ(value)" is MUCH faster
+addition. Similarly, "value*value" or "SQ(value)" is <emphasis>much</emphasis> faster
 than the equivalent "value^2". Another interesting case is "x/2.0".
 The REAL divide will cost 3870 cycles, but REAL multiplcation takes
 only 990 cycles. The mathematical equivalent to division by a
@@ -5909,8 +5904,8 @@
 are used for loop counters.
 </para>
 <para>
-When writing program loops, remember that statements INSIDE the loop
-may be executed many times for each single execution OUTSIDE the loop.
+When writing program loops, remember that statements <emphasis>inside</emphasis> the loop
+may be executed many times for each single execution <emphasis>outside</emphasis> the loop.
 Thus, any value which can be computed before entering a loop will increase
 program speed.
 </para></sect1>
@@ -5927,7 +5922,7 @@
 structures. This feature is much faster than copying arrays or structures
 element-by-element inside a loop.
 </para></sect1>
-<sect1><title>The PACK Command</title>
+<sect1 id="pack" xreflabel="PACK"><title>The PACK Command</title>
 <para>
 The PACK command produces a compressed version of a &b09;
 procedure. Depending on the number of comments, line numbers, etc.,
@@ -5989,7 +5984,7 @@
 
 
 
-<appendix>
+<appendix id="sample-programs">
 <title>Sample Programs</title>
 <para>
 <programlisting>
--- a/docs/nitros9guide/chap2.chapter	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/nitros9guide/chap2.chapter	Tue Apr 08 17:49:14 2003 +0000
@@ -132,8 +132,8 @@
 each command.
 </para>
 <para>
-For example, the LIST program is used to display the contents of
-a text file on your display. It is necessary to tell to the LIST
+For example, the <command>list</command> program is used to display the contents of
+a text file on your display. It is necessary to tell to the <command>list</command>
 program which file it is to be displayed, therefore, the name of the
 desired file is given as a parameter in the command line. For
 example, to list the file called startup  (the system initialization
--- a/docs/nitros9guide/chap4.chapter	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/nitros9guide/chap4.chapter	Tue Apr 08 17:49:14 2003 +0000
@@ -227,7 +227,7 @@
 OS9: DIR &gt;/D1/savelisting
 </screen>
 <para>
-If the LIST command is used on the file <filename>/D1/savelisting</filename>, output
+If the <command>list</command> command is used on the file <filename>/D1/savelisting</filename>, output
 from the <command>dir</command> command will be displayed as shown below:
 </para>
 <screen>
@@ -331,8 +331,10 @@
 
 </para>
 <para>
-Because they were followed by &quot;&amp;&quot; separators, the <command>dir</command>, LIST, and
-<command>copy</command> programs will run concurrently, but the <command>del</command> program will not
+Because they were followed by &quot;&amp;&quot; separators, the <command>dir</command>,
+<command>list</command>, and
+<command>copy</command> programs will run concurrently,
+but the <command>del</command> program will not
 run until the <command>copy</command> program has terminated because sequential
 execution (&quot;;&quot;) was specified.
 </para>
@@ -621,7 +623,7 @@
 <para>
 Many programs (including the shell) use OS-9's standard error
 reporting function, which displays an error number on the error
-output path. The standard error codes are listed in the Appendix of
+output path. The standard error codes are listed in the <xref linkend="errorcodes"/> of
 this manual. If desired, the <command>printerr</command> command can be executed,
 which replaces the smaller, built-in error display routine with a
 larger (and slower) routine that looks up descriptive error messages
@@ -680,15 +682,15 @@
 their I/O redirected to each timesharing terminal.
 </para>
 <para>
-Usually one TSMON command program is started up concurrently for
+Usually one <command>tsmon</command> command program is started up concurrently for
 each terminal in the system. This is a special program which
 monitors a terminal for activity. When a carriage return character
-is typed on any of these terminals, the TSMON command initiates the
-LOGIN command program. If a user does not enter a correct password
-or user number in three tries, the LOGIN command will be aborted.
+is typed on any of these terminals, the <command>tsmon</command> command initiates the
+<command>login</command> command program. If a user does not enter a correct password
+or user number in three tries, the <command>login</command> command will be aborted.
 Here's a sample procedure file for a 4-terminal timesharing system
-having terminals names &quot;TERM&quot;, &quot;T1&quot;,
-&quot;T2&quot;, and &quot;T3&quot;.
+having terminals names <quote>TERM</quote>, <quote>T1</quote>,
+<quote>T2</quote>, and <quote>T3</quote>.
 </para>
 <programlisting>
 * system startup procedure file
@@ -700,9 +702,9 @@
 tsmon /t3&amp;
 </programlisting>
 <para>
-NOTE: This LOGIN procedure will not work until a password file
+NOTE: This <command>login</command> procedure will not work until a password file
 called <filename>/DD/SYS/PASSWORD</filename> has been created. For more information,
-please see the LOGIN command description.
+please see the <command>login</command> command description.
 </para>
 <para>
 The example above deserves special attention. Note that the
--- a/docs/nitros9guide/chap7.chapter	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/nitros9guide/chap7.chapter	Tue Apr 08 17:49:14 2003 +0000
@@ -8,12 +8,13 @@
 Editor, etc. Unless otherwise noted, these programs are designed to
 run as individual processes.
 </para>
+<warning>
 <para>
-<emphasis>WARNING</emphasis>
-- ALTHOUGH MANY OS-9 COMMANDS MAY WORK ON LEVEL ONE OR LEVEL
-TWO SYSTEMS, THERE ARE DIFFERENCES. TAKE CARE NOT TO MIX COMMAND
-FILES FROM LEVEL ONE SYSTEMS ON LEVEL TWO, OR THE REVERSE.
+Although many os-9 commands may work on Level One or Level
+Two systems, there are differences. Take care not to mix command
+files from Level One systems on Level Two, or the reverse.
 </para>
+</warning>
 <section>
 <title>Formal Syntax Notation</title>
 <para>
--- a/docs/nitros9guide/errorcodes.appendix	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/nitros9guide/errorcodes.appendix	Tue Apr 08 17:49:14 2003 +0000
@@ -1,4 +1,4 @@
-<appendix>
+<appendix id="errorcodes">
 <title>OS-9 Error Codes</title>
 <para>
 The error codes are shown in both hexadecimal (first column) and
--- a/docs/nitros9guide/help.refentry	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/nitros9guide/help.refentry	Tue Apr 08 17:49:14 2003 +0000
@@ -7,21 +7,27 @@
 <refsynopsisdiv>
 <cmdsynopsis>
 <command>help</command>
-<arg choice="opt">
-  <option>command - the command for which you want syntax help.  Include
-as many command names in one <command>help</command> line as you wish.  The proper form and
-syntax appears for each valid command you include.
-</option>
+<arg choice="plain">
+&repeatst;<replaceable>command</replaceable>&repeaten;
 </arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
-<refsect1><title>Notes</title>
-
+<refsect1><title>Description</title>
 <para>
-To use <command>help</command>, first copy Cmds.hp from the SYS directory of the CONFIG/BOOT
-Diskette to the SYS directory of your system diskette.  Next, copy <command>help</command>
-from the CMDS directory of the CONFIG/BOOT Diskette to the CMDS directory
+Provide as argument the command for which you want syntax help.  Include
+as many command names in one <command>help</command> line as you wish.  The proper form and
+syntax appears for each valid command you include.
+</para>
+</refsect1>
+
+<refsect1><title>Notes</title>
+<para>
+To use <command>help</command>, first copy <filename>Cmds.hp</filename> from the <filename class="directory">SYS</filename> directory of the CONFIG/BOOT
+Diskette to the <filename class="directory">SYS</filename> directory of your system diskette.
+Next, copy <command>help</command>
+from the <filename class="directory">CMDS</filename> directory of
+the CONFIG/BOOT Diskette to the <filename class="directory">CMDS</filename> directory
 of your system diskette as follows:
 </para>
 <para>
--- a/docs/nitros9guide/mdir.refentry	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/nitros9guide/mdir.refentry	Tue Apr 08 17:49:14 2003 +0000
@@ -48,12 +48,13 @@
 C363  798 E1  1 R   2 KBVDIO
 CAFB   38 F1  1 R   2 TERM
 </screen>
+<caution>
 <para>
-
-WARNING: Many of the modules listed by <command>mdir</command> are OS-9 system modules
-and NOT executable as programs: always check the module type code
+Many of the modules listed by <command>mdir</command> are OS-9 system modules
+and <emphasis>not</emphasis> executable as programs: always check the module type code
 before running a module if you are not familiar with it!
 </para>
+</caution>
 <para>
 For more information see: <xref linkend="sec5.4.1"/>
 </para>
--- a/docs/nitros9guide/setime.refentry	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/nitros9guide/setime.refentry	Tue Apr 08 17:49:14 2003 +0000
@@ -20,17 +20,22 @@
 delimiters. OS-9 system time uses the 24 hour clock, i.e., 1520 is
 3:20 PM.
 </para>
+<important>
 <para>
-IMPORTANT NOTE: This command must be executed before OS-9 can
+This command must be executed before OS-9 can
 perform multitasking operations. If the system does not have a real
 time clock this command should still be used to set the date for the
 file system.
 </para>
+</important>
+<tip>
+<title>Systems With Battery Backed up Clocks</title>
 <para>
-SYSTEMS WITH BATTERY BACKED UP CLOCKS: <command>Setime</command> should still be run to
+<command>Setime</command> should still be run to
 start time-slicing, but only the <emphasis>year</emphasis> need be given,
 the date and time will be read from the clock.
 </para>
+</tip>
 </refsect1>
 <refsect1><title>Examples</title>
 <screen>
--- a/docs/nitros9guide/unlink.refentry	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/nitros9guide/unlink.refentry	Tue Apr 08 17:49:14 2003 +0000
@@ -11,7 +11,7 @@
   <replaceable>modname</replaceable>
 </arg>
 <arg choice="plain">
-&repeatst;  <replaceable>modname</replaceable>&repeaten;
+&repeatst;<replaceable>modname</replaceable>&repeaten;
 </arg>
 </cmdsynopsis>
 </refsynopsisdiv>
--- a/docs/os9sysprog/errorcodes.appendix	Mon Apr 07 21:01:46 2003 +0000
+++ b/docs/os9sysprog/errorcodes.appendix	Tue Apr 08 17:49:14 2003 +0000
@@ -1,4 +1,4 @@
-<appendix>
+<appendix id="errorcodes">
 <title>Error Codes</title>
 <section>
 <title>OS-9 Error Codes</title>