Sync lib/libc/string with FreeBSD:
[dragonfly.git] / lib / libc / string / strchr.3
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 .\" 4. 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 .\"     @(#)strchr.3    8.2 (Berkeley) 4/19/94
33 .\" $FreeBSD: src/lib/libc/string/strchr.3,v 1.13 2007/01/09 00:28:12 imp Exp $
34 .\" $DragonFly: src/lib/libc/string/strchr.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
35 .\"
36 .Dd April 19, 1994
37 .Dt STRCHR 3
38 .Os
39 .Sh NAME
40 .Nm strchr ,
41 .Nm strrchr
42 .Nd locate character in string
43 .Sh LIBRARY
44 .Lb libc
45 .Sh SYNOPSIS
46 .In string.h
47 .Ft "char *"
48 .Fn strchr "const char *s" "int c"
49 .Ft "char *"
50 .Fn strrchr "const char *s" "int c"
51 .Sh DESCRIPTION
52 The
53 .Fn strchr
54 function locates the first occurrence of
55 .Fa c
56 (converted to a
57 .Vt char )
58 in the string pointed to by
59 .Fa s .
60 The terminating null character is considered part of the string;
61 therefore if
62 .Fa c
63 is
64 .Ql \e0 ,
65 the functions locate the terminating
66 .Ql \e0 .
67 .Pp
68 The
69 .Fn strrchr
70 function is identical to
71 .Fn strchr
72 except it locates the last occurrence of
73 .Fa c .
74 .Sh RETURN VALUES
75 The functions
76 .Fn strchr
77 and
78 .Fn strrchr
79 return a pointer to the located character, or
80 .Dv NULL
81 if the character does not appear in the string.
82 .Sh SEE ALSO
83 .Xr memchr 3 ,
84 .Xr memmem 3 ,
85 .Xr strcspn 3 ,
86 .Xr strpbrk 3 ,
87 .Xr strsep 3 ,
88 .Xr strspn 3 ,
89 .Xr strstr 3 ,
90 .Xr strtok 3
91 .Sh STANDARDS
92 The functions
93 .Fn strchr
94 and
95 .Fn strrchr
96 conform to
97 .St -isoC .