xref: /minix3/lib/libc/string/index.3 (revision f14fb602092e015ff630df58e17c2a9cd57d29b3)
12fe8fb19SBen Gras.\" Copyright (c) 1990, 1991, 1993
22fe8fb19SBen Gras.\"	The Regents of the University of California.  All rights reserved.
32fe8fb19SBen Gras.\"
42fe8fb19SBen Gras.\" This code is derived from software contributed to Berkeley by
52fe8fb19SBen Gras.\" Chris Torek.
62fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
72fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
82fe8fb19SBen Gras.\" are met:
92fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
102fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
112fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
122fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
132fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
142fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
152fe8fb19SBen Gras.\"    may be used to endorse or promote products derived from this software
162fe8fb19SBen Gras.\"    without specific prior written permission.
172fe8fb19SBen Gras.\"
182fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
192fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
202fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
212fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
222fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
232fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
242fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
252fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
262fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
272fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
282fe8fb19SBen Gras.\" SUCH DAMAGE.
292fe8fb19SBen Gras.\"
302fe8fb19SBen Gras.\"     from: @(#)index.3	8.1 (Berkeley) 6/4/93
31*f14fb602SLionel Sambuc.\"	$NetBSD: index.3,v 1.15 2012/05/05 21:18:43 dholland Exp $
322fe8fb19SBen Gras.\"
33*f14fb602SLionel Sambuc.Dd May 5, 2012
342fe8fb19SBen Gras.Dt INDEX 3
352fe8fb19SBen Gras.Os
362fe8fb19SBen Gras.Sh NAME
372fe8fb19SBen Gras.Nm index
382fe8fb19SBen Gras.Nd locate character in string
392fe8fb19SBen Gras.Sh LIBRARY
402fe8fb19SBen Gras.Lb libc
412fe8fb19SBen Gras.Sh SYNOPSIS
422fe8fb19SBen Gras.In strings.h
432fe8fb19SBen Gras.Ft char *
442fe8fb19SBen Gras.Fn index "const char *s" "int c"
452fe8fb19SBen Gras.Sh DESCRIPTION
462fe8fb19SBen GrasThe
472fe8fb19SBen Gras.Fn index
482fe8fb19SBen Grasfunction
492fe8fb19SBen Graslocates the first character matching
502fe8fb19SBen Gras.Fa c
512fe8fb19SBen Gras(converted to a
522fe8fb19SBen Gras.Em char )
532fe8fb19SBen Grasin the nul-terminated string
542fe8fb19SBen Gras.Fa s .
55*f14fb602SLionel Sambuc.Pp
56*f14fb602SLionel SambucThis function is obsolete.
57*f14fb602SLionel SambucThe equivalent function
58*f14fb602SLionel Sambuc.Xr strchr 3
59*f14fb602SLionel Sambucshould be used instead.
602fe8fb19SBen Gras.Sh RETURN VALUES
612fe8fb19SBen GrasA pointer to the character is returned if it is found; otherwise
622fe8fb19SBen Gras.Dv NULL
632fe8fb19SBen Grasis returned.
642fe8fb19SBen GrasIf
652fe8fb19SBen Gras.Fa c
662fe8fb19SBen Grasis '\e0',
672fe8fb19SBen Gras.Fn index
682fe8fb19SBen Graslocates the terminating '\e0'.
692fe8fb19SBen Gras.Sh SEE ALSO
702fe8fb19SBen Gras.Xr memchr 3 ,
712fe8fb19SBen Gras.Xr rindex 3 ,
722fe8fb19SBen Gras.Xr strchr 3 ,
732fe8fb19SBen Gras.Xr strcspn 3 ,
742fe8fb19SBen Gras.Xr strpbrk 3 ,
752fe8fb19SBen Gras.Xr strrchr 3 ,
762fe8fb19SBen Gras.Xr strsep 3 ,
772fe8fb19SBen Gras.Xr strspn 3 ,
782fe8fb19SBen Gras.Xr strstr 3 ,
792fe8fb19SBen Gras.Xr strtok 3
802fe8fb19SBen Gras.Sh STANDARDS
812fe8fb19SBen GrasThe
822fe8fb19SBen Gras.Fn index
832fe8fb19SBen Grasfunction conforms to
842fe8fb19SBen Gras.St -p1003.1-2001 .
852fe8fb19SBen GrasThe
862fe8fb19SBen Gras.St -p1003.1-2004
872fe8fb19SBen Grasrevision marked it as legacy and recommended the use of
882fe8fb19SBen Gras.Xr strchr 3
892fe8fb19SBen Grasinstead.
902fe8fb19SBen GrasThe
912fe8fb19SBen Gras.St -p1003.1-2008
922fe8fb19SBen Grasrevision removed
932fe8fb19SBen Gras.Fn index
942fe8fb19SBen Grasfrom the specification.
952fe8fb19SBen Gras.Sh HISTORY
962fe8fb19SBen GrasAn
972fe8fb19SBen Gras.Fn index
982fe8fb19SBen Grasfunction appeared in
992fe8fb19SBen Gras.At v6 .
100