1.\" Copyright (c) 2001 Mike Barcroft <mike@FreeBSD.org> 2.\" Copyright (c) 1990, 1991, 1993 3.\" The Regents of the University of California. All rights reserved. 4.\" 5.\" This code is derived from software contributed to Berkeley by 6.\" Chris Torek and the American National Standards Committee X3, 7.\" on Information Processing Systems. 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.\" @(#)strstr.3 8.1 (Berkeley) 6/4/93 38.\" $FreeBSD: src/lib/libc/string/strstr.3,v 1.3.2.5 2001/12/25 00:36:53 ache Exp $ 39.\" $DragonFly: src/lib/libc/string/strstr.3,v 1.4 2004/07/08 00:27:11 hmp Exp $ 40.\" 41.Dd October 11, 2001 42.Dt STRSTR 3 43.Os 44.Sh NAME 45.Nm strstr , strcasestr , strnstr 46.Nd locate a substring in a string 47.Sh LIBRARY 48.Lb libc 49.Sh SYNOPSIS 50.In string.h 51.Ft char * 52.Fn strstr "const char *big" "const char *little" 53.Ft char * 54.Fn strcasestr "const char *big" "const char *little" 55.Ft char * 56.Fn strnstr "const char *big" "const char *little" "size_t len" 57.Sh DESCRIPTION 58The 59.Fn strstr 60function 61locates the first occurrence of the null-terminated string 62.Fa little 63in the null-terminated string 64.Fa big . 65.Pp 66The 67.Fn strcasestr 68function is similar to 69.Fn strstr , 70but ignores the case of both strings. 71.Pp 72The 73.Fn strnstr 74function 75locates the first occurrence of the null-terminated string 76.Fa little 77in the string 78.Fa big , 79where not more than 80.Fa len 81characters are searched. 82Characters that appear after a 83.Ql \e0 84character are not searched. 85Since the 86.Fn strnstr 87function is a 88.Fx 89/ 90.Dx 91specific API, it should only be used when portability is not a concern. 92.Sh RETURN VALUES 93If 94.Fa little 95is an empty string, 96.Fa big 97is returned; 98if 99.Fa little 100occurs nowhere in 101.Fa big , 102.Dv NULL 103is returned; 104otherwise a pointer to the first character of the first occurrence of 105.Fa little 106is returned. 107.Sh EXAMPLES 108The following sets the pointer 109.Va ptr 110to the 111.Qq Li Bar Baz 112portion of 113.Va largestring : 114.Bd -literal -offset indent 115const char *largestring = "Foo Bar Baz"; 116const char *smallstring = "Bar"; 117char *ptr; 118 119ptr = strstr(largestring, smallstring); 120.Ed 121.Pp 122The following sets the pointer 123.Va ptr 124to 125.Dv NULL , 126because only the first 4 characters of 127.Va largestring 128are searched: 129.Bd -literal -offset indent 130const char *largestring = "Foo Bar Baz"; 131const char *smallstring = "Bar"; 132char *ptr; 133 134ptr = strnstr(largestring, smallstring, 4); 135.Ed 136.Sh SEE ALSO 137.Xr memchr 3 , 138.Xr strchr 3 , 139.Xr strcspn 3 , 140.Xr strpbrk 3 , 141.Xr strrchr 3 , 142.Xr strsep 3 , 143.Xr strspn 3 , 144.Xr strtok 3 145.Sh STANDARDS 146The 147.Fn strstr 148function 149conforms to 150.St -isoC . 151