diff options
| author |   stsp <stsp@openbsd.org> | 2020-01-13 18:05:10 +0000 |
|---|---|---|
| committer | stsp <stsp@openbsd.org> | 2020-01-13 18:05:10 +0000 |
| commit | dd25ef17a06ad9df7442f548eb63fec7df9b0bfe (patch) | |
| tree | 2e36f2f9ff5fcf7f783a4d663895055a9ba9c894 /lib/libc/stdlib/getopt_long.3 | |
| parent | Make clean should not require SUDO. (diff) | |
| download | wireguard-openbsd-dd25ef17a06ad9df7442f548eb63fec7df9b0bfe.tar.xz wireguard-openbsd-dd25ef17a06ad9df7442f548eb63fec7df9b0bfe.zip | |
Document how to make getopt_long(3) process arguments in order and stop
at the first non-option argument.
I had to read source code to figure it out.
Diffstat (limited to 'lib/libc/stdlib/getopt_long.3')
| -rw-r--r-- | lib/libc/stdlib/getopt_long.3 | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/lib/libc/stdlib/getopt_long.3 b/lib/libc/stdlib/getopt_long.3 index 88e0dffb1b4..706619203fe 100644 --- a/lib/libc/stdlib/getopt_long.3 +++ b/lib/libc/stdlib/getopt_long.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getopt_long.3,v 1.21 2016/01/04 19:43:13 tb Exp $ +.\" $OpenBSD: getopt_long.3,v 1.22 2020/01/13 18:05:10 stsp Exp $ .\" $NetBSD: getopt_long.3,v 1.11 2002/10/02 10:54:19 wiz Exp $ .\" .\" Copyright (c) 1988, 1991, 1993 @@ -30,7 +30,7 @@ .\" .\" @(#)getopt.3 8.5 (Berkeley) 4/27/95 .\" -.Dd $Mdocdate: January 4 2016 $ +.Dd $Mdocdate: January 13 2020 $ .Dt GETOPT_LONG 3 .Os .Sh NAME @@ -98,6 +98,22 @@ Abbreviated long option names are accepted when processes long options if the abbreviation is unique. An exact match is always preferred for a defined long option. .Pp +By default, +.Fn getopt_long +permutes +.Ar argv +such that all option arguments are evaluated before any non-options arguments. +If the first character of +.Fa optstring +is a plus sign +.Pq Ql + +or if the environment variable +.Ev POSIXLY_CORRECT +is set, then +.Ar argv +is processed in order and option processing stops as soon as the first +non-option argument is encountered. +.Pp The .Fn getopt_long call requires an array to be initialized describing the long |