summaryrefslogtreecommitdiff
path: root/usr.bin/getopt/getopt.1
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>1999-07-04 11:53:56 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>1999-07-04 11:53:56 +0000
commitf5558a2c81394fbddd25d59efa1c36d1e4c4e0e0 (patch)
treec23144785810bbeda4c01b8a385873bfa83c8032 /usr.bin/getopt/getopt.1
parent8e68b36a929e0ad1721fd7f9eee6d57ade5db145 (diff)
correct use of .Nm; some other formatting nits
Diffstat (limited to 'usr.bin/getopt/getopt.1')
-rw-r--r--usr.bin/getopt/getopt.112
1 files changed, 6 insertions, 6 deletions
diff --git a/usr.bin/getopt/getopt.1 b/usr.bin/getopt/getopt.1
index 0f8317ad6f4..556eed95d11 100644
--- a/usr.bin/getopt/getopt.1
+++ b/usr.bin/getopt/getopt.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getopt.1,v 1.3 1998/09/26 19:54:50 aaron Exp $ -*- nroff -*-
+.\" $OpenBSD: getopt.1,v 1.4 1999/07/04 11:53:54 aaron Exp $ -*- nroff -*-
.Dd June 21, 1993
.Dt GETOPT 1
.Os
@@ -8,10 +8,10 @@
.Sh SYNOPSIS
.Nm set \-\- \`getopt optstring $*\`
.Sh DESCRIPTION
-.Nm getopt
+.Nm
is used to break up options in command lines for easy parsing by
shell procedures, and to check for legal options.
-.Op Optstring
+.Op optstring
is a string of recognized option letters (see
.Xr getopt 3
);
@@ -21,7 +21,7 @@ separated from it by white space.
The special option
.Dq \-\-
is used to delimit the end of the options.
-.Nm getopt
+.Nm
will place
.Dq \-\-
in the arguments at the end of the options,
@@ -75,7 +75,7 @@ cmd \-a \-oarg \-\- file file
.Xr sh 1 ,
.Xr getopt 3
.Sh DIAGNOSTICS
-.Nm getopt
+.Nm
prints an error message on the standard error output when it
encounters an option letter not included in
.Op optstring .
@@ -92,7 +92,7 @@ generally will not survive intact; this looks easy to fix but isn't.
.Pp
The error message for an invalid option is identified as coming
from
-.Nm getopt
+.Nm
rather than from the shell procedure containing the invocation
of
.Nm getopt ;