share/man/man8/Intro.8

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