Sync lib/libc/string with FreeBSD:
[dragonfly.git] / lib / libc / string / bzero.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 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 4. Neither the name of the University nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)bzero.3     8.1 (Berkeley) 6/4/93
32 .\" $FreeBSD: src/lib/libc/string/bzero.3,v 1.10 2007/01/09 00:28:11 imp Exp $
33 .\" $DragonFly: src/lib/libc/string/bzero.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
34 .\"
35 .Dd June 4, 1993
36 .Dt BZERO 3
37 .Os
38 .Sh NAME
39 .Nm bzero
40 .Nd write zeroes to a byte string
41 .Sh LIBRARY
42 .Lb libc
43 .Sh SYNOPSIS
44 .In strings.h
45 .Ft void
46 .Fn bzero "void *b" "size_t len"
47 .Sh DESCRIPTION
48 The
49 .Fn bzero
50 function
51 writes
52 .Fa len
53 zero bytes to the string
54 .Fa b .
55 If
56 .Fa len
57 is zero,
58 .Fn bzero
59 does nothing.
60 .Sh SEE ALSO
61 .Xr memset 3 ,
62 .Xr swab 3
63 .Sh HISTORY
64 A
65 .Fn bzero
66 function
67 appeared in
68 .Bx 4.3 .
69 Its prototype existed previously in
70 .In string.h
71 before it was moved to
72 .In strings.h
73 for
74 .St -p1003.1-2001
75 compliance.