Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / string / strpbrk.3
blobeec03562382b0c064b07f5ee92148072188df3a1
1 .\" Copyright (c) 1990, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Chris Torek and the American National Standards Committee X3,
6 .\" on Information 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. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     from: @(#)strpbrk.3     8.1 (Berkeley) 6/4/93
33 .\"     $NetBSD: strpbrk.3,v 1.8 2003/08/07 16:43:52 agc Exp $
34 .\"
35 .Dd June 4, 1993
36 .Dt STRPBRK 3
37 .Os
38 .Sh NAME
39 .Nm strpbrk
40 .Nd locate multiple characters in string
41 .Sh LIBRARY
42 .Lb libc
43 .Sh SYNOPSIS
44 .In string.h
45 .Ft char *
46 .Fn strpbrk "const char *s" "const char *charset"
47 .Sh DESCRIPTION
48 The
49 .Fn strpbrk
50 function
51 locates in the nul-terminated string
52 .Fa s
53 the first occurrence of any character in the string
54 .Fa charset
55 and returns a pointer to this character.
56 If no characters from
57 .Fa charset
58 occur anywhere in
59 .Fa s
60 .Fn strpbrk
61 returns
62 .Dv NULL .
63 .Sh SEE ALSO
64 .Xr index 3 ,
65 .Xr memchr 3 ,
66 .Xr rindex 3 ,
67 .Xr strchr 3 ,
68 .Xr strcspn 3 ,
69 .Xr strrchr 3 ,
70 .Xr strsep 3 ,
71 .Xr strspn 3 ,
72 .Xr strstr 3 ,
73 .Xr strtok 3
74 .Sh STANDARDS
75 The
76 .Fn strpbrk
77 function
78 conforms to
79 .St -ansiC .