'\"macro stdmacro
.if n .pH g1.intro @(#)intro	40.9 of 12/21/89
.\" Copyright 1989 AT&T
.nr X
.if \nX=0 .ds x} intro 1 "" "\&"
.if \nX=1 .ds x} intro 1 ""
.if \nX=2 .ds x} intro 1 "" "\&"
.if \nX=3 .ds x} intro "" "" "\&"
.TH \*(x}
.SH NAME
\f4intro\f1 \- introduction to commands and application programs
.SH DESCRIPTION
This section describes, in alphabetical order, commands available for
the AT&T 3B2 Computer.
Certain distinctions of purpose are made in the headings.
.P
The following Utility packages are delivered with the computer:
.P
.ta 0.25i 0.5i
.nf
	BSD Compatibility Package
	Basic Networking Utilities
	C Programming Language Utilities
	Directory and File Management Utilities
	Distributed File Systems Utilities
	Editing Utilities
	Encryption Utilities (CRYPT)
	Essential Boot Utilities
	Essential Utilities
	Ethernet Media Driver Utilities
	Extended Software Generation System Utilities
	Framed Access Command Environment (FACE) Utilities
	Inter-Process Communication (IPC) Utilities
	Internet Utilities
	Line Printer Spooling Utilities
	Network File System Utilities
	Networking Support Utilities
	OPEN LOOK\(tm/Graphics Utilities
	Remote File System Utilities
	Remote Procedure Call Utilities
	Spell Utilities
	System Administration Utilities
	System Header Files
	System Performance Analysis Utilities (SPAU)
	Terminal Information Utilities
	UFS Utilities
	User Environment Utilities
	Windowing Utilities
	XENIX Compatibility Package
.fi
.SS Manual Page Command Syntax
Unless otherwise noted, commands described in the
\f4\s-1SYNOPSIS\s0\f1
section of a manual page accept options and
other arguments according to the following syntax
and should be interpreted as explained below.
.PP
.I name
.RI [ \f4\-\fPoption ...]
.RI [ cmdarg ...]
.br
where:
.TP 13
[\ ]
Surround an
.I option\^
or
.I cmdarg\^
that is not required.
.TP
.I "..."
Indicates multiple occurrences of the
.I option\^
or
.IR cmdarg\^ .
.TP
.I name
The name of an executable file.
.TP
.I option\^
(Always preceded by a
\f1``\f4\-\f1''.)
.br
.IR noargletter\^ ...
or,
.br
.I argletter\^
.IR optarg [\f4,\fP...]
.TP
.I noargletter\^
A single letter representing an option without an option-argument.
Note that more than one
.I noargletter\^
option can be grouped after one
\f1``\f4\-\f1''
(Rule 5, below).
.TP
.I argletter\^
A single letter representing an option requiring an option-argument.
.TP
.I optarg\^
An option-argument (character string) satisfying a preceding
.IR argletter .
Note that groups of
.I optargs\^
following an
.I argletter\^
must be separated by commas,
or separated by white space and quoted (Rule 8, below).
.TP
.I cmdarg\^
Path name (or other command argument)
.I not\^
beginning with
\f1``\f4\-\f1'',
or
\f1``\f4\-\f1''
by itself indicating the standard input.
.SS "Command Syntax Standard:  Rules"
These command syntax rules are not followed by all current commands,
but all new commands will obey them.
\f4getopts\fP(1)
should be used by all shell procedures to parse positional parameters 
and to check for legal options.
It supports Rules 3-10 below.
The enforcement of the other rules must be done by the command itself.
.PP
.RS
.TP 5
1.
Command names (\f2name\f1 above) must be between two and nine characters long.
.TP
2.
Command names must include only lower-case letters and digits.
.TP
3.
Option names (\f2option\f1 above) must be one character long.
.TP
4.
All options must be preceded by
\f1``\f4\-\f1''.
.TP
5.
Options with no arguments may be grouped after a single
\f1``\f4\-\f1''.
.TP
6.
The first
option-argument
.RI ( optarg\^
above)
following an option must be preceded by white space.
.TP
7.
Option-arguments cannot be optional.
.TP
8.
Groups of option-arguments following an option must either be separated by
commas or separated by white space and quoted
(e.g., \f4\-o xxx,z,yy\fP or \f4 \-o "xxx z yy"\fP).
.TP
9.
All options must precede operands
.RI ( cmdarg\^
above)
on the command line.
.TP
10.
\f1``\f4\-\-\f1''
may be used to indicate the end of the options.
.TP
11.
The order of the options relative to one another should not matter.
.TP
12.
The relative order of the operands (\f2cmdarg\f1 above)
may affect their significance
in ways determined by the command with which they appear.
.TP
13.
\f1``\f4\-\f1''
preceded and followed by white space should only be used to mean standard input.
.RE
.SH SEE ALSO
\f4getopts\fP(1).
.br
\f4exit\fP(2),
\f4wait\fP(2),
\f4getopt\fP(3C) in the \f2Programmer's Reference Manual\f1.
.PD 0
.PP
.IR "How to Get Started" ,
at the front of this document.
.PD
.br
.ne 5
.SH DIAGNOSTICS
Upon termination, each command returns two bytes of status,
one supplied by the system and giving the cause for
termination, and (in the case of ``normal'' termination)
one supplied by the program
[see
\f4wait\fP(2)
and
\f4exit\fP(2)].
The former byte is 0 for normal termination; the latter
is customarily 0 for successful execution and non-zero
to indicate troubles such as erroneous parameters, or bad or inaccessible data.
It is called variously ``exit code'', ``exit status'', or
``return code'', and is described only where special
conventions are involved.
.SH WARNINGS
Some commands produce unexpected results
when processing files containing null characters.
These commands often treat text input lines as strings and therefore
become confused upon encountering a null character (the string terminator) 
within a line.
.\"	@(#)intro.1	6.2 of 9/2/83
.Ee
