summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libc/stdlib/getopt.325
-rw-r--r--src/lib/libc/stdlib/getopt_long.329
2 files changed, 52 insertions, 2 deletions
diff --git a/src/lib/libc/stdlib/getopt.3 b/src/lib/libc/stdlib/getopt.3
index f261edcab7..0a28fa9e60 100644
--- a/src/lib/libc/stdlib/getopt.3
+++ b/src/lib/libc/stdlib/getopt.3
@@ -29,7 +29,7 @@
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE. 30.\" SUCH DAMAGE.
31.\" 31.\"
32.\" $OpenBSD: getopt.3,v 1.18 2002/12/04 20:31:30 millert Exp $ 32.\" $OpenBSD: getopt.3,v 1.19 2002/12/04 21:42:22 millert Exp $
33.\" 33.\"
34.Dd April 19, 1994 34.Dd April 19, 1994
35.Dt GETOPT 3 35.Dt GETOPT 3
@@ -126,6 +126,29 @@ When all options have been processed (i.e., up to the first non-option
126argument), 126argument),
127.Fn getopt 127.Fn getopt
128returns \-1. 128returns \-1.
129.Sh RETURN VALUES
130The
131.Fn getopt
132function returns the next known option character in
133.Fa optstring .
134If
135.Fn getopt
136encounters a character not found in
137.Fa optstring
138or if it detects a missing option argument,
139it returns
140.Sq ? .
141If
142.Fa optstring
143has a leading
144.Sq \:
145then a missing option argument causes
146.Sq \:
147to be returned instead of
148.Sq ? .
149The
150.Fn getopt
151function returns \-1 when the argument list is exhausted.
129.Sh EXAMPLES 152.Sh EXAMPLES
130.Bd -literal -compact 153.Bd -literal -compact
131int bflag, ch, fd; 154int bflag, ch, fd;
diff --git a/src/lib/libc/stdlib/getopt_long.3 b/src/lib/libc/stdlib/getopt_long.3
index d55f4ead53..cfbe255e6c 100644
--- a/src/lib/libc/stdlib/getopt_long.3
+++ b/src/lib/libc/stdlib/getopt_long.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: getopt_long.3,v 1.1 2002/12/03 20:24:30 millert Exp $ 1.\" $OpenBSD: getopt_long.3,v 1.2 2002/12/04 21:42:22 millert Exp $
2.\" $NetBSD: getopt_long.3,v 1.11 2002/10/02 10:54:19 wiz Exp $ 2.\" $NetBSD: getopt_long.3,v 1.11 2002/10/02 10:54:19 wiz Exp $
3.\" 3.\"
4.\" Copyright (c) 1988, 1991, 1993 4.\" Copyright (c) 1988, 1991, 1993
@@ -163,6 +163,33 @@ If an option starting with
163.Sq - 163.Sq -
164does not match a long option but does match a single-character option, 164does not match a long option but does match a single-character option,
165the single-character option is returned. 165the single-character option is returned.
166.Sh RETURN VALUES
167If the
168.Fa flag
169field in
170.Li struct option
171is
172.Dv NULL ,
173.Fn getopt_long
174and
175.Fn getopt_long_only
176return the value specified in the
177.Fa val
178field, which is usually just the corresponding short option.
179If
180.Fa flag
181is not
182.Dv NULL ,
183these functions return 0 and store
184.Fa val
185in the location pointed to by
186.Fa flag .
187These functions return
188.Sq \:
189if there was a missing option argument,
190.Sq ?
191if the user specified an unknown or ambiguous option, and
192\-1 when the argument list has been exhausted.
166.Sh EXAMPLES 193.Sh EXAMPLES
167.Bd -literal -compact 194.Bd -literal -compact
168int bflag, ch, fd; 195int bflag, ch, fd;