Merge branch 'lsfd--close-all' of https://github.com/masatake/util-linux

[thirdparty/util-linux.git] / sys-utils / blkdiscard.8.adoc

diff --git a/sys-utils/blkdiscard.8.adoc b/sys-utils/blkdiscard.8.adoc
index 45b5c21042a4df562fc00b0131d1d26934427d8a..cf661acd9c367b359ca07ad8040d9e22480c4395 100644 (file)
--- a/sys-utils/blkdiscard.8.adoc
+++ b/sys-utils/blkdiscard.8.adoc
@@ -1,3 +1,4 @@
+//po4a: entry man manual
 = blkdiscard(8)
 :doctype: manpage
 :man manual: System Administration
@@ -11,7 +12,7 @@ blkdiscard - discard sectors on a device
 
 == SYNOPSIS
 
-*blkdiscard* _options_ [*-o* _offset_] *-l* [_length_] _device_
+*blkdiscard* [options] [*-o* _offset_] [*-l* _length_] _device_
 
 == DESCRIPTION
 
@@ -23,49 +24,64 @@ The _device_ argument is the pathname of the block device.
 
 *WARNING: All data in the discarded region on the device will be lost!*
 
+Since util-linux v2.41, fdisk has the ability to discard sectors on both partitions and unpartitioned areas using the 'T' command.
+
 == OPTIONS
 
 The _offset_ and _length_ arguments 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.
 
 *-f*, *--force*::
-  Disable all checking. Since v2.36 the block device is open in exclusive mode (O_EXCL) by default to avoid collision with mounted filesystem or another kernel subsystem. The *--force* option disables the exclusive access mode.
+Disable all checking. Since v2.36 the block device is open in exclusive mode (*O_EXCL*) by default to avoid collision with mounted filesystem or another kernel subsystem. The *--force* option disables the exclusive access mode.
 
 *-o*, *--offset* _offset_::
-  Byte offset into the device from which to start discarding. The provided value must be aligned to the device sector size. The default value is zero.
+Byte offset into the device from which to start discarding. The provided value must be aligned to the device sector size. The default value is zero.
 
 *-l*, *--length* _length_::
-  The number of bytes to discard (counting from the starting point). The provided value must be aligned to the device sector size. If the specified value extends past the end of the device, *blkdiscard* will stop at the device size boundary. The default value extends to the end of the device.
+The number of bytes to discard (counting from the starting point). The provided value must be aligned to the device sector size. If the specified value extends past the end of the device, *blkdiscard* will stop at the device size boundary. The default value extends to the end of the device.
 
 *-p*, *--step* _length_::
-  The number of bytes to discard within one iteration. The default is to discard all by one ioctl call.
+The number of bytes to discard within one iteration. The default is to discard all by one ioctl call.
+
+*-q*, *--quiet*::
+Suppress warning messages.
 
 *-s*, *--secure*::
-  Perform a secure discard. A secure discard is the same as a regular discard except that all copies of the discarded blocks that were possibly created by garbage collection must also be erased. This requires support from the device.
+Perform a secure discard. A secure discard is the same as a regular discard except that all copies of the discarded blocks that were possibly created by garbage collection must also be erased. This requires support from the device.
 
 *-z*, *--zeroout*::
-  Zero-fill rather than discard.
+Zero-fill rather than discard.
 
 *-v*, *--verbose*::
-  Display the aligned values of _offset_ and _length_. If the *--step* option is specified, it prints the discard progress every second.
+Display the aligned values of _offset_ and _length_. If the *--step* option is specified, it prints the discard progress every second.
+
+include::man-common/help-version.adoc[]
+
+== EXIT STATUS
+
+*blkdiscard* has the following exit status values:
+
+*0*::
+success
 
-*-V*, *--version*::
-  Display version information and exit.
+*1*::
+failure; incorrect invocation, permissions or any other generic error
 
-*-h*, *--help*::
-  Display help text and exit.
+*2*::
+failure; since v2.39, the device does not support discard operation
 
 == AUTHORS
 
-mailto:lczerner@redhat.com[Lukas Czerner]
+mailto:lczerner@redhat.com[Lukas Czerner],
+mailto:kzak@redhat.com[Karel Zak]
 
 == SEE ALSO
 
 *fstrim*(8)
 
-include::../man-common/bugreports.adoc[]
+include::man-common/bugreports.adoc[]
 
-include::../man-common/footer.adoc[]
+include::man-common/footer.adoc[]
 
 ifdef::translation[]
-include::../man-common/translation.adoc[]
+include::man-common/translation.adoc[]
 endif::[]