From: jmc <jmc@openbsd.org>
Date: Mon, 15 Jul 2024 05:36:08 +0000 (+0000)
Subject: bioctl.8:
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=178701b61bdaa697dfddcc3479b863623a1c7115;p=openbsd

bioctl.8:
- tweak bioctl text
- don;t repeat the device examples
- reinstate softraid device being always softraid0

usage():
- add vertical blank between two formats
- rewrap to match 80col (shorter and matches man)

feedback/ok krw kn
---

diff --git a/sbin/bioctl/bioctl.8 b/sbin/bioctl/bioctl.8
index 52e4333530d..357baffdaec 100644
--- a/sbin/bioctl/bioctl.8
+++ b/sbin/bioctl/bioctl.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: bioctl.8,v 1.115 2024/07/14 16:09:06 krw Exp $
+.\"	$OpenBSD: bioctl.8,v 1.116 2024/07/15 05:36:08 jmc Exp $
 .\"
 .\" Copyright (c) 2004, 2005 Marco Peereboom
 .\"
@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: July 14 2024 $
+.Dd $Mdocdate: July 15 2024 $
 .Dt BIOCTL 8
 .Os
 .Sh NAME
@@ -56,17 +56,14 @@
 is used to interact with device drivers that register with
 .Xr bio 4 .
 .Pp
-The options
+The
 .Fl h ,
 .Fl i ,
 .Fl q ,
 and
 .Fl v
-are used to display information about
-.Ar device
-e.g. sd0, ami0, nvme0.
-Providing no options is equivalent to
-.Fl i .
+options are used to display information about the specified
+.Ar device :
 .Bl -tag -width disable
 .It Fl h
 Where appropriate, produce
@@ -76,13 +73,14 @@ 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.
+Display default information for the specified device.
+For example, for hardware RAID controllers enumerate attached devices.
+This is the default if no options are specified.
 .It Fl q
 If
 .Ar device
-is a
-.Xr sd 4
+is an
+.Xr sd 4 ,
 display its vendor, product, revision, and serial number.
 .It Fl v
 Be more verbose in output.
@@ -91,7 +89,7 @@ Be more verbose in output.
 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
+specifies either a drive (e.g. sd1), a hardware RAID controller (e.g. ami0) or a
 .Xr ses 4
 or
 .Xr safte 4
@@ -99,8 +97,9 @@ enclosure.
 .Pp
 The second synopsis shows options used to manage
 .Xr softraid 4
-volumes (e.g. sd0) or
-softraid0 itself.
+volumes (e.g. sd0)
+or the softraid controller itself
+(always softraid0).
 .Pp
 The options for hardware RAID controllers are as follows:
 .Bl -tag -width Ds
diff --git a/sbin/bioctl/bioctl.c b/sbin/bioctl/bioctl.c
index 2e25d5801d9..c403baf3244 100644
--- a/sbin/bioctl/bioctl.c
+++ b/sbin/bioctl/bioctl.c
@@ -1,4 +1,4 @@
-/* $OpenBSD: bioctl.c,v 1.157 2023/10/07 12:20:10 kn Exp $ */
+/* $OpenBSD: bioctl.c,v 1.158 2024/07/15 05:36:08 jmc Exp $ */
 
 /*
  * Copyright (c) 2004, 2005 Marco Peereboom
@@ -288,13 +288,12 @@ usage(void)
 		"[-R chunk | channel:target[.lun]]\n"
 		"\t[-t patrol-function] "
 		"[-u channel:target[.lun]] "
-		"device\n"
+		"device\n\n"
 		"       %s [-dhiPqsv] "
 		"[-C flag[,...]] [-c raidlevel] [-k keydisk]\n"
 		"\t[-l chunk[,...]] "
-		"[-O device | channel:target[.lun]]\n"
-		"\t[-p passfile] [-R chunk | channel:target[.lun]]\n"
-		"\t[-r rounds] "
+		"[-O device | channel:target[.lun]] [-p passfile]\n"
+		"\t[-R chunk | channel:target[.lun]] [-r rounds] "
 		"device\n", __progname, __progname);
 
 	exit(1);