changeset 136:94476830df51

Split up the commands into individual files.
author roug
date Sun, 07 Jul 2002 08:58:56 +0000
parents af482a526063
children a6eb496dbc1e
files docs/nitros9guide/del.refentry docs/nitros9guide/deldir.refentry docs/nitros9guide/dir.refentry docs/nitros9guide/display.refentry
diffstat 4 files changed, 222 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/del.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,62 @@
+<refentry id="del">
+<refnamediv>
+<refname>DEL</refname>
+<refpurpose>Delete a file</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DEL</command>
+<arg choice="opt">
+  <option>-x</option>
+</arg>
+<arg choice="plain">
+  &replstart;path&replend;
+</arg>
+<arg choice="plain">
+  &repeatst;&replstart;path&replend;&repeaten;
+</arg>
+<arg choice="opt">
+  <option>-x</option>
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<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).
+Directory files cannot be deleted unless their type is changed to
+non-directory: see the &quot;ATTR&quot; command description.
+</para>
+<para>
+If the -x option appears, the current
+<emphasis>execution</emphasis> directory is assumed.
+</para>
+<para>
+For more information see: 3.5, 3.8.1
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+del test_program old_test_program
+
+del /D1/number_five
+
+OS9:dir /D1
+
+   Directory of /D1 14:29:46
+myfile          newfile
+
+OS9:del /D1/newfile
+OS9:dir /D1
+
+   Directory of /D1 14:30:37
+myfile
+
+OS9:del myprog -x
+OS9:del -x CMDS.SUBDIR/file
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/deldir.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,61 @@
+<refentry id="deldir">
+<refnamediv>
+<refname>DELDIR</refname>
+<refpurpose>Delete All Files In a Directory System</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DELDIR</command>
+<arg choice="plain">
+  &replstart;directory name&replend;
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+This command is a convenient alternative to manually deleting
+directories and files they contain. It is only used when
+<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:
+</para>
+<screen>
+OS9: deldir OLDFILES
+Deleting directory file.
+List directory, delete directory, or quit ? (l/d/q)
+</screen>
+<para>
+An &quot;l&quot; response will cause a &quot;dir e&quot; command to be run so you can
+have an opportunity to see the files in the directory before they
+are deleted.
+</para>
+<para>
+A &quot;d&quot; response will initiate the process of deleting files.
+</para>
+<para>
+A &quot;q&quot; response will abort the command before action is taken.
+</para>
+<para>
+The directory to be deleted may include directory files, which
+may themselves include directory files, etc. In this case, DELDIR
+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
+encountering the first file for which you do not have write
+permission.
+</para>
+<para>
+The DELDIR command automatically calls the DIR and ATTR
+commands, so they both must reside in the current execution
+directory.
+</para>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/dir.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,59 @@
+<refentry id="dir">
+<refnamediv>
+<refname>DIR</refname>
+<refpurpose>Display the names of files contained in a directory</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DIR</command>
+<arg choice="opt">
+  <option>e</option>
+</arg>
+<arg choice="opt">
+  <option>x</option>
+</arg>
+<arg choice="opt">
+  &replstart;path&replend;
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+Displays a formatted list of files names in a directory file on. the
+standard output path. If no parameters are given, the current
+<emphasis>data</emphasis>
+directory is shown. If the &quot;x&quot; option is given, the current
+<emphasis>execution</emphasis>
+directory is shown. If a pathlist of a directory file is
+given, it is shown.
+
+</para>
+<para>
+If the &quot;e&quot; option is included, each file's entire description is
+displayed: size, address, owner, permissions, date and time of last
+modification.
+
+</para>
+<para>
+For more information see: 1.0.3, 3.4, and 3.8.1
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+dir                  (display data directory)
+
+dir x                (display execution directory)
+
+dir x e              (display entire description of execution dir)
+
+dir ..               (display parent of working data directory)
+
+dir newstuff         (display newstuff directory)
+
+dir e test_programs  (display entire description of &quot;test.programs)
+</screen>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/display.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,40 @@
+<refentry id="display">
+<refnamediv>
+<refname>DISPLAY</refname>
+<refpurpose>Display Converted Characters</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DISPLAY</command>
+<arg choice="plain">
+  &replstart;hex&replend;
+</arg>
+<arg choice="plain">
+  &repeatst;&replstart;hex&replend;&repeaten;
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+Display reads one or more hexadecimal numbers given as parameters,
+converts them to ASCII characters, and writes them to the standard
+output. It is commonly used to send special characters (such as
+cursor and screen control codes) to terminals and other I/O devices.
+
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+display 0C 1F 02 7F
+
+
+display 15 &gt;/p      (sends &quot;form feed&quot; to printer)
+
+OS9: display 41 42 43 44 45 46
+ABCDEF
+</screen>
+</refsect1>
+</refentry>
+