xref: /386bsd/usr/src/lib/libc/string/strtok.3 (revision a2142627)
1.\" Copyright (c) 1988, 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.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)strtok.3	5.8 (Berkeley) 6/29/91
37.\"
38.Dd June 29, 1991
39.Dt STRTOK 3
40.Os BSD 3
41.Sh NAME
42.Nm strtok ,
43.Nm strsep
44.Nd string token operations
45.Sh SYNOPSIS
46.Fd #include <string.h>
47.Ft char *
48.Fn strtok "char *str" "const char *sep"
49.Sh DESCRIPTION
50.Bf -symbolic
51This interface is obsoleted by strsep(3).
52.Ef
53.Pp
54The
55.Fn strtok
56function
57is used to isolate sequential tokens in a null-terminated string,
58.Fa str .
59These tokens are separated in the string by at least one of the
60characters in
61.Fa sep .
62The first time that
63.Fn strtok
64is called,
65.Fa str
66should be specified; subsequent calls, wishing to obtain further tokens
67from the same string, should pass a null pointer instead.
68The separator string,
69.Fa sep ,
70must be supplied each time, and may change between calls.
71.Pp
72The
73.Fn strtok
74function
75returns a pointer to the beginning of each subsequent token in the string,
76after replacing the token itself with a
77.Dv NUL
78character.
79When no more tokens remain, a null pointer is returned.
80.Sh SEE ALSO
81.Xr index 3 ,
82.Xr memchr 3 ,
83.Xr rindex 3 ,
84.Xr strchr 3 ,
85.Xr strcspn 3 ,
86.Xr strpbrk 3 ,
87.Xr strrchr 3 ,
88.Xr strsep 3 ,
89.Xr strspn 3 ,
90.Xr strstr 3
91.Sh STANDARDS
92The
93.Fn strtok
94function
95conforms to
96.St -ansiC .
97.Sh BUGS
98There is no way to get tokens from multiple strings simultaneously.
99.Pp
100The System V
101.Fn strtok ,
102if handed a string containing only delimiter characters,
103will not alter the next starting point, so that a call to
104.Fn strtok
105with a different (or empty) delimiter string
106may return a
107.Pf non- Dv NULL
108value.
109Since this implementation always alters the next starting point,
110such a sequence of calls would always return
111.Dv NULL .
112