string/bstring.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 .\"     @(#)bstring.3   8.1 (Berkeley) 6/4/93
  35 .\" $FreeBSD: src/lib/libc/string/bstring.3,v 1.7 2001/10/01 16:09:00 ru Exp $
  36 .\"
  37 .Dd June 4, 1993
  38 .Dt BSTRING 3
  39 .Os
  40 .Sh NAME
  41 .Nm bcmp ,
  42 .Nm bcopy ,
  43 .Nm bzero ,
  44 .Nm memccpy ,
  45 .Nm memchr ,
  46 .Nm memcmp ,
  47 .Nm memcpy ,
  48 .Nm memmove ,
  49 .Nm memset
  50 .Nd byte string operations
  51 .Sh LIBRARY
  52 .Lb libc
  53 .Sh SYNOPSIS
  54 .In strings.h
  55 .Ft int
  56 .Fo bcmp
  57 .Fa "const void *s1"
  58 .Fa "const void *s2"
  59 .Fa "size_t n"
  60 .Fc
  61 .Ft void
  62 .Fo bcopy
  63 .Fa "const void *s1"
  64 .Fa "void *s2"
  65 .Fa "size_t n"
  66 .Fc
  67 .Ft void
  68 .Fo bzero
  69 .Fa "void *s"
  70 .Fa "size_t n"
  71 .Fc
  72 .In string.h
  73 .Ft void *
  74 .Fo memccpy
  75 .Fa "void *restrict s1"
  76 .Fa "const void *restrict s2"
  77 .Fa "int c"
  78 .Fa "size_t n"
  79 .Fc
  80 .Ft void *
  81 .Fo memchr
  82 .Fa "const void *s"
  83 .Fa "int c"
  84 .Fa "size_t n"
  85 .Fc
  86 .Ft int
  87 .Fo memcmp
  88 .Fa "const void *s1"
  89 .Fa "const void *s2"
  90 .Fa "size_t n"
  91 .Fc
  92 .Ft void *
  93 .Fo memcpy
  94 .Fa "void *restrict s1"
  95 .Fa "const void *restrict s2"
  96 .Fa "size_t n"
  97 .Fc
  98 .Ft void *
  99 .Fo memmove
 100 .Fa "void *s1"
 101 .Fa "const void *s2"
 102 .Fa "size_t n"
 103 .Fc
 104 .Ft void *
 105 .Fo memset
 106 .Fa "void *s"
 107 .Fa "int c"
 108 .Fa "size_t n"
 109 .Fc
 110 .Sh DESCRIPTION
 111 These functions operate on variable length strings of bytes.
 112 They do not check for terminating null bytes, as the routines
 113 listed in
 114 .Xr string 3
 115 do.
 116 .Pp
 117 See the specific manual pages for more information.
 118 .Sh LEGACY SYNOPSIS
 119 .Fd #include <string.h>
 120 .Pp
 121 The include file
 122 .In string.h
 123 is necessary and sufficient for all functions.
 124 .Sh SEE ALSO
 125 .Xr bcmp 3 ,
 126 .Xr bcopy 3 ,
 127 .Xr bzero 3 ,
 128 .Xr memccpy 3 ,
 129 .Xr memchr 3 ,
 130 .Xr memcmp 3 ,
 131 .Xr memcpy 3 ,
 132 .Xr memmove 3 ,
 133 .Xr memset 3 ,
 134 .Xr compat 5
 135 .Sh STANDARDS
 136 The functions
 137 .Fn memchr ,
 138 .Fn memcmp ,
 139 .Fn memcpy ,
 140 .Fn memmove ,
 141 and
 142 .Fn memset
 143 conform to
 144 .St -isoC .
 145 .Sh HISTORY
 146 The functions
 147 .Fn bzero
 148 and
 149 .Fn memccpy
 150 appeared in
 151 .Bx 4.3 ;
 152 the functions
 153 .Fn bcmp ,
 154 .Fn bcopy ,
 155 appeared in
 156 .Bx 4.2 .