d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e35c28a24b
freebsd-dev/lib/libc/string/strchr.3

126 lines
3.3 KiB
Groff
Raw Normal View History

BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\" Copyright (c) 1990, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
Renumber clauses to reduce diffs to other versions NetBSD, OpenBSD, and Android's Bionic number the clauses 1 through 3, so follow suit to make comparison easier.
2013-05-28 20:57:40 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)strchr.3 8.2 (Berkeley) 4/19/94
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\"
Add strchrnul(), a GNU function similar to strchr(), except that it returns a pointer to the end of the string, rather than NULL, if the character was not found. Approved by: theraven
2013-02-13 15:46:33 +00:00
.Dd February 13, 2013
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Dt STRCHR 3
.Os
.Sh NAME
Add strchrnul(), a GNU function similar to strchr(), except that it returns a pointer to the end of the string, rather than NULL, if the character was not found. Approved by: theraven
2013-02-13 15:46:33 +00:00
.Nm strchr , strrchr , strchrnul
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Nd locate character in string
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
.Sh LIBRARY
.Lb libc
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In string.h
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
.Ft "char *"
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fn strchr "const char *s" "int c"
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
.Ft "char *"
.Fn strrchr "const char *s" "int c"
Add strchrnul(), a GNU function similar to strchr(), except that it returns a pointer to the end of the string, rather than NULL, if the character was not found. Approved by: theraven
2013-02-13 15:46:33 +00:00
.Ft "char *"
.Fn strchrnul "const char *s" "int c"
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh DESCRIPTION
The
.Fn strchr
function locates the first occurrence of
mdoc(7) police: Fixed abuses of the .Ar and .Em macros.
2002-12-18 13:33:04 +00:00
.Fa c
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
(converted to a
.Vt char )
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
in the string pointed to by
mdoc(7) police: Fixed abuses of the .Ar and .Em macros.
2002-12-18 13:33:04 +00:00
.Fa s .
Move a sentence about the terminating \0 from the RETURN VALUES section (where it didn't really belong), to the DESCRIPTION section. English advice: ceri Requested by: das MFC after: 4 weeks
2003-09-04 20:36:54 +00:00
The terminating null character is considered part of the string;
therefore if
.Fa c
is
.Ql \e0 ,
the functions locate the terminating
.Ql \e0 .
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
.Pp
The
.Fn strrchr
function is identical to
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fn strchr
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
except it locates the last occurrence of
.Fa c .
Add strchrnul(), a GNU function similar to strchr(), except that it returns a pointer to the end of the string, rather than NULL, if the character was not found. Approved by: theraven
2013-02-13 15:46:33 +00:00
.Pp
The
.Fn strchrnul
function is identical to
.Fn strchr
except that if
.Fa c
is not found in
.Fa s
a pointer to the terminating
.Ql \e0
is returned.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh RETURN VALUES
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
The functions
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fn strchr
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
and
.Fn strrchr
return a pointer to the located character, or
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Dv NULL
if the character does not appear in the string.
Add strchrnul(), a GNU function similar to strchr(), except that it returns a pointer to the end of the string, rather than NULL, if the character was not found. Approved by: theraven
2013-02-13 15:46:33 +00:00
.Pp
.Fn strchrnul
returns a pointer to the terminating
.Ql \e0
if the character does not appear in the string.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh SEE ALSO
.Xr memchr 3 ,
Add the function memmem(3) as found in glibc and others. It is the binary equivalent to strstr(3). void *memmem(const void *big, size_t big_len, const void *little, size_t little_len); Submitted by: Pascal Gloor <pascal.gloor at spale.com> MFC after: 3 days
2005-08-25 18:26:58 +00:00
.Xr memmem 3 ,
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Xr strcspn 3 ,
.Xr strpbrk 3 ,
.Xr strsep 3 ,
.Xr strspn 3 ,
.Xr strstr 3 ,
Add wide character variants of string manipulations routines to 'SEE ALSO'. Approved by: rwatson (mentor)
2009-04-07 13:42:53 +00:00
.Xr strtok 3 ,
.Xr wcschr 3
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh STANDARDS
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
The functions
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fn strchr
* Merge index(3) and rindex(3) to index(3) since the two functions are almost identical. * Merge strchr(3) and strrchr(3) to strchr(3) since the two functions are almost identical. * Make the wording of index(3) and strchr(3) more similar. * mdoc(7) cleanup. Submitted by: SUZUKI Koichi <metal@gc5.so-net.ne.jp>, keramida, myself PR: docs/32054 Reviewed by: ru Approved by: ceri (mentor)
2003-07-28 22:50:42 +00:00
and
.Fn strrchr
conform to
.St -ansiC -> .St -isoC
2001-02-26 13:23:47 +00:00
.St -isoC .
strchr(3): Mdoc fixes.
2015-06-04 21:54:46 +00:00
The function
Add strchrnul(), a GNU function similar to strchr(), except that it returns a pointer to the end of the string, rather than NULL, if the character was not found. Approved by: theraven
2013-02-13 15:46:33 +00:00
.Fn strchrnul
strchr(3): Mdoc fixes.
2015-06-04 21:54:46 +00:00
is a
.Tn GNU
extension.
.Sh HISTORY
Add strchrnul(), a GNU function similar to strchr(), except that it returns a pointer to the end of the string, rather than NULL, if the character was not found. Approved by: theraven
2013-02-13 15:46:33 +00:00
The
.Fn strchrnul
function first appeared in glibc 2.1.1 and was added in
.Fx 10.0 .
Reference in New Issue Copy Permalink