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