Files
nwipe/man/nwipe.8

154 lines
4.8 KiB
Groff
Raw Normal View History

.TH NWIPE "8" "Sep 2025" "nwipe version 0.39" "User Commands"
2013-09-06 23:38:39 +01:00
.SH NAME
nwipe \- securely erase disks
.SH SYNOPSIS
.B nwipe
[\fIoptions\fR] [\fIdevice1\fR] [\fIdevice2\fR] ...
.SH DESCRIPTION
nwipe is a command that will securely erase disks using a variety of
2025-09-30 12:38:29 +02:00
recognized methods. It is a fork of the dwipe command used by Darik's Boot
and Nuke (DBAN). nwipe is included with partedmagic if you want a quick and
2013-09-06 23:38:39 +01:00
easy bootable CD version. nwipe was created out of a need to run the DBAN
dwipe command outside of DBAN, in order to allow its use with any host
distribution, thus giving better hardware support. It is essentially the
same as dwipe, with a few changes:
.TP
2025-09-30 12:38:29 +02:00
- pthreads is used instead of fork.
2013-09-06 23:38:39 +01:00
.TP
2025-09-30 12:38:29 +02:00
- The parted library is used to detect drives.
2013-09-06 23:38:39 +01:00
.TP
2025-09-30 12:38:29 +02:00
- The code is designed to be compiled with gcc.
.TP
2025-09-30 12:38:29 +02:00
- SIGUSR1 can be used to log the stats of the current wipe.
.TP
- Additional wiping methods and PRNGs.
2013-09-06 23:38:39 +01:00
.SH OPTIONS
.TP
\fB\-V\fR, \fB\-\-version\fR
2025-09-30 12:38:29 +02:00
Prints the version number.
2013-09-06 23:38:39 +01:00
.TP
\fB\-h\fR, \fB\-\-help\fR
2025-09-30 12:38:29 +02:00
Prints a help summary.
2013-09-06 23:38:39 +01:00
.TP
\fB\-\-autonuke\fR
If no devices have been specified on the command line, starts wiping all
devices immediately. If devices have been specified, starts wiping only
those specified devices immediately.
.TP
\fB\-\-autopoweroff\fR
2023-10-01 23:52:38 +02:00
Power off system on completion of wipe delayed for one minute. During
this one minute delay you can abort the shutdown by typing sudo shutdown -c
.TP
2020-12-18 10:13:35 +01:00
\fB\-\-sync\fR=\fINUM\fR
2025-09-30 12:38:29 +02:00
Will perform a syn after NUM writes (default: 100000).
2020-12-18 10:13:35 +01:00
.IP
0 \- fdatasync after the disk is completely written
fdatasync errors not detected until completion.
0 is not recommended as disk errors may cause nwipe
2025-09-30 12:38:29 +02:00
to appear to hang.
2020-12-18 10:13:35 +01:00
.IP
2025-09-30 12:38:29 +02:00
1 \- fdatasync after every write.
2020-12-18 10:13:35 +01:00
Warning: Lower values will reduce wipe speeds.
.IP
2025-09-30 12:38:29 +02:00
1000 \- fdatasync after 1000 writes.
2013-09-06 23:38:39 +01:00
.TP
\fB\-\-noblank\fR
Do not perform the final blanking pass after the wipe (default is to blank,
except when the method is RCMP TSSIT OPS\-II).
.TP
2013-09-06 23:38:39 +01:00
\fB\-\-nowait\fR
Do not wait for a key before exiting (default is to wait).
.TP
\fB\-\-nosignals\fR
Do not allow signals to interrupt a wipe (default is to allow).
.TP
\fB\-\-nousb\fR
Do not show or wipe any USB devices, whether in GUI, --nogui or autonuke
mode. (default is to allow USB devices to be shown and wiped).
.TP
2013-09-06 23:38:39 +01:00
\fB\-\-nogui\fR
Do not show the GUI interface. Can only be used with the autonuke option.
Nowait option is automatically invoked with the nogui option.
SIGUSR1 can be used to retrieve the current wiping statistics.
2013-09-06 23:38:39 +01:00
.TP
\fB\-\-pdftag\fR
Enables a field on the PDF that holds a tag that identifies the host computer
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Log more messages, useful for debugging.
.TP
2013-09-06 23:38:39 +01:00
\fB\-\-verify\fR=\fITYPE\fR
2025-09-30 12:38:29 +02:00
Whether to perform verification of erasure (default: last).
.IP
2025-09-30 12:38:29 +02:00
off \- Do not verify.
.IP
2025-09-30 12:38:29 +02:00
last \- Verify after the last pass.
.IP
2025-09-30 12:38:29 +02:00
all \- Verify every pass.
.IP
Please mind that HMG IS5 enhanced always verifies the last (PRNG) pass
regardless of this option.
2013-09-06 23:38:39 +01:00
.TP
\fB\-m\fR, \fB\-\-method\fR=\fIMETHOD\fR
The wiping method (default: dodshort).
.IP
dod522022m / dod \- 7 pass DOD 5220.22\-M method
.IP
dodshort / dod3pass \- 3 pass DOD method
.IP
gutmann \- Peter Gutmann's algorithm
2013-09-06 23:38:39 +01:00
.IP
ops2 \- RCMP TSSIT OPS\-II
.IP
random / prng / stream \- PRNG Stream
.IP
2025-09-19 07:27:35 +02:00
zero / quick \- Overwrite with zeros (0x00)
2019-11-13 18:35:12 -05:00
.IP
2025-09-19 07:27:35 +02:00
one \- Overwrite with ones (0xFF)
.IP
2025-09-19 07:27:35 +02:00
verify_zero \- Verifies disk is zero (0x00) filled
2021-10-28 21:50:19 +01:00
.IP
2025-09-19 07:27:35 +02:00
verify_one \- Verifies disk is one (0xFF) filled
.IP
is5enh \- HMG IS5 enhanced
.IP
2025-09-19 07:27:35 +02:00
bruce7 \- Schneier Bruce 7-pass mixed pattern
2013-09-06 23:38:39 +01:00
.TP
\fB\-l\fR, \fB\-\-logfile\fR=\fIFILE\fR
2025-09-30 12:38:29 +02:00
Filename to log to. Default is STDOUT.
2013-09-06 23:38:39 +01:00
.TP
2023-10-02 20:28:49 +02:00
\fB\-P\fR, \fB\-\-PDFreportpath\fR=\fIDIR\fR
Directory to write the PDF nwipe reports/certificates to.
Defaults to ".".
If \fIDIR\fR is set to \fInoPDF\fR no report PDF files are written.
.TP
2013-09-06 23:38:39 +01:00
\fB\-p\fR, \fB\-\-prng\fR=\fIMETHOD\fR
2025-09-30 12:38:29 +02:00
The PRNG option (default: xoroshiro256_prng).
(mersenne|twister|isaac|isaac64|add_lagg_fibonacci_prng|xoroshiro256_prng)
2013-09-06 23:38:39 +01:00
.TP
\fB\-q\fR, \fB\-\-quiet\fR
2025-09-30 12:38:29 +02:00
Anonymize serial numbers, GUI & logs display:
XXXXXXXX = S/N obtained & anonymized.
???????? = S/N not available.
.TP
2013-09-06 23:38:39 +01:00
\fB\-r\fR, \fB\-\-rounds\fR=\fINUM\fR
2025-09-30 12:38:29 +02:00
Number of times to wipe the device using the selected method (default: 1).
.TP
\fB\-e\fR, \fB\-\-exclude\fR=\fIDEVICES\fR
Up to ten comma separated devices to be excluded, examples:
--exclude=/dev/sdc
--exclude=/dev/sdc,/dev/sdd
2024-04-05 05:36:06 +08:00
--exclude=/dev/sdc,/dev/sdd,/dev/mapper/cryptswap1
2013-09-06 23:38:39 +01:00
.SH BUGS
2025-09-30 12:38:29 +02:00
Please see the GitHub site for the latest list:
2017-02-12 19:05:36 +01:00
(https://github.com/martijnvanbrummelen/nwipe/issues)
2013-09-06 23:38:39 +01:00
.SH AUTHOR
2025-09-30 12:38:29 +02:00
nwipe is developed by Martijn van Brummelen <github@brumit.nl>.
2013-09-06 23:38:39 +01:00
.SH "SEE ALSO"
.BR shred (1),
.BR dwipe (1),
.BR dd (1),
.BR dcfldd (1),
.BR dc3dd (1)