intro(1) intro(1)
NAME
intro - introduction to programming commands
DESCRIPTION
This section describes the programming commands in alphabetical
order. The commands in this section should be used along with those
listed in Sections 1M, 7 and 8 of the System Administrator's Manual
and Sections 2, 3, 4 and 5 of the Programmer's Reference Manual.
References of the form name(1) refer to entries in this manual.
Some of the AT&T 3B2 SVR4 documentation set guides include duplicates
of relevant manpages. In this documentation set, all manpages may be
found in the appropriate Reference Manual and, with the exception of
the Programmer's Guide: XWIN Graphical Windowing System, the
Programmer's Guide: OPEN LOOK Graphical User Interface, and the OPEN
LOOK Graphical User Interface User's Guide, are never duplicated in
the guides.
COMMAND SYNTAX
Unless otherwise noted, the commands accept options and other
arguments according to the following syntax:
name [option(s)] [cmdarg(s)]
where:
name is the name of an executable file.
option is -noargletter(s) or -argletter <> optarg, where:
noargletter is a single letter representing an option
without an option argument;
argletter is a single letter representing an option
requiring an option argument;
<> is optional white space;
optarg is an option argument (character string)
satisfying the preceding argletter.
cmdarg is ``-'' by itself, which indicates the standard input,
or a path name (or other command argument) not beginning
with ``-''.
Throughout the manual pages there are references to TMPDIR, BINDIR,
INCDIR, and LIBDIR. These represent directory names whose value is
specified on each manual page as necessary. For example, TMPDIR
might refer to /var/tmp. These are not environment variables and
cannot be set. [There is an environment variable called TMPDIR which
can be set. See tmpnam(3S).] There are also references to LIBPATH,
the default search path of the link editor and other tools.
8/91 Page 1
intro(1) intro(1)
SEE ALSO
exit(2), wait(2), getopt(3C).
getopts(1) in the User's Reference Manual.
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
wait(2) and exit(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.
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.
Page 2 8/91