annotate docs/nitros9guide/shell.refentry @ 321:2c0ddf807efa

Made some changes
author boisy
date Tue, 23 Jul 2002 23:43:29 +0000
parents d9631713b7cd
children c565a4700689
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
1 <refentry id="shell">
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
2 <refnamediv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
3 <refname>SHELL</refname>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
4 <refpurpose>OS-9 Command Interpreter</refpurpose>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
5 </refnamediv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
6
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
7 <refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
8 <cmdsynopsis>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
9 <command>SHELL</command>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
10 <arg choice="plain">&replstart;arglist&replend;</arg>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
11 </cmdsynopsis>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
12 </refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
13
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
14 <refsect1><title>Description</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
15 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
16 The Shell is OS-9's command interpreter program. It reads data from
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
17 its standard input path (the keyboard or a file), and interprets the
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
18 data as a sequence of commands. - The basic function of the shell is
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
19 to initiate and control execution of other OS-9 programs.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
20 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
21 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
22 The shell reads and interprets one text line at a time from the
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
23 standard input path. After interpretation of each line it reads
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
24 another until an end-of-file condition occurs, at which time it
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
25 terminates itself. A special case is when the shell is called from
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
26 another program, in which case it will take the parameter area (rest
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
27 of the command line) as its first line of input. If this command
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
28 line consists of &quot;built in&quot; commands only, more lines will be read
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
29 and processed; otherwise control will return to the calling program
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
30 after the single command line is processed.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
31 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
32 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
33 The rest of this description is a technical specification of the
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
34 shell syntax. Use of the Shell is described fully in Chapters 2
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
35 and 4 of this manual.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
36 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
37 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
38 <refsect1><title>Shell Input Line Formal Syntax</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
39 <synopsis>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
40 &replstart;pgm line&replend; := &replstart;pgm&replend; {&replstart;pgm&replend;}
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
41 &replstart;pgm&replend; := [&replstart;params&replend;] [ &replstart;name&replend; [&replstart;modif&replend;] [&replstart;pgm params&replend;] [&replstart;modif&replend;] ] [&replstart;sep&replend;]
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
42
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
43 Program Specifications
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
44
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
45 &replstart;name&replend; := &replstart;module name&replend;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
46 := &replstart;pathlist&replend;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
47 := ( &replstart;pgm list&replend; )
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
48
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
49 Parameters
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
50
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
51 &replstart;params&replend;:= &replstart;param&replend; { &replstart;delim&replend; &replstart;param&replend; }
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
52 &replstart;delim&replend; := space or comma characters
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
53 &replstart;param&replend; := ex &replstart;name&replend; [&replstart;modif&replend;] chain to program specified
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
54 := chd &replstart;pathlist&replend; change working directory
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
55 := kill &replstart;procID&replend; send abort signal to process
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
56 := setpr&replstart;procID&replend; &replstart;pty&replend; change process priority
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
57 := chx &replstart;pathlist&replend; change execution directory
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
58 := w wait for any process to die
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
59 := p turn &quot;OS9:&quot; prompting on
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
60 := -p turn prompting off
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
61 := t echo input lines to std output
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
62 := -t don't echo input lines
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
63 := -x dont abort on error
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
64 := x abort on error
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
65 := * &replstart;text&replend; comment line: not processed
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
66 &replstart;sep&replend; := ; sequential execution separator
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
67 := &amp; concurrent execution separator
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
68 := ! pipeline separator
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
69 := &replstart;cr&replend; end-of-line (sequential execution separator)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
70
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
71
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
72 Modifiers
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
73
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
74 &replstart;modif&replend; := &replstart;mod&replend; { &replstart;delim&replend; &replstart;mod&replend; }
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
75 &replstart;mod&replend; := &lt; &replstart;pathlist&replend; redirect standard input
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
76 := &gt; &replstart;pathlist&replend; redirect standard output
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
77 := &gt;&gt; &replstart;pathlist&replend; redirect standard error output
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
78 := # &replstart;integer&replend; set process memory size in pages
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
79 := # &replstart;integer&replend; K set program memory size in 1K increments
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
80 </synopsis>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
81 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
82 </refentry>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
83