| Alexandre Lision | ddd731e | 2014-01-31 11:50:08 -0500 | [diff] [blame] | 1 | .\" scrub-files - securely erase files by filling with random data first. |
| 2 | .\" Copyright (c) 2010 David Sugar <dyfet@gnutelephony.org> |
| 3 | .\" |
| 4 | .\" This manual page is free software; you can redistribute it and/or modify |
| 5 | .\" it under the terms of the GNU General Public License as published by |
| 6 | .\" the Free Software Foundation; either version 3 of the License, or |
| 7 | .\" (at your option) any later version. |
| 8 | .\" |
| 9 | .\" This program is distributed in the hope that it will be useful, |
| 10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | .\" GNU General Public License for more details. |
| 13 | .\" |
| 14 | .\" You should have received a copy of the GNU General Public License |
| 15 | .\" along with this program; if not, write to the Free Software |
| 16 | .\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 17 | .\" |
| 18 | .\" This manual page is written especially for Debian GNU/Linux. |
| 19 | .\" |
| 20 | .TH scrub-files "1" "January 2010" "GNU uCommon" "GNU Telephony" |
| 21 | .SH NAME |
| 22 | scrub\-files \- securely erase files by filling with random data first. |
| 23 | .SH SYNOPSIS |
| 24 | .B scrub |
| 25 | .RI [ options ] |
| 26 | .I paths... |
| 27 | .br |
| 28 | .SH DESCRIPTION |
| 29 | This command is used to securely erase files. This is accomplished by |
| 30 | filling the file with random data in pre-sized chunks. Multiple passes |
| 31 | of random data may also be used. The pre-sized chunks are used to remove |
| 32 | information about exact original file size. Other options include random |
| 33 | renaming of the original file before deletion and the use of truncation to |
| 34 | break down meta-data on what blocks in the file system were originally |
| 35 | associated with a securely deleted file. This is specifically intended to |
| 36 | make it harder to perform forensic analysis on securely erased files. |
| 37 | .SH OPTIONS |
| 38 | .TP |
| 39 | .BI \-\-blocksize " size" |
| 40 | Set the default block size (in 1 k increments) for scrub\-files to use when |
| 41 | writing random data. This effects both the final file length, which will |
| 42 | be aligned to the specified size, and the way the truncate option decomposes |
| 43 | files. The default is 1k. |
| 44 | .TP |
| 45 | .B \-\-follow |
| 46 | Dereference and follow symlinks, erasing the target file. |
| 47 | .TP |
| 48 | .BI \-\-passes= count |
| 49 | The number of passes used when writing random data. The default is 1 pass. |
| 50 | .TP |
| 51 | .B \-\-recursive |
| 52 | If argument is a directory, recursively scan directory and any subdirectory |
| 53 | contents as arguments. |
| 54 | .TP |
| 55 | .B \-\-rename |
| 56 | Rename the file randomly before deletion to clear persistant inode data. |
| 57 | .TP |
| 58 | .B \-\-truncate |
| 59 | Decompose the file through truncation to break down file system page maps. |
| 60 | .TP |
| 61 | .B \-\-verbose |
| 62 | Display each file being processed to the console. |
| 63 | .TP |
| 64 | \fB--help\fR |
| 65 | Outputs help screen for the user. |
| 66 | .SH AUTHOR |
| 67 | .B scrub\-files |
| 68 | was written by David Sugar <dyfet@gnutelephony.org>. |
| 69 | .SH "REPORTING BUGS" |
| 70 | Report bugs to bug-commoncpp@gnu.org. |
| 71 | .SH COPYRIGHT |
| 72 | Copyright \(co 2010 David Sugar, Tycho Softworks. |
| 73 | .br |
| 74 | This is free software; see the source for copying conditions. There is NO |
| 75 | warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| 76 | PURPOSE. |
| 77 | |
| 78 | |