diff options
Diffstat (limited to 'doc/rrmdir.3')
| -rw-r--r-- | doc/rrmdir.3 | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/rrmdir.3 b/doc/rrmdir.3 new file mode 100644 index 0000000..bb4be4e --- /dev/null +++ b/doc/rrmdir.3 @@ -0,0 +1,33 @@ +'\" t +.\" Copyright 2024 axtlos (axtlos@disroot.org) +.\" +.\" SPDX-License-Identifier: BSD-3-Clause + +.TH rrmdir 3 2024-07-14 "extlib" +.SH NAME +rrmdir \- recursively remove a directory +.SH LIBRARY +extlib extended standard library +.RI ( libextlib ", " \-lextlib ) +.SH SYNOPSIS +.nf +.B #define _XOPEN_SOURCE 500 +.P +.B #include <extlib.h> +.P +.BI "int rrmdir(char *pathname);" +.fi +.SH DESCRIPTION +.BR rrmdir () +loops over +.I *pathname +using +.BR nftw () +and removes every file and directory found in +.I *pathname +. +.fi +.SH RETURN VALUE +.BR rrmdir () +return zero on sucess, non-zero on error. +.\" SRC END |