mirror of
https://gitlab.freedesktop.org/libbsd/libbsd.git
synced 2025-01-07 09:48:12 +01:00
f35c545847
While using fully uppercase man page titles has been the usual convention for a very long time, it is rather ugly and something that some other projects are switching away from.
78 lines
2.6 KiB
Plaintext
78 lines
2.6 KiB
Plaintext
.\" Copyright (c) 1990, 1991 The Regents of the University of California.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to Berkeley by
|
|
.\" Chris Torek.
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $OpenBSD: bzero.3,v 1.10 2014/01/22 21:06:45 tedu Exp $
|
|
.\"
|
|
.Dd $Mdocdate: January 22 2014 $
|
|
.Dt explicit_bzero 3bsd
|
|
.Os
|
|
.Sh NAME
|
|
.Nm explicit_bzero
|
|
.Nd write zeroes to a byte string
|
|
.Sh LIBRARY
|
|
.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd)
|
|
.ds doc-str-Lb-libbsd \*[str-Lb-libbsd]
|
|
.Lb libbsd
|
|
.Sh SYNOPSIS
|
|
.In string.h
|
|
(See
|
|
.Xr libbsd 7
|
|
for include usage.)
|
|
.Ft void
|
|
.Fn explicit_bzero "void *buf" "size_t len"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn explicit_bzero
|
|
function writes
|
|
.Fa len
|
|
zero bytes to the string
|
|
.Fa buf .
|
|
If
|
|
.Fa len
|
|
is zero,
|
|
.Fn explicit_bzero
|
|
does nothing.
|
|
.Pp
|
|
The
|
|
.Fn explicit_bzero
|
|
variant behaves the same as the
|
|
.Fn bzero
|
|
function, but will not be removed by a compiler's dead store optimization
|
|
pass, making it useful for clearing sensitive memory such as a password.
|
|
.Sh SEE ALSO
|
|
.Xr bzero 3 ,
|
|
.Xr memset 3 ,
|
|
.Xr swab 3
|
|
.Sh HISTORY
|
|
The
|
|
.Fn explicit_bzero
|
|
function first appeared in
|
|
.Ox 5.5 ,
|
|
glibc 2.25.
|