usr.bin/getopt/getopt.1

   1 .\" $FreeBSD: src/usr.bin/getopt/getopt.1,v 1.10.2.5 2002/12/29 16:35:39 schweikh Exp $
   2 .\" $DragonFly: src/usr.bin/getopt/getopt.1,v 1.4 2006/03/27 07:36:39 swildner Exp $
   3 .\"
   4 .Dd April 3, 1999
   5 .Dt GETOPT 1
   6 .Os
   7 .Sh NAME
   8 .Nm getopt
   9 .Nd parse command options
  10 .Sh SYNOPSIS
  11 .Nm args=\`getopt Ar optstring $*\`
  12 ; errcode=$?; set \-\- $args
  13 .Sh DESCRIPTION
  14 The
  15 .Nm
  16 utility is used to break up options in command lines for easy parsing by
  17 shell procedures, and to check for legal options.
  18 .Ar Optstring
  19 is a string of recognized option letters (see
  20 .Xr getopt 3 ) ;
  21 if a letter is followed by a colon, the option
  22 is expected to have an argument which may or may not be
  23 separated from it by white space.
  24 The special option
  25 .Ql \-\-
  26 is used to delimit the end of the options.
  27 The
  28 .Nm
  29 utility will place
  30 .Ql \-\-
  31 in the arguments at the end of the options,
  32 or recognize it if used explicitly.
  33 The shell arguments
  34 (\fB$1 $2\fR ...) are reset so that each option is
  35 preceded by a
  36 .Ql \-
  37 and in its own shell argument;
  38 each option argument is also in its own shell argument.
  39 .Sh EXAMPLES
  40 The following code fragment shows how one might process the arguments
  41 for a command that can take the options
  42 .Fl a
  43 and
  44 .Fl b ,
  45 and the option
  46 .Fl o ,
  47 which requires an argument.
  48 .Pp
  49 .Bd -literal -offset indent
  50 args=\`getopt abo: $*\`
  51 # you should not use \`getopt abo: "$@"\` since that would parse
  52 # the arguments differently from what the set command below does.
  53 if [ $? != 0 ]
  54 then
  55         echo 'Usage: ...'
  56         exit 2
  57 fi
  58 set \-\- $args
  59 # You cannot use the set command with a backquoted getopt directly,
  60 # since the exit code from getopt would be shadowed by those of set,
  61 # which is zero by definition.
  62 for i
  63 do
  64         case "$i"
  65         in
  66                 \-a|\-b)
  67                         echo flag $i set; sflags="${i#-}$sflags";
  68                         shift;;
  69                 \-o)
  70                         echo oarg is "'"$2"'"; oarg="$2"; shift;
  71                         shift;;
  72                 \-\-)
  73                         shift; break;;
  74         esac
  75 done
  76 echo single-char flags: "'"$sflags"'"
  77 echo oarg is "'"$oarg"'"
  78 .Ed
  79 .Pp
  80 This code will accept any of the following as equivalent:
  81 .Pp
  82 .Bd -literal -offset indent
  83 cmd \-aoarg file file
  84 cmd \-a \-o arg file file
  85 cmd \-oarg -a file file
  86 cmd \-a \-oarg \-\- file file
  87 .Ed
  88 .Sh DIAGNOSTICS
  89 The
  90 .Nm
  91 utility prints an error message on the standard error output and exits with
  92 status > 0 when it encounters an option letter not included in
  93 .Ar optstring .
  94 .Sh SEE ALSO
  95 .Xr sh 1 ,
  96 .Xr getopt 3
  97 .Sh HISTORY
  98 Written by
  99 .An Henry Spencer ,
 100 working from a Bell Labs manual page.
 101 Behavior believed identical to the Bell version.
 102 Example changed in
 103 .Fx
 104 version 3.2 and 4.0.
 105 .Sh BUGS
 106 Whatever
 107 .Xr getopt 3
 108 has.
 109 .Pp
 110 Arguments containing white space or embedded shell metacharacters
 111 generally will not survive intact;  this looks easy to fix but
 112 isn't. People trying to fix
 113 .Nm
 114 or the example in this manpage should check the history of this file
 115 in
 116 .Fx .
 117 .Pp
 118 The error message for an invalid option is identified as coming
 119 from
 120 .Nm
 121 rather than from the shell procedure containing the invocation
 122 of
 123 .Nm ;
 124 this again is hard to fix.
 125 .Pp
 126 The precise best way to use the
 127 .Nm set
 128 command to set the arguments without disrupting the value(s) of
 129 shell options varies from one shell version to another.
 130 .Pp
 131 Each shellscript has to carry complex code to parse arguments halfway
 132 correctly (like the example presented here). A better getopt-like tool
 133 would move much of the complexity into the tool and keep the client
 134 shell scripts simpler.