From 9182e17618cb636eaa42096a2ea42bcdb00dd2c4 Mon Sep 17 00:00:00 2001 From: krw Date: Sun, 14 Jul 2024 16:09:06 +0000 Subject: [PATCH] Shuffle verbiage to make page more general. e.g. by mentioning nvme(4). Feedback jmc@ jmatthew@ deraadt@ kn@ ok jmc@ kn@ --- sbin/bioctl/bioctl.8 | 111 ++++++++++++++++++++++++++----------------- 1 file changed, 68 insertions(+), 43 deletions(-) diff --git a/sbin/bioctl/bioctl.8 b/sbin/bioctl/bioctl.8 index a187daf36ed..52e4333530d 100644 --- a/sbin/bioctl/bioctl.8 +++ b/sbin/bioctl/bioctl.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bioctl.8,v 1.114 2023/09/02 09:14:47 kn Exp $ +.\" $OpenBSD: bioctl.8,v 1.115 2024/07/14 16:09:06 krw Exp $ .\" .\" Copyright (c) 2004, 2005 Marco Peereboom .\" @@ -23,12 +23,12 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd $Mdocdate: September 2 2023 $ +.Dd $Mdocdate: July 14 2024 $ .Dt BIOCTL 8 .Os .Sh NAME .Nm bioctl -.Nd RAID management interface +.Nd storage management interface .Sh SYNOPSIS .Nm bioctl .Op Fl hiqv @@ -52,33 +52,57 @@ .Op Fl r Ar rounds .Ar device .Sh DESCRIPTION -RAID device drivers which support management functionality can -register their services with the -.Xr bio 4 -driver. .Nm bioctl -then can be used to maintain RAID volumes. +is used to interact with device drivers that register with +.Xr bio 4 . .Pp -In the first synopsis, -RAID controllers are managed. +The options +.Fl h , +.Fl i , +.Fl q , +and +.Fl v +are used to display information about .Ar device -specifies either a drive (e.g. sd0) or a RAID controller (e.g. ami0). -For operations which will be performed against +e.g. sd0, ami0, nvme0. +Providing no options is equivalent to +.Fl i . +.Bl -tag -width disable +.It Fl h +Where appropriate, produce +.Dq human-readable +output. +Use unit suffixes: Byte, Kilobyte, Megabyte, +Gigabyte, Terabyte, Petabyte, Exabyte in order to reduce the number of +digits to four or less. +.It Fl i +Display default information. +e.g. for hardware RAID controllers enumerate attached devices. +.It Fl q +If +.Ar device +is a +.Xr sd 4 +display its vendor, product, revision, and serial number. +.It Fl v +Be more verbose in output. +.El +.Pp +The first synopsis shows options used to manage +hardware RAID controllers. +.Ar device +specifies either a drive (e.g. sd0), a hardware RAID controller (e.g. ami0) or a .Xr ses 4 or .Xr safte 4 -enclosures, it is also possible to directly specify the enclosure name -(e.g. safte0). +enclosure. .Pp -In the second synopsis, +The second synopsis shows options used to manage .Xr softraid 4 -volumes are managed. -.Ar device -specifies either a volume (e.g. sd0) or the -.Xr softraid 4 -controller (always softraid0). +volumes (e.g. sd0) or +softraid0 itself. .Pp -The options for RAID controllers are as follows: +The options for hardware RAID controllers are as follows: .Bl -tag -width Ds .It Fl a Ar alarm-function Control the RAID card's alarm functionality, if supported. @@ -116,29 +140,13 @@ is currently marked .Dq Unused , promote it to being a .Dq Hot Spare . -.It Fl h -Where necessary, produce -.Dq human-readable -output. -Use unit suffixes: Byte, Kilobyte, Megabyte, -Gigabyte, Terabyte, Petabyte, Exabyte in order to reduce the number of -digits to four or less. -.It Fl i -Enumerate the selected RAID devices. -This is the default if no other option is given. -.It Fl q -Show vendor, product, revision, and serial number for the given disk. .It Fl R Ar chunk | channel : Ns Ar target Ns Op Pf . Ar lun Manually kick off a rebuild of a degraded RAID volume, using .Ar chunk or .Ar channel : Ns Ar target Ns Op Pf . Ar lun -as a new chunk (with -.Xr softraid 4 , -a partition of fstype -.Dq RAID ) , -replacing the offline chunk in the volume; -it is not possible to change the number of chunks. +as a new chunk replacing the offline chunk in the volume. +It is not possible to change the number of chunks. The .Ar chunk must be specified as a full path to a device file (e.g. /dev/wd0d). @@ -174,12 +182,9 @@ to cease blinking, if there is or .Xr safte 4 support in the enclosure. -.It Fl v -Be more verbose in output. .El .Pp -In addition to the relevant options listed above, -the options for +The options for .Xr softraid 4 devices are as follows: .Bl -tag -width Ds @@ -276,6 +281,21 @@ Change the passphrase on the selected crypto volume. .It Fl p Ar passfile Passphrase file used when crypto volumes are brought up. This file must be root owned and have 0600 permissions. +.It Fl R Ar chunk | channel : Ns Ar target Ns Op Pf . Ar lun +Manually kick off a rebuild of a degraded volume, using +.Ar chunk +or +.Ar channel : Ns Ar target Ns Op Pf . Ar lun +as a new chunk, +replacing the offline chunk in the volume. +It is not possible to change the number of chunks. +The +.Ar chunk +must be specified as a full path to a device file (e.g. /dev/sd0d) which +refers to a partition of fstype RAID. +A +.Xr softraid 4 +volume rather than softraid0 is expected as the final argument. .It Fl r Ar rounds The number of iterations for the KDF algorithm to use when converting a passphrase into a key, in order to create a new encrypted volume or change the @@ -336,6 +356,11 @@ using a new chunk on wd0d: .Bd -literal -offset 3n # bioctl -R /dev/wd0d sd0 .Ed +.Pp +Show detailed information about the nvme0 controller: +.Bd -literal -offset 3n +# bioctl -v nvme0 +.Ed .Sh SEE ALSO .Xr bio 4 , .Xr scsi 4 , -- 2.20.1