lib/libc/string/string.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\"     @(#)string.3    8.2 (Berkeley) 12/11/93
  35 .\" $FreeBSD: src/lib/libc/string/string.3,v 1.6.2.4 2001/12/14 18:33:59 ru Exp $
  36 .\" $DragonFly: src/lib/libc/string/string.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  37 .\"
  38 .Dd December 11, 1993
  39 .Dt STRING 3
  40 .Os
  41 .Sh NAME
  42 .Nm strcat ,
  43 .Nm strncat ,
  44 .Nm strchr ,
  45 .Nm strrchr ,
  46 .Nm strcmp ,
  47 .Nm strncmp ,
  48 .Nm strcasecmp ,
  49 .Nm strncasecmp ,
  50 .Nm strcpy ,
  51 .Nm strncpy ,
  52 .Nm strerror ,
  53 .Nm strlen ,
  54 .Nm strpbrk ,
  55 .Nm strsep ,
  56 .Nm strspn ,
  57 .Nm strcspn ,
  58 .Nm strstr ,
  59 .Nm strtok ,
  60 .Nm index ,
  61 .Nm rindex
  62 .Nd string specific functions
  63 .Sh LIBRARY
  64 .Lb libc
  65 .Sh SYNOPSIS
  66 .In string.h
  67 .Ft char *
  68 .Fn strcat "char *s" "const char * append"
  69 .Ft char *
  70 .Fn strncat "char *s" "const char *append" "size_t count"
  71 .Ft char *
  72 .Fn strchr "const char *s" "int c"
  73 .Ft char *
  74 .Fn strrchr "const char *s" "int c"
  75 .Ft int
  76 .Fn strcmp "const char *s1" "const char *s2"
  77 .Ft int
  78 .Fn strncmp "const char *s1" "const char *s2" "size_t count"
  79 .Ft int
  80 .Fn strcasecmp "const char *s1" "const char *s2"
  81 .Ft int
  82 .Fn strncasecmp "const char *s1" "const char *s2" "size_t count"
  83 .Ft char *
  84 .Fn strcpy "char *dst" "const char *src"
  85 .Ft char *
  86 .Fn strncpy "char *dst" "const char *src" "size_t count"
  87 .Ft char *
  88 .Fn strerror "int errno"
  89 .Ft size_t
  90 .Fn strlen "const char *s"
  91 .Ft char *
  92 .Fn strpbrk "const char *s" "const char *charset"
  93 .Ft char *
  94 .Fn strsep "char **stringp" "const char *delim"
  95 .Ft size_t
  96 .Fn strspn "const char *s" "const char *charset"
  97 .Ft size_t
  98 .Fn strcspn "const char *s" "const char *charset"
  99 .Ft char *
 100 .Fn strstr "const char *big" "const char *little"
 101 .Ft char *
 102 .Fn strtok "char *s" "const char *delim"
 103 .Ft char *
 104 .Fn index "const char *s" "int c"
 105 .Ft char *
 106 .Fn rindex "const char *s" "int c"
 107 .Sh DESCRIPTION
 108 The string
 109 functions manipulate strings terminated by a
 110 null byte.
 111 .Pp
 112 See the specific manual pages for more information.
 113 For manipulating variable length generic objects as byte
 114 strings (without the null byte check), see
 115 .Xr bstring 3 .
 116 .Pp
 117 Except as noted in their specific manual pages,
 118 the string functions do not test the destination
 119 for size limitations.
 120 .Sh SEE ALSO
 121 .Xr bstring 3 ,
 122 .Xr index 3 ,
 123 .Xr rindex 3 ,
 124 .Xr strcasecmp 3 ,
 125 .Xr strcat 3 ,
 126 .Xr strchr 3 ,
 127 .Xr strcmp 3 ,
 128 .Xr strcpy 3 ,
 129 .Xr strcspn 3 ,
 130 .Xr strerror 3 ,
 131 .Xr strlen 3 ,
 132 .Xr strpbrk 3 ,
 133 .Xr strrchr 3 ,
 134 .Xr strsep 3 ,
 135 .Xr strspn 3 ,
 136 .Xr strstr 3 ,
 137 .Xr strtok 3
 138 .Sh STANDARDS
 139 The
 140 .Fn strcat ,
 141 .Fn strncat ,
 142 .Fn strchr ,
 143 .Fn strrchr ,
 144 .Fn strcmp ,
 145 .Fn strncmp ,
 146 .Fn strcpy ,
 147 .Fn strncpy ,
 148 .Fn strerror ,
 149 .Fn strlen ,
 150 .Fn strpbrk ,
 151 .Fn strsep ,
 152 .Fn strspn ,
 153 .Fn strcspn ,
 154 .Fn strstr ,
 155 and
 156 .Fn strtok
 157 functions
 158 conform to
 159 .St -isoC .