This commit is contained in:
Michael Kerrisk 2007-12-22 21:52:46 +00:00
parent 8c1a40ca50
commit 2bbf22921c
1 changed files with 33 additions and 41 deletions

View File

@ -13,53 +13,43 @@ argz_next, argz_replace, argz_stringify \- functions to handle an argz list
.sp
.B "#include <argz.h>"
.sp
.B "error_t"
.BI "argz_add(char **" argz ", size_t *" argz_len ", const char *" str );
.BI "error_t argz_add(char **" argz ", size_t *" argz_len \
", const char *" str );
.sp
.B "error_t"
.BI "argz_add_sep(char **" argz ", size_t *" argz_len ,
.BI "error_t argz_add_sep(char **" argz ", size_t *" argz_len ,
.ti 20n
.BI "const char *" str ", int " delim );
.sp
.B "error_t"
.BI "argz_append(char **" argz ", size_t *" argz_len ,
.BI "error_t argz_append(char **" argz ", size_t *" argz_len ,
.ti 20n
.BI "const char *" buf ", size_t " buf_len );
.sp
.B "size_t"
.BI "argz_count(const char *" argz ", size_t " argz_len );
.BI "size_t argz_count(const char *" argz ", size_t " argz_len );
.sp
.B "error_t"
.BI "argz_create(char * const " argv "[], char **" argz ,
.BI "error_t argz_create(char * const " argv "[], char **" argz ,
.ti 20n
.BI "size_t *" argz_len );
.sp
.B "error_t"
.BI "argz_create_sep(const char *" str ", int " sep ", char **" argz ,
.BI "error_t argz_create_sep(const char *" str ", int " sep ", char **" argz ,
.ti 20n
.BI "size_t *" argz_len );
.sp
.B "error_t"
.BI "argz_delete(char **" argz ", size_t *" argz_len ", char *" entry );
.BI "error_t argz_delete(char **" argz ", size_t *" argz_len ", char *" entry );
.sp
.B "void"
.BI "argz_extract(char *" argz ", size_t " argz_len ", char **" argv );
.BI "void argz_extract(char *" argz ", size_t " argz_len ", char **" argv );
.sp
.B "error_t"
.BI "argz_insert(char **" argz ", size_t *" argz_len ", char *" before ,
.BI "error_t argz_insert(char **" argz ", size_t *" argz_len ", char *" before ,
.ti 20n
.BI "const char *" entry );
.sp
.B "char *"
.BI "argz_next(char *" argz ", size_t " argz_len ", const char *" entry );
.BI "char *argz_next(char *" argz ", size_t " argz_len ", const char *" entry );
.sp
.B "error_t"
.BI "argz_replace(char **" argz ", size_t *" argz_len ", const char *" str ,
.BI "error_t argz_replace(char **" argz ", size_t *" argz_len \
", const char *" str ,
.ti 20n
.BI "const char *" with ", unsigned int *" replace_count );
.sp
.B "void"
.BI "argz_stringify(char *" argz ", size_t " len ", int " sep );
.BI "void argz_stringify(char *" argz ", size_t " len ", int " sep );
.SH DESCRIPTION
These functions are glibc-specific.
.LP
@ -81,11 +71,11 @@ can be used to dispose of them again.
adds the string
.I str
at the end of the array
.RI * argz ,
.IR *argz ,
and updates
.RI * argz
.I *argz
and
.RI * argz_len .
.IR *argz_len .
.LP
.BR argz_add_sep ()
is similar, but splits the string
@ -99,13 +89,13 @@ delimiter ':'.
appends the argz vector
.RI ( buf , buf_len )
after
.RI (* argz ,* argz_len )
.RI ( *argz ,\ *argz_len )
and updates
.RI * argz
.IR *argz
and
.RI * argz_len .
.IR *argz_len .
(Thus,
.RI * argz_len
.I *argz_len
will be increased by
.IR buf_len .)
.LP
@ -117,14 +107,16 @@ the number of null bytes ('\\0'), in
.BR argz_create ()
converts a Unix-style argument vector
.IR argv ,
terminated by (char *) 0, into an argz vector
.RI (* argz ,* argz_len ).
terminated by
.IR "(char *) 0" ,
into an argz vector
.RI ( *argz ,\ *argz_len ).
.LP
.BR argz_create_sep ()
converts the null-terminated string
.I str
into an argz vector
.RI (* argz ,* argz_len )
.RI ( *argz ,\ *argz_len )
by breaking it up at every occurrence of the separator
.IR sep .
.LP
@ -132,11 +124,11 @@ by breaking it up at every occurrence of the separator
removes the substring pointed to by
.I entry
from the argz vector
.RI (* argz ,* argz_len )
.RI ( *argz ,\ *argz_len )
and updates
.RI * argz
.I *argz
and
.RI * argz_len .
.IR *argz_len .
.LP
.BR argz_extract ()
is the opposite of
@ -161,11 +153,11 @@ It inserts the argument
at position
.I before
into the argz vector
.RI (* argz ,* argz_len )
.RI ( *argz ,\ *argz_len )
and updates
.RI * argz
.I *argz
and
.RI * argz_len .
.IR *argz_len .
If
.I before
is NULL, then
@ -190,7 +182,7 @@ reallocating argz as necessary.
If
.I replace_count
is non-NULL,
.RI * replace_count
.I *replace_count
will be incremented by the number of replacements.
.LP
.BR argz_stringify ()