1 files changed, 98 insertions, 69 deletions

diff --git a/src/lib/libc/stdlib/getopt.3 b/src/lib/libc/stdlib/getopt.3
index f843881afd..d25b497035 100644
--- a/src/lib/libc/stdlib/getopt.3
+++ b/src/lib/libc/stdlib/getopt.3
@@ -29,11 +29,11 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\"     @(#)getopt.3    8.4 (Berkeley) 4/19/94
+.\"     $OpenBSD: getopt.3,v 1.22 2003/05/10 06:48:30 jmc Exp $
 .\"
-.Dd April 19, 1994
+.Dd December 8, 2002
 .Dt GETOPT 3
-.Os BSD 4.3
+.Os
 .Sh NAME
 .Nm getopt
 .Nd get option character from command line argument list
@@ -51,30 +51,28 @@ The
 .Fn getopt
 function incrementally parses a command line argument list
 .Fa argv
-and returns the next
-.Em known
-option character.
+and returns the next known option character.
 An option character is
-.Em known
+.Dq known
 if it has been specified in the string of accepted option characters,
 .Fa optstring .
 .Pp
 The option string
 .Fa optstring
-may contain the following elements: individual characters, and
+may contain the following elements: individual characters and
 characters followed by a colon to indicate an option argument
 is to follow.
 For example, an option string
-.Li "\&""x""
+.Qq x
 recognizes an option
-.Dq Fl x ,
+.Fl x ,
 and an option string
-.Li "\&""x:""
+.Qq Li x:
 recognizes an option and argument
-.Dq Fl x Ar argument .
+.Fl x Ar argument .
 It does not matter to
 .Fn getopt
-if a following argument has leading white space.
+if a following argument has leading whitespace.
 .Pp
 On return from
 .Fn getopt ,
@@ -89,12 +87,10 @@ to
 .Fn getopt .
 The variable
 .Va optopt
-saves the last
-.Em known
-option character returned by
+saves the last known option character returned by
 .Fn getopt .
 .Pp
-The variable
+The variables
 .Va opterr
 and
 .Va optind
@@ -119,10 +115,7 @@ must be reinitialized.
 .Pp
 The
 .Fn getopt
-function
-returns \-1
-when the argument list is exhausted, or a non-recognized
-option is encountered.
+function returns \-1 when the argument list is exhausted.
 The interpretation of options in the argument list may be cancelled
 by the option
 .Ql --
@@ -133,49 +126,36 @@ When all options have been processed (i.e., up to the first non-option
 argument),
 .Fn getopt
 returns \-1.
-.Sh DIAGNOSTICS
-If the
+.Sh RETURN VALUES
+The
 .Fn getopt
-function encounters a character not found in the string
-.Va optarg
-or detects
-a missing option argument it writes an error message and returns
-.Ql ?
-to the
-.Em stderr .
-Setting
-.Va opterr
-to a zero will disable these error messages.
+function returns the next known option character in
+.Fa optstring .
 If
-.Va optstring 
-has a leading 
-.Ql \&:
-then a missing option argument causes a
-.Ql \&:
-to be returned in addition to suppressing any error messages.
-.Pp
-Option arguments are allowed to begin with
-.Dq Li \- ;
-this is reasonable but
-reduces the amount of error checking possible.
-.Sh EXTENSIONS
+.Fn getopt
+encounters a character not found in
+.Fa optstring
+or if it detects a missing option argument,
+it returns
+.Sq ? .
+If
+.Fa optstring
+has a leading
+.Sq \:
+then a missing option argument causes
+.Sq \:
+to be returned instead of
+.Sq ? .
 The
-.Va optreset
-variable was added to make it possible to call the
 .Fn getopt
-function multiple times.
-This is an extension to the
-.St -p1003.2
-specification.
-.Sh EXAMPLE
+function returns \-1 when the argument list is exhausted.
+.Sh EXAMPLES
 .Bd -literal -compact
-extern char *optarg;
-extern int optind;
 int bflag, ch, fd;
 
 bflag = 0;
-while ((ch = getopt(argc, argv, "bf:")) != -1)
-        switch(ch) {
+while ((ch = getopt(argc, argv, "bf:")) != -1) {
+        switch (ch) {
         case 'b':
                 bflag = 1;
                 break;
@@ -189,31 +169,69 @@ while ((ch = getopt(argc, argv, "bf:")) != -1)
         case '?':
         default:
                 usage();
+        }
 }
 argc -= optind;
 argv += optind;
 .Ed
+.Sh SEE ALSO
+.Xr getopt 1 ,
+.Xr getopt_long 3 ,
+.Xr getsubopt 3
+.Sh DIAGNOSTICS
+If the
+.Fn getopt
+function encounters a character not found in the string
+.Va optstring
+or detects
+a missing option argument it writes an error message to
+.Em stderr
+and returns
+.Ql ? .
+Setting
+.Va opterr
+to a zero will disable these error messages.
+If
+.Va optstring
+has a leading
+.Ql \&:
+then a missing option argument causes a
+.Ql \&:
+to be returned in addition to suppressing any error messages.
+.Pp
+Option arguments are allowed to begin with
+.Ql - ;
+this is reasonable but reduces the amount of error checking possible.
+.Sh EXTENSIONS
+The
+.Va optreset
+variable was added to make it possible to call the
+.Fn getopt
+function multiple times.
+This is an extension to the
+.St -p1003.2
+specification.
 .Sh HISTORY
 The
 .Fn getopt
-function appeared
+function appeared in
 .Bx 4.3 .
 .Sh BUGS
 The
 .Fn getopt
 function was once specified to return
-.Dv EOF 
+.Dv EOF
 instead of \-1.
 This was changed by
 .St -p1003.2-92
-to decouple 
+to decouple
 .Fn getopt
-from 
+from
 .Pa <stdio.h> .
 .Pp
 A single dash
-.Dq Li -
-may be specified as an character in
+.Pq Ql -
+may be specified as a character in
 .Fa optstring ,
 however it should
 .Em never
@@ -221,15 +239,25 @@ have an argument associated with it.
 This allows
 .Fn getopt
 to be used with programs that expect
-.Dq Li -
+.Ql -
 as an option flag.
 This practice is wrong, and should not be used in any current development.
 It is provided for backward compatibility
 .Em only .
+Care should be taken not to use
+.Ql -
+as the first character in
+.Fa optstring
+to avoid a semantic conflict with
+.Tn GNU
+.Fn getopt ,
+which assigns different meaning to an
+.Fa optstring
+that begins with a
+.Ql - .
 By default, a single dash causes
 .Fn getopt
 to return \-1.
-This is, we believe, compatible with System V.
 .Pp
 It is also possible to handle digits as option letters.
 This allows
@@ -242,18 +270,19 @@ It is provided for backward compatibility
 .Em only .
 The following code fragment works in most cases.
 .Bd -literal -offset indent
-int length;
+int ch;
+long length;
 char *p;
 
-while ((c = getopt(argc, argv, "0123456789")) != -1)
-        switch (c) {
+while ((ch = getopt(argc, argv, "0123456789")) != -1) {
+        switch (ch) {
         case '0': case '1': case '2': case '3': case '4':
         case '5': case '6': case '7': case '8': case '9':
                 p = argv[optind - 1];
                 if (p[0] == '-' && p[1] == ch && !p[2])
-                        length = atoi(++p);
+                        length = ch - '0';
                 else
-                        length = atoi(argv[optind] + 1);
+                        length = strtol(argv[optind] + 1, NULL, 10);
                 break;
         }
 }