changeset 140:35dd8ae53dee

Split up the commands into individual files.
author roug
date Sun, 07 Jul 2002 08:58:56 +0000
parents 0b25831b73ee
children 21649cf64510
files docs/nitros9guide/tsmon.refentry docs/nitros9guide/unlink.refentry docs/nitros9guide/verify.refentry
diffstat 3 files changed, 172 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/tsmon.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,47 @@
+<refentry id="tsmon">
+<refnamediv>
+<refname>TSMON</refname>
+<refpurpose>Timesharing monitor</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>TSMON</command>
+<arg choice="opt">&replstart;pathlist&replend;</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+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 &quot;LOGIN&quot; command. If the
+login fails because the user could not supply a valid user name or
+password, it will return to TSMON.
+</para>
+<para>
+Note: The LOGIN command and its password file must be present for
+TSMON to work correctly (see the LOGIN 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.
+</para>
+<para>
+For more information see: 2.5, LOGIN
+</para>
+</refsect2>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+
+OS9:tsmon /t1&amp;
+&amp;005
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/unlink.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,66 @@
+<refentry id="unlink">
+<refnamediv>
+<refname>UNLINK</refname>
+<refpurpose>Unlink memory module</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>UNLINK</command>
+<arg choice="plain">
+  &replstart;modname&replend;
+</arg>
+<arg choice="plain">
+&repeatst;  &replstart;modname&replend;&repeaten;
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+Tells OS-9 that the memory module(s) named are no longer needed by
+the user. The module(s) may or may not be destroyed and their
+memory reassigned, depending on if in use by other processes or
+user, whether resident in ROM or RAM, etc.
+</para>
+<para>
+It is good practice to unload modules whenever possible to make most
+efficient use of available memory resources.
+</para>
+<para>
+
+Warning: never unlink a module you did not load or link to.
+</para>
+<para>
+
+
+For more information see: 5.4, 5.4.1, 5.4.2
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+unlink pgml pgm5 pgm99
+
+
+OS9: mdir
+
+   Module Directory at 11:26:22
+DCB4        D0          D1          D2          D3
+OS9P2       INIT        OS9         IOMAN       RBF
+SCF         ACIA        TERM        T1          T2
+T3          P           PIA         Sysgo       Clock
+Shell       Tsmon       Edit
+
+OS9: unlink edit
+OS9: mdir
+
+   Module Directory at 11:26:22
+DCB4        D0          D1          D2          D3
+OS9P2       INIT        OS9         IOMAN       RBF
+SCF         ACIA        TERM        T1          T2
+T3          P           PIA         Sysgo       Clock
+Shell       Tsmon
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/verify.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,59 @@
+<refentry id="verify">
+<refnamediv>
+<refname>VERIFY</refname>
+<refpurpose>Verify or update module header and CRC</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>VERIFY</command>
+<arg choice="opt">
+  <option>u</option>
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>
+This command is used to verify that module header parity and CRC
+value of one or more modules on a file (standard input) are correct.
+Module(s) are read from standard input, and messages will be sent to
+the standard error path.
+</para>
+<para>
+If the U (update) option is specified, the module(s) will be copied
+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.
+</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
+whether or not the module's header parity and CRC matched those
+which were computed.
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+OS9: verify &lt;EDIT &gt;NEWEDIT
+
+Module's header parity is correct.
+Calculated CRC matches module's.
+
+OS9: verify &lt;myprograml &gt;myprogram2
+
+Module's header parity is correct.
+CRC does not match.
+
+OS9: verify &lt;myprogram2
+
+Module's header parity is correct.
+Calculated CRC matches module's.
+
+OS9: verify u &lt;module &gt;temp
+</screen>
+</refsect1>
+</refentry>
+