Blame man3/index.3

Packit 7cfc04
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" References consulted:
Packit 7cfc04
.\"     Linux libc source code
Packit 7cfc04
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
Packit 7cfc04
.\"     386BSD man pages
Packit 7cfc04
.\" Modified Mon Apr 12 12:54:34 1993, David Metcalfe
Packit 7cfc04
.\" Modified Sat Jul 24 19:13:52 1993, Rik Faith (faith@cs.unc.edu)
Packit 7cfc04
.TH INDEX 3 2015-03-02 "GNU" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
index, rindex \- locate character in string
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <strings.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "char *index(const char *" s ", int " c );
Packit 7cfc04
.PP
Packit 7cfc04
.BI "char *rindex(const char *" s ", int " c );
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR index ()
Packit 7cfc04
function returns a pointer to the first occurrence
Packit 7cfc04
of the character \fIc\fP in the string \fIs\fP.
Packit 7cfc04
.PP
Packit 7cfc04
The
Packit 7cfc04
.BR rindex ()
Packit 7cfc04
function returns a pointer to the last occurrence
Packit 7cfc04
of the character \fIc\fP in the string \fIs\fP.
Packit 7cfc04
.PP
Packit 7cfc04
The terminating null byte (\(aq\\0\(aq) is considered to be a part of the
Packit 7cfc04
strings.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
The
Packit 7cfc04
.BR index ()
Packit 7cfc04
and
Packit 7cfc04
.BR rindex ()
Packit 7cfc04
functions return a pointer to
Packit 7cfc04
the matched character or NULL if the character is not found.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR index (),
Packit 7cfc04
.BR rindex ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
4.3BSD; marked as LEGACY in POSIX.1-2001.
Packit 7cfc04
POSIX.1-2008 removes the specifications of
Packit 7cfc04
.BR index ()
Packit 7cfc04
and
Packit 7cfc04
.BR rindex (),
Packit 7cfc04
recommending
Packit 7cfc04
.BR strchr (3)
Packit 7cfc04
and
Packit 7cfc04
.BR strrchr (3)
Packit 7cfc04
instead.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR memchr (3),
Packit 7cfc04
.BR strchr (3),
Packit 7cfc04
.BR string (3),
Packit 7cfc04
.BR strpbrk (3),
Packit 7cfc04
.BR strrchr (3),
Packit 7cfc04
.BR strsep (3),
Packit 7cfc04
.BR strspn (3),
Packit 7cfc04
.BR strstr (3),
Packit 7cfc04
.BR strtok (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.