diff options
Diffstat (limited to 'sys-utils/blkzone.8')
-rw-r--r-- | sys-utils/blkzone.8 | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/sys-utils/blkzone.8 b/sys-utils/blkzone.8 new file mode 100644 index 0000000..bf7f15f --- /dev/null +++ b/sys-utils/blkzone.8 @@ -0,0 +1,109 @@ +.TH BLKZONE 8 "February 2017" "util-linux" "System Administration" +.SH NAME +blkzone \- run zone command on a device +.SH SYNOPSIS +.B blkzone +.I command +[options] +.I device +.SH DESCRIPTION +.B blkzone +is used to run zone command on device that support the Zoned Block Commands +(ZBC) or Zoned-device ATA Commands (ZAC). The zones to operate on can be +specified using the offset, count and length options. +.PP +The +.I device +argument is the pathname of the block device. +.SH COMMANDS +.SS report +The command \fBblkzone report\fP is used to report device zone information. +.PP +By default, the command will report all zones from the start of the +block device. Options may be used to modify this behavior, changing the +starting zone or the size of the report, as explained below. + +.B Report output +.TS +tab(:); +l l. +start:Zone start sector +len:Zone length in number of sectors +wptr:Zone write pointer position +reset:Reset write pointer recommended +non-seq:Non-sequential write resources active +cond:Zone condition +type:Zone type +.TE + +.B Zone conditions +.TS +tab(:); +l l. +cl:Closed +nw:Not write pointer +em:Empty +fu:Full +oe:Explicitly opened +oi:Implicitly opened +ol:Offline +ro:Read only +x?:Reserved conditions (should not be reported) +.TE + +.SS reset +The command \fBblkzone reset\fP is used to reset one or more zones. Unlike +.BR sg_reset_wp (8), +this command operates from the block layer and can reset a range of zones. +.PP +By default, the command will operate from the zone at device +sector 0 and reset all zones. Options may be used to modify this behavior +as well as specify the operation to be performed on the zone, as explained below. + +.SH OPTIONS +The +.I offset +and +.I length +option 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. +Additionally, the 0x prefix can be used to specify \fIoffset\fR and +\fIlength\fR in hex. +.TP +.BR \-o , " \-\-offset "\fIsector\fP +The starting zone specified as a sector offset. The provided offset in sector +units (512 bytes) should match the start of a zone. The default value is zero. +.TP +.BR \-l , " \-\-length "\fIsectors\fP +The maximum number of sectors the command should operate on. The default value +is the number of sectors remaining after \fIoffset\fR. This option cannot be +used together with the option \fB\-\-count\fP. +.TP +.BR \-c , " \-\-count "\fIcount\fP +The maximum number of zones the command should operate on. The default value +is the number of zones starting from \fIoffset\fR. This option cannot be +used together with the option \fB\-\-length\fP. +.TP +.BR \-v , " \-\-verbose" +Display the number of zones returned in the report or the range of sectors +reset.. +.TP +.BR \-V , " \-\-version" +Display version information and exit. +.TP +.BR \-h , " \-\-help" +Display help text and exit. +.SH AUTHORS +.nf +Shaun Tancheff <shaun@tancheff.com> +Karel Zak <kzak@redhat.com> +.fi +.SH SEE ALSO +.BR sg_rep_zones (8) +.SH AVAILABILITY +The blkzone command is part of the util-linux package and is available from +.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ +Linux Kernel Archive +.UE . |