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 .\"     from: @(#)bstring.3     8.1 (Berkeley) 6/4/93
  31 .\"     $NetBSD: bstring.3,v 1.11 2007/02/17 09:04:57 wiz Exp $
  32 .\"
  33 .Dd February 9, 2007
  34 .Dt BSTRING 3
  35 .Os
  36 .Sh NAME
  37 .Nm memccpy ,
  38 .Nm memchr ,
  39 .Nm memcmp ,
  40 .Nm memcpy ,
  41 .Nm memmem ,
  42 .Nm memmove ,
  43 .Nm memset
  44 .Nd byte string operations
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In string.h
  49 .Ft void *
  50 .Fn memchr "const void *b" "int c" "size_t len"
  51 .Ft int
  52 .Fn memcmp "const void *b1" "const void *b2" "size_t len"
  53 .Ft void *
  54 .Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
  55 .Ft void *
  56 .Fn memcpy "void *dst" "const void *src" "size_t len"
  57 .Ft void *
  58 .Fn memmem "const void *block" "size_t blen" "const void *pat" "size_t plen"
  59 .Ft void *
  60 .Fn memmove "void *dst" "const void *src" "size_t len"
  61 .Ft void *
  62 .Fn memset "void *b" "int c" "size_t len"
  63 .Sh DESCRIPTION
  64 These functions operate on variable length strings of bytes.
  65 They do not check for terminating nul bytes as the routines
  66 listed in
  67 .Xr string 3
  68 do.
  69 .Pp
  70 See the specific manual pages for more information.
  71 .Sh SEE ALSO
  72 .Xr memccpy 3 ,
  73 .Xr memchr 3 ,
  74 .Xr memcmp 3 ,
  75 .Xr memcpy 3 ,
  76 .Xr memmem 3 ,
  77 .Xr memmove 3 ,
  78 .Xr memset 3
  79 .Sh STANDARDS
  80 The functions
  81 .Fn memchr ,
  82 .Fn memcmp ,
  83 .Fn memcpy ,
  84 .Fn memmove ,
  85 and
  86 .Fn memset
  87 conform to
  88 .St -ansiC .
  89 .Sh HISTORY
  90 The function
  91 .Fn memccpy
  92 appeared in
  93 .Bx 4.3 .