lib/libc/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 .\" 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 .\"     @(#)bstring.3   8.1 (Berkeley) 6/4/93
  31 .\" $FreeBSD: src/lib/libc/string/bstring.3,v 1.8 2007/01/09 00:28:11 imp Exp $
  32 .\" $DragonFly: src/lib/libc/string/bstring.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  33 .\"
  34 .Dd June 4, 1993
  35 .Dt BSTRING 3
  36 .Os
  37 .Sh NAME
  38 .Nm bcmp ,
  39 .Nm bcopy ,
  40 .Nm bzero ,
  41 .Nm memccpy ,
  42 .Nm memchr ,
  43 .Nm memcmp ,
  44 .Nm memcpy ,
  45 .Nm memmove ,
  46 .Nm memset
  47 .Nd byte string operations
  48 .Sh LIBRARY
  49 .Lb libc
  50 .Sh SYNOPSIS
  51 .In string.h
  52 .Ft int
  53 .Fn bcmp "const void *b1" "const void *b2" "size_t len"
  54 .Ft void
  55 .Fn bcopy "const void *src" "void *dst" "size_t len"
  56 .Ft void
  57 .Fn bzero "void *b" "size_t len"
  58 .Ft void *
  59 .Fn memchr "const void *b" "int c" "size_t len"
  60 .Ft int
  61 .Fn memcmp "const void *b1" "const void *b2" "size_t len"
  62 .Ft void *
  63 .Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
  64 .Ft void *
  65 .Fn memcpy "void *dst" "const void *src" "size_t len"
  66 .Ft void *
  67 .Fn memmove "void *dst" "const void *src" "size_t len"
  68 .Ft void *
  69 .Fn memset "void *b" "int c" "size_t len"
  70 .Sh DESCRIPTION
  71 These functions operate on variable length strings of bytes.
  72 They do not check for terminating null bytes as the routines
  73 listed in
  74 .Xr string 3
  75 do.
  76 .Pp
  77 See the specific manual pages for more information.
  78 .Sh SEE ALSO
  79 .Xr bcmp 3 ,
  80 .Xr bcopy 3 ,
  81 .Xr bzero 3 ,
  82 .Xr memccpy 3 ,
  83 .Xr memchr 3 ,
  84 .Xr memcmp 3 ,
  85 .Xr memcpy 3 ,
  86 .Xr memmove 3 ,
  87 .Xr memset 3
  88 .Sh STANDARDS
  89 The functions
  90 .Fn memchr ,
  91 .Fn memcmp ,
  92 .Fn memcpy ,
  93 .Fn memmove ,
  94 and
  95 .Fn memset
  96 conform to
  97 .St -isoC .
  98 .Sh HISTORY
  99 The functions
 100 .Fn bzero
 101 and
 102 .Fn memccpy
 103 appeared in
 104 .Bx 4.3 ;
 105 the functions
 106 .Fn bcmp ,
 107 .Fn bcopy ,
 108 appeared in
 109 .Bx 4.2 .