1 '\" te
   2 .\" Copyright 2008, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH INTRO 1M "Nov 17, 2008"
   8 .SH NAME
   9 Intro, intro \- introduction to maintenance commands and application programs
  10 .SH DESCRIPTION
  11 .sp
  12 .LP
  13 This section describes, in alphabetical order, commands that are used chiefly
  14 for system maintenance and administration purposes.
  15 .sp
  16 .LP
  17 Because of command restructuring for the Virtual File System architecture,
  18 there are several instances of multiple manual pages that begin with the same
  19 name. For example, the   \fBmount\fR, pages \(mi \fBmount\fR(1M),
  20 \fBmount_cachefs\fR(1M), \fBmount_hsfs\fR(1M), \fBmount_nfs\fR(1M), \fB
  21 mount_tmpfs\fR(1M), and \fBmount_ufs\fR(1M). In each such case the first of the
  22 multiple pages describes the syntax and options of the generic command, that
  23 is, those options applicable to all FSTypes (file system types). The succeeding
  24 pages describe the functionality of the FSType-specific modules of the command.
  25 These pages list the command followed by an underscore ( _ ) and the FSType to
  26 which they pertain. Note that the administrator should not attempt to call
  27 these modules directly. The generic command provides a common interface to all
  28 of them. Thus the FSType-specific manual pages should not be viewed as
  29 describing distinct commands, but rather as detailing those aspects of a
  30 command that are specific to a particular FSType.
  31 .SH COMMAND SYNTAX
  32 .sp
  33 .LP
  34 Unless otherwise noted, commands described in this section accept options and
  35 other arguments according to the following syntax:
  36 .sp
  37 .in +2
  38 .nf
  39 \fIname\fR [\fIoption\fR(\fIs\fR)] [\fIcmdarg\fR(\fIs\fR)]
  40 .fi
  41 .in -2
  42 
  43 .sp
  44 .LP
  45 where:
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIname\fR\fR
  50 .ad
  51 .RS 15n
  52 The name of an executable file.
  53 .RE
  54 
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIoption\fR\fR
  59 .ad
  60 .RS 15n
  61 \fB\(mi\fR \fInoargletter\fR(\fIs\fR) or,
  62 .sp
  63 \fB\(mi\fR \fIargletter\fR<\|>\fIoptarg\fR
  64 .sp
  65 where <\|> is optional white space.
  66 .RE
  67 
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fInoargletter\fR\fR
  72 .ad
  73 .RS 15n
  74 A single letter representing an option without an argument.
  75 .RE
  76 
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fIargletter\fR\fR
  81 .ad
  82 .RS 15n
  83 A single letter representing an option requiring an argument.
  84 .RE
  85 
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fIoptarg\fR\fR
  90 .ad
  91 .RS 15n
  92 Argument (character string) satisfying preceding \fIargletter\fR.
  93 .RE
  94 
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fIcmdarg\fR\fR
  99 .ad
 100 .RS 15n
 101 Pathname (or other command argument) \fInot\fR beginning with \fB\(mi\fR or,
 102 \fB\(mi\fR by itself indicating the standard input.
 103 .RE
 104 
 105 .SH ATTRIBUTES
 106 .sp
 107 .LP
 108 See \fBattributes\fR(5) for a discussion of the attributes listed in this
 109 section.
 110 .SH ACKNOWLEDGMENTS
 111 .sp
 112 .LP
 113 Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to
 114 reproduce portions of its copyrighted documentation. Original documentation
 115 from The Open Group can be obtained online at
 116 http://www.opengroup.org/bookstore/\&.
 117 .sp
 118 .LP
 119 The Institute of Electrical and Electronics Engineers and The Open Group, have
 120 given us permission to reprint portions of their documentation.
 121 .sp
 122 .LP
 123 In the following statement, the phrase ``this text'' refers to portions of the
 124 system documentation.
 125 .sp
 126 .LP
 127 Portions of this text are reprinted and reproduced in electronic form in the
 128 SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for
 129 Information Technology -- Portable Operating System Interface (POSIX), The Open
 130 Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
 131 Electrical and Electronics Engineers, Inc and The Open Group.  In the event of
 132 any discrepancy between these versions and the original IEEE and The Open Group
 133 Standard, the original IEEE and The Open Group Standard is the referee
 134 document.  The original Standard can be obtained online at
 135 http://www.opengroup.org/unix/online.html\&.
 136 .sp
 137 .LP
 138 This notice shall appear on any product containing this material.
 139 .SH SEE ALSO
 140 .sp
 141 .LP
 142 \fBgetopt\fR(1), \fBgetopt\fR(3C), \fBattributes\fR(5)
 143 .SH DIAGNOSTICS
 144 .sp
 145 .LP
 146 Upon termination, each command returns 0 for normal termination and non-zero to
 147 indicate troubles such as erroneous parameters, bad or inaccessible data, or
 148 other inability to cope with the task at hand. It is called variously ``exit
 149 code,'' ``exit status,'' or ``return code,'' and is described only where
 150 special conventions are involved.
 151 .SH NOTES
 152 .sp
 153 .LP
 154 Unfortunately, not all commands adhere to the standard syntax.