usr/src/man/man1/getopt.1

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Copyright 2000, Sun Microsystems, Inc.  All Rights Reserved
   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 GETOPT 1 "Jan 7, 2000"
   8 .SH NAME
   9 getopt \- parse command options
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBset\fR \fB--\fR ` getopt \fIoptstring\fR $ * `
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBgetopts\fR command supersedes \fBgetopt\fR. For more information, see
  20 NOTES below.
  21 .sp
  22 .LP
  23 \fBgetopt\fR is used to break up options in command lines for easy parsing by
  24 shell procedures and to check for legal options. \fIoptstring\fR is a string of
  25 recognized option letters; see \fBgetopt\fR(3C). If a letter is followed by a
  26 colon (\fB:\fR), the option is expected to have an argument which may or may
  27 not be separated from it by white space. The special option \fB-\fR is used to
  28 delimit the end of the options. If it is used explicitly, \fBgetopt\fR
  29 recognizes it; otherwise, \fBgetopt\fR generates it; in either case,
  30 \fBgetopt\fR places it at the end of the options. The positional parameters
  31 (\fB$1 $2\fR .\|.\|.\|) of the shell are reset so that each option is preceded
  32 by a \fB\(mi\fR and is in its own positional parameter; each option argument is
  33 also parsed into its own positional parameter.
  34 .SH EXAMPLES
  35 .LP
  36 \fBExample 1 \fRProcessing the arguments for a command
  37 .sp
  38 .LP
  39 The following code fragment shows how one might process the arguments for a
  40 command that can take the options \fB-a\fR or \fB-b\fR, as well as the option
  41 \fB-o\fR, which requires an argument:
  42
  43 .sp
  44 .in +2
  45 .nf
  46 \fBset -- `getopt abo: $*`
  47 if [ $? != 0 ]
  48 then
  49            echo $USAGE
  50            exit 2
  51 fi
  52 for i in $*
  53 do
  54            case $i in
  55            -a | -b)     FLAG=$i; shift;;
  56            -o)           OARG=$2; shift 2;;
  57            --)           shift; break;;
  58            esac
  59 done\fR
  60 .fi
  61 .in -2
  62 .sp
  63
  64 .sp
  65 .LP
  66 This code accepts any of the following as equivalent:
  67
  68 .sp
  69 .in +2
  70 .nf
  71 \fBcmd -aoarg filename1 filename2
  72 cmd -a -o arg filename1 filename2
  73 cmd -oarg -a filename1 filename2
  74 cmd -a -oarg -- filename1 filename2\fR
  75 .fi
  76 .in -2
  77 .sp
  78
  79 .SH ATTRIBUTES
  80 .sp
  81 .LP
  82 See \fBattributes\fR(5) for descriptions of the following attributes:
  83 .sp
  84
  85 .sp
  86 .TS
  87 box;
  88 c | c
  89 l | l .
  90 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  91 CSI     enabled
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBIntro\fR(1), \fBgetopts\fR(1), \fBgetoptcvt\fR(1), \fBsh\fR(1),
  98 \fBshell_builtins\fR(1), \fBgetopt\fR(3C), \fBattributes\fR(5)
  99 .SH DIAGNOSTICS
 100 .sp
 101 .LP
 102 \fBgetopt\fR prints an error message on the standard error when it encounters
 103 an option letter not included in \fIoptstring\fR.
 104 .SH NOTES
 105 .sp
 106 .LP
 107 \fBgetopt\fR will not be supported in the next major release. For this release
 108 a conversion tool has been provided, namely, \fBgetoptcvt\fR. For more
 109 information, see \fBgetopts\fR(1) and \fBgetoptcvt\fR(1).
 110 .sp
 111 .LP
 112 Reset \fBoptind\fR to \fB1\fR when rescanning the options.
 113 .sp
 114 .LP
 115 \fBgetopt\fR does not support the part of Rule 8 of the command syntax standard
 116 (see \fBIntro\fR(1)) that permits groups of option-arguments following an
 117 option to be separated by white space and quoted. For example,
 118 .sp
 119 .in +2
 120 .nf
 121 \fBcmd -a -b -o "xxx z yy" filename\fR
 122 .fi
 123 .in -2
 124 .sp
 125
 126 .sp
 127 .LP
 128 is not handled correctly. To correct this deficiency, use the \fBgetopts\fR
 129 command in place of \fBgetopt\fR.
 130 .sp
 131 .LP
 132 If an option that takes an option-argument is followed by a value that is the
 133 same as one of the options listed in \fIoptstring\fR (referring to the earlier
 134 EXAMPLES section, but using the following command line:
 135 .sp
 136 .in +2
 137 .nf
 138 \fBcmd -o -a filename\fR
 139 .fi
 140 .in -2
 141 .sp
 142
 143 .sp
 144 .LP
 145 \fBgetopt\fR always treats it as an option-argument to \fB-o\fR; it never
 146 recognizes \fB-a\fR as an option. For this case, the \fBfor\fR loop in the
 147 example shifts past the \fIfilename\fR argument.