From d77ab463184d113ca6119403887c9f4ed0dfdf0b Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 26 Apr 2026 22:36:47 +0200 Subject: First commit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- librecrypt_wipe_str.3 | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 librecrypt_wipe_str.3 (limited to 'librecrypt_wipe_str.3') diff --git a/librecrypt_wipe_str.3 b/librecrypt_wipe_str.3 new file mode 100644 index 0000000..80aa301 --- /dev/null +++ b/librecrypt_wipe_str.3 @@ -0,0 +1,61 @@ +.TH LIBRECRYPT_WIPE_STR 3 LIBRECRYPT +.SH NAME +librecrypt_wipe_str - Securely erase a string + +.SH SYNOPSIS +.nf +#include + +void \fBlibrecrypt_wipe_str\fP(char *\fIstring\fP); +.fi +.PP +Link with +.IR -lrecrypt . + +.SH DESCRIPTION +The +.BR librecrypt_wipe_str () +function securely erases the string referenced by +.IR string . +.PP +If +.I string +is +.IR NULL , +no action is taken. + +.SH RETURN VALUES +None. + +.SH ERRORS +The +.BR librecrypt_wipe_str () +function cannot fail. + +.SH ATTRIBUTES +For an explanation of the terms used in this section, see +.BR attributes (7). +.PP +.TS +allbox; +lb lb lb +l l l. +Interface Attribute Value +T{ +.BR librecrypt_wipe_str () +T} Thread safety MT-Safe +T{ +.BR librecrypt_wipe_str () +T} Async-signal safety AS-Safe +.TE +.sp + +.SH HISTORY +The +.BR librecrypt_wipe_str () +function was introduced in version 1.0 of +.BR librecrypt . + +.SH SEE ALSO +.BR librecrypt (7), +.BR librecrypt_wipe (3) -- cgit v1.2.3-70-g09d2