original/man1/shred.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
   2 .TH SHRED "1" "January 2016" "GNU coreutils 8.25" "User Commands"
   3 .SH NAME
   4 shred \- overwrite a file to hide its contents, and optionally delete it
   5 .SH SYNOPSIS
   6 .B shred
   7 [\fI\,OPTION\/\fR]... \fI\,FILE\/\fR...
   8 .SH DESCRIPTION
   9 .\" Add any additional description here
  10 .PP
  11 Overwrite the specified FILE(s) repeatedly, in order to make it harder
  12 for even very expensive hardware probing to recover the data.
  13 .PP
  14 If FILE is \-, shred standard output.
  15 .PP
  16 Mandatory arguments to long options are mandatory for short options too.
  17 .TP
  18 \fB\-f\fR, \fB\-\-force\fR
  19 change permissions to allow writing if necessary
  20 .TP
  21 \fB\-n\fR, \fB\-\-iterations\fR=\fI\,N\/\fR
  22 overwrite N times instead of the default (3)
  23 .TP
  24 \fB\-\-random\-source\fR=\fI\,FILE\/\fR
  25 get random bytes from FILE
  26 .TP
  27 \fB\-s\fR, \fB\-\-size\fR=\fI\,N\/\fR
  28 shred this many bytes (suffixes like K, M, G accepted)
  29 .TP
  30 \fB\-u\fR
  31 truncate and remove file after overwriting
  32 .TP
  33 \fB\-\-remove\fR[=\fI\,HOW\/\fR]
  34 like \fB\-u\fR but give control on HOW to delete;  See below
  35 .TP
  36 \fB\-v\fR, \fB\-\-verbose\fR
  37 show progress
  38 .TP
  39 \fB\-x\fR, \fB\-\-exact\fR
  40 do not round file sizes up to the next full block;
  41 .IP
  42 this is the default for non\-regular files
  43 .TP
  44 \fB\-z\fR, \fB\-\-zero\fR
  45 add a final overwrite with zeros to hide shredding
  46 .TP
  47 \fB\-\-help\fR
  48 display this help and exit
  49 .TP
  50 \fB\-\-version\fR
  51 output version information and exit
  52 .PP
  53 Delete FILE(s) if \fB\-\-remove\fR (\fB\-u\fR) is specified.  The default is not to remove
  54 the files because it is common to operate on device files like \fI\,/dev/hda\/\fP,
  55 and those files usually should not be removed.
  56 The optional HOW parameter indicates how to remove a directory entry:
  57 \&'unlink' => use a standard unlink call.
  58 \&'wipe' => also first obfuscate bytes in the name.
  59 \&'wipesync' => also sync each obfuscated byte to disk.
  60 The default mode is 'wipesync', but note it can be expensive.
  61 .PP
  62 CAUTION: Note that shred relies on a very important assumption:
  63 that the file system overwrites data in place.  This is the traditional
  64 way to do things, but many modern file system designs do not satisfy this
  65 assumption.  The following are examples of file systems on which shred is
  66 not effective, or is not guaranteed to be effective in all file system modes:
  67 .PP
  68 * log\-structured or journaled file systems, such as those supplied with
  69 AIX and Solaris (and JFS, ReiserFS, XFS, Ext3, etc.)
  70 .PP
  71 * file systems that write redundant data and carry on even if some writes
  72 fail, such as RAID\-based file systems
  73 .PP
  74 * file systems that make snapshots, such as Network Appliance's NFS server
  75 .PP
  76 * file systems that cache in temporary locations, such as NFS
  77 version 3 clients
  78 .PP
  79 * compressed file systems
  80 .PP
  81 In the case of ext3 file systems, the above disclaimer applies
  82 (and shred is thus of limited effectiveness) only in data=journal mode,
  83 which journals file data in addition to just metadata.  In both the
  84 data=ordered (default) and data=writeback modes, shred works as usual.
  85 Ext3 journaling modes can be changed by adding the data=something option
  86 to the mount options for a particular file system in the \fI\,/etc/fstab\/\fP file,
  87 as documented in the mount man page (man mount).
  88 .PP
  89 In addition, file system backups and remote mirrors may contain copies
  90 of the file that cannot be removed, and that will allow a shredded file
  91 to be recovered later.
  92 .SH AUTHOR
  93 Written by Colin Plumb.
  94 .SH "REPORTING BUGS"
  95 GNU coreutils online help: <http://www.gnu.org/software/coreutils/>
  96 .br
  97 Report shred translation bugs to <http://translationproject.org/team/>
  98 .SH COPYRIGHT
  99 Copyright \(co 2016 Free Software Foundation, Inc.
 100 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
 101 .br
 102 This is free software: you are free to change and redistribute it.
 103 There is NO WARRANTY, to the extent permitted by law.
 104 .SH "SEE ALSO"
 105 Full documentation at: <http://www.gnu.org/software/coreutils/shred>
 106 .br
 107 or available locally via: info \(aq(coreutils) shred invocation\(aq