summaryrefslogtreecommitdiff
path: root/man/shred.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/shred.1')
-rw-r--r--man/shred.1106
1 files changed, 106 insertions, 0 deletions
diff --git a/man/shred.1 b/man/shred.1
new file mode 100644
index 0000000..7115829
--- /dev/null
+++ b/man/shred.1
@@ -0,0 +1,106 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35.
+.TH SHRED "1" "March 2007" "GNU coreutils 6.9" "User Commands"
+.SH NAME
+shred \- overwrite a file to hide its contents, and optionally delete it
+.SH SYNOPSIS
+.B shred
+[\fIOPTIONS\fR] \fIFILE \fR[...]
+.SH DESCRIPTION
+.\" Add any additional description here
+.PP
+Overwrite the specified FILE(s) repeatedly, in order to make it harder
+for even very expensive hardware probing to recover the data.
+.PP
+Mandatory arguments to long options are mandatory for short options too.
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+change permissions to allow writing if necessary
+.TP
+\fB\-n\fR, \fB\-\-iterations\fR=\fIN\fR
+Overwrite N times instead of the default (25)
+.TP
+\fB\-\-random\-source\fR=\fIFILE\fR
+get random bytes from FILE (default /dev/urandom)
+.TP
+\fB\-s\fR, \fB\-\-size\fR=\fIN\fR
+shred this many bytes (suffixes like K, M, G accepted)
+.TP
+\fB\-u\fR, \fB\-\-remove\fR
+truncate and remove file after overwriting
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+show progress
+.TP
+\fB\-x\fR, \fB\-\-exact\fR
+do not round file sizes up to the next full block;
+.IP
+this is the default for non\-regular files
+.TP
+\fB\-z\fR, \fB\-\-zero\fR
+add a final overwrite with zeros to hide shredding
+.TP
+\fB\-\-help\fR
+display this help and exit
+.TP
+\fB\-\-version\fR
+output version information and exit
+.PP
+If FILE is \-, shred standard output.
+.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 /dev/hda,
+and those files usually should not be removed. When operating on regular
+files, most people use the \fB\-\-remove\fR option.
+.PP
+CAUTION: Note that shred relies on a very important assumption:
+that the file system overwrites data in place. This is the traditional
+way to do things, but many modern file system designs do not satisfy this
+assumption. The following are examples of file systems on which shred is
+not effective, or is not guaranteed to be effective in all file system modes:
+.PP
+* log\-structured or journaled file systems, such as those supplied with
+AIX and Solaris (and JFS, ReiserFS, XFS, Ext3, etc.)
+.PP
+* file systems that write redundant data and carry on even if some writes
+fail, such as RAID\-based file systems
+.PP
+* file systems that make snapshots, such as Network Appliance's NFS server
+.PP
+* file systems that cache in temporary locations, such as NFS
+version 3 clients
+.PP
+* compressed file systems
+.PP
+In the case of ext3 file systems, the above disclaimer applies
+(and shred is thus of limited effectiveness) only in data=journal mode,
+which journals file data in addition to just metadata. In both the
+data=ordered (default) and data=writeback modes, shred works as usual.
+Ext3 journaling modes can be changed by adding the data=something option
+to the mount options for a particular file system in the /etc/fstab file,
+as documented in the mount man page (man mount).
+.PP
+In addition, file system backups and remote mirrors may contain copies
+of the file that cannot be removed, and that will allow a shredded file
+to be recovered later.
+.SH AUTHOR
+Written by Colin Plumb.
+.SH "REPORTING BUGS"
+Report bugs to <bug\-coreutils@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2007 Free Software Foundation, Inc.
+.br
+This is free software. You may redistribute copies of it under the terms of
+the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
+There is NO WARRANTY, to the extent permitted by law.
+.SH "SEE ALSO"
+The full documentation for
+.B shred
+is maintained as a Texinfo manual. If the
+.B info
+and
+.B shred
+programs are properly installed at your site, the command
+.IP
+.B info shred
+.PP
+should give you access to the complete manual.