.sp 1
.fi
..
-.TH str 3mLib "20 June 1999" mLib
+.TH str 3 "20 June 1999" mLib
.SH NAME
str \- small string utilities
+.\" @str_getword
+.\" @str_split
+.\" @str_sanitize
.SH SYNOPSIS
.nf
.B "#include <mLib/str.h>"
divides a string into whitespace-separated words. The arguments are as
follows:
.TP
-.I p
+.BI "char *" p
The address of the string to split. The string is modified by having
null terminators written after each word extracted.
.TP
-.I v
+.BI "char *" v []
The address of an array of pointers to characters. This array will be
filled in by
.BR str_split :
and so on. If there aren't enough words in the string, the remaining
array elements are filled with null pointers.
.TP
-.I c
-The maxmimum number of words to extract; also, the number of elements in
+.BI "size_t " c
+The maximum number of words to extract; also, the number of elements in
the array
.IR v .
.TP
-.I rest
+.BI "char **" rest
The address of a pointer in which to store the address of the remainder
of the string. Leading whitespace is removed from the remainder before
storing. If the remainder string is empty, a null pointer is stored
and
.B rest
will be null.
+.SH "SEE ALSO"
+.BR mLib (3).
.SH AUTHOR
Mark Wooding, <mdw@nsict.org>