1 .\" Copyright (c) 1998 Softweyr LLC. All rights reserved.
3 .\" strtok_r, from Berkeley strtok
4 .\" Oct 13, 1998 by Wes Peters <wes@softweyr.com>
6 .\" Copyright (c) 1988, 1991, 1993
7 .\" The Regents of the University of California. All rights reserved.
9 .\" This code is derived from software contributed to Berkeley by
10 .\" the American National Standards Committee X3, on Information
11 .\" Processing Systems.
13 .\" Redistribution and use in source and binary forms, with or without
14 .\" modification, are permitted provided that the following conditions
17 .\" 1. Redistributions of source code must retain the above copyright
18 .\" notices, this list of conditions and the following disclaimer.
20 .\" 2. Redistributions in binary form must reproduce the above
21 .\" copyright notices, this list of conditions and the following
22 .\" disclaimer in the documentation and/or other materials provided
23 .\" with the distribution.
25 .\" 3. All advertising materials mentioning features or use of this
26 .\" software must display the following acknowledgement:
28 .\" This product includes software developed by Softweyr LLC, the
29 .\" University of California, Berkeley, and its contributors.
31 .\" 4. Neither the name of Softweyr LLC, the University nor the names
32 .\" of its contributors may be used to endorse or promote products
33 .\" derived from this software without specific prior written
36 .\" THIS SOFTWARE IS PROVIDED BY SOFTWEYR LLC, THE REGENTS AND
37 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
38 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
39 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 .\" DISCLAIMED. IN NO EVENT SHALL SOFTWEYR LLC, THE REGENTS, OR
41 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 .\" @(#)strtok.3 8.2 (Berkeley) 2/3/94
51 .\" $FreeBSD: src/lib/libc/string/strtok.3,v 1.10.2.8 2001/12/14 18:33:59 ru Exp $
52 .\" $DragonFly: src/lib/libc/string/strtok.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
65 .Fn strtok "char *str" "const char *sep"
67 .Fn strtok_r "char *str" "const char *sep" "char **last"
70 This interface is obsoleted by
77 is used to isolate sequential tokens in a null-terminated string,
79 These tokens are separated in the string by at least one of the
86 should be specified; subsequent calls, wishing to obtain further tokens
87 from the same string, should pass a null pointer instead.
90 must be supplied each time, and may change between calls.
92 The implementation will behave as if no library function calls
97 function is a reentrant version of
101 must be provided on each call.
103 may also be used to nest two parsing loops within one another, as
104 long as separate context pointers are used.
111 return a pointer to the beginning of each subsequent token in the string,
112 after replacing the token itself with a
115 When no more tokens remain, a null pointer is returned.
119 to parse two strings using separate contexts:
121 char test[80], blah[80];
122 char *sep = "\e\e/:;=-";
123 char *word, *phrase, *brkt, *brkb;
125 strcpy(test, "This;is.a:test:of=the/string\e\etokenizer-function.");
127 for (word = strtok_r(test, sep, &brkt);
129 word = strtok_r(NULL, sep, &brkt))
131 strcpy(blah, "blah:blat:blab:blag");
133 for (phrase = strtok_r(blah, sep, &brkb);
135 phrase = strtok_r(NULL, sep, &brkb))
137 printf("So far we're at %s:%s\en", word, phrase);
159 if handed a string containing only delimiter characters,
160 will not alter the next starting point, so that a call to
162 with a different (or empty) delimiter string
166 Since this implementation always alters the next starting point,
167 such a sequence of calls would always return