Mercurial > hg > Members > kono > nitros9-code
changeset 1053:b5ff125a1d60
Since this book was only typeset in fixed width, single-font, they used
capitalization and quotes (") to show what was commands, files and just
text. With today's formatting, this is not necessary, so everywhere
capitalization was used to show a command the <command> element is now
used instead, and everywhere a file is mentioned the <filename> element is used.
line wrap: on
line diff
--- a/docs/nitros9guide/attr.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/attr.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -17,7 +17,7 @@ <refsect1><title>Description</title> <para> This command is used to examine or change the security permissions -of a file. To enter the command, type "ATTR" followed by the +of a file. To enter the command, type <command>attr</command> followed by the pathlist for the file who's security permissions are to be changed, followed by a list of permissions which are to be turned on or off. A permission is turned on by giving its abbreviation, or turned off @@ -42,7 +42,7 @@ </literallayout> <para> -The ATTR command may be used to change a directory file to a +The <command>attr</command> command may be used to change a directory file to a non-directory file if all entries have been deleted from it. Since the DEL command will only delete non-directory files, this is the only way a directory may be deleted. You cannot change a non-directory
--- a/docs/nitros9guide/backup.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/backup.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -63,12 +63,12 @@ OS9: </screen> <para> -Below is an example of a single drive backup. BACKUP will read a +Below is an example of a single drive backup. <command>backup</command> will read a portion of the source disk into memory, you remove the source disk -and place the destination disk into the drive, BACKUP writes on the +and place the destination disk into the drive, <command>backup</command> writes on the destination disk, you remove the destination disk and place the source disk into the drive. This continues until the entire disk -has been copied. Giving BACKUP as much memory as possible will cause +has been copied. Giving <command>backup</command> as much memory as possible will cause fewer disk exchanges to be required. </para> <para>
--- a/docs/nitros9guide/binex.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/binex.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -24,15 +24,15 @@ programs to load on non-OS-9 systems. </para> <para> -BINEX converts "path1", an OS-9 binary format file, to a new file +<command>Binex</command> converts "path1", an OS-9 binary format file, to a new file named "path2" in S-Record format. If invoked on a non-binary load module file, a warning message is printed and the user is asked if -BINEX should proceed anyway. A "Y" response means yes; any other +<command>binex</command> should proceed anyway. A "Y" response means yes; any other answer will terminate the program. S-Records have a header record to store the program name for informational purposes and each data record has an absolute memory address which is not meaningful to OS-9 since it uses position-independent-code. However, the S-Record -format requires them so BINEX will prompt the user for a program +format requires them so <command>binex</command> will prompt the user for a program name and starting load address. For example: </para> <screen>
--- a/docs/nitros9guide/build.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/build.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -15,11 +15,11 @@ <para> This command is used to build short text files by copying the standard input path into the file specified by -<replaceable>path</replaceable>. BUILD creates a file according to the pathlist parameter, +<replaceable>path</replaceable>. <command>Build</command> creates a file according to the pathlist parameter, then displays a "?" prompt to request an input line. Each line entered is written to the output path (file). Entering a line consisting of a carriage -return only causes BUILD to terminate. +return only causes <command>build</command> to terminate. </para> </refsect1>
--- a/docs/nitros9guide/cc.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/cc.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -16,12 +16,12 @@ <refsect1><title>Description</title> <para> The are two commands which invoke distinct versions of the -compiler. "cc1" is for OS-9 Level I which uses a two pass compiler, -and, "cc2" is for Level II which causes a single pass version. Both +compiler. <command>cc1</command> is for OS-9 Level I which uses a two pass compiler, +and, <command>cc2</command> is for Level II which causes a single pass version. Both versions of the compiler works identically, the main difference is -that cc1 has been divided into two passes to fit the smaller memory +that <command>cc1</command> has been divided into two passes to fit the smaller memory size of OS-9 Level I systems. In the following text, "cc" refers to -either "cc1" or "cc2" as appropiate for your system. +either <command>cc1</command> or <command>cc2</command> as appropiate for your system. </para> </refsect1> <refsect1><title>Options</title>
--- a/docs/nitros9guide/chap1.chapter Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/chap1.chapter Thu Mar 20 20:19:53 2003 +0000 @@ -62,7 +62,7 @@ <listitem><para>If your &make; doesn't seem to understand the &DOSCMD; command, your controller has DOS 1.0. You will need to upgrade to DOS 1.1.</para></listitem> -<listitem><para>If the "OS9 BOOT message is displayed but nothing else happens, +<listitem><para>If the "OS9 BOOT" message is displayed but nothing else happens, you may have a corrupted system disk. Hopefully you did make a backup!</para></listitem> </itemizedlist> @@ -103,7 +103,7 @@ </para> <para> Now you're ready to try some commands. A good first command to -try is DIR (for "<emphasis>dir</emphasis>ectory"). +try is <command>dir</command> (for "<emphasis>dir</emphasis>ectory"). This will display a list of the files on the System Disk. Just type: <screen> @@ -114,12 +114,12 @@ <screen> OS9Boot startup CMDS SYS DEFS </screen> -The file "OS9Boot" contains the OS-9 program in &CPU; machine +The file <filename>OS9Boot</filename> contains the OS-9 program in &CPU; machine language, which was loaded into memory during the bootstrap operation. </para> <para> -The file "startup" is a "command file" which is automatically run +The file <filename>startup</filename> is a "command file" which is automatically run when the system starts up, and has the commands that printed the welcoming message and asked for the time. Later, You may want to replace this startup file with your own customized version after you @@ -128,9 +128,9 @@ <screen> list startup </screen> -As you can see, the LIST command displays the contents of files +As you can see, the <command>list</command> command displays the contents of files that contain text (alphabetic characters). Some files like the -"OS9Boot" file contain binary data such as machine language +<filename>OS9Boot</filename> file contain binary data such as machine language programs. These files are called "binary files", and attempts to list them will result in a jumbled, meaningless display. On the other hand, OS-9 will complain mightily if you try to run a text @@ -139,13 +139,13 @@ <para> As you may have surmised by now, the way you ask OS-9 to run a program or command (they're really the same thing) is to simply type -its name. Some commands like LIST require one or more names of +its name. Some commands like <command>list</command> require one or more names of files or options. If so, they are typed on the same line using spaces to separate each item. </para> <para> -But where did the LIST and DIR programs come from? There are -really more files on the disk than you suspect. The DIR command +But where did the <command>list</command> and <command>dir</command> programs come from? There are +really more files on the disk than you suspect. The <command>dir</command> command showed you what is the disk's <emphasis>root directory</emphasis> - so named because the OS-9 filing system resembles a tree. Growing out of the root @@ -155,25 +155,27 @@ paper of how this works it does look like a tree. </para> <para> -The directory files on your system disk are called "CMDS", -"SYS", and "DEFS". -The file "CMDS" is a directory that consists of -all the system commands such as DIR, LIST, FORMAT, etc. To see the -files contained in this directory, enter: +The directory files on your system disk are called <filename class="directory">CMDS</filename>, +<filename class="directory">SYS</filename>, and <filename class="directory">DEFS</filename>. +The file <filename class="directory">CMDS</filename> is a directory that consists of +all the system commands such as <command>dir</command>, <command>list</command>, +<command>format</command>, etc. To see the files contained in this directory, enter: <screen> dir cmds </screen> -which tells DIR to show files on the directory file CMDS instead +which tells <command>dir</command> to show files on the directory file +<filename class="directory">CMDS</filename> instead of the root directory. After you type this you should see a long list of file names. These are the complete set of command programs that come with OS-9 and perform a myriad of functions. Chapter -Seven explains each one in detail. The DIR command also has a handy -option to display the CMDS directory with less typing: +Seven explains each one in detail. The <command>dir</command> command also has a handy +option to display the +<filename class="directory">CMDS</filename> directory with less typing: <screen> dir -x </screen> Whenever you want a list of available commands you can use this so -you don't have to look it up in the book. The DIR command has +you don't have to look it up in the book. The <command>dir</command> command has options which can give you more detailed information about each file. </para> </section> @@ -192,7 +194,7 @@ <para> Before the actual backup procedure can be done (or any fresh diskette is used for any purpose), the blank disk which is to become -the backup disk must be initialized by OS-9's FORMAT command. +the backup disk must be initialized by OS-9's <command>format</command> command. </para> <para> IF YOU HAVE ONLY ONE DISK DRIVE you have to be extra careful not to @@ -231,7 +233,7 @@ The name you give is not important. If you have only one drive, replace the system disk after the FORMAT program has finished. If the FORMAT program reported any errors, try again. Disks used for -backups can't have any errors. You're now ready to run the BACKUP +backups can't have any errors. You're now ready to run the <command>backup</command> program. </para> <para> @@ -245,7 +247,7 @@ <section> <title>Running the Backup Program</title> <para> -The BACKUP program makes an exact duplicate of a disk. It can be +The <command>backup</command> program makes an exact duplicate of a disk. It can be used even if you only have one disk drive. </para> <para> @@ -255,7 +257,7 @@ backup /d0 #32k </screen> <para> -The BACKUP program will prompt you to alternately insert the source +The <command>backup</command> program will prompt you to alternately insert the source disk (the system disk) and the destination disk (the freshly formatted disk). </para> @@ -267,7 +269,7 @@ </screen> <para> -The BACKUP program will respond with +The <command>backup</command> program will respond with </para> <screen> Ready to backup from /d0 to /d1? @@ -280,19 +282,19 @@ Ok ?: </screen> <para> -Answer "Y" for yes again, and the BACKUP process should begin. +Answer "Y" for yes again, and the backup process should begin. </para> <para> -The BACKUP command has two phases: the first phase copies +The <command>backup</command> command has two phases: the first phase copies everything from drive zero to drive one checking for errors while reading from the master but not for "write" errors. The second phase is the "verify" pass which makes sure everything was copied onto the new disk correctly. If any errors are reported during the first (copy) pass, there is a problem with the master disk or its drive. If errors occur during the second (verify) pass, there is a -problem with the new disk and the BACKUP program should be run -again. If BACKUP repeatedly fails on the second pass, reformat the -disk and try to BACKUP again. If BACKUP fails again, the disk is +problem with the new disk and the <command>backup</command> program should be run +again. If <command>backup</command> repeatedly fails on the second pass, reformat the +disk and try to <command>backup</command> again. If <command>backup</command> fails again, the disk is physically defective. </para> <para>
--- a/docs/nitros9guide/chap2.chapter Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/chap2.chapter Thu Mar 20 20:19:53 2003 +0000 @@ -4,7 +4,7 @@ <section> <title>Running Commands and Basic Shell Operation</title> <para> -The "shell" is a the part of OS-9 that accepts commands from your +The <command>shell</command> is a the part of OS-9 that accepts commands from your keyboard. It was designed to provide a convenient, flexible, and easy-to-use interface between you and the powerful functions of the operating system. The shell is automatically entered after OS-9 is @@ -29,8 +29,8 @@ </itemizedlist> <para> If you're a beginner, you will almost always use the first case, -which causes the program to be automatically loaded from the CMDS -directory and run. +which causes the program to be automatically loaded from the +<filename class="directory">CMDS</filename> directory and run. </para> <para> When processing the command line, the shell searches for a @@ -41,7 +41,7 @@ <listitem><para> If the program named is already in memory, it is run.</para></listitem> -<listitem><para> The "execution directory", usually "CMDS", is searched. +<listitem><para> The "execution directory", usually <filename class="directory">CMDS</filename>, is searched. If a file having the name given is found, it is loaded and run.</para></listitem> @@ -56,7 +56,7 @@ Mention is made above of the "data directory" and the "execution directory". At all times each user is associated with two file directories. A more detailed explanation of directories is presented -later. The execution directory (usually CMDS) includes +later. The execution directory (usually <filename class="directory">CMDS</filename>) includes files which are executable programs. </para> <para> @@ -71,7 +71,7 @@ list file1 </screen> <para> -the program name is LIST, and the parameter passed to it is FILE1. +the program name is <command>list</command>, and the parameter passed to it is FILE1. </para> <para> A command line may also include one or more "modifiers" which are @@ -95,13 +95,13 @@ The ">" character tells the shell to redirect output (See 4.3.2) to the printer using the &make;'s printer port, which has the device name "/P" (See 3.2). For example, to redirect the output of the -"dir" command to the printer, enter: +<command>dir</command> command to the printer, enter: </para> <screen> dir >/p </screen> <para> -The "xmode" command can be used to set the printer port's +The <command>xmode</command> command can be used to set the printer port's operating mode such as auto line feed, etc. For example, to examine the printer's current settings, type: </para> @@ -143,7 +143,7 @@ list startup </screen> <para> -Some commands have two parameters. For example, the COPY command is +Some commands have two parameters. For example, the <command>copy</command> command is used to make an exact copy of a file. It requires two parameters: The name of the file to be copied and the name of the file which is to be the copy, for example: @@ -169,7 +169,7 @@ dir -e </screen> <para> -The DIR command also can accept a file name as a parameter which +The <command>dir</command> command also can accept a file name as a parameter which specifies a directory file other than the (default) data directory. For example, to list file names in the directory sys , type: </para> @@ -235,7 +235,7 @@ MAKDIR filename makdir NEWFILES </screen> Creates a new directory file using the name given. Often followed -by a "chd" command to make it the new working data directory. +by a <command>chd</command> command to make it the new working data directory. <screen> RENAME filename1 filename2 rename zip zap </screen> @@ -270,7 +270,7 @@ <para> The screen pause feature stops programs after 16 lines have been displayed. Output will continue if you hit any key. Normally this -feature is on. It can be turned on or off with the TMODE command as +feature is on. It can be turned on or off with the <command>tmode</command> command as follows: </para> <screen>
--- a/docs/nitros9guide/chap3.chapter Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/chap3.chapter Thu Mar 20 20:19:53 2003 +0000 @@ -230,7 +230,7 @@ Every multifile device has a master directory (called the "root directory") that includes the names of the files and sub-directories stored on the device. The root directory is created automatically -when the disk is initialized by the "format" command. +when the disk is initialized by the <command>format</command> command. </para> <para> Pathlists that refer to multifile devices may have more than one @@ -258,7 +258,7 @@ OS-9 system disk. Note that device and directory names are capitalized and ordinary file names are not. This is a customary (but not mandatory) practice which allows you to easily identify directory -files using the short form of the "dir" command. +files using the short form of the <command>dir</command> command. </para> <literallayout class="monospaced"> System Device Directory @@ -284,7 +284,7 @@ "P", "D0" and "D1". The root directory of device "D0" includes two directory -files, DEFS and CMDS, and one ordinary file "startup". Notice that +files, <filename class="directory">DEFS</filename> and <filename class="directory">CMDS</filename>, and one ordinary file "startup". Notice that device "D1" has in its root directory three ordinary files. In order to access the file "file2" on device "d1", a pathlist having @@ -294,7 +294,7 @@ </screen> To construct a pathlist to access the file "dir" on device "d0" it is necessary to include in the pathlist the name of the -intermediate directory file "CMDS". For example, to copy this file +intermediate directory file <filename class="directory">CMDS</filename>. For example, to copy this file requires a pathlist having three names to describe the "from" file: <screen> copy /d0/cmds/dir temp @@ -306,7 +306,7 @@ <title>Creating and Using Directories</title> <para> It is possible to create a virtually unlimited number of levels -of directories on a mass storage device using the "makdir" command. +of directories on a mass storage device using the <command>makdir</command> command. Directories are a special type of file (see 3.8.1). They can be processed by the same I/O functions used to access regular files which makes directory-related processing fairly simple. @@ -314,8 +314,8 @@ <para> To demonstrate how directories work, assume that the disk in drive one ("d1") has been freshly formatted so that it has a root -directory only. The build command can be used to create a text file -on "d1". The build command will print out "?" as a prompt to +directory only. The <command>build</command> command can be used to create a text file +on "d1". The <command>build</command> command will print out "?" as a prompt to indicate that it is waiting for a text line to be entered. It will place each line into the text file until an empty line with only a carriage return is entered, as shown below: @@ -328,7 +328,7 @@ </screen> <para> -The "dir" command will now indicate the existence of the new file: +The <command>dir</command> command will now indicate the existence of the new file: </para> <screen> @@ -339,7 +339,7 @@ </screen> <para> -The "list" command can be used to display the text stored in the +The <command>list</command> command can be used to display the text stored in the file: </para> @@ -351,7 +351,7 @@ </screen> <para> -The "build" command again is again used to create two more text +The <command>build</command> command again is again used to create two more text files: </para> @@ -367,7 +367,7 @@ </screen> <para> -The dir command will now show three file names: +The <command>dir</command> command will now show three file names: </para> <screen> @@ -377,8 +377,8 @@ </screen> <para> -To make a new directory in this directory, the "makdir" command is -used. The new directory will be called "NEWDIR". Notice that +To make a new directory in this directory, the <command>makdir</command> command is +used. The new directory will be called <filename class="directory">NEWDIR</filename>. Notice that throughout this manual directory names are always capitalized. This is <emphasis>not</emphasis> a requirement of OS-9 (see 3.1) . Rather, it is a practice popular with many OS-9 users because it allows easy identification @@ -391,7 +391,7 @@ </screen> <para> -The directory file "NEWDIR" is now a file listed in D1's root +The directory file <filename class="directory">NEWDIR</filename> is now a file listed in D1's root directory: </para> @@ -404,7 +404,7 @@ <para> Now we will create a new file and put in the new directory, using -the COPY command to duplicate "file1": +the <command>copy</command> command to duplicate <filename>file1</filename>: </para> <screen> OS9: copy /d1/file1 /d1/newdir/file1.copy @@ -412,7 +412,7 @@ <para> Observe that the second pathlist now has three names: the name of the root directory ("D1"), the name of the next lower directory -("NEWDIR"), then the actual file name ("file1.copy"). Here's what +(<filename class="directory">NEWDIR</filename>), then the actual file name (<filename class="directory">file1.copy</filename>). Here's what the directories look like now: </para> <screen> @@ -425,7 +425,7 @@ file1.copy </screen> <para> -The dir command can now show the files in the new directory: +The <command>dir</command> command can now show the files in the new directory: </para> <screen> OS9: dir /D1/NEWDIR @@ -434,8 +434,8 @@ file1.copy </screen> <para> -It is possible to use "makdir" to create additional new directories -within "NEWDIR", and so on, limited only by available disk +It is possible to use <command>makdir</command> to create additional new directories +within <filename class="directory">NEWDIR</filename>, and so on, limited only by available disk space. </para> </section> @@ -443,7 +443,7 @@ <section> <title>Deleting Directory Files</title> <para> -The "del" command cannot be used to directly delete a directory +The <command>del</command> command cannot be used to directly delete a directory file. If a directory file that still contained file names were to be deleted, OS-9 would have no way to access the files or to return their storage to the unallocated storage pool. Therefore, the @@ -453,14 +453,14 @@ 1. All file names in the directory must be deleted. </para> <para> -2. The "attr" command is used to turn off the files directory +2. The <command>attr</command> command is used to turn off the files directory attrribute (-d option), making it an ordinary file (see 3.8). </para> <para> -3. The file may now be deleted using the "del" command. +3. The file may now be deleted using the <command>del</command> command. </para> <para> -A simpler alternative is to use the DELDIR command to automatically +A simpler alternative is to use the <command>deldir</command> command to automatically perform all these steps for you. </para> </section> @@ -542,7 +542,7 @@ explicitly given. This not only makes pathlists shorter, but allows OS-9 to locate files faster because (typically) fewer directories need be searched. For example, if the current working directory is -"/D1/PETE/GAMES" and a pathlist is given such as: +<filename class="directory">/D1/PETE/GAMES</filename> and a pathlist is given such as: </para> <para> baseball @@ -593,29 +593,29 @@ <para> Immediately after startup, OS-9 will set the data directory to be (the root directory of) the system disk drive (usually "D0"), and -the working directory to be a directory called "cmds" on the same -drive ("/D0/cmds"). On timesharing systems, the "login" command +the working directory to be a directory called <filename class="directory">cmds</filename> on the same +drive (<filename class="directory">/D0/cmds</filename>). On timesharing systems, the <command>login</command> command selects the initial execution and data directories to the file names specified in each user's information record stored in the system password file(ref. 5.4.2). </para> <para> -Here is an example of a shell command statement using the default +Here is an example of a <command>shell</command> command statement using the default working directory notation, and its equivalent expansion: </para> <screen> copy file1 file2 </screen> <para> -If the current execution directory is "/D0/CMDS" and the current -data directory is "/D0/JONES", the same command, fully expanded to +If the current execution directory is <filename class="directory">/D0/CMDS</filename> and the current +data directory is <filename class="directory">/D0/JONES</filename>, the same command, fully expanded to show complete pathlists implied is: </para> <screen> OS9: /D0/CMDS/copy /D0/JONES/filel /D0/JONES/file2 </screen> <para> -Notice that the first pathlist "copy" expands to the current working +Notice that the first pathlist <command>copy</command> expands to the current working directory pathlist because it is assumed to be an executable program but the two other file names expand using the data directory because they are not assumed to be executable. @@ -625,7 +625,7 @@ <section> <title>Changing Current Working Directories</title> <para> -The built-in shell commands "chd" and "chx" can be used to +The built-in shell commands <command>chd</command> and <command>chx</command> can be used to independently change the current working data and execution directories, respectively. These command names must be followed by a pathlist that describes the new directory file. You must have @@ -638,7 +638,7 @@ OS9: chx /D0/TESTPROGRAMS </screen> <para> -When using the CHD or CHX commands, pathlists work the same as they +When using the <command>chd</command> or <command>chx</command> commands, pathlists work the same as they do for regular files, except for the last name in the pathlist must be a directory name. If the pathlist begins with a "/" , OS-9 will begin searching in the device directory for the new working @@ -663,14 +663,14 @@ available. They are: </para> <para> -"." refers to the present working directory +<filename class="directory">.</filename> refers to the present working directory </para> <para> -".." refers to the directory that contains the name of the present +<filename class="directory">..</filename> refers to the directory that contains the name of the present directory (e.g., the next highest level directory) </para> <para> -"..." refers to directory two levels up, and so on +<filename class="directory">...</filename> refers to directory two levels up, and so on </para> <para> These can be used in place of pathlists and/or the first name in a @@ -691,7 +691,7 @@ </row> <row> <entry>OS9: del ../temp</entry> -<entry>deletes the file "temp" from the +<entry>deletes the file <filename>temp</filename> from the working data directory's parent directory.</entry> </row> </tbody> @@ -700,9 +700,9 @@ <para> The substitute names refer to either the execution or data directories, depending on the context in which they are used. -For example, if ".." is used in a pathlist of a file which +For example, if <filename class="directory">..</filename> is used in a pathlist of a file which will be loaded and/or executed, it will represent the parent -directory of the execution directory. Likewise, if "." is used in a +directory of the execution directory. Likewise, if <filename class="directory">.</filename> is used in a pathlist describing a program's input file, it will represent the current data directory. </para> @@ -775,9 +775,9 @@ <section> <title>Examining and Changing File Attributes</title> <para> -The "DIR" command may be used to examine the security permissions +The <command>dir</command> command may be used to examine the security permissions of the files in any particular directory when the "e" option is -used. An example using the "dir e" command to show the detailed +used. An example using the <command>dir e</command> command to show the detailed attributes of the files in the current working directory is: </para> <screen> @@ -803,8 +803,8 @@ <para> The character positions correspond to from left to right: directory; sharable; public execute; public write; public read; owner execute; -owner write; owner read. The "attr" command is used to examine or -change a file's attributes. Typing "attr" followed by a file name +owner write; owner read. The <command>attr</command> command is used to examine or +change a file's attributes. Typing <command>attr</command> followed by a file name will result in the present attributes to be displayed, for example: </para> @@ -830,9 +830,9 @@ read, write, and execute permissions. This is because it would be quite dangerous to be able to change directory files to normal files, and creation of a directory requires special initialization. -Therefore, the "attr" command +Therefore, the <command>attr</command> command <emphasis>cannot</emphasis> be used to turn -the directory (d) attribute on (only "makdir" can), and can be used +the directory (d) attribute on (only <command>makdir</command> can), and can be used to turn it off <emphasis>only</emphasis> if the directory is empty. </para> </section> @@ -875,8 +875,8 @@ <para> Even though there is physically only one type of file, the logical usage of files in OS-9 covers a broad spectrum. Because all -OS-9 files have the same physical type, commands such as "copy", -"del", etc., can be used with any file regardless of its logical +OS-9 files have the same physical type, commands such as <command>copy</command>, +<command>del</command>, etc., can be used with any file regardless of its logical usage. Similarly, a particular file can be treated as having a different logical usage at different times by different programs. The main usage of files covered in this section are: @@ -909,7 +909,7 @@ carriage return characters. </para> <para> -The content of text files may be examined using the "list" +The content of text files may be examined using the <command>list</command> command. </para> </section> @@ -970,7 +970,7 @@ must have a valid module header and CRC check value. If a program module has been altered in any way, either as a file or in memory, its CRC check value will be incorrect And OS-9 will refuse to load -the module. The "verify" command can be used to check the correctness +the module. The <command>verify</command> command can be used to check the correctness of the check values, and update them to corrected values if necessary. </para> @@ -979,9 +979,9 @@ treated as independent entities after loading and reside at different memory regions. </para> <para> -Like other files that contain "binary" data, attempts to "list +Like other files that contain "binary" data, attempts to "list" program files will result in the display of random characters on the -terminal giving strange effects. The "dump" command can be used to +terminal giving strange effects. The <command>dump</command> command can be used to safely examine the contents of this kind of file in hexadecimal and controlled ASCII format. </para> @@ -990,7 +990,7 @@ <section> <title>Directory Files</title> <para> -Directory files play a key role in the OS-9 file system. They can only be created by the "makdir" command, and +Directory files play a key role in the OS-9 file system. They can only be created by the <command>makdir</command> command, and can be identified by the "d" attribute being set (see 3.8.1). The file is organized into 32-byte records. Each record can be a directory entry. The first 29 bytes of the record is a string of @@ -1002,13 +1002,13 @@ located. </para> <para> -The "makdir" command initializes all records in a new directory +The <command>makdir</command> command initializes all records in a new directory to be unused entries except for the first two entries. These -entries have the names "." and ".." along with the logical sector +entries have the names <filename class="directory">.</filename> and <filename class="directory">..</filename> along with the logical sector numbers of the directory and its parent directory, respectively (see 3.7.3). </para> <para> -Directories cannot be copied or listed - the "dir" command is +Directories cannot be copied or listed - the <command>dir</command> command is used instead. Directories also cannot be deleted directly (see 3.5). </para> </section> @@ -1026,7 +1026,7 @@ files and some special word processor file formats which allow random access of text lines. As discussed in Sec. 3.9.1, most OS-9 utility commands work with any file format including -these special types. In general, the "dump" command is the preferred +these special types. In general, the <command>dump</command> command is the preferred method for examining the contents of unusually formatted files. </para> </section>
--- a/docs/nitros9guide/chap4.chapter Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/chap4.chapter Thu Mar 20 20:19:53 2003 +0000 @@ -91,7 +91,7 @@ </row> <row> <entry>sourcefile l -o</entry> -<entry>are parameters passed to "asm</entry> +<entry>are parameters passed to <command>asm</command></entry> </row> <row> <entry>>/p</entry> @@ -211,7 +211,7 @@ When redirection modifiers are used on a command line, they must be immediately followed by a pathlist describing the file or device the I/O is to be redirected to or from. For example, the standard -output of "list" can be redirected to write to the system printer +output of <command>list</command> can be redirected to write to the system printer instead of the terminal: </para> <screen> @@ -220,15 +220,15 @@ <para> Files referenced by I/O redirection modifiers are automatically opened or created, and closed (as appropriate) by the shell. Here is -another example, the output of the DIR command is redirected to the -file "/D1/savelisting": +another example, the output of the <command>dir</command> command is redirected to the +file <filename>/D1/savelisting</filename>: </para> <screen> OS9: DIR >/D1/savelisting </screen> <para> -If the LIST command is used on the file "/D1/savelisting", output -from the DIR command will be displayed as shown below: +If the LIST 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> OS9: list /d1/savelisting @@ -268,8 +268,8 @@ OS9: copy myfile /d1/newfile ; dir >/p </screen> <para> -This command line will first execute the COPY command and then the -DIR command. +This command line will first execute the <command>copy</command> command and then the +<command>dir</command> command. </para> <para> If an error is returned by any program, subsequent commands on @@ -316,12 +316,12 @@ OS9: </screen> <para> -This command line will cause shell to start the DIR command +This command line will cause shell to start the <command>dir</command> command executing, print the process ID number (&007), and then immediately display the "OS9:" prompt and wait for another command to be -entered. Meanwhile the DIR command will be busy sending a directory +entered. Meanwhile the <command>dir</command> command will be busy sending a directory listing to the printer. You can display a "status summary" of all -processes you have created by using the PROCS command. Below is +processes you have created by using the <command>procs</command> command. Below is another example: </para> <screen> @@ -331,9 +331,9 @@ </para> <para> -Because they were followed by "&" separators, the DIR, LIST, and -COPY programs will run concurrently, but the DEL program will not -run until the COPY program has terminated because sequential +Because they were followed by "&" separators, the <command>dir</command>, LIST, 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 (";") was specified. </para> </section> @@ -372,10 +372,10 @@ OS9: update <master_file ! sort ! write_report >/p </screen> <para> -In the example above, the program "update" has its input redirected -from a path called "master_file". Its standard output becomes the -standard input for the program "sort". Its output, in turn, becomes -the standard input for the program "write_report", which has its +In the example above, the program <command>update</command> has its input redirected +from a path called <filename>master_file</filename>. Its standard output becomes the +standard input for the program <command>sort</command>. Its output, in turn, becomes +the standard input for the program <command>write_report</command>, which has its standard output redirected to the printer. </para> <para> @@ -388,7 +388,7 @@ conversion, print file formatting, data compression/decompression, etc. Programs which are designed to process data as components of a pipeline are often called "filters". -The "tee" command, which uses +The <command>tee</command> command, which uses pipes to allow data to be simultaneously "broadcast" from a single input path to several output paths, is a useful filter. </para> @@ -412,7 +412,7 @@ </screen> except for the subtle difference that the printer is "kept" continuously in the first example; in the second case another user -could "steal" the printer in between the "dir" commands. +could "steal" the printer in between the <command>dir</command> commands. </para> <para> Command grouping can be used to cause a group of programs to be @@ -431,12 +431,12 @@ </screen> <para> Here is a very practical example of the use of pipelines. Recall -that the "DSAVE" command generates a procedure file to copy all the +that the <command>dsave</command> command generates a procedure file to copy all the files in a directory. The example below shows how the output of -"DSAVE" can be pipelined to a shell which will execute the OS-9 -commands as they are generated by DSAVE. Assume that we want to -copy all files from a directory called WORKING to a directory called -ARCHIVE: +<command>dsave</command> can be pipelined to a shell which will execute the OS-9 +commands as they are generated by <command>dsave</command>. Assume that we want to +copy all files from a directory called <filename class="directory">WORKING</filename> to a directory called +<filename class="directory">ARCHIVE</filename>: </para> <screen> OS9: chd /d0/WORKING; dsave /d0/ARCHIVE ! shell -p @@ -464,36 +464,36 @@ <colspec colwidth="3.5in"/> <tbody> <row> -<entry>chd <replaceable>pathlist</replaceable></entry> +<entry><command>chd</command> <replaceable>pathlist</replaceable></entry> <entry>change the working data directory to the directory specified by the pathlist.</entry> </row> <row> -<entry>chx <replaceable>pathlist</replaceable></entry> +<entry><command>chx</command> <replaceable>pathlist</replaceable></entry> <entry>change the working execution directory to the directory specified by the pathlist.</entry> </row> <row> -<entry>ex name</entry> +<entry><command>ex</command> <replaceable>name</replaceable></entry> <entry>directly execute the module named. This transforms the shell process so it ceases to exist and a new module begins execution in its place.</entry> </row> <row> -<entry>w</entry> +<entry><command>w</command></entry> <entry>wait for any process to terminate.</entry> </row> <row> -<entry>* text</entry> +<entry>* <replaceable>text</replaceable></entry> <entry>comment: "text" is not processed.</entry> </row> <row> -<entry>kill <replaceable>Proc ID</replaceable></entry> +<entry><command>kill</command> <replaceable>Proc ID</replaceable></entry> <entry>abort the process specified.</entry> </row> <row> -<entry>setpr <replaceable>proc ID</replaceable> <replaceable>priority</replaceable></entry> +<entry><command>setpr</command> <replaceable>Proc ID</replaceable> <replaceable>priority</replaceable></entry> <entry>changes process' priority.</entry> </row> <row> @@ -528,8 +528,8 @@ <para> The change directory commands switch the shell's working directory and, by inheritance, any subsequently created child process. The -"ex" command is used where the shell is needed to initiate execution -of a program without the overhead of a suspended "shell" process. +<command>ex</command> command is used where the shell is needed to initiate execution +of a program without the overhead of a suspended <command>shell</command> process. The name used is processed according to standard shell operation, and modifiers can be used. </para> @@ -547,7 +547,7 @@ </para> <para> The shell can start up another process also running the shell by -means of the "shell" command. If the standard input path is +means of the <command>shell</command> command. If the standard input path is redirected to a mass storage file, the new "incarnation" of the shell can accept and execute command lines from the file instead of a terminal keyboard. The text file to be processed is @@ -588,7 +588,7 @@ </screen> <para> Both do exactly the same thing: execute the commands of the file -"procfile". To run the procedure file in a "background" mode you +<filename>procfile</filename>. To run the procedure file in a "background" mode you simply add the ampersand operator: </para> <screen> @@ -622,11 +622,11 @@ 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 -this manual. If desired, the "printerr" command can be executed, +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 -from a text file called "/dd/sys/errmsg". -Once the "printerr" +from a text file called <filename>/dd/sys/errmsg</filename>. +Once the <command>printerr</command> command has been run it cannot be turned off. Also, its effect is system-wide. </para> @@ -654,7 +654,7 @@ </para> <para> For example, if you wanted to run a Basic09 I-code module called -"adventure", you could type the command given below: +<command>adventure</command>, you could type the command given below: </para> <screen> OS9: basic09 adventure @@ -673,7 +673,7 @@ <para> OS-9 systems used for timesharing usually have a procedure file that brings the system up by means of one simple command or by using -the system "startup" file. A procedure file which initiates the +the system <filename>startup</filename> file. A procedure file which initiates the timesharing monitor for each terminal is executed to start up the system. The procedure file first starts the system clock, then initiates concurrent execution of a number of processes that have @@ -701,12 +701,12 @@ </programlisting> <para> NOTE: This LOGIN procedure will not work until a password file -called "/DD/SYS/PASSWORD" has been created. For more information, +called <filename>/DD/SYS/PASSWORD</filename> has been created. For more information, please see the LOGIN command description. </para> <para> The example above deserves special attention. Note that the -"setime" command has its input redirected to the system console +<command>setime</command> command has its input redirected to the system console "term", which is necessary because it would otherwise attempt to read the time information from its current standard input path, which is the procedure file and not the keyboard.
--- a/docs/nitros9guide/chap5.chapter Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/chap5.chapter Thu Mar 20 20:19:53 2003 +0000 @@ -330,7 +330,7 @@ </para> <para> Programs can also be explicitly loaded into memory using the -"load" command. As with fork, the program will actually be loaded +<command>load</command> command. As with fork, the program will actually be loaded only if it is not already in memory. If the module is not in memory, OS-9 will copy a candidate memory module from the file into memory, verify the CRC, and then, if the module is not already in @@ -353,22 +353,22 @@ continuously, instead of being loaded repeatedly. </para> <para> -The opposite of "load" is the "unlink" command, which decreases a +The opposite of <command>load</command> is the <command>unlink</command> command, which decreases a program module's link count by one. Recall that when this count becomes zero (indicating the module in no longer used by any process), the module is deleted, e.g., its memory is deallocated and its name -is removed from the module directory. The "unlink" command is -generally used in conjunction with the "load" command (programs +is removed from the module directory. The <command>unlink</command> command is +generally used in conjunction with the <command>load</command> command (programs loaded by fork are automatically unlinked when the program terminates). </para> <para> Here is an example of the use of -"load" and "unlink" to lock a -program in memory. Suppose the "copy" command will be used five +<command>load</command> and <command>unlink</command> to lock a +program in memory. Suppose the <command>copy</command> command will be used five times. Normally, the copy command would be loaded each time the -"copy" command is called. If the "load" command is used first, -"copy" will be locked into memory first, for example: +<command>copy</command> command is called. If the <command>load</command> command is used first, +<command>copy</command> will be locked into memory first, for example: </para> <screen> OS9: load copy @@ -378,7 +378,7 @@ OS9: unlink copy </screen> <para> -It is important to use the "unlink" command after the program is no +It is important to use the <command>unlink</command> command after the program is no longer needed, or the program will continue to occupy memory which otherwise could be used for other purposes. Be very careful <emphasis>not</emphasis> to @@ -405,7 +405,7 @@ powerful features. </para> <para> -The "load" command can therefore be used two or more times (or a +The <command>load</command> command can therefore be used two or more times (or a single file may contain several memory modules), and each program module will be automatically loaded at different, non-overlapping addresses (most other operating systems write over the @@ -438,8 +438,8 @@ than the largest free space. </para> <para> -The "mfree" command shows the location and size of each unused -memory area and the "mdir e" command shows the address, size, and +The <command>mfree</command> command shows the location and size of each unused +memory area and the <command>mdir e</command> command shows the address, size, and link (use) count of each module in the address space. These commands can be used to detect fragmentation. Memory can usually be de-fragmemted by unlinking scattered modules and reloading them.
--- a/docs/nitros9guide/chap6.chapter Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/chap6.chapter Thu Mar 20 20:19:53 2003 +0000 @@ -8,11 +8,13 @@ system is running. </para> <para> -Two files used during the system startup operation, "OS9Boot" and -"startup" <emphasis>must</emphasis> +Two files used during the system startup operation, <filename>OS9Boot</filename> and +<filename>startup</filename> <emphasis>must</emphasis> reside in the system disk's root directory. Other -files are organized into three directories: CMDS (commands), DEFS -(system-wide definitions), and SYS (other system files). Other files +files are organized into three directories: +<filename class="directory">CMDS</filename> (commands), +<filename class="directory">DEFS</filename> (system-wide definitions), +and <filename class="directory">SYS</filename> (other system files). Other files and directories created by the system manager and/or users may also reside on the system disk. These frequently include each user s initial data directory. @@ -22,11 +24,11 @@ <title>The OS9Boot File</title> <para> -The file called "OS9Boot" loaded into RAM memory by the +The file called <filename>OS9Boot</filename> loaded into RAM memory by the "bootstrap" routine located in the OS-9 firmware. It includes file managers, device drivers and descriptors, and any other modules which are permanently resident in memory. A typical Microware OS-9 -distribution disk's "OS9Boot" file contains the following modules: +distribution disk's <filename>OS9Boot</filename> file contains the following modules: </para> <informaltable frame="none"> <tgroup cols="2"> @@ -111,7 +113,7 @@ <para> Users may create new bootstrap files which may include additional -modules (see "OS9Gen" command). Any module loaded as part of the +modules (see <command>OS9Gen</command> command). Any module loaded as part of the bootstrap cannot be unlinked and is stored in memory with a minimum of fragmentation. It may be advantageous to include in the OS9Boot file any module used constantly during normal system operation. @@ -123,7 +125,7 @@ <title>The SYS Directory</title> <para> -The directory "/d0/SYS" contains two important files: +The directory <filename>/d0/SYS</filename> contains two important files: </para> <informaltable frame="none"> <tgroup cols="2"> @@ -132,7 +134,7 @@ <tbody> <row> <entry>password</entry> -<entry>the system password file (see "login" command)</entry> +<entry>the system password file (see <command>login</command> command)</entry> </row> <row> <entry>errmsg</entry> @@ -142,9 +144,9 @@ </tgroup> </informaltable> <para> -These files (and the SYS directory itself) are not absolutely -required to boot OS-9, they are needed if "login", "tsmon", or -"printerr" will be used. Users may add other system-wide files of +These files (and the <filename class="directory">SYS</filename> directory itself) are not absolutely +required to boot OS-9, they are needed if <command>login</command>, <command>tsmon</command>, or +<command>printerr</command> will be used. Users may add other system-wide files of similar nature if desired. </para> </section> @@ -153,10 +155,10 @@ <title>The Startup File</title> <para> -The file "/d0/startup" is a shell procedure file which +The file <filename>/d0/startup</filename> is a shell procedure file which is automatically processed immediately after system startup. The -user may include in "startup" any legal shell command line. Often -this will include "setime" to start the system clock. If this file +user may include in <filename>startup</filename> any legal shell command line. Often +this will include <command>setime</command> to start the system clock. If this file is not present the system will still start correctly but the user must run the SETIME command manually. </para> @@ -166,11 +168,11 @@ <title>The CMDS Directory</title> <para> -The directory "/d0/CMDS" is the system-wide command object code +The directory <filename class="directory">/d0/CMDS</filename> is the system-wide command object code directory, which is normally shared by all users as their working -execution directory. If "shell" is not part of the -"OS9Boot" file, it must be present in this directory. The system -startup process "sysgo" makes CMDS the initial execution directory. +execution directory. If <command>shell</command> is not part of the +<filename>OS9Boot</filename> file, it must be present in this directory. The system +startup process "sysgo" makes <filename class="directory">CMDS</filename> the initial execution directory. </para> </section> @@ -178,7 +180,7 @@ <title>The DEFS Directory</title> <para> -The directory "/d0/DEFS" is a directory that contains assembly +The directory <filename class="directory">/d0/DEFS</filename> is a directory that contains assembly language source code files which contain common system-wide symbolic definitions, and are normally included in assembly language programs by means of the OS-9 Assembler "use" directive. The presence and @@ -218,8 +220,8 @@ <para> The system disk is not usually removed while the system is running, especially -on multiuser systems. If it is, the "chx" and -"chd" (if the working data directory was on the system disk) +on multiuser systems. If it is, the <command>chx</command> and +<command>chd</command> (if the working data directory was on the system disk) commands should be executed to reset the working directory pointers because the directories may be at different addresses on the new disk, for example: @@ -252,16 +254,17 @@ </para></listitem> <listitem><para> -The "OS9Boot" file must be created and linked by the "OS9Gen" or -"Cobbler" commands. +The <filename>OS9Boot</filename> file must be created and linked by the <command>OS9Gen</command> or +<command>Cobbler</command> commands. </para></listitem> <listitem><para> -The "startup" file must be created or copied. +The <filename>startup</filename> file must be created or copied. </para></listitem> <listitem><para> -The CMDS and SYS directories and the files they contain must be +The <filename class="directory">CMDS</filename> and +<filename class="directory">SYS</filename> directories and the files they contain must be copied. </para></listitem> </orderedlist> @@ -274,11 +277,11 @@ </para></listitem> <listitem><para> -By a shell procedure file generated by the "dsave" command +By a shell procedure file generated by the <command>dsave</command> command </para></listitem> <listitem><para> -By the "backup" command +By the <command>backup</command> command </para></listitem> </orderedlist> </para>
--- a/docs/nitros9guide/chd.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/chd.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -30,7 +30,7 @@ </para> <para> NOTE: These commands do not appear in the CMDS directory as they -are built-in to the SHELL. +are built-in to the <command>shell</command>. </para> <para> For more information see: 3.7, 3.7.2
--- a/docs/nitros9guide/cobbler.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/cobbler.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -15,20 +15,20 @@ <refsect1><title>Description</title> <para> -COBBLER is used to create the "OS9Boot" file required on any disk +<command>Cobbler</command> is used to create the <filename>OS9Boot</filename> file required on any disk from which OS-9 is to be bootstrapped. The boot file will consist of the <emphasis>same modules which were loaded into memory during the most recent boostrap.</emphasis> To add modules to the bootstrap file use the -"OS9Gen" command. COBBLER also writes the OS-9 kernel on the first +<command>OS9Gen</command> command. <command>Cobbler</command> also writes the OS-9 kernel on the first fifteen sectors of track 34, and excludes these sectors from the disk allocation map. If any files are present on these sectors -COBBLER will display an error message. +<command>cobbler</command> will display an error message. </para> <para> NOTE: The boot file must fit into one contiguous block on the mass-storage -device. For this reason COBBLER is normally used on a -freshly formatted disk. If COBBLER is used on a disk and there is +device. For this reason <command>cobbler</command> is normally used on a +freshly formatted disk. If <command>cobbler</command> is used on a disk and there is not a contiguous block of storage large enough to hold the boot file, the old boot file may have been destroyed and OS-9 will not be able to boot from that disk until it is reformatted.
--- a/docs/nitros9guide/config.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/config.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -13,22 +13,22 @@ <refsect1><title>Description</title> <para> -CONFIG provides menus of all I/O options and all system commands. You select +<command>Config</command> provides menus of all I/O options and all system commands. You select the device drivers and commands you want to include on a new system diskette from these menus. Selecting only the device drivers and commands you and your system require lets you make the most efficient use of computer memory and system diskette storage. </para> <para> -The CONFIG utility is on a separate CONFIG/BOOT Diskette. Make a copy of this -diskette using the OS-9 BACKUP command and use the copy as your working +The <command>config</command> utility is on a separate CONFIG/BOOT Diskette. Make a copy of this +diskette using the OS-9 <command>backup</command> command and use the copy as your working diskette. Keep the original CONFIG/BOOT Diskette in a safe place to use for future backups. You can use the CONFIG/BOOT Diskette for booting OS-9 from &make; Disk BASIC from Drive /D0. </para> <para> -CONFIG requires no initial parameters. You establish parameters during the -operation of CONFIG. Be sure that the execution directory is at /D0/CMDS +<command>Config</command> requires no initial parameters. You establish parameters during the +operation of <command>config</command>. Be sure that the execution directory is at /D0/CMDS before executing the command. </para> <para> @@ -38,12 +38,12 @@ CONFIG [ENTER] </screen> <para> -CONFIG executes and a prompt asks you to indicate whether you wish to use +<command>Config</command> executes and a prompt asks you to indicate whether you wish to use one or two disk drives. Press [1] for single- or [2] for two-drive operation. </para> <para> -Next, CONFIG builds a list of the various devices from the MODULES directory. +Next, <command>config</command> builds a list of the various devices from the MODULES directory. When the list is complete, a screen menu appears. Use the up and down arrow keys to move to a device. Then, press [S] to either select or exclude a particular device. Press [S] once to display an X to the right of the @@ -181,9 +181,9 @@ device. </para> <para> -CONFIG builds a boot list from the selected devices and their associated +<command>Config</command> builds a boot list from the selected devices and their associated drivers and managers. "Bootlist" is created in the ROOT directory of -Drive 0. CONFIG next displays two clock options: +Drive 0. <command>Config</command> next displays two clock options: </para> <literallayout> 1 - 60Hz (American) @@ -221,7 +221,7 @@ commands to the new system diskette. Use this option to create a new boot file on a diskette on which you have prefviously copied the OS-9 system. If you have only one disk drive, this procedure is quicker than using -the CONFIG utility to complete the entire system transfer, as less +the <command>config</command> utility to complete the entire system transfer, as less diskette swaps are required. </para> <para> @@ -256,7 +256,7 @@ <para> If you have a multi-drive system, a prompt appears asking you to insert your OS-9 system diskette in /D0. Press the spacebar. The process finishes the -CONFIG operation and returns to OS-9. +<command>config</command> operation and returns to OS-9. </para> <para> If you have a single-drive system, you swawp diskettes during the final @@ -268,10 +268,10 @@ </para> <para> It would be quicker and easier to use BACKUP to create a system disk, use -CONFIG to create a new bootfile, then delete unwanted commands. However, +<command>config</command> to create a new bootfile, then delete unwanted commands. However, this process causes fragmentation of diskette space. Fragmentation results in slower diskette access, and free memory is broken into segments that -might not be large enough for some OS-9 operations. CONFIG causes no +might not be large enough for some OS-9 operations. <command>Config</command> causes no fragmentation. </para> <para>
--- a/docs/nitros9guide/copy.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/copy.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -32,15 +32,15 @@ occurs on the input path. Because block transfers are used, normal output processing of data does not occur on character-oriented devices such as terminals, printers, etc. Therefore, the -LIST command is preferred over COPY when a file consisting of text +<command>list</command> command is preferred over <command>copy</command> when a file consisting of text is to be sent to a terminal or printer. </para> <para> -The "-s" option causes COPY to perform a single drive copy +The "-s" option causes <command>copy</command> to perform a single drive copy operation. The second pathlist must be a full pathlist if "-s -appears. COPY will read a portion of the source disk into memory, +appears. <command>Copy</command> will read a portion of the source disk into memory, you remove the source disk and place the destination disk into the -drive, enter a "C" whereupon COPY writes on the destination disk, +drive, enter a "C" whereupon <command>copy</command> writes on the destination disk, this process continues until the entire file is copied. </para> <para>
--- a/docs/nitros9guide/dcheck.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/dcheck.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -22,13 +22,13 @@ but in fact are not actually associated with a file or the disk's free space. This can happen if a disk is removed from a drive while files are still open, or if a directory which still contains files -is deleted (see 3.5). DCHECK is a diagnostic that can be used to +is deleted (see 3.5). <command>Dcheck</command> is a diagnostic that can be used to detect this condition, as well as the general integrity of the directory/file linkages. </para> <para> -DCHECK is given as a parameter the name of the disk device to be +<command>Dcheck</command> is given as a parameter the name of the disk device to be checked. After verifying and printing some vital file structure -parameters, DCHECK follows pointers down the disk's file system tree +parameters, <command>dcheck</command> follows pointers down the disk's file system tree to all directories and files on the disk. As it does so, it verifies the integrity of the file descriptor sectors, reports any discrepancies in the directory/file linkages, and builds a sector @@ -47,9 +47,9 @@ are bad, the allocation map is <emphasis>not</emphasis> updated for corrupt FDs. </para> <para> -While building the allocation map, DCHECK also makes sure that each +While building the allocation map, <command>dcheck</command> also makes sure that each disk cluster appears only once and only once in the file structure. -If this condition is detected, DCHECK will display a message like: +If this condition is detected, <command>dcheck</command> will display a message like: </para> <screen> Cluster $xxxxxx was previously allocated @@ -84,11 +84,11 @@ in the disk's allocation map. It is possible that this cluster may be allocated to another file later, overwriting the contents of the cluster with data from the newly allocated file. Any clusters that -have been reported as "previously allocated" by DCHECK as described +have been reported as "previously allocated" by <command>dcheck</command> as described above surely have this problem. </para> <para> -Available DCHECK options are: +Available <command>dcheck</command> options are: </para> <informaltable frame="none"> @@ -118,38 +118,38 @@ </row> <row> <entry>-o</entry> -<entry>print DCHECK's valid options</entry> +<entry>print <command>dcheck</command>'s valid options</entry> </row> </tbody> </tgroup> </informaltable> <para> -The "-s" option causes DCHECK to display a count of files and +The "-s" option causes <command>dcheck</command> to display a count of files and directories only; only FDs are checked for validity. The "-b" option suppresses listing of clusters allocated but not in file structure. -The "-p" option causes DCHECK to make a second pass through the file -structure printing the pathlists for any clusters that DCHECK finds +The "-p" option causes <command>dcheck</command> to make a second pass through the file +structure printing the pathlists for any clusters that <command>dcheck</command> finds as "already allocated" or "in file structure but not in allocation -map". The "-w=" option tells DCHECK where to locate it's allocation +map". The "-w=" option tells <command>dcheck</command> where to locate it's allocation map work file(s). The pathlist specified must be a FULL pathlist to a <emphasis>directory</emphasis>. The directory "/D0" is used is used if "-w" is not specified. It is recommended that this pathlist NOT be located on -the disk being DCHECKed if the disk's file structure integrity is in +the disk being <command>dcheck</command>ed if the disk's file structure integrity is in doubt. </para> <para> -DCHECK builds its disk allocation map in a file called +<command>Dcheck</command> builds its disk allocation map in a file called <replaceable>pathlist</replaceable>/DCHECKppO, where <replaceable>pathlist</replaceable> is as specified by the "-w=" option and pp is the process number in hexadecimal. Each bit in this bitmap file corresponds to a cluster of sectors on the disk. -If the "-p" option appears on the command line, DCHECK creates a +If the "-p" option appears on the command line, <command>dcheck</command> creates a second bitmap file (<replaceable>pathlist</replaceable>/DCHECKpp1) that has a bit set for -each cluster DCHECK finds as "previously allocated" or "in file +each cluster <command>dcheck</command> finds as "previously allocated" or "in file structure but not in allocation map" while building the allocation -map. DCHECK them makes another pass through the directory structure +map. <command>Dcheck</command> them makes another pass through the directory structure to determine the pathlists for these questionable clusters. These bitmap work files may be saved by specifying the "-m" option on the command line. @@ -157,10 +157,10 @@ </refsect1> <refsect1><title>Restrictions</title> <para> -For best results, DCHECK should have exclusive access to the disk -being checked. Otherwise DCHECK may be fooled if the disk allocation map +For best results, <command>dcheck</command> should have exclusive access to the disk +being checked. Otherwise <command>dcheck</command> may be fooled if the disk allocation map changes while it is building its bitmap file from the -changing file structure. DCHECK cannot process disks with a directory +changing file structure. <command>Dcheck</command> cannot process disks with a directory depth greater than 39 levels. </para> <para>
--- a/docs/nitros9guide/ded.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/ded.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -13,7 +13,7 @@ <refsect1><title>Description</title> <para> -dEd is a screen-oriented disk editor utility. +<command>dEd</command> is a screen-oriented disk editor utility. It was originally conceived as a floppy disk editor, so the display is organized around individual sectors. It performs most of the functions of Patch, from @@ -27,22 +27,22 @@ </para><para> To use, type: <screen> -dEd <replaceable>pathlist</replaceable> +<command>dEd</command> <replaceable>pathlist</replaceable> </screen> where <pathlist> is of the form: filename or dirname or /path/filename or /D0@ (edits entire disk) </para><para> -dEd will read in and display the first 256 bytes in the file +<command>dEd</command> will read in and display the first 256 bytes in the file (disk). This is Logical Sector Number (LSN) zero. You move through the file sector (LSN) by sector using the up and down arrow keys. The current LSN number is displayed in Hex and Decimal in the upper left corner of the screen. If the disk itself was accessed (by appending '@' to it's name when -dEd was called), the LSN is the disk sector number. If an +<command>dEd</command> was called), the LSN is the disk sector number. If an individual file is being editted, however, the LSN displayed refers to the file, not to the disk. All numbers requested -by dEd must be in Hex format. All commands are accessed by +by <command>dEd</command> must be in Hex format. All commands are accessed by simply pressing the desired key. </para> </refsect1>
--- a/docs/nitros9guide/deiniz.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/deiniz.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -29,7 +29,7 @@ <para> is the name of the device drivere you want to detach. Specify as many device drivers as you -wish with one DEINIZ command. +wish with one <command>deiniz</command> command. </para> </listitem> </varlistentry>
--- a/docs/nitros9guide/del.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/del.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -25,9 +25,9 @@ <refsect1><title>Description</title> <para> This command is used to delete the file(s) specified by the -pathllst(s). The user must have write permission for the file(s). +pathlist(s). The user must have write permission for the file(s). Directory files cannot be deleted unless their type is changed to -non-directory: see the "ATTR" command description. +non-directory: see the <command>ATTR</command> command description. </para> <para> If the -x option appears, the current
--- a/docs/nitros9guide/deldir.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/deldir.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -20,7 +20,7 @@ <emphasis>all</emphasis> files in the directory system are to be deleted. </para> <para> -When DELDIR is run, it prints a prompt message like this: +When <command>deldir</command> is run, it prints a prompt message like this: </para> <screen> OS9: deldir OLDFILES @@ -28,7 +28,7 @@ List directory, delete directory, or quit ? (l/d/q) </screen> <para> -An "l" response will cause a "dir e" command to be run so you can +An "l" response will cause a <command>dir e</command> command to be run so you can have an opportunity to see the files in the directory before they are deleted. </para> @@ -40,19 +40,19 @@ </para> <para> The directory to be deleted may include directory files, which -may themselves include directory files, etc. In this case, DELDIR +may themselves include directory files, etc. In this case, <command>deldir</command> operates recursively (e.g., it calls itself) so all lower-level directories are deleted as well. In this case the lower-level directories are processed first. </para> <para> You must have correct access permission to delete all files and -directories encountered. If not, DELDIR will abort upon +directories encountered. If not, <command>deldir</command> will abort upon encountering the first file for which you do not have write permission. </para> <para> -The DELDIR command automatically calls the DIR and ATTR +The <command>deldir</command> command automatically calls the DIR and ATTR commands, so they both must reside in the current execution directory. </para>
--- a/docs/nitros9guide/dir.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/dir.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -52,7 +52,7 @@ dir newstuff (display newstuff directory) -dir -e test_programs (display entire description of "test.programs) +dir -e test_programs (display entire description of <filename class="directory">test_programs</filename>) </screen> </refsect1> </refentry>
--- a/docs/nitros9guide/dirm.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/dirm.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -32,7 +32,7 @@ of each module is displayed. All numbers shown are in hexadecimal. </para> <para> -WARNING: Many of the modules listed by DIRM are OS-9 system modules +WARNING: Many of the modules listed by <command>dirm</command> are OS-9 system modules and NOT executable as programs: always check the module type code before running a module if you are not familiar with it! </para>
--- a/docs/nitros9guide/disasm.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/disasm.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -19,7 +19,7 @@ <para> Disasm was written to hack apart OS9 system modules,command modules, file managers and device drivers/descriptors either from memory or disk. -Unlike most other disassemblers,DISASM is a two pass disassembler, creating +Unlike most other disassemblers, <command>disasm</command> is a two pass disassembler, creating output using only referenced labels. This output can be redirected to a file and (after modifications if desired) then re-assembled. </para>
--- a/docs/nitros9guide/dmode.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/dmode.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -28,7 +28,7 @@ </refsect1> <refsect1><title>Examples</title> <para> -Typical DMODE output: +Typical <command>dmode</command> output: <screen> OS9: dmode /dd {enter} @@ -38,7 +38,7 @@ Now, let's say we want to change the number of cylinders this descripter shows. The following command lines would -all be valid and accepted by the new DMODE: +all be valid and accepted by the new <command>dmode</command>: <screen> OS9: dmode /dd CYL=276
--- a/docs/nitros9guide/dsave.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/dsave.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -27,30 +27,30 @@ which is executed later to actually do the work. </para> <para> -When DSAVE is executed, it writes copy commands to +When <command>dsave</command> is executed, it writes copy commands to <emphasis>standard output</emphasis> to copy files from the current <emphasis>data</emphasis> directory on <replaceable>devname</replaceable> (the default is /D0) to the directory specified by <replaceable>path</replaceable>. If <replaceable>path</replaceable> does not appear, the copy is performed to the current data directory -<emphasis>at the time the DSAVE procedure file is executed.</emphasis> -If DSAVE -encounters a directory file, it will automatically include "makdir" -and "chd" commands in the output before generating copy commands for -files in the subdirectory. Since DSAVE is recursive in operation, +<emphasis>at the time the <command>dsave</command> procedure file is executed.</emphasis> +If <command>dsave</command> +encounters a directory file, it will automatically include <command>makdir</command> +and <command>chd</command> commands in the output before generating copy commands for +files in the subdirectory. Since <command>dsave</command> is recursive in operation, the procedure file will exactly replicate all levels of the file system from the current data directory downward (such a section of the file system is called a "subtree"). </para> <para> If the current working directory happens to be the root directory of -the disk, DSAVE will create a procedure file that will backup the +the disk, <command>dsave</command> will create a procedure file that will backup the entire disk file by file. This is useful when it is necessary to copy many files from different format disks, or from floppy disk to a hard disk. </para> <para> -Available DSAVE options are: +Available <command>dsave</command> options are: </para> <informaltable frame="none"> @@ -61,12 +61,12 @@ <row> <entry>-b</entry> <entry>make output disk a system disk by using source disk's -"OS9Boot" file,. if present.</entry> +<filename>OS9Boot</filename> file,. if present.</entry> </row> <row> <entry>-b=<replaceable>path</replaceable></entry> <entry>make output disk a system disk using <replaceable>path</replaceable> as source -for the "OS9Boot" file.</entry> +for the <filename>OS9Boot</filename> file.</entry> </row> <row> <entry>-i</entry> @@ -78,7 +78,7 @@ </row> <row> <entry>-m</entry> -<entry>do not include "makdir" commands in procedure file</entry> +<entry>do not include <command>makdir</command> commands in procedure file</entry> </row> <row> <entry>-s<replaceable>integer</replaceable></entry>
--- a/docs/nitros9guide/ex.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/ex.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -33,7 +33,7 @@ waste memory space on SHELL. </para> <para> -The "ex" command should always be the last command on a shell input +The <command>ex</command> command should always be the last command on a shell input line because any command line following will never be processed. </para> <para>
--- a/docs/nitros9guide/exbin.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/exbin.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -25,12 +25,12 @@ </para> <para> "Path1" is assumed to be an -S-Record format text file which EXBIN converts to pure binary form on +S-Record format text file which <command>exbin</command> converts to pure binary form on a new file called "path2". The load addresses of each data record must describe continguous data in ascending order. </para> <para> -EXBIN does not generate or check for the proper OS-9 module +<command>Exbin</command> does not generate or check for the proper OS-9 module headers or CRC check value required to actually load the binary file. The IDENT or VERIFY commands can be used to check the validity of the modules if they are to be loaded or run.
--- a/docs/nitros9guide/exmode.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/exmode.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -14,21 +14,22 @@ <refsect1><title>Description</title> <para> -EXMODE is an enhanced verison of the XMODE utility, and is useful for +<command>exmode</command> is an enhanced verison of the <command>xmode</command> utility, and is useful for changing initialization parameters specific to CoCo 3 window descriptors and enhanced ACIA device descriptors. </para> <para> -EXMODE is very similar to the TMODE command. TMODE only operates on -open paths so its effect is temporary. EXMODE actually updates the +<command>Exmode</command> is very similar to the <command>tmode</command> command. +<command>Tmode</command> only operates on +open paths so its effect is temporary. <command>Exmode</command> actually updates the device descriptor so the change persists as long as the computer is running, even if paths to the device are repetitively opened and -closed. If EXMODE is used to change parameter(s) and the COBBLER +closed. If <command>exmode</command> is used to change parameter(s) and the COBBLER program is used to make a new system disk, the changed parameter will be permanently reflected on the new system disk. </para> <para> -EXMODE requires a device name to be given. If no arguments are +<command>Exmode</command> requires a device name to be given. If no arguments are given, the present values for each parameter are displayed, otherwise, the parameter(s) given in the argument list are processed. Any number of parameters can be given, and are separated @@ -36,7 +37,7 @@ </para> </refsect1> -<refsect1><title>EXMODE Parameter Names</title> +<refsect1><title><command>Exmode</command> Parameter Names</title> <informaltable frame="none"> <tgroup cols="2">
--- a/docs/nitros9guide/format.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/format.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -20,8 +20,8 @@ before they can be used on an OS-9 system. </para> <para> -NOTE: If the diskette is to be used as a system disk, "OS9gen" or -"cobbler" must be run to create the bootstrap after the disk has +NOTE: If the diskette is to be used as a system disk, <command>OS9gen</command> or +<command>cobbler</command> must be run to create the bootstrap after the disk has been formatted. </para> <para> @@ -53,7 +53,7 @@ </listitem> </orderedlist> <para> -FORMAT will prompt for a disk volume name, which can be up to 32 +<command>Format</command> will prompt for a disk volume name, which can be up to 32 characters long and may include spaces or punctuation. This name can later be displayed using the FREE command. </para>
--- a/docs/nitros9guide/free.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/free.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -18,7 +18,7 @@ This command displays the number of unused 256-byte sectors on a device which are available for new files or for expanding existing files. The device name given must be that of a mass-storage -multifile device. "Free" also displays the disk's name, creation +multifile device. <command>Free</command> also displays the disk's name, creation date, and cluster size. </para> <para> @@ -27,7 +27,7 @@ characteristics of the specific device. This means that small amounts of free space may not be divisible into as many files. For example, if a given disk system uses 8 sectors per cluster, and a -"free" command shows 32 sectors free, a maximum of four new files +<command>free</command> command shows 32 sectors free, a maximum of four new files could be created even if each has only one cluster. </para> <para>
--- a/docs/nitros9guide/go51.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/go51.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -29,13 +29,13 @@ means that an extra 6K bytes will be needed in this mode. This extra memory requirement is not normally a problem but in memory-critical applications, such as the C and Pascal compilers, the user -can simply avoid the use of GO51. +can simply avoid the use of <command>go51</command>. </para> <para> This mode of display has a set of <emphasis>escape sequences</emphasis> (commands) to emulate commercial data terminals. In addition to the video screen -driver, GO51 provides a new keyboard driver which features auto-repeat. +driver, <command>go51</command> provides a new keyboard driver which features auto-repeat. The keyboard code allocation is the same as described in section 2.4.3 and Appendix D. </para>
--- a/docs/nitros9guide/help.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/help.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -9,7 +9,7 @@ <command>HELP</command> <arg choice="opt"> <option>command - the command for which you want syntax help. Include -as many command names in one HELP line as you wish. The proper form and +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> @@ -19,8 +19,8 @@ <refsect1><title>Notes</title> <para> -To use HELP, first copy Cmds.hp from the SYS directory of the CONFIG/BOOT -Diskette to the SYS directory of your system diskette. Next, copy HELP +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 of your system diskette as follows: </para> @@ -77,7 +77,7 @@ for standard OS-9 commands. </para> <para> -HELP displays the form and syntax of the specified command. If you use a +<command>Help</command> displays the form and syntax of the specified command. If you use a non-standard command name, a screen display tells you that help is not available for that command. </para>
--- a/docs/nitros9guide/ident.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/ident.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -22,16 +22,16 @@ <refsect1><title>Description</title> <para> This command is used to display header information from OS-9 memory -modules. IDENT displays the module size, CRC bytes (with verification), and for +modules. <command>Ident</command> displays the module size, CRC bytes (with verification), and for program and device driver modules, the execution -offset and the permanent storage requirement bytes. IDENT will +offset and the permanent storage requirement bytes. <command>ident</command> will print and interpret the type/language and attribute/revision bytes. -In addition, IDENT displays the byte immediately following the +In addition, <command>ident</command> displays the byte immediately following the module name since most Microware-supplied modules set this byte to indicate the module edition. </para> <para> -IDENT will display all modules contained in a disk file. If the +<command>Ident</command> will display all modules contained in a disk file. If the "-m" option appears, <replaceable>path</replaceable> is assumed to be a module in memory. </para> <para> @@ -42,7 +42,7 @@ directory. </para> <para> -The "-s" option causes IDENT to display the. following module +The "-s" option causes <command>ident</command> to display the. following module information on a single line: </para> <simplelist> @@ -57,7 +57,7 @@ </member> <member> A "." if the CRC verifies correctly, "?" if incorrect. -(IDENT will leave this field blank if the "-v" option appears.) +(<command>Ident</command> will leave this field blank if the "-v" option appears.) </member> <member> Module name
--- a/docs/nitros9guide/iniz.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/iniz.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -19,7 +19,7 @@ Links the specified device to OS-9, places the device addres in a new device table entry, allocates the memory needed by the device driver, and calls the device driver initialization routine. If the device is already -installed, INIZ does not reinitialize it. +installed, <command>iniz</command> does not reinitialize it. </para> <refsect2> <title>Options:</title> @@ -30,7 +30,7 @@ <para> is the name of the device drivere you want to initialize. Specify as many device drivers as you -wish with one INIZ command. +wish with one <command>iniz</command> command. </para> </listitem> </varlistentry>
--- a/docs/nitros9guide/kill.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/kill.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -18,20 +18,20 @@ This shell "built in" command sends an "abort" signal to the process having the process ID number specified. The process to be aborted must have the same user ID as the user that executed the -command. The "procs" command can be used to obtain the process ID +command. The <command>procs</command> command can be used to obtain the process ID numbers. </para> <para> NOTE: If a process is waiting for I/O, it may not die until it -completes the current I/O operation, therefore, if you KILL a -process and the PROCS command shows it still exists, it is probably +completes the current I/O operation, therefore, if you <command>kill</command> a +process and the <command>procs</command> command shows it still exists, it is probably waiting for receive a line of data from a terminal before it can die. -Since this is a built-in SHELL command, it does not appear in the +Since this is a built-in <command>shell</command> command, it does not appear in the CMDS directory. -For more information see: 4.5, 5.2, PROCS +For more information see: 4.5, 5.2, <command>procs</command> </para> </refsect1>
--- a/docs/nitros9guide/link.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/link.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -17,7 +17,7 @@ <para> This command is used to "lock" a previously loaded module into memory. The link count of the module specified is incremented by one -each time it is "linked". The "unlink" command is +each time it is "linked". The <command>unlink</command> command is used to "unlock" the module when it is no longer needed. </para>
--- a/docs/nitros9guide/login.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/login.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -13,7 +13,7 @@ <refsect1><title>Description</title> <para> Login is used in timesharing systems to provide log-in security. It -is automatically called by the timesharing monitor "tsmon", or can +is automatically called by the timesharing monitor <command>tsmon</command>, or can be used after initial log-in to change a terminal's user. </para> <para> @@ -21,10 +21,10 @@ validation file. If the information is correct, the user's system priority, user ID, and working directories are set up according to information stored in the file, and the initial program specified in -the password file is executed (usually SHELL). If the user cannot +the password file is executed (usually <command>shell</command>). If the user cannot supply a correct user name and password after three attempts, the -process is aborted. The validation file is called "PASSWORD" and -must be present in the directory "/d0/SYS". The file contains one or +process is aborted. The validation file is called <filename>PASSWORD</filename> and +must be present in the directory <filename class="directory">/d0/SYS</filename>. The file contains one or more variable-length text records, one for each user name. Each record has the following fields, which are delimited by commas: </para> @@ -47,13 +47,13 @@ 4. Initial process (CPU time) priority: 1 - 255 (see 5.2) </para> <para> -5. Pathlist of initial execution directory (usually /d0/CMDS) +5. Pathlist of initial execution directory (usually <filename class="directory">/d0/CMDS</filename>) </para> <para> 6. Pathlist of initial data directory (specific user's directory) </para> <para> -7. Name of initial program to execute (usually "shell"). +7. Name of initial program to execute (usually <command>shell</command>). NOTE: This is not a shell command line. </para> <para> @@ -68,7 +68,7 @@ </screen> <para> -To use the login command, enter: +To use the <command>login</command> command, enter: </para> <literallayout> login @@ -76,16 +76,16 @@ <para> This will cause prompts for the user's name and (optionally) password to be displayed, and if answered correctly, the user is -logged into the system. Login initializes the user number, working +logged into the system. <command>Login</command> initializes the user number, working execution directory, working data directory, and executes the initial program specified by the password file. The date, time and process number (which is <emphasis>not</emphasis> the same as the user ID, see 5.3) are also displayed. </para> <para> -Note: if the shell from which "login" was called will not be needed -again, it may be discarded by using the EX command to start the -LOGIN command. For example: +Note: if the shell from which <command>login</command> was called will not be needed +again, it may be discarded by using the <command>ex</command> command to start the +<command>login</command> command. For example: </para> <literallayout> ex login @@ -94,7 +94,7 @@ <title>Logging Off the System</title> <para> To log off the system, the initial program specified in the password -file must be terminated. For most programs (including shell) this +file must be terminated. For most programs (including <command>shell</command>) this may be done by typing an end of file character (escape) as the first character on a line. </para> @@ -102,9 +102,9 @@ <refsect2> <title>Displaying a "Message-of-the-Day"</title> <para> -If desired, a file named "motd" appearing in the SYS directory will -cause LOGIN to display it's contents on the user's terminal after -successful login. This file is not required for LOGIN to operate. +If desired, a file named <filename>motd</filename> appearing in the SYS directory will +cause <command>login</command> to display it's contents on the user's terminal after +successful login. This file is not required for <command>login</command> to operate. </para> <para> For more information see: tsmon, 2.5, 3.8, 5.3
--- a/docs/nitros9guide/makdir.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/makdir.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -21,7 +21,7 @@ </para> <para> The new directory is initialized and initially does not contain -files except for the "." and ".." pointers to its parent directory +files except for the <filename class="directory">.</filename> and <filename class="directory">..</filename> pointers to its parent directory and itself, respectively (see 3.7.3). All access permissions are enabled (except sharable). </para>
--- a/docs/nitros9guide/mdir.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/mdir.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -50,7 +50,7 @@ </screen> <para> -WARNING: Many of the modules listed by MDIR are OS-9 system modules +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 before running a module if you are not familiar with it! </para>
--- a/docs/nitros9guide/merge.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/merge.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -21,7 +21,7 @@ This command copies multiple input files specified by the pathlists given as parameters to the standard output path. it is commonly used to combine several files into a single output file. Data is -copied in the order the pathlists are given. MERGE does no output +copied in the order the pathlists are given. <command>Merge</command> does no output line editing (such as automatic line feed). The standard output is generally redirected to a file or device. </para>
--- a/docs/nitros9guide/os9gen.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/os9gen.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -15,38 +15,38 @@ <refsect1><title>Description</title> <para> -OS9Gen is used to create and link the "OS9Boot" file required on any -disk from which OS-9 is to be bootstrapped. OS9Gen is used to add +<command>OS9Gen</command> is used to create and link the <filename>OS9Boot</filename> file required on any +disk from which OS-9 is to be bootstrapped. <command>OS9Gen</command> is used to add modules to an existing boot or to create an entirely new boot file. -If an exact copy of the existing OS9Boot file is desired, the -COBBLER command should be used instead. +If an exact copy of the existing <filename>OS9Boot</filename> file is desired, the +<command>cobbler</command> command should be used instead. </para> <para> -The name of the device on which the "OS9Boot" file is to be -installed is passed to OS9Gen as a command line parameter. OS9Gen then -creates a working file called "TempBoot" on the device specified. +The name of the device on which the <filename>OS9Boot</filename> file is to be +installed is passed to <command>OS9Gen</command> as a command line parameter. <command>OS9Gen</command> then +creates a working file called <filename>TempBoot</filename> on the device specified. Next it reads file names (pathlists) from its standard input, one pathlist per line. Every file named is opened and copied to -"TempBoot". This is repeated until end-of-file or a blank line is -reached on OS9Gen's standard input. All boot files must contain the +<filename>TempBoot</filename>. This is repeated until end-of-file or a blank line is +reached on <command>OS9Gen</command>'s standard input. All boot files must contain the OS-9 component modules listed in section 6.1. </para> <para> -After all input files have been copied to "TempBoot", the old -"OS9Boot" file, if present, is deleted. "TempBoot" is then renamed -to "OS9Boot", and its starting address and size is linked in the +After all input files have been copied to <filename>TempBoot</filename>, the old +<filename>OS9Boot</filename> file, if present, is deleted. <filename>TempBoot</filename> is then renamed +to <filename>OS9Boot</filename>, and its starting address and size is linked in the disk's Identification Sector (LSN 0) for use by the OS-9 bootstrap firmware. </para> <para> -WARNING: Any "OS9Boot" file must be stored in physically contiguous -sectors. Therefore, OS9Gen is normally used on a freshly formatted -disk. If the "OS9Boot" file is fragmented, OS9Gen will print a +WARNING: Any <filename>OS9Boot</filename> file must be stored in physically contiguous +sectors. Therefore, <command>OS9Gen</command> is normally used on a freshly formatted +disk. If the <filename>OS9Boot</filename> file is fragmented, <command>OS9Gen</command> will print a warning message indicated the disk cannot be used to bootstrap OS-9. </para> <para> -The list of file names given to OS9Gen can be entered from a keyboard, or -OS9Gen's standard input may be redirected to a text file +The list of file names given to <command>OS9Gen</command> can be entered from a keyboard, or +<command>OS9Gen</command>'s standard input may be redirected to a text file containing a list of file names (pathlists) . If names are entered manually, no prompts are given, and the end-of-file key (usually ESCAPE) or a blank line is entered after the line containing the @@ -59,7 +59,7 @@ <refsect1><title>Examples</title> <para> To manually install a boot file on device "d1" which is an exact -copy of the "OS9Boot" file on device "d0": +copy of the <filename>OS9Boot</filename> file on device "d0": </para> <screen> OS9: os9gen /d1 (run OS9Gen) @@ -68,8 +68,8 @@ </screen> <para> To manually install a boot file on device "d1" which is a copy of -the "OS9Boot" file on device "do" with the addition of -modules stored in the files "/d0/tape.driver" and "/d2/video.driver": +the <filename>OS9Boot</filename> file on device "d0" with the addition of +modules stored in the files <filename>/d0/tape.driver</filename> and <filename>/d2/video.driver</filename>: </para> <screen> OS9: os9gen /d1 (run OS9Gen) @@ -79,14 +79,14 @@ [ESCAPE] (enter end-of-file) </screen> <para> -As above, but automatically by redirecting OS9Gen standard input: +As above, but automatically by redirecting <command>OS9Gen</command> standard input: </para> <screen> -OS9: build /d0/bootlist (use "build" to create file "bootlist") +OS9: build /d0/bootlist (use <command>build</command> to create file <filename>bootlist</filename>) ? /d0/os9boot (enter first file name) ? /d0/tape.driver (enter second file name) ? /d2/video.driver (enter third file name) -? [RETURN] (terminate "build") +? [RETURN] (terminate <command>build</command>) OS9: os9gen /d1 </d0/bootlist (run OS9gen with redirected input) </screen> </refsect1>
--- a/docs/nitros9guide/printerr.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/printerr.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -15,7 +15,7 @@ This command replaces the basic OS-9 error printing routine (F$PERR service request) which only prints error code numbers, with a routine the reads and displays textual error messages from the file -"/d0/SYS/errmsg". Printerr's effect is system-wide. +<filename>/d0/SYS/errmsg</filename>. Printerr's effect is system-wide. </para> <para> A standard error message file is supplied with OS-9. This file can @@ -29,9 +29,10 @@ permits multi-line error messages. </para> <para> -WARNING: Once the printerr command has been used, it can not be undone. Once -installed, the PRINTERR module should not be unlinked. -PRINTERR uses the current user's stack for an I/O buffer, so users +WARNING: Once the <command>printerr</command> command has been used, +it can not be undone. Once +installed, the <command>printerr</command> module should not be unlinked. +<command>Printerr</command> uses the current user's stack for an I/O buffer, so users are encouraged to reserve reasonably large stacks. </para> <para>
--- a/docs/nitros9guide/proc.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/proc.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -19,7 +19,7 @@ can switch states rapidly, usually many times per second. </para> <para> -PROC shows the user and process ID numbers, priority, state +<command>Proc</command> shows the user and process ID numbers, priority, state (process status), memory size (in 256 byte pages), primary program module, and standard input path. </para>
--- a/docs/nitros9guide/pwd.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/pwd.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -15,10 +15,10 @@ <refsect1><title>Description</title> <para> -PWD displays a pathlist that shows the path from the root +<command>Pwd</command> displays a pathlist that shows the path from the root directory to the user's current data directory. It can be used by programs to discover the actual physical location of files, or by -humans who get lost in the file system. PXD is identical except +humans who get lost in the file system. <command>Pxd</command> is identical except that is shows the pathlist of the user's current execution directory. </para> </refsect1>
--- a/docs/nitros9guide/rename.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/rename.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -20,8 +20,8 @@ <para> Gives the mass storage file specified in the pathlist a new name. The user must have write permission for the file to change its name. -It is not possible to change the names of devices, ".", or -".." +It is not possible to change the names of devices, <filename class="directory">.</filename>, or +<filename class="directory">..</filename> </para> </refsect1> <refsect1><title>Examples</title>
--- a/docs/nitros9guide/save.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/save.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -27,7 +27,7 @@ permissions for all modes except public write. </para> <para> -Note: SAVE's default directory is the current data directory. +Note: <command>save</command>'s default directory is the current data directory. Executable modules should generally be saved in the default execution directory. </para>
--- a/docs/nitros9guide/setime.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/setime.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -15,7 +15,7 @@ <para> This command sets the system date and time, then activates the real time clock. The date and time can be entered as parameters, or if no -parameters are given, SETIME will issue a prompt. Numbers are one +parameters are given, <command>setime</command> will issue a prompt. Numbers are one or two decimal digits using space, colon, semicolon or slash delimiters. OS-9 system time uses the 24 hour clock, i.e., 1520 is 3:20 PM. @@ -27,7 +27,7 @@ file system. </para> <para> -SYSTEMS WITH BATTERY BACKED UP CLOCKS: Setime should still be run to +SYSTEMS WITH BATTERY BACKED UP CLOCKS: <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>
--- a/docs/nitros9guide/setpr.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/setpr.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -20,15 +20,15 @@ <para> This command changes the CPU priority of a process. It may only be used with a process having the user's ID. The process number is a -decimal number in the range of 1 (lowest) to 255. The "procs" +decimal number in the range of 1 (lowest) to 255. The <command>procs</command> command can be used to obtain process ID numbers and present priority. </para> <para> -NOTE: This command does not appear in the CMDS directory as it is -built-in to the SHELL. +NOTE: This command does not appear in the <filename class="directory">CMDS</filename> directory as it is +built-in to the <command>shell</command>. </para> <para> -For more information see: 5.1, PROCS +For more information see: 5.1, <command>procs</command> </para> </refsect1> <refsect1><title>Examples</title>
--- a/docs/nitros9guide/shell.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/shell.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -13,7 +13,7 @@ <refsect1><title>Description</title> <para> -The Shell is OS-9's command interpreter program. It reads data from +The <command>shell</command> is OS-9's command interpreter program. It reads data from its standard input path (the keyboard or a file), and interprets the data as a sequence of commands. - The basic function of the shell is to initiate and control execution of other OS-9 programs. @@ -31,7 +31,7 @@ </para> <para> The rest of this description is a technical specification of the -shell syntax. Use of the Shell is described fully in Chapters 2 +shell syntax. Use of the <command>shell</command> is described fully in Chapters 2 and 4 of this manual. </para> </refsect1>
--- a/docs/nitros9guide/tee.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/tee.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -16,23 +16,14 @@ <refsect1><title>Description</title> <para> - -TEE - -Copy standard input to multiple output paths - -Syntax: Tee {<replaceable>path</replaceable>} - - - This command is a filter (see 4.3.3) that copies all text lines from its standard input path to the standard output path <emphasis>and</emphasis> any number of additional output paths whose pathlists are given as parameters. </para> <para> -The example below uses a pipeline and TEE to simultaneously send the -output listing of the "dir" command to the terminal, printer, and a +The example below uses a pipeline and <command>tee</command> to simultaneously send the +output listing of the <command>dir</command> command to the terminal, printer, and a disk file: </para> <screen>
--- a/docs/nitros9guide/tmode.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/tmode.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -190,10 +190,10 @@ tmode pag=24 pause bsl -echo bsp=8 bsl=C </screen> <para> -NOTE: If you use TMODE in a procedure file, it will be necessary to +NOTE: If you use <command>tmode</command> in a procedure file, it will be necessary to specify one of the standard output paths (.1 or .2) since the shell's standard input path will have been redirected to the disk -file (TMODE can be used on an SCFMAN-type devices only). +file (<command>Tmode</command> can be used on an SCFMAN-type devices only). Example: </para>
--- a/docs/nitros9guide/tsmon.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/tsmon.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -16,23 +16,23 @@ This command is used to supervise idle terminals and initiate the login sequence in timesharing applications. If a pathlist is given, standard I/O paths are opened for the device. When a carriage return -is typed, TSMON will automatically call the "LOGIN" command. If the +is typed, <command>tsmon</command> will automatically call the <command>login</command> command. If the login fails because the user could not supply a valid user name or -password, it will return to TSMON. +password, it will return to <command>tsmon</command>. </para> <para> -Note: The LOGIN command and its password file must be present for -TSMON to work correctly (see the LOGIN command description). +Note: The <command>login</command> command and its password file must be present for +<command>tsmon</command> to work correctly (see the <command>login</command> command description). </para> <refsect2> <title>Logging Off the System</title> <para> Most programs will terminate when an end of file character (escape) is entered as the first character on a command line. This will log -you off of the system and return control to TSMON. +you off of the system and return control to <command>tsmon</command>. </para> <para> -For more information see: 2.5, LOGIN +For more information see: 2.5, <command>login</command> </para> </refsect2> </refsect1>
--- a/docs/nitros9guide/verify.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/verify.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -26,11 +26,11 @@ to the standard output path with the module's header parity and CRC values replaced with the computed values. A message will be displayed to indicate whether or not the module's values matched -those computed by VERIFY. +those computed by <command>verify</command>. </para> <para> If the option is NOT specified, the module will not be copied to -standard output. VERIFY will only display a message to indicate +standard output. <command>Verify</command> will only display a message to indicate whether or not the module's header parity and CRC matched those which were computed. </para>
--- a/docs/nitros9guide/xmode.refentry Thu Mar 20 13:41:42 2003 +0000 +++ b/docs/nitros9guide/xmode.refentry Thu Mar 20 20:19:53 2003 +0000 @@ -20,16 +20,17 @@ control key definitions, etc. </para> <para> -XMODE is very similar to the TMODE command. TMODE only operates on -open paths so its effect is temporary. XMODE actually updates the +<command>Xmode</command> is very similar to the <command>tmode</command> command. +<command>Tmode</command> only operates on +open paths so its effect is temporary. <command>Xmode</command> actually updates the device descriptor so the change persists as long as the computer is running, even if paths to the device are repetitively opened and -closed. If XMODE is used to change parameter(s) and the COBBLER +closed. If <command>xmode</command> is used to change parameter(s) and the COBBLER program is used to make a new system disk, the changed parameter will be permanently reflected on the new system disk. </para> <para> -XMODE requires a device name to be given. If no arguments are +<command>Xmode</command> requires a device name to be given. If no arguments are given, the present values for each parameter are displayed, otherwise, the parameter(s) given in the argument list are processed. Any number of parameters can be given, and are separated