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. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     from: @(#)string.3      8.2 (Berkeley) 12/11/93
  31 .\"     $NetBSD: string.3,v 1.16 2009/05/01 17:27:01 perry Exp $
  32 .\"
  33 .Dd May 1, 2009
  34 .Dt STRING 3
  35 .Os
  36 .Sh NAME
  37 .Nm stpcpy ,
  38 .Nm stpncpy ,
  39 .Nm strcat ,
  40 .Nm strlcat ,
  41 .Nm strncat ,
  42 .Nm strchr ,
  43 .Nm strrchr ,
  44 .Nm strcmp ,
  45 .Nm strncmp ,
  46 .Nm strcasecmp ,
  47 .Nm strncasecmp ,
  48 .Nm strcoll ,
  49 .Nm strcpy ,
  50 .Nm strlcpy ,
  51 .Nm strncpy ,
  52 .Nm strerror ,
  53 .Nm strerror_r ,
  54 .Nm strlen ,
  55 .Nm strnlen ,
  56 .Nm strpbrk ,
  57 .Nm strsep ,
  58 .Nm stresep ,
  59 .Nm strspn ,
  60 .Nm strcspn ,
  61 .Nm strdup ,
  62 .Nm strndup ,
  63 .Nm strstr ,
  64 .Nm strcasestr ,
  65 .Nm strtok ,
  66 .Nm strtok_r ,
  67 .Nm strxfrm
  68 .Nd string specific functions
  69 .Sh LIBRARY
  70 .Lb libc
  71 .Sh SYNOPSIS
  72 .In string.h
  73 .Ft char *
  74 .Fn stpcpy "char *dst" "const char *src"
  75 .Ft char *
  76 .Fn stpncpy "char *dst" "const char *src" "size_t count"
  77 .Ft char *
  78 .Fn strcat "char *s" "const char * append"
  79 .Ft size_t
  80 .Fn strlcat "char *dst" "const char *src" "size_t size"
  81 .Ft char *
  82 .Fn strncat "char *s" "const char *append" "size_t count"
  83 .Ft char *
  84 .Fn strchr "const char *s" "int c"
  85 .Ft char *
  86 .Fn strrchr "const char *s" "int c"
  87 .Ft int
  88 .Fn strcmp "const char *s1" "const char *s2"
  89 .Ft int
  90 .Fn strncmp "const char *s1" "const char *s2" "size_t count"
  91 .Ft int
  92 .Fn strcasecmp "const char *s1" "const char *s2"
  93 .Ft int
  94 .Fn strncasecmp "const char *s1" "const char *s2" "size_t count"
  95 .Ft int
  96 .Fn strcoll "const char *s1" "const char *s2"
  97 .Ft char *
  98 .Fn strcpy "char *dst" "const char *src"
  99 .Ft size_t
 100 .Fn strlcpy "char *dst" "const char *src" "size_t size"
 101 .Ft char *
 102 .Fn strncpy "char *dst" "const char *src" "size_t count"
 103 .Ft char *
 104 .Fn strerror "int errno"
 105 .Ft int
 106 .Fn strerror_r "int errnum" "char *strerrbuf" "size_t buflen"
 107 .Ft size_t
 108 .Fn strlen "const char *s"
 109 .Ft size_t
 110 .Fn strnlen "const char *s" "size_t count"
 111 .Ft char *
 112 .Fn strpbrk "const char *s" "const char *charset"
 113 .Ft char *
 114 .Fn strsep "char **stringp" "const char *delim"
 115 .Ft char *
 116 .Fn stresep "char **stringp" "const char *delim" "int escape"
 117 .Ft size_t
 118 .Fn strspn "const char *s" "const char *charset"
 119 .Ft size_t
 120 .Fn strcspn "const char *s" "const char *charset"
 121 .Ft char *
 122 .Fn strdup "const char *str"
 123 .Ft char *
 124 .Fn strndup "const char *str" "size_t len"
 125 .Ft char *
 126 .Fn strstr "const char *big" "const char *little"
 127 .Ft char *
 128 .Fn strcasestr "const char *big" "const char *little"
 129 .Ft char *
 130 .Fn strtok "char *s" "const char *delim"
 131 .Ft char *
 132 .Fn strtok_r "char *s" "const char *delim" "char **lasts"
 133 .Ft size_t
 134 .Fn strxfrm "char *dst" "const char *src" "size_t n"
 135 .Sh DESCRIPTION
 136 The string
 137 functions manipulate strings terminated by a
 138 nul byte.
 139 .Pp
 140 See the specific manual pages for more information.
 141 For manipulating variable length generic objects as byte
 142 strings (without the nul byte check), see
 143 .Xr bstring 3 .
 144 .Pp
 145 Except as noted in their specific manual pages,
 146 the string functions do not test the destination
 147 for size limitations.
 148 .Sh SEE ALSO
 149 .Xr bstring 3 ,
 150 .Xr strcat 3 ,
 151 .Xr strchr 3 ,
 152 .Xr strcmp 3 ,
 153 .Xr strcoll 3 ,
 154 .Xr strcpy 3 ,
 155 .Xr strcspn 3 ,
 156 .Xr strdup 3 ,
 157 .Xr strerror 3 ,
 158 .Xr strings 3 ,
 159 .Xr strlcat 3 ,
 160 .Xr strlen 3 ,
 161 .Xr strpbrk 3 ,
 162 .Xr strrchr 3 ,
 163 .Xr strsep 3 ,
 164 .Xr strspn 3 ,
 165 .Xr strstr 3 ,
 166 .Xr strtok 3 ,
 167 .Xr strxfrm 3
 168 .Sh STANDARDS
 169 The
 170 .Fn strcat ,
 171 .Fn strncat ,
 172 .Fn strchr ,
 173 .Fn strrchr ,
 174 .Fn strcmp ,
 175 .Fn strncmp ,
 176 .Fn strcpy ,
 177 .Fn strncpy ,
 178 .Fn strcoll ,
 179 .Fn strerror ,
 180 .Fn strlen ,
 181 .Fn strpbrk ,
 182 .Fn strsep ,
 183 .Fn strspn ,
 184 .Fn strcspn ,
 185 .Fn strstr ,
 186 .Fn strtok ,
 187 and
 188 .Fn strxfrm
 189 functions conform to
 190 .St -ansiC .
 191 .Pp
 192 The
 193 .Fn strtok_r
 194 function conforms to
 195 .St -p1003.1c-95 .
 196 .Pp
 197 The
 198 .Fn strerror_r
 199 function conform to
 200 .St -p1003.1-2001 .