intro_sarm1(1M)                                             intro_sarm1(1M)

NAME
     introsarm1 - introduction to commands and application programs

DESCRIPTION
     This section describes commands that are mainly used for system
     maintenance and administration purposes, listing them in alphabetical
     order.

     Since the commands for the architecture of the virtual file system
     have been restructured, there are several instances of multiple manual
     pages with the same name. For example, there are two manual pages
     dealing with the command mount(1M). In these cases, the first of the
     multiple pages describes the syntax and options of the generic com-
     mand, i.e. those options applicable to all FSTs (file system types).
     The functionality of the FST-specific modules for the command is
     described below, and the name of the FST in question is also
     displayed. Note that the administrator should not attempt to call
     these modules directly. The generic command provides a common inter-
     face to all of them. Thus the FST-specific manual pages should not be
     viewed as describing distinct commands, but rather as detailing those
     aspects of a command that are specific to a particular type of file
     system.

SYNOPSIS
     Options and arguments of the commands are specified according to the
     following syntax:

          name [-option(s)] [cmdarg(s)] [nvarg(s)]

     The different syntax elements have the following meaning:

     [ ]       Selectable option or argument

     name      Name of an executable file (command)

     option    (always with a preceding "-"): noargletter(s) or: argletter
               optarg

               noargletter    One or more single letters each representing
                              an option without an argument (e.g. -i or
                              -dna).

               argletter      A single letter representing an option
                              requiring an argument (optarg), e.g. t in
                              -t file.

               optarg         An argument (character string) satisfying
                              preceding argletter (e.g. file in -t file).

     cmdarg    Variable argument(s) (character string) for a command, e.g.
               a pathname, directory, target device etc.; "-" indicates the
               standard input. Examples:



Page 1                       Reliant UNIX 5.44                Printed 11/98

intro_sarm1(1M)                                             intro_sarm1(1M)

               devfree key [device [...]]
               or: colltbl [file | -]

     nvarg     One or more arguments that cannot be modified, e.g.
               on | off, demand

     ...       Repetition: One or more options or arguments can be speci-
               fied several times. Example: [attribute ...]

     |         Alternative: Only one option or one argument of several com-
               mands can be specified. Example: -v |-p |-a

     { }       Grouping: At least one option or argument from this group
               must be specified. Example: {special | mountpoint}

DIAGNOSTICS
     When terminated, each command returns 0 for normal termination and a
     value other than zero to indicate problems such as erroneous parame-
     ters, bad or inaccessible data, or any other difficulty coping with
     the task at hand. This value is called "exit code" or "return code",
     and is described only where special conventions are involved.

NOTE
     Unfortunately, not all commands adhere to the standard syntax.

SEE ALSO
     getopts(1), exit(2), wait(2), getopt(3C).



























Page 2                       Reliant UNIX 5.44                Printed 11/98