diff options
Diffstat (limited to '')
| -rw-r--r-- | misc-utils/wipefs.8 | 166 | ||||
| -rw-r--r-- | misc-utils/wipefs.8.adoc | 114 |
2 files changed, 280 insertions, 0 deletions
diff --git a/misc-utils/wipefs.8 b/misc-utils/wipefs.8 new file mode 100644 index 0000000..6323872 --- /dev/null +++ b/misc-utils/wipefs.8 @@ -0,0 +1,166 @@ +'\" t +.\" Title: wipefs +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.20 +.\" Date: 2023-10-23 +.\" Manual: System Administration +.\" Source: util-linux 2.39.3 +.\" Language: English +.\" +.TH "WIPEFS" "8" "2023-10-23" "util\-linux 2.39.3" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +wipefs \- wipe a signature from a device +.SH "SYNOPSIS" +.sp +\fBwipefs\fP [options] \fIdevice\fP... +.sp +\fBwipefs\fP [\fB\-\-backup\fP] \fB\-o\fP \fIoffset device\fP... +.sp +\fBwipefs\fP [\fB\-\-backup\fP] \fB\-a\fP \fIdevice\fP... +.SH "DESCRIPTION" +.sp +\fBwipefs\fP can erase filesystem, raid or partition\-table signatures (magic strings) from the specified \fIdevice\fP to make the signatures invisible for libblkid. \fBwipefs\fP does not erase the filesystem itself nor any other data from the device. +.sp +When used without any options, \fBwipefs\fP lists all visible filesystems and the offsets of their basic signatures. The default output is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using \fB\-\-output\fP \fIcolumns\-list\fP in environments where a stable output is required. +.sp +\fBwipefs\fP calls the \fBBLKRRPART\fP ioctl when it has erased a partition\-table signature to inform the kernel about the change. The ioctl is called as the last step and when all specified signatures from all specified devices are already erased. This feature can be used to wipe content on partitions devices as well as partition table on a disk device, for example by \fBwipefs \-a /dev/sdc1 /dev/sdc2 /dev/sdc\fP. +.sp +Note that some filesystems and some partition tables store more magic strings on the device (e.g., FAT, ZFS, GPT). The \fBwipefs\fP command (since v2.31) lists all the offset where a magic strings have been detected. +.sp +When option \fB\-a\fP is used, all magic strings that are visible for \fBlibblkid\fP(3) are erased. In this case the \fBwipefs\fP scans the device again after each modification (erase) until no magic string is found. +.sp +Note that by default \fBwipefs\fP does not erase nested partition tables on non\-whole disk devices. For this the option \fB\-\-force\fP is required. +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-all\fP +.RS 4 +Erase all available signatures. The set of erased signatures can be restricted with the \fB\-t\fP option. +.RE +.sp +\fB\-b\fP, \fB\-\-backup\fP +.RS 4 +Create a signature backup to the file \fI$HOME/wipefs\-<devname>\-<offset>.bak\fP. For more details see the \fBEXAMPLE\fP section. +.RE +.sp +\fB\-f\fP, \fB\-\-force\fP +.RS 4 +Force erasure, even if the filesystem is mounted. This is required in order to erase a partition\-table signature on a block device. +.RE +.sp +\fB\-J\fP, \fB\-\-json\fP +.RS 4 +Use JSON output format. +.RE +.sp +\fB\-\-lock\fP[=\fImode\fP] +.RS 4 +Use exclusive BSD lock for device or file it operates. The optional argument \fImode\fP can be \fByes\fP, \fBno\fP (or 1 and 0) or \fBnonblock\fP. If the \fImode\fP argument is omitted, it defaults to \fB"yes"\fP. This option overwrites environment variable \fB$LOCK_BLOCK_DEVICE\fP. The default is not to use any lock at all, but it\(cqs recommended to avoid collisions with udevd or other tools. +.RE +.sp +\fB\-i\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line. +.RE +.sp +\fB\-O\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Specify which output columns to print. Use \fB\-\-help\fP to get a list of all supported columns. +.RE +.sp +\fB\-n\fP, \fB\-\-no\-act\fP +.RS 4 +Causes everything to be done except for the \fBwrite\fP(2) call. +.RE +.sp +\fB\-o\fP, \fB\-\-offset\fP \fIoffset\fP +.RS 4 +Specify the location (in bytes) of the signature which should be erased from the device. The \fIoffset\fP number may include a "0x" prefix; then the number will be interpreted as a hex value. It is possible to specify multiple \fB\-o\fP options. +.sp +The \fIoffset\fP argument may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB"), or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. +.RE +.sp +\fB\-p\fP, \fB\-\-parsable\fP +.RS 4 +Print out in parsable instead of printable format. Encode all potentially unsafe characters of a string to the corresponding hex value prefixed by \*(Aq\(rsx\*(Aq. +.RE +.sp +\fB\-q\fP, \fB\-\-quiet\fP +.RS 4 +Suppress any messages after a successful signature wipe. +.RE +.sp +\fB\-t\fP, \fB\-\-types\fP \fIlist\fP +.RS 4 +Limit the set of printed or erased signatures. More than one type may be specified in a comma\-separated list. The list or individual types can be prefixed with \*(Aqno\*(Aq to specify the types on which no action should be taken. For more details see \fBmount\fP(8). +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Print version and exit. +.RE +.SH "ENVIRONMENT" +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables \fBlibblkid\fP(3) debug output. +.RE +.sp +LOCK_BLOCK_DEVICE=<mode> +.RS 4 +use exclusive BSD lock. The mode is "1" or "0". See \fB\-\-lock\fP for more details. +.RE +.SH "EXAMPLES" +.sp +\fBwipefs /dev/sda\fP* +.RS 4 +Prints information about sda and all partitions on sda. +.RE +.sp +\fBwipefs \-\-all \-\-backup /dev/sdb\fP +.RS 4 +Erases all signatures from the device \fI/dev/sdb\fP and creates a signature backup file \fI~/wipefs\-sdb\-<offset>.bak\fP for each signature. +.RE +.sp +\fBdd if=~/wipefs\-sdb\-0x00000438.bak of=/dev/sdb seek=$((0x00000438)) bs=1 conv=notrunc\fP +.RS 4 +Restores an ext2 signature from the backup file \fI~/wipefs\-sdb\-0x00000438.bak\fP. +.RE +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBblkid\fP(8), +\fBfindfs\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBwipefs\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/misc-utils/wipefs.8.adoc b/misc-utils/wipefs.8.adoc new file mode 100644 index 0000000..d53b768 --- /dev/null +++ b/misc-utils/wipefs.8.adoc @@ -0,0 +1,114 @@ +//po4a: entry man manual +// Copyright 2009 by Karel Zak. All Rights Reserved. +// This file may be copied under the terms of the GNU Public License. += wipefs(8) +:doctype: manpage +:man manual: System Administration +:man source: util-linux {release-version} +:page-layout: base +:command: wipefs + +== NAME + +wipefs - wipe a signature from a device + +== SYNOPSIS + +*wipefs* [options] _device_... + +*wipefs* [*--backup*] *-o* _offset device_... + +*wipefs* [*--backup*] *-a* _device_... + + +== DESCRIPTION + +*wipefs* can erase filesystem, raid or partition-table signatures (magic strings) from the specified _device_ to make the signatures invisible for libblkid. *wipefs* does not erase the filesystem itself nor any other data from the device. + +When used without any options, *wipefs* lists all visible filesystems and the offsets of their basic signatures. The default output is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using *--output* _columns-list_ in environments where a stable output is required. + +*wipefs* calls the *BLKRRPART* ioctl when it has erased a partition-table signature to inform the kernel about the change. The ioctl is called as the last step and when all specified signatures from all specified devices are already erased. This feature can be used to wipe content on partitions devices as well as partition table on a disk device, for example by *wipefs -a /dev/sdc1 /dev/sdc2 /dev/sdc*. + +Note that some filesystems and some partition tables store more magic strings on the device (e.g., FAT, ZFS, GPT). The *wipefs* command (since v2.31) lists all the offset where a magic strings have been detected. + +When option *-a* is used, all magic strings that are visible for *libblkid*(3) are erased. In this case the *wipefs* scans the device again after each modification (erase) until no magic string is found. + +Note that by default *wipefs* does not erase nested partition tables on non-whole disk devices. For this the option *--force* is required. + +== OPTIONS + +*-a*, *--all*:: +Erase all available signatures. The set of erased signatures can be restricted with the *-t* option. + +*-b*, *--backup*:: +Create a signature backup to the file _$HOME/wipefs-<devname>-<offset>.bak_. For more details see the *EXAMPLE* section. + +*-f*, *--force*:: +Force erasure, even if the filesystem is mounted. This is required in order to erase a partition-table signature on a block device. + +*-J*, *--json*:: +Use JSON output format. + +*--lock*[=_mode_]:: +Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *"yes"*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with udevd or other tools. + +*-i*, *--noheadings*:: +Do not print a header line. + +*-O*, *--output* _list_:: +Specify which output columns to print. Use *--help* to get a list of all supported columns. + +*-n*, *--no-act*:: +Causes everything to be done except for the *write*(2) call. + +*-o*, *--offset* _offset_:: +Specify the location (in bytes) of the signature which should be erased from the device. The _offset_ number may include a "0x" prefix; then the number will be interpreted as a hex value. It is possible to specify multiple *-o* options. ++ +The _offset_ argument may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB"), or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. + +*-p*, *--parsable*:: +Print out in parsable instead of printable format. Encode all potentially unsafe characters of a string to the corresponding hex value prefixed by '\x'. + +*-q*, *--quiet*:: +Suppress any messages after a successful signature wipe. + +*-t*, *--types* _list_:: +Limit the set of printed or erased signatures. More than one type may be specified in a comma-separated list. The list or individual types can be prefixed with 'no' to specify the types on which no action should be taken. For more details see *mount*(8). + +include::man-common/help-version.adoc[] + +== ENVIRONMENT + +LIBBLKID_DEBUG=all:: +enables *libblkid*(3) debug output. + +LOCK_BLOCK_DEVICE=<mode>:: +use exclusive BSD lock. The mode is "1" or "0". See *--lock* for more details. + +== EXAMPLES + +*wipefs /dev/sda**:: +Prints information about sda and all partitions on sda. + +*wipefs --all --backup /dev/sdb*:: +Erases all signatures from the device _/dev/sdb_ and creates a signature backup file _~/wipefs-sdb-<offset>.bak_ for each signature. + +*dd if=~/wipefs-sdb-0x00000438.bak of=/dev/sdb seek=$\((0x00000438)) bs=1 conv=notrunc*:: +Restores an ext2 signature from the backup file _~/wipefs-sdb-0x00000438.bak_. + +== AUTHORS + +mailto:kzak@redhat.com[Karel Zak] + +== SEE ALSO + +*blkid*(8), +*findfs*(8) + +include::man-common/bugreports.adoc[] + +include::man-common/footer.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] |