diff options
| author | Philippe Charnier <charnier@FreeBSD.org> | 2002-04-19 23:44:58 +0000 |
|---|---|---|
| committer | Philippe Charnier <charnier@FreeBSD.org> | 2002-04-19 23:44:58 +0000 |
| commit | 3898680cf705cef4e1cc606b44cd91fc4252bcd5 (patch) | |
| tree | 1070287b1054de985087e8287086ae5d4c5ed090 /usr.bin/getopt | |
| parent | 0c7c579ba6b65512b9b668508dc41b8b5b057c65 (diff) | |
| download | src-test2-3898680cf705cef4e1cc606b44cd91fc4252bcd5.tar.gz src-test2-3898680cf705cef4e1cc606b44cd91fc4252bcd5.zip | |
Notes
Diffstat (limited to 'usr.bin/getopt')
| -rw-r--r-- | usr.bin/getopt/getopt.1 | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/usr.bin/getopt/getopt.1 b/usr.bin/getopt/getopt.1 index 9c1d60a98e3a..0fc84c4a6343 100644 --- a/usr.bin/getopt/getopt.1 +++ b/usr.bin/getopt/getopt.1 @@ -10,8 +10,9 @@ .Nm args=\`getopt Ar optstring $*\` ; errcode=$?; set \-\- $args .Sh DESCRIPTION -.Nm Getopt -is used to break up options in command lines for easy parsing by +The +.Nm +utility is used to break up options in command lines for easy parsing by shell procedures, and to check for legal options. .Ar Optstring is a string of recognized option letters (see @@ -22,8 +23,9 @@ separated from it by white space. The special option .Ql \-\- is used to delimit the end of the options. -.Nm Getopt -will place +The +.Nm +utility will place .Ql \-\- in the arguments at the end of the options, or recognize it if used explicitly. @@ -87,8 +89,9 @@ cmd \-a \-oarg \-\- file file .Xr sh 1 , .Xr getopt 3 .Sh DIAGNOSTICS -.Nm Getopt -prints an error message on the standard error output and exits with +The +.Nm +utility prints an error message on the standard error output and exits with status > 0 when it encounters an option letter not included in .Ar optstring . .Sh HISTORY |