1.\" Copyright (c) 1998 Softweyr LLC. All rights reserved. 2.\" 3.\" strtok_r, from Berkeley strtok 4.\" Oct 13, 1998 by Wes Peters <wes@softweyr.com> 5.\" 6.\" Copyright (c) 1988, 1991, 1993 7.\" The Regents of the University of California. All rights reserved. 8.\" 9.\" This code is derived from software contributed to Berkeley by 10.\" the American National Standards Committee X3, on Information 11.\" Processing Systems. 12.\" 13.\" Redistribution and use in source and binary forms, with or without 14.\" modification, are permitted provided that the following conditions 15.\" are met: 16.\" 17.\" 1. Redistributions of source code must retain the above copyright 18.\" notices, this list of conditions and the following disclaimer. 19.\" 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. 24.\" 25.\" 3. All advertising materials mentioning features or use of this 26.\" software must display the following acknowledgement: 27.\" 28.\" This product includes software developed by Softweyr LLC, the 29.\" University of California, Berkeley, and its contributors. 30.\" 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 34.\" permission. 35.\" 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 48.\" SUCH DAMAGE. 49.\" 50.\" @(#)strtok.3 8.2 (Berkeley) 2/3/94 51.\" $FreeBSD$ 52.\" 53.Dd November 27, 1998 54.Dt STRTOK 3 55.Os FreeBSD 3.0 56.Sh NAME 57.Nm strtok, strtok_r 58.Nd string tokens 59.Sh LIBRARY 60.Lb libc 61.Sh SYNOPSIS 62.Fd #include <string.h> 63.Ft char * 64.Fn strtok "char *str" "const char *sep" 65.Ft char * 66.Fn strtok_r "char *str" "const char *sep" "char **last" 67.Sh DESCRIPTION 68.Bf -symbolic 69This interface is obsoleted by strsep(3). 70.Ef 71.Pp 72The 73.Fn strtok 74function 75is used to isolate sequential tokens in a null-terminated string, 76.Fa str . 77These tokens are separated in the string by at least one of the 78characters in 79.Fa sep . 80The first time that 81.Fn strtok 82is called, 83.Fa str 84should be specified; subsequent calls, wishing to obtain further tokens 85from the same string, should pass a null pointer instead. 86The separator string, 87.Fa sep , 88must be supplied each time, and may change between calls. 89.Pp 90The 91.Fn strtok_r 92function is a reentrant version of 93.Fn strtok . 94The context pointer 95.Fa last 96must be provided on each call. 97.Fn strtok_r 98may also be used to nest two parsing loops within one another, as 99long as separate context pointers are used. 100.Pp 101The 102.Fn strtok 103and 104.Fn strtok_r 105functions 106return a pointer to the beginning of each subsequent token in the string, 107after replacing the token itself with a 108.Dv NUL 109character. 110When no more tokens remain, a null pointer is returned. 111.Sh EXAMPLE 112The following uses 113.Fn strtok_r 114to parse two strings using separate contexts: 115.Bd -literal 116char test[80], blah[80]; 117char *sep = "\e\e/:;=-"; 118char *word, *phrase, *brkt, *brkb; 119 120strcpy(test, "This;is.a:test:of=the/string\e\etokenizer-function."); 121 122for (word = strtok_r(test, sep, &brkt); 123 word; 124 word = strtok_r(NULL, sep, &brkt)) 125{ 126 strcpy(blah, "blah:blat:blab:blag"); 127 128 for (phrase = strtok_r(blah, sep, &brkb); 129 phrase; 130 phrase = strtok_r(NULL, sep, &brkb)) 131 { 132 printf("So far we're at %s:%s\en", word, phrase); 133 } 134} 135.Ed 136.Sh SEE ALSO 137.Xr index 3 , 138.Xr memchr 3 , 139.Xr rindex 3 , 140.Xr strchr 3 , 141.Xr strcspn 3 , 142.Xr strpbrk 3 , 143.Xr strrchr 3 , 144.Xr strsep 3 , 145.Xr strspn 3 , 146.Xr strstr 3 147.Sh STANDARDS 148The 149.Fn strtok 150function 151conforms to 152.St -ansiC . 153.Sh BUGS 154The System V 155.Fn strtok , 156if handed a string containing only delimiter characters, 157will not alter the next starting point, so that a call to 158.Fn strtok 159with a different (or empty) delimiter string 160may return a 161.Pf non- Dv NULL 162value. 163Since this implementation always alters the next starting point, 164such a sequence of calls would always return 165.Dv NULL . 166.Sh AUTHORS 167.An Wes Peters, Softweyr LLC: Aq wes@softweyr.com 168.br 169Based on the 170.Fx 3.0 171implementation. 172