xref: /netbsd-src/lib/libc/string/strsep.3 (revision ce63d6c20fc4ec8ddc95c84bb229e3c4ecf82b69)
1.\" Copyright (c) 1990, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek.
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)strsep.3	5.3 (Berkeley) 4/19/91
35.\"
36.Dd April 19, 1991
37.Dt STRSEP 3
38.Os
39.Sh NAME
40.Nm strsep
41.Nd separate strings
42.Sh SYNOPSIS
43.Fd #include <string.h>
44.Ft char *
45.Fn strsep "char **stringp" "char *delim"
46.Sh DESCRIPTION
47The
48.Fn strsep
49locates in the null-terminated string at
50.Fa *stringp
51the first occurence of any character in
52.Fa delim
53and replaces this with a
54.Ql \e0 ,
55records the location of the immediate following character in
56.Fa *stringp ,
57then returns the original value of
58.Fa *stringp .
59If no delimiter characters are found,
60.Fn strsep
61sets
62.Fa *stringp
63to
64.Dv NULL ;
65if
66.Fa *stringp
67is initially
68.Dv NULL ,
69.Fn strsep
70returns
71.Dv NULL .
72.Sh EXAMPLES
73The following uses
74.Fn strsep
75to parse strings containing runs of white space,
76making up an argument vector:
77.Bd -literal -offset indent
78char inputstring[100];
79char **argv[51], **ap = argv, *p, *val;
80/* set up inputstring */
81for (p = inputstring; p != NULL; ) {
82	while ((val = strsep(&p, " \et")) != NULL && *val == '\e0');
83	*ap++ = val;
84}
85*ap = 0;
86.Ed
87.Sh HISTORY
88The
89.Fn strsep
90function is
91.Ud .
92