| 1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. |
| 2 | .\" All rights reserved. |
| 3 | .\" |
| 4 | .\" This code is derived from software contributed to Berkeley by |
| 5 | .\" Chris Torek. |
| 6 | .\" Redistribution and use in source and binary forms, with or without |
| 7 | .\" modification, are permitted provided that the following conditions |
| 8 | .\" are met: |
| 9 | .\" 1. Redistributions of source code must retain the above copyright |
| 10 | .\" notice, this list of conditions and the following disclaimer. |
| 11 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 12 | .\" notice, this list of conditions and the following disclaimer in the |
| 13 | .\" documentation and/or other materials provided with the distribution. |
| 14 | .\" 3. All advertising materials mentioning features or use of this software |
| 15 | .\" must display the following acknowledgement: |
| 16 | .\" This product includes software developed by the University of |
| 17 | .\" California, Berkeley and its contributors. |
| 18 | .\" 4. Neither the name of the University nor the names of its contributors |
| 19 | .\" may be used to endorse or promote products derived from this software |
| 20 | .\" without specific prior written permission. |
| 21 | .\" |
| 22 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
| 23 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 24 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 25 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
| 26 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 27 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 28 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 29 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 30 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 31 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 32 | .\" SUCH DAMAGE. |
| 33 | .\" |
| 34 | .\" @(#)index.3 5.3 (Berkeley) 4/19/91 |
| 35 | .\" |
| 36 | .Dd April 19, 1991 |
| 37 | .Dt INDEX 3 |
| 38 | .Os |
| 39 | .Sh NAME |
| 40 | .Nm index |
| 41 | .Nd locate character in string |
| 42 | .Sh SYNOPSIS |
| 43 | .Fd #include <string.h> |
| 44 | .Ft char * |
| 45 | .Fn index "const char *s" "int c" |
| 46 | .Sh DESCRIPTION |
| 47 | The |
| 48 | .Fn index |
| 49 | function |
| 50 | locates the first character matching |
| 51 | .Fa c |
| 52 | (converted to a |
| 53 | .Em char ) |
| 54 | in the null-terminated string |
| 55 | .Fa s . |
| 56 | .Sh RETURN VALUES |
| 57 | The character |
| 58 | .Fa c |
| 59 | is returned if it is found; otherwise |
| 60 | .Dv NULL |
| 61 | is returned. |
| 62 | If |
| 63 | .Fa c |
| 64 | is '\e0', |
| 65 | .Fn index |
| 66 | locates the terminating '\e0'. |
| 67 | .Sh SEE ALSO |
| 68 | .Xr memchr 3 , |
| 69 | .Xr rindex 3 , |
| 70 | .Xr strchr 3 , |
| 71 | .Xr strcspn 3 , |
| 72 | .Xr strpbrk 3 , |
| 73 | .Xr strrchr 3 , |
| 74 | .Xr strsep 3 , |
| 75 | .Xr strspn 3 , |
| 76 | .Xr strstr 3 , |
| 77 | .Xr strtok 3 |
| 78 | .Sh HISTORY |
| 79 | A |
| 80 | .Fn index |
| 81 | function appeared in |
| 82 | .At v6 . |