original/man3/index.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\" Modified Mon Apr 12 12:54:34 1993, David Metcalfe
  28 .\" Modified Sat Jul 24 19:13:52 1993, Rik Faith (faith@cs.unc.edu)
  29 .TH INDEX 3 2010-09-20 "GNU" "Linux Programmer's Manual"
  30 .SH NAME
  31 index, rindex \- locate character in string
  32 .SH SYNOPSIS
  33 .nf
  34 .B #include <strings.h>
  35 .sp
  36 .BI "char *index(const char *" s ", int " c );
  37 .sp
  38 .BI "char *rindex(const char *" s ", int " c );
  39 .fi
  40 .SH DESCRIPTION
  41 The
  42 .BR index ()
  43 function returns a pointer to the first occurrence
  44 of the character \fIc\fP in the string \fIs\fP.
  45 .PP
  46 The
  47 .BR rindex ()
  48 function returns a pointer to the last occurrence
  49 of the character \fIc\fP in the string \fIs\fP.
  50 .PP
  51 The terminating NULL character is considered to be a part of the
  52 strings.
  53 .SH "RETURN VALUE"
  54 The
  55 .BR index ()
  56 and
  57 .BR rindex ()
  58 functions return a pointer to
  59 the matched character or NULL if the character is not found.
  60 .SH "CONFORMING TO"
  61 4.3BSD; marked as LEGACY in POSIX.1-2001.
  62 POSIX.1-2008 removes the specifications of
  63 .BR index ()
  64 and
  65 .BR rindex (),
  66 recommending
  67 .BR strchr (3)
  68 and
  69 .BR strrchr (3)
  70 instead.
  71 .SH "SEE ALSO"
  72 .BR memchr (3),
  73 .BR strchr (3),
  74 .BR string (3),
  75 .BR strpbrk (3),
  76 .BR strrchr (3),
  77 .BR strsep (3),
  78 .BR strspn (3),
  79 .BR strstr (3),
  80 .BR strtok (3)