From 1ad8ef9187ba6ca814189c0466c46fbdf483f904 Mon Sep 17 00:00:00 2001 From: Karel Zak Date: Thu, 23 Feb 2017 16:43:51 +0100 Subject: blkzone: add new command (merge blkreport and blkreset) This new command is based on the original implementation of blkreport and blkreset command. Signed-off-by: Karel Zak --- sys-utils/blkzone.8 | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 sys-utils/blkzone.8 (limited to 'sys-utils/blkzone.8') diff --git a/sys-utils/blkzone.8 b/sys-utils/blkzone.8 new file mode 100644 index 000000000..6394ed274 --- /dev/null +++ b/sys-utils/blkzone.8 @@ -0,0 +1,103 @@ +.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 are addresses by the offset +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 on up to 4k 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(:); +left 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(:); +left l l. +Cl:closed +cv:conventional zone +e0:empty +fu:full +Oe:open explicit +Oi:open implicit +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 on the zone at device logical +sector 0. Options may be used to modify this behavior as well as specify the +operation to be performed on the zone, as explained below. +.PP +The default number of zones (options \fB\-\-length\fP) is 4096, the maximum 65536. + +.SH OPTIONS +The +.I sector +and +.I count +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 \fIsector\fR and +\fIcount\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 "\fIcount\fP +The maximum number of zones to be used for the command. +.TP +.BR \-v , " \-\-verbose" +Display the number of zones returned in the report. +.TP +.BR \-V , " \-\-version" +Display version information and exit. +.TP +.BR \-h , " \-\-help" +Display help text and exit. +.SH AUTHORS +.nf +Shaun Tancheff +Karel Zak +.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 . -- cgit v1.2.3-55-g7522