kgess-mirror/freebsd-src
1
0
Fork 0
mirror of https://git.freebsd.org/src.git synced 2026-01-11 19:57:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

getopt(3): be more explicit about :: extension

Browse source 
Make it possible to search for literal two colons (::) and actually
find something.  Make the "x"/"x:"/"x::" examples more explicit and
more visibile.

Signed-off-by: Simon Wollwage <rootnode+freebsd@wollwage.com>
Obtained from:	NetBSD, nbuwe <uwe@stderr.spb.ru>, 856d5b6
PR: 291374
Reviewed by: imp, jlduran
Pull Request: https://github.com/freebsd/freebsd-src/pull/1923
This commit is contained in:
Simon Wollwage 2025-12-12 05:11:40 +00:00 • committed by Warner Losh
parent 85bf328868
commit 4b2a8aab43
1 changed files with 34 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
lib/libc/stdlib/getopt.3
View file

@ -27,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd June 5, 2014
.Dd December 14, 2025
.Dt GETOPT 3
.Os
.Sh NAME
@ -60,30 +60,49 @@ if it has been specified in the string of accepted option characters,
The option string
.Fa optstring
may contain the following elements: individual characters, and
characters followed by a colon to indicate an option argument
is to follow.
If an individual character is followed by two colons, then the
option argument is optional;
characters followed by a colon
.Pq Ql \&:
to indicate an option argument is to follow.
If an individual character is followed by two colons
.Pq Ql \&:\&: ,
then the option argument is optional;
.Va optarg
is set to the rest of the current
.Va argv
.Fa argv
word, or
.Dv NULL
if there were no more characters in the current word.
This is a
.Tn GNU
extension.
This is an extension not covered by POSIX.
.Pp
For example, an option string
.Li \&"x"
recognizes an option
.Dq Fl x ,
and an option string
.Dq Fl x .
.Pp
An option string
.Li \&"x:"
recognizes an option and argument
.Dq Fl x Ar argument .
recognizes an option with an argument, both
.Dq Fl x Ns Ar arg\^ ,
and
.Dq Fl x Ar arg\^ .
It does not matter to
.Fn getopt
if a following argument has leading white space.
if the option's argument is a separate word or not.
.Pp
An option string
.Li \&"x::"
recognizes the option both without an argument
.Dq Fl x ,
and with an argument
.Dq Fl x Ns Ar arg\^ .
In the latter case the argument must be part of the same
.Fa argv
word.
The
.Dq Fl x
and
.Dq Ar arg\^
must not be separated by a whitespace on the command line.
.Pp
On return from
.Fn getopt ,
@ -267,7 +286,7 @@ Care should be taken not to use
as the first character in
.Fa optstring
to avoid a semantic conflict with
.Tn GNU
GNU
.Fn getopt ,
which assigns different meaning to an
.Fa optstring