Mercurial > hg > Members > kono > nitros9-code

annotate docs/nitros9guide/shell.refentry @ 1041:91bae4f761e4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated to reflect - in front of option
author boisy
date Wed, 12 Mar 2003 16:43:32 +0000
parents c565a4700689
children b5ff125a1d60
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>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
10 <arg choice="plain"><replaceable>arglist</replaceable></arg>
138
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>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
40 <replaceable>pgm line</replaceable> := <replaceable>pgm</replaceable> {<replaceable>pgm</replaceable>}
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
41 <replaceable>pgm</replaceable> := [<replaceable>params</replaceable>] [ <replaceable>name</replaceable> [<replaceable>modif</replaceable>] [<replaceable>pgm params</replaceable>] [<replaceable>modif</replaceable>] ] [<replaceable>sep</replaceable>]
138
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
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
45 <replaceable>name</replaceable> := <replaceable>module name</replaceable>
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
46 := <replaceable>pathlist</replaceable>
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
47 := ( <replaceable>pgm list</replaceable> )
138
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
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
51 <replaceable>params</replaceable>:= <replaceable>param</replaceable> { <replaceable>delim</replaceable> <replaceable>param</replaceable> }
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
52 <replaceable>delim</replaceable> := space or comma characters
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
53 <replaceable>param</replaceable> := ex <replaceable>name</replaceable> [<replaceable>modif</replaceable>] chain to program specified
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
54 := chd <replaceable>pathlist</replaceable> change working directory
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
55 := kill <replaceable>procID</replaceable> send abort signal to process
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
56 := setpr<replaceable>procID</replaceable> <replaceable>pty</replaceable> change process priority
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
57 := chx <replaceable>pathlist</replaceable> change execution directory
138
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
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
65 := * <replaceable>text</replaceable> comment line: not processed
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
66 <replaceable>sep</replaceable> := ; sequential execution separator
138
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
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
69 := <replaceable>cr</replaceable> end-of-line (sequential execution separator)
138
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
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
74 <replaceable>modif</replaceable> := <replaceable>mod</replaceable> { <replaceable>delim</replaceable> <replaceable>mod</replaceable> }
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
75 <replaceable>mod</replaceable> := &lt; <replaceable>pathlist</replaceable> redirect standard input
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
76 := &gt; <replaceable>pathlist</replaceable> redirect standard output
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
77 := &gt;&gt; <replaceable>pathlist</replaceable> redirect standard error output
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
78 := # <replaceable>integer</replaceable> set process memory size in pages
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
79 := # <replaceable>integer</replaceable> K set program memory size in 1K increments
138
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