aboutsummaryrefslogtreecommitdiff
path: root/man/shred.1
blob: 8de40c1f71d6f738199de7c1fa5139922353fc0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
.TH SHRED "1" "2026-07-28" "BNU 9.11" "BNU Commands"
.SH NAME
shred \- overwrite a file to hide its contents, and optionally delete it
.SH SYNOPSIS
.B shred
[\fI\,OPTION\/\fR]... \fI\,FILE\/\fR...
.SH DESCRIPTION
.\" This page is derived from GNU Coreutils documentation.
This page documents BNU, an independent Bun implementation compatible with
GNU Coreutils 9.11.
.PP
Overwrite the specified FILE(s) repeatedly, in order to make it harder
for even very expensive hardware probing to recover the data.
.PP
If FILE is \-, shred standard output.
.PP
Mandatory arguments to long options are mandatory for short options too.
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred-f'\fB\-f, \-\-force\fP\X'tty: link'
change permissions to allow writing if necessary
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred-n'\fB\-n, \-\-iterations=\,N\fP\X'tty: link'\/\fR
overwrite N times instead of the default (3)
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred--random-source'\fB\-\-random\-source=FILE\fP\X'tty: link'
get random bytes from FILE
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred-s'\fB\-s, \-\-size=\,N\fP\X'tty: link'\/\fR
shred this many bytes (suffixes like K, M, G accepted)
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred-u'\fB\-u\fP\X'tty: link'
deallocate and remove file after overwriting
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred--remove'\fB\-\-remove[=HOW]\fP\X'tty: link'
like \fB\-u\fR but give control on HOW to delete;  See below
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred-v'\fB\-v, \-\-verbose\fP\X'tty: link'
show details of data and metadata operations performed
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred-x'\fB\-x, \-\-exact\fP\X'tty: link'
do not round file sizes up to the next full block;
this is the default for non\-regular files
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#shred-z'\fB\-z, \-\-zero\fP\X'tty: link'
add a final overwrite with zeros to hide shredding
.TP
\X'tty: link https://www.gnu.org/software/coreutils/shred#shred--help'\fB\-\-help\fP\X'tty: link'
display this help and exit
.TP
\X'tty: link https://www.gnu.org/software/coreutils/shred#shred--version'\fB\-\-version\fP\X'tty: link'
output version information and exit
.PP
Delete FILE(s) if \fB\-\-remove\fR (\fB\-u\fR) is specified.  The default is not to remove
the files because it is common to operate on device files like \fI\,/dev/hda\/\fP,
and those files usually should not be removed.
The optional HOW parameter indicates how to remove a directory entry:
\&'unlink' => use a standard unlink call.
\&'wipe' => also first obfuscate bytes in the name.
\&'wipesync' => also sync each obfuscated byte to the device.
The default mode is 'wipesync', but note it can be expensive.
.PP
CAUTION: shred assumes the file system and hardware overwrite data in place.
Although this is common, many platforms operate otherwise.  Also, backups
and mirrors may contain unremovable copies that will let a shredded file
be recovered later.  See the GNU coreutils manual for details.
.SH AUTHORS
Upstream GNU Coreutils documentation authors:
Written by Colin Plumb.
.br
Adapted for BNU; the BNU implementation is independent.
.SH "REPORTING BUGS"
Report BNU bugs at <https://github.com/Soccera1/bnu/issues>.
.br
For upstream GNU Coreutils, see <https://www.gnu.org/software/coreutils/>.
.SH COPYRIGHT
Copyright \(co 2026 Free Software Foundation, Inc.
.br
This manual page was adapted for BNU in 2026.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
Upstream documentation <https://www.gnu.org/software/coreutils/shred>
.br
BNU documentation is available locally via: info \(aq(bnu) shred invocation\(aq