Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ Intro(CP) — OpenDesktop Software Development System 3.0.0

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

getopts(C)

exit(S)

getopt(S)

getopt(C)

wait(S)


 Intro(CP)                      6 January 1993                      Intro(CP)


 Name

    Intro - Introduces Development System commands

 Description

    This section describes use of the standalone commands available in the
    Development System.  Each command is labeled with the letters CP to dis-
    tinguish it from commands available in the Operating System and other
    commands within the Development System.  This convention points users to
    the documentation set that contains information on a particular command.
    For example, the reference cc(CP) indicates a reference to a discussion
    of the cc command in this section; the letter ``C'' stands for ``Com-
    mand'' and the letter ``P'' stands for ``Programming''.

    The ADM (administration) section contains miscellaneous information,
    including a great deal of system maintenance information. Other reference
    sections related to the Development System include the M (miscellaneous)
    section, the S (system services) section, and the FP (programming file
    formats) section.

 Syntax

    Unless otherwise noted, commands described in the ``Syntax'' section of a
    manual page accept options and other arguments according to the following
    syntax and should be interpreted as explained below.  This syntax and the
    rules which describe it are not followed by all commands, but they indi-
    cate what is generally true.

    name [-option... ] [cmdarg... ]

    [ ]          Surround a syntactic element that is not required.

    ...          Indicates multiple occurrences

    name         The command name

    option       letter [arg[,... ]]
                 An option is always preceded by a ``-''.

    letter       Any single letter

    arg          A character string that follows a letter in an option.

    cmdarg       A path name, filename, any other argument not beginning with
                 a dash (-), or a dash by itself.

    Command syntax standard rules


    +  Command names are between two and nine characters long and must
       include only lowercase letters and digits

    +  Options must be one character long

    +  All options must be preceded by a dash

    +  Options with no arguments may be grouped after a single dash

    +  The first arg following an option must be preceded by white space

    +  args cannot be optional

    +  Groups of args following an option must either be separated by commas
       or be separated by white space and quoted (for example, -o xxx,z,yy or
       -o "xxx z yy")

    +  All options must precede cmdargs on the command line

    +  A dash may be used to indicate the end of the options

    +  The order of the options relative to one another should not matter

    +  The order of the cmdargs may be significant for some commands

    +  A dash preceded and followed by white space should only be used to
       indicate standard input


 Diagnostics

    Upon termination, each command returns two status bytes, 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(S) and
    exit(S)).  The first byte is 0 for normal termination; the second is cus-
    tomarily 0 for successful execution and non-zero to indicate problems
    such as erroneous parameters, bad or inaccessible data.  The second byte
    is called variously ``exit code'', ``exit status'', or ``return code'',
    and is described only where special conventions are involved.

 Note

    Not all commands adhere to the syntax described here.

 See also

    getopts(C), exit(S), getopt(S), getopt(C), wait(S)


Typewritten Software • bear@typewritten.org • Edmonds, WA 98026