string/FreeBSD/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 string.h
  55 .Ft int
  56 .Fn bcmp "const void *b1" "const void *b2" "size_t len"
  57 .Ft void
  58 .Fn bcopy "const void *src" "void *dst" "size_t len"
  59 .Ft void
  60 .Fn bzero "void *b" "size_t len"
  61 .Ft void *
  62 .Fn memchr "const void *b" "int c" "size_t len"
  63 .Ft int
  64 .Fn memcmp "const void *b1" "const void *b2" "size_t len"
  65 .Ft void *
  66 .Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
  67 .Ft void *
  68 .Fn memcpy "void *dst" "const void *src" "size_t len"
  69 .Ft void *
  70 .Fn memmove "void *dst" "const void *src" "size_t len"
  71 .Ft void *
  72 .Fn memset "void *b" "int c" "size_t len"
  73 .Sh DESCRIPTION
  74 These functions operate on variable length strings of bytes.
  75 They do not check for terminating null bytes as the routines
  76 listed in
  77 .Xr string 3
  78 do.
  79 .Pp
  80 See the specific manual pages for more information.
  81 .Sh SEE ALSO
  82 .Xr bcmp 3 ,
  83 .Xr bcopy 3 ,
  84 .Xr bzero 3 ,
  85 .Xr memccpy 3 ,
  86 .Xr memchr 3 ,
  87 .Xr memcmp 3 ,
  88 .Xr memcpy 3 ,
  89 .Xr memmove 3 ,
  90 .Xr memset 3
  91 .Sh STANDARDS
  92 The functions
  93 .Fn memchr ,
  94 .Fn memcmp ,
  95 .Fn memcpy ,
  96 .Fn memmove ,
  97 and
  98 .Fn memset
  99 conform to
 100 .St -isoC .
 101 .Sh HISTORY
 102 The functions
 103 .Fn bzero
 104 and
 105 .Fn memccpy
 106 appeared in
 107 .Bx 4.3 ;
 108 the functions
 109 .Fn bcmp ,
 110 .Fn bcopy ,
 111 appeared in
 112 .Bx 4.2 .