Section (1) describes, in alphabetic order, shell-level commands delivered with the TUXEDO System/T software.
Unless otherwise noted, commands described in the SYNOPSIS section of a manual page accept options and other arguments according to the following syntax and should be interpreted as explained below.
name [ -option ...] [ cmdarg ...] where:
is the name of an executable file or represents the name of an executable file.
is a string of one of the following two types: noargletter [...] or, argletter optarg [,...] (An option is always preceded by a ``-''.)
is a single letter representing an option that requires no option-argument. More than one noargletter option can be grouped after a ``-''
is a letter representing an option that requires an option-argument.
is a character string that satisfies a preceding argletter. Multiple optargs following a single argletter must be separated by commas, or separated by white space and enclosed in quotes.
is a pathname (or other command argument) that represents an operand of the command.
(dash) by itself means that additional arguments are provided in the standard input.
(two dashes) means that what follows are arguments for a subordinate program.
surrounding an option or cmdarg, mean that the option or argument is not required.
surrounding cmdargs that are separated by an or sign (|), mean that one of the choices must be selected if the associated option is used.
means multiple occurrences of the option or cmdarg are permitted.
As a minimum, many commands in Section 1 require TUXDIR to be set and exported. You should also have $TUXDIR/bin in your $PATH. Some of the pages in this section list other variables that are expected by the command.
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.
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.
getopts(1), exit(2), wait(2), getopt(3C) in a UNIX System Reference Manual.