1.\" $OpenBSD: strsep.3,v 1.4 1998/06/15 17:55:14 mickey Exp $ 2.\" 3.\" Copyright (c) 1990, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software contributed to Berkeley by 7.\" Chris Torek. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the University of 20.\" California, Berkeley and its contributors. 21.\" 4. Neither the name of the University nor the names of its contributors 22.\" may be used to endorse or promote products derived from this software 23.\" without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35.\" SUCH DAMAGE. 36.\" 37.\" @(#)strsep.3 8.1 (Berkeley) 6/9/93 38.\" 39.Dd June 9, 1993 40.Dt STRSEP 3 41.Os 42.Sh NAME 43.Nm strsep 44.Nd separate strings 45.Sh SYNOPSIS 46.Fd #include <string.h> 47.Ft char * 48.Fn strsep "char **stringp" "char *delim" 49.Sh DESCRIPTION 50The 51.Fn strsep 52function locates, in the string referenced by 53.Fa *stringp , 54the first occurrence of any character in the string 55.Fa delim 56(or the terminating 57.Ql \e0 58character) and replaces it with a 59.Ql \e0 . 60The location of the next character after the delimiter character 61(or NULL, if the end of the string was reached) is stored in 62.Fa *stringp . 63The original value of 64.Fa *stringp 65is returned. 66.Pp 67An ``empty'' field, i.e. one caused by two adjacent delimiter characters, 68can be detected by comparing the location referenced by the pointer returned 69in 70.Fa *stringp 71to 72.Ql \e0 . 73.Pp 74If 75.Fa *stringp 76is initially 77.Dv NULL , 78.Fn strsep 79returns 80.Dv NULL . 81.Sh EXAMPLES 82The following uses 83.Fn strsep 84to parse a string, containing tokens delimited by white space, into an 85argument vector: 86.Bd -literal -offset indent 87char **ap, *argv[10], *inputstring; 88 89for (ap = argv; (*ap = strsep(&inputstring, " \et")) != NULL;) 90 if (**ap != '\e0') 91 ++ap; 92.Ed 93.Sh HISTORY 94The 95.Fn strsep 96function 97is intended as a replacement for the 98.Fn strtok 99function. 100While the 101.Fn strtok 102function should be preferred for portability reasons (it conforms to 103.St -ansiC ) 104it is unable to handle empty fields, i.e. detect fields delimited by 105two adjacent delimiter characters, or to be used for more than a single 106string at a time. 107The 108.Fn strsep 109function first appeared in 110.Bx 4.4 . 111