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