intro_urm(1) intro_urm(1)
NAME
introurm - general explanations of command descriptions
DESCRIPTION
This explanation contains general information about the individual
sections of a command description. For example, notes on syntax ele-
ments and command input may be found under the section headings of the
relevant command description.
The DESCRIPTION section of individual commands contains a description
of the command's usage and effect.
SYNOPSIS
Gives an overview of the syntax of the command. The following schema
contains the most important syntax elements:
command[<blank>-a|<blank>-b][<blank>-c<blank>optarg][<blank>--][<blank>arg]...
Note: Depending on the terminal type, when displayed on the screen
(called using the man command), the <blank> character appears
either as a visible "bathtub" character, or simply as a blank
space:
command[ -a| -b][ -c optarg][ --][ argument]...
In the printed version of the manual, <blank> is always repre-
sented in the form of a character (the "bathtub" character).
constant width script indicates parts which must be input exactly as
they appear in the description; italic script denotes variables; syn-
tax elements not entered by the user are represented by normal script.
command
Command name
-a, -b
Options without arguments
-c optarg
Option with accompanying argument.
-- Options separated from arguments.
argument
Variable argument(s) for a command, e.g. a pathname, a directory,
target device etc.; "-" indicates the standard input.
Displays all options and arguments which can be processed by the com-
mand.
The following rules apply for the input of options and arguments.
Older commands may not comply entirely with these rules. getopts(1)
Page 1 Reliant UNIX 5.44 Printed 11/98
intro_urm(1) intro_urm(1)
should be used in all shell procedures to parse positional parameters
and to check for legal options.
1. Option names must be one character long. (e.g. o, p, s).
2. All options must be preceded by "-".
3. Options with no arguments may be grouped after a single "-" (e.g.
-ps).
4. Options with arguments must have a blank between the option and
its arguments.
For compatibility reasons the blank may be omitted from some com-
mands. Portable shell scripts should contain a blank.
5. Option arguments must not be omitted.
6. Groups of option arguments following an option must either be sep-
arated by commas or separated by white spaces and quoted (e.g. -o
xxx,z,yy or -o "xxx z yy").
7. All command-line options must precede arguments (argument).
8. "--" may be used to indicate the end of the option. All subsequent
entries will be interpreted as arguments. The entry is necessary
if its first argument begins with "-".
Page 2 Reliant UNIX 5.44 Printed 11/98
intro_urm(1) intro_urm(1)
9. The order of options relative to one another does not matter.
Options which are mutually exclusive, and repeats of options with
arguments in which the arguments are evaluated in a specified
sequence, are exceptions.
10. The relative order of arguments (argument) is significant and is
determined by the command with which they appear.
11. "-" preceded and followed by white spaces should only be used to
indicate standard input or standard output.
EXIT STATUS
The exit status is a numeric value which a command returns to the
invoked process after its execution. It gives information about the
execution of the command. If the initiated process is a shell then the
exit status is stored in the shell variable $?.
The exit status is only described if it does not correspond to the
following standards:
0 The command was implemented correctly.
>0 An error occurred.
DIAGNOSTICS
Important error messages are listed and explained here. Notes on
avoiding errors and error recovery are also contained here. Unless
otherwise specified, error messages are written to the standard error
output.
Page 3 Reliant UNIX 5.44 Printed 11/98
intro_urm(1) intro_urm(1)
LOCALE
The effects of variables belonging to an internationalized environment
on the command are described here.
Language, national conventions, and character set may be set for the
entire system or set individually using environment variables. The
following variables are relevant:
______________________________________________________________________
| LANG, LCALL | Entire internationalized environment |
|_______________|_____________________________________________________|
| LCCTYPE | Character classes and conversion from from lower- |
| | case to uppercase letters |
|_______________|_____________________________________________________|
| LCCOLLATE | Sorting sequence |
|_______________|_____________________________________________________|
| LCTIME | Time and date specifications |
|_______________|_____________________________________________________|
| LCMONETARY | Currency symbols and format |
|_______________|_____________________________________________________|
| LCNUMERIC | Decimal point, exponentiation symbol, thousands |
| | separator |
|_______________|_____________________________________________________|
| LCMESSAGES | Message texts and answers to yes/no questions |
|_______________|_____________________________________________________|
To create a specific working environment you assign the name of the
desired locale to the variables:
variable=localename
or
variable=languageterritory.characterset
Page 4 Reliant UNIX 5.44 Printed 11/98
intro_urm(1) intro_urm(1)
Possible values:
______________________________________________________________________
| DeDE.646 | German locale (7-bit code) |
|_______________|_____________________________________________________|
| DeDE.88591 | German locale (8-bit code) |
|_______________|_____________________________________________________|
| EnGB.646 | English locale, British English (7-bit code) |
|_______________|_____________________________________________________|
| EnGB.88591 | English locale, British English (8-bit code) |
|_______________|_____________________________________________________|
| C, EnUS.ASCII| English locale, American English (7-bit code) |
|_______________|_____________________________________________________|
| EnUS.88591 | English locale, American English (8-bit code) |
|_______________|_____________________________________________________|
| FrFR.88591 | French locale (8-bit code) |
|_______________|_____________________________________________________|
| EsSP.88591 | Spanish locale (8-bit code) |
|_______________|_____________________________________________________|
| ... | etc. |
|_______________|_____________________________________________________|
Further information can be found in the "Programmer's Guide: Interna-
tionalization - Localization".
EXAMPLES
These examples illustrate the main functions and the most important
options of commands. Where necessary, useful complex combinations of
options and arguments are described.
ENVIRONMENT VARIABLES
Environment variables which interpret the command are listed here.
NOTES
Points out borderline cases or describes known errors in the software
that were not corrected. A solution is occasionally suggested.
FILES
Files which the command accesses or initializes are specified here.
SEE ALSO
This section contains reference to other commands which operate in a
similar manner or interoperate with the command.
Information about syntax, options and exit status can be found in the
following descriptions:
getopts(1), exit(2), wait(2), getopt(3C).
Page 5 Reliant UNIX 5.44 Printed 11/98
intro_urm(1) intro_urm(1)
Information about command input may be found in the corresponding com-
mand interpreters:
csh(1), ksh(1), sh(1).
Page 6 Reliant UNIX 5.44 Printed 11/98