Intro(1) (man pages section 1: User Commands)

man pages section 1: User Commands

Intro(1)

NAME

Intro- introduction to commands and application programs

DESCRIPTION

This section describes, in alphabetical order, commands available with this operating system.

Pages of special interest are categorized as follows:

1B: Commands found only in the SunOS/BSD Compatibility Package.
1C: Commands for communicating with other systems.
1F: Commands associated with Form and Menu Language Interpreter (FMLI).
1S: Commands specific to the SunOS system.

OTHER SECTIONS

See these sections of the man pages section 1M: System Administration Commands for more information.

Section 1M in this manual for system maintenance commands.
Section 4 of this manual for information on file formats.
Section 5 of this manual for descriptions of publicly available files and miscellaneous information pages.
Section 6 in this manual for computer demonstrations.

For tutorial information about these commands and procedures, see:

Solaris Advanced User's Guide

Manual Page Command Syntax

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:

[ ]: Surround an option or cmdarg that is not required.
...: Indicates multiple occurrences of the option or cmdarg.
name: The name of an executable file.
{ }: The options and/or arguments enclosed within braces are interdependent, such that everything enclosed must be treated as a unit.
option: (Always preceded by a “-”.) noargletter... or, argletter optarg[,...]
noargletter: A single letter representing an option without an option-argument. Note that more than one noargletter option can be grouped after one “-” (Rule 5, below).
argletter: A single letter representing an option requiring an option-argument.
optarg: An option-argument (character string) satisfying a preceding argletter. Note that groups of optargs following an argletter must be separated by commas, or separated by a tab or space character and quoted (Rule 8, below).
cmdarg: Path name (or other command argument) not beginning with “-”, or “-” by itself indicating the standard input.

Command Syntax Standard: Rules

These command syntax rules are not followed by all current commands, but all new commands will obey them. getopts(1) should be used by all shell procedures to parse positional parameters and to check for legal options. It supports Rules 3-10 below. The enforcement of the other rules must be done by the command itself.

Command names (name above) must be between two and nine characters long.
Command names must include only lower-case letters and digits.
Option names (option above) must be one character long.
All options must be preceded by “-”.
Options with no arguments may be grouped after a single “-”.
The first option-argument (optarg above) following an option must be preceded by a tab or space character.
Option-arguments cannot be optional.
Groups of option-arguments following an option must either be separated by commas or separated by tab or space character and quoted (-o xxx,z,yy or -o "xxx z yy").
All options must precede operands (cmdarg above) on the command line.
“- -” may be used to indicate the end of the options.
The order of the options relative to one another should not matter.
The relative order of the operands (cmdarg above) may affect their significance in ways determined by the command with which they appear.
“-” preceded and followed by a space character should only be used to mean standard input.

ATTRIBUTES

See attributes(5) for a discussion of the attributes listed in this section.

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(3UCB) 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.

SunOS 5.9 Last Revised 1 Nov 1999