Intro(1M)

NAME | DESCRIPTION | COMMAND SYNTAX | ATTRIBUTES | SEE ALSO | DIAGNOSTICS | NOTES

NAME

Intro– introduction to maintenance commands and application programs

DESCRIPTION

This section describes, in alphabetical order, commands that are used chiefly for system maintenance and administration purposes.

Because of command restructuring for the Virtual File System architecture, there are several instances of multiple manual pages that begin with the same name. For example, the mount, pages - mount(1M), mount_cachefs(1M), mount_hsfs(1M), mount_nfs(1M), mount_tmpfs(1M), and mount_ufs(1M). In each such case the first of the multiple pages describes the syntax and options of the generic command, that is, those options applicable to all FSTypes (file system types). The succeeding pages describe the functionality of the FSType-specific modules of the command. These pages list the command followed by an underscore ( _ ) and the FSType to which they pertain. Note that the administrator should not attempt to call these modules directly. The generic command provides a common interface to all of them. Thus the FSType-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 FSType.

COMMAND SYNTAX

Unless otherwise noted, commands described in this section accept options and other arguments according to the following syntax:

---

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

---

where:

name

The name of an executable file.

option

- noargletter(s) or,

- argletter< >optarg

where < > is optional white space.

noargletter

A single letter representing an option without an argument.

argletter

A single letter representing an option requiring an argument.

optarg

Argument (character string) satisfying preceding argletter.

cmdarg

Pathname (or other command argument) not beginning with - or, - by itself indicating the standard input.

ATTRIBUTES

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

SEE ALSO

getopt(1), getopt(3C), attributes(5)

DIAGNOSTICS

Upon termination, each command returns 0 for normal termination and non-zero to indicate troubles such as erroneous parameters, bad or inaccessible data, or other inability to cope with the task at hand. It is called variously ``exit code,'' ``exit status,'' or ``return code,'' and is described only where special conventions are involved.

NOTES

Unfortunately, not all commands adhere to the standard syntax.

NAME | DESCRIPTION | COMMAND SYNTAX | ATTRIBUTES | SEE ALSO | DIAGNOSTICS | NOTES