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

116 lines
3.0 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.
.\" 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.
.\"
.\" @(#)index.3 8.1 (Berkeley) 6/4/93
$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
.\"
index(3): Mention that index/rindex are deprecated and not specified by POSIX.1-2008. MFC after: 1 week
2011-03-20 20:53:55 +00:00
.Dd March 20, 2011
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Dt INDEX 3
.Os
.Sh NAME
* 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
.Nm index , rindex
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
- Update the manual pages of index() and rindex() to show <strings.h> as the associated header file. The prototypes have been moved there from <string.h> because POSIX.1-2001 said so. - Conditionally include either <strings.h> or <string.h> based on whether the [r]index() or str[r]chr() functions are compiled, respectively. - Style(9) tells us to - put a space after the return keyword - to check for a NUL character without using the ! operator. - use NULL instead of (type *)NULL where the compiler knows the type. Apply these rules. - Rather use ANSI-C function definitions than K&R ones. - For index(3), correct second function argument's type; it was declared to be a `const char' before and is now an `int'.
2002-08-30 19:42:07 +00:00
.In strings.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 index "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 rindex "const char *s" "int c"
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh DESCRIPTION
index(3): Mention that index/rindex are deprecated and not specified by POSIX.1-2008. MFC after: 1 week
2011-03-20 20:53:55 +00:00
.Bf -symbolic
The
.Fn index
and
.Fn rindex
functions have been deprecated in favor of
.Xr strchr 3
and
.Xr strrchr 3 .
.Ef
.Pp
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
The
.Fn index
function
* 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
locates the first occurrence of
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fa c
(converted to a
mdoc(7) police: Fixed abuses of the .Ar and .Em macros.
2002-12-18 13:33:04 +00:00
.Vt char )
* 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
in the string pointed to by
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +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 rindex
function is identical to
.Fn index ,
except it locates the last occurrence of
.Fa c .
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
.Fn index
and
.Fn rindex
return a pointer to the located character, or
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Dv NULL
* 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
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 ,
.Xr strchr 3 ,
.Xr strcspn 3 ,
.Xr strpbrk 3 ,
.Xr strrchr 3 ,
.Xr strsep 3 ,
.Xr strspn 3 ,
.Xr strstr 3 ,
.Xr strtok 3
.Sh HISTORY
* 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
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fn index
* 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 rindex
functions appeared in
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.At v6 .
* 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
Their prototypes existed previously in
mdoc(7): Use the new feature of the .In macro.
2003-09-08 19:57:22 +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
before they were moved to
mdoc(7): Use the new feature of the .In macro.
2003-09-08 19:57:22 +00:00
.In strings.h
- Update the manual pages of index() and rindex() to show <strings.h> as the associated header file. The prototypes have been moved there from <string.h> because POSIX.1-2001 said so. - Conditionally include either <strings.h> or <string.h> based on whether the [r]index() or str[r]chr() functions are compiled, respectively. - Style(9) tells us to - put a space after the return keyword - to check for a NUL character without using the ! operator. - use NULL instead of (type *)NULL where the compiler knows the type. Apply these rules. - Rather use ANSI-C function definitions than K&R ones. - For index(3), correct second function argument's type; it was declared to be a `const char' before and is now an `int'.
2002-08-30 19:42:07 +00:00
for
.St -p1003.1-2001
compliance.
index(3): Mention that index/rindex are deprecated and not specified by POSIX.1-2008. MFC after: 1 week
2011-03-20 20:53:55 +00:00
The functions are not specified by
.St -p1003.1-2008 .
Reference in New Issue Copy Permalink