summaryrefslogtreecommitdiffstats
path: root/man3/getsubopt.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--man3/getsubopt.323
1 files changed, 11 insertions, 12 deletions
diff --git a/man3/getsubopt.3 b/man3/getsubopt.3
index 8cbccb0..caf03a2 100644
--- a/man3/getsubopt.3
+++ b/man3/getsubopt.3
@@ -23,7 +23,7 @@
.\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.\" %%%LICENSE_END
.\"
-.TH getsubopt 3 2023-07-20 "Linux man-pages 6.05.01"
+.TH getsubopt 3 2023-10-31 "Linux man-pages 6.7"
.SH NAME
getsubopt \- parse suboption arguments from a string
.SH LIBRARY
@@ -32,16 +32,16 @@ Standard C library
.SH SYNOPSIS
.nf
.B #include <stdlib.h>
-.PP
+.P
.BI "int getsubopt(char **restrict " optionp ", char *const *restrict " tokens ,
.BI " char **restrict " valuep );
.fi
-.PP
+.P
.RS -4
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.RE
-.PP
+.P
.BR getsubopt ():
.nf
_XOPEN_SOURCE >= 500
@@ -62,13 +62,13 @@ which is separated from the suboption name by an equal sign.
The following is an example of the kind of string
that might be passed in
.IR optionp :
-.PP
+.P
.in +4n
.EX
.B ro,name=xyz
.EE
.in
-.PP
+.P
The
.I tokens
argument is a pointer to a NULL-terminated array of pointers to the tokens that
@@ -77,7 +77,7 @@ will look for in
.IR optionp .
The tokens should be distinct, null-terminated strings containing at
least one character, with no embedded equal signs or commas.
-.PP
+.P
Each call to
.BR getsubopt ()
returns information about the next unprocessed suboption in
@@ -98,11 +98,11 @@ The first comma in
is overwritten with a null byte, so
.I *valuep
is precisely the "value string" for that suboption.
-.PP
+.P
If the suboption is recognized, but no value string was found,
.I *valuep
is set to NULL.
-.PP
+.P
When
.BR getsubopt ()
returns,
@@ -122,7 +122,7 @@ Otherwise, \-1 is returned and
is the entire
.IB name [= value ]
string.
-.PP
+.P
Since
.I *optionp
is changed, the first suboption before the call to
@@ -143,7 +143,6 @@ T{
.BR getsubopt ()
T} Thread safety MT-Safe
.TE
-.sp 1
.SH STANDARDS
POSIX.1-2008.
.SH HISTORY
@@ -156,7 +155,7 @@ overwrites any commas it finds in the string
that string must be writable; it cannot be a string constant.
.SH EXAMPLES
The following program expects suboptions following a "\-o" option.
-.PP
+.P
.\" SRC BEGIN (getsubopt.c)
.EX
#define _XOPEN_SOURCE 500