changeset 134:52af9581ef1e

Split up the commands into individual files.
author roug
date Sun, 07 Jul 2002 08:58:56 +0000
parents 40f5c43c8c03
children af482a526063
files docs/nitros9guide/backup.refentry docs/nitros9guide/binex.refentry docs/nitros9guide/build.refentry docs/nitros9guide/chd.refentry docs/nitros9guide/cmp.refentry docs/nitros9guide/cobbler.refentry docs/nitros9guide/copy.refentry docs/nitros9guide/date.refentry
diffstat 8 files changed, 495 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/backup.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,98 @@
+<refentry id="backup">
+<refnamediv>
+<refname id="backupname">BACKUP</refname>
+<refpurpose>Make a backup copy of a disk</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>BACKUP</command>
+<arg choice="opt">
+  <option>e</option>
+</arg>
+<arg choice="opt">
+  <option>s</option>
+</arg>
+<arg choice="opt">
+  <option>-v</option>
+</arg>
+<arg choice="opt">&replstart;devname&replend;
+  <arg choice="opt">&replstart;devname&replend;</arg></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+This command is used to physically copy all data from one device to
+another. A physical copy is performed sector by sector without
+regard to file structures. In almost all cases the devices
+specified mun.t have the exact same format (size, density, etc.) and
+must not have defective sectors.
+</para>
+<para>
+If both device name are omitted the names &quot;/d0&quot; and &quot;/d1&quot; are
+assumed. If the second device name is omitted, a single unit backup
+will be performed on the drive specified.
+</para>
+<para>
+The options are:
+</para>
+<literallayout>
+  E = Exit if any read error occurs.
+  S = Print single drive prompt message.
+ -V = Do not verify.
+#nK = more memory makes backup run faster
+</literallayout>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+backup /D2 /D3
+
+backup -V
+
+
+
+OS9: backup
+
+Ready to BACKUP from /D0 to /D1 ?: Y
+MYDISK is being scratched
+OK ?: Y
+Number of sectors copied: $04D0
+Verify pass
+Number of sectors verified: $04D0
+OS9:
+</screen>
+<para>
+Below is an example of a single drive backup. BACKUP 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
+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
+fewer disk exchanges to be required.
+</para>
+<para>
+For more information see: 1.1.2
+</para>
+<screen>
+OS9:backup /D0 #10k
+
+Ready to BACKUP from /D0 to /D0 ?: Y
+Ready DESTINATION, hit a key:
+MYDISK is being scratched
+OK ?: Y
+Ready SOURCE, hit a key:
+Ready DESTINATION, hit a key:
+Ready SOURCE, hit a key:
+Ready DESTINATION, hit a key:
+
+(several repetitions)
+
+Ready DESTINATION, hit a key:
+Number of sectors copied: $4D0
+Verify pass
+Number of sectors verified: $4D0
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/binex.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,73 @@
+<refentry id="binex">
+<refnamediv>
+<refname id="binexname">BINEX / EXBIN</refname>
+<refpurpose>Convert Binary To S-Record File / Convert S-Record To Binary File</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+    <command>BINEX</command>
+    <arg choice="plain">&replstart;path1&replend;</arg>
+    <arg choice="plain">&replstart;path2&replend;</arg>
+</cmdsynopsis>
+<cmdsynopsis>
+    <command>EXBIN</command>
+    <arg choice="plain">&replstart;path2&replend;</arg>
+    <arg choice="plain">&replstart;path1&replend;</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+S-Record files are a type of text file that contains records that
+represent binary data in hexadecimal character form. This
+Motorola-standard format is often directly accepted by commercial PROM
+programmers, emulators, logic analyzers and similar devices that are
+interfaced RS-232 interfaces. It can also be useful for
+transmitting files over data links that can only handle character-type
+data; or to convert OS-9 assembler or compiler-generated
+programs to load on non-OS-9 systems.
+</para>
+<para>
+BINEX converts &quot;path1&quot;, an OS-9 binary format file, to a new file
+named &quot;path2&quot; 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 &quot;Y&quot; 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
+name and starting load address. For example:
+</para>
+<screen>
+binex /d0/cmds/scanner scanner.S1
+Enter starting address for file: <emphasis>$100</emphasis>
+Enter name for header record: <emphasis>scanner</emphasis>
+</screen>
+<para>
+To download the program to a device such as a PROM programmer
+(for example using serial port T1) type:
+</para>
+<screen>
+list scanner.S1 &gt;/T1
+</screen>
+<para>
+EXBIN is the inverse operation; &quot;path1&quot; is assumed to be a
+S-Record format text file which EXBIN converts to pure binary form on
+a new file called &quot;path2&quot;. 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
+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.
+Example:
+</para>
+<screen>
+exbin program.S1 cmds/program
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/build.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,55 @@
+<refentry id="build">
+<refnamediv>
+<refname id="buildname">BUILD</refname>
+<refpurpose>Build a text file from standard input</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>BUILD</command>
+<arg choice="plain">&replstart;path&replend;</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+This command is used to build short text files by copying the
+standard input path into the file specified by
+&replstart;path&replend;. BUILD creates a file according to the pathlist parameter,
+then displays a &quot;?&quot;
+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.
+</para>
+
+</refsect1>
+<refsect1><title>Example:</title>
+
+<screen>
+build small_file
+build /p                  (copies keyboard to printer)
+</screen>
+<para>
+The standard input path may also be redirected to a file. Below is
+an example:
+</para>
+<screen>
+build &lt;mytext /T2      (copies file &quot;mytext&quot; to terminal T2)
+
+
+OS9: build newfile
+
+? The powers of the OS-9
+? operating system are truly
+? fantastic.
+? [RETURN]
+
+OS9: list newfile
+
+The powers of the OS-9
+operating system are truly
+fantastic.
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/chd.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,53 @@
+<refentry id="chd">
+<refnamediv>
+<refname>CHD/CHX</refname>
+<refpurpose>Change working data directory / Change working execution directory</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>chd</command>
+<arg choice="plain">
+  &replstart;pathlist&replend;
+</arg>
+</cmdsynopsis>
+<cmdsynopsis>
+<command>chx</command>
+<arg choice="plain">
+  &replstart;pathlist&replend;
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+These are shell &quot;built in&quot; commands used to change OS-9's working
+data directory or working execution directory. Many commands in OS-9
+work with user data such as text files, programs, etc. These
+commands assume that a file is located in the working data
+directory. Other OS-9 commands will assume that a file is in the
+working execution directory.
+</para>
+<para>
+NOTE: These commands do not appear in the CMDS directory as they
+are built-in to the SHELL.
+</para>
+<para>
+For more information see: 3.7, 3.7.2
+
+
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+chd /d1/PROGRAMS
+
+chx ..
+
+chx binary_files/test_programs
+
+chx /D0/CMDS; chd /D1
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/cmp.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,60 @@
+<refentry id="cmp">
+<refnamediv>
+<refname>CMP</refname>
+<refpurpose>File Comparison Utility</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>cmp</command>
+<arg choice="plain">
+  &replstart;file1&replend;
+</arg>
+<arg choice="plain">
+  &replstart;file2&replend;
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+Opens two files and performs a comparison of the binary values of
+the corresponding data bytes of the files. If any differences are
+encountered, the file offset (address) and the values of the bytes
+from each file are displayed in hexadecimal.
+</para>
+<para>
+The comparison ends when end-of-file is encountered on either
+file. A summary of the number of bytes compared and the number of
+differences found is then displayed.
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+
+OS9: cmp red blue
+
+ Differences
+
+byte      #1 #2
+========  == ==
+00000013  00 01
+00000022  B0 B1
+0000002A  9B AB
+0000002B  3B 36
+0000002C  6D 65
+
+Bytes compared:   0000002D
+Bytes different:  00000005
+
+OS9: cmp red red
+
+ Differences
+   None ...
+
+Bytes compared:   0000002D
+Bytes different:  00000000
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/cobbler.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,46 @@
+<refentry id="cobbler">
+<refnamediv>
+<refname>COBBLER</refname>
+<refpurpose>Make a bootstrap file</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>COBBLER</command>
+<arg choice="plain">
+  &replstart;device name&replend;
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+COBBLER is used to create the &quot;OS9Boot&quot; 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
+&quot;OS9Gen&quot; command. COBBLER 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.
+</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
+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.
+</para>
+<para>
+For more information see: 1.1.2, 6.1
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+OS9: cobbler /D1
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/copy.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,67 @@
+<refentry id="copy">
+<refnamediv>
+<refname>COPY</refname>
+<refpurpose>Copy data from one path to another</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>COPY</command>
+<arg choice="plain">
+  &replstart;path&replend;
+</arg>
+<arg choice="plain">
+  &replstart;path&replend;
+</arg>
+<arg choice="opt">
+  <option>-s</option>
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+This command copies data from the first file or device specified to
+the second. The first file or device must already exist, the
+second file is automatically created if the second path is a file on
+a mass storage device. Data may be of any type and is NOT modified
+in any way as it is copied.
+</para>
+<para>
+Data is transferred using large block reads and writes until end-of-file
+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
+is to be sent to a terminal or printer.
+</para>
+<para>
+The &quot;-s&quot; option causes COPY to perform a single drive copy
+operation. The second pathlist must be a full pathlist if &quot;-s
+appears. COPY 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 &quot;C&quot; whereupon COPY writes on the destination disk,
+this process continues until the entire file is copied.
+</para>
+<para>
+Using the shell's alternate memory size modifier to give a large
+memory space will increase speed and reduce the number of media
+exchanges required for single drive copies.
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+copy file1 file2 #15k           (copies file1 to file2)
+
+copy /D1/joe/news /D0/peter/messages
+
+copy /TERM /P                   (copies console to printer)
+
+copy /d0/cat /d0/animals/cat -s #32k
+Ready DESTINATION, hit C to continue: c
+Ready SOURCE, hit C to continue: c
+Ready DESTINATION, hit C to continue:c
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/date.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,43 @@
+<refentry id="date">
+<refnamediv>
+<refname>DATE</refname>
+<refpurpose>Display system date and time</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DATE</command>
+<arg choice="opt">
+  <option>t</option>
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+This command will display the current system date, and if the &quot;t&quot;
+option is given, the current system time.
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+date t
+
+date t &gt;/p (Output is redirected to printer)
+
+OS9: setime
+
+       YY/MM/DD HH:MM:SS
+TIME ? 81/04/15 14:19:00
+
+OS9:date
+
+April 15, 1981
+
+OS9:date t
+
+April 15, 1981 14:20:20
+</screen>
+</refsect1>
+</refentry>
+