Reformat cli help and man page to be in sync

The man page and CLI usage statements were both a little out
of sync and neither fully alphabetized correctly. That has
been fixed. One outstanding question is whether to get rid of
the ellipses on the CLI usage.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Cameron Harr <harr1@llnl.gov>
Closes #16004
Closes #17357
This commit is contained in:
Cameron Harr 2025-05-19 14:25:59 -07:00 committed by Brian Behlendorf
parent ddf28f27c5
commit cdb4c44684
2 changed files with 43 additions and 35 deletions

View File

@ -521,11 +521,11 @@ get_usage(zpool_help_t idx)
return (gettext("\ttrim [-dw] [-r <rate>] [-c | -s] <pool> " return (gettext("\ttrim [-dw] [-r <rate>] [-c | -s] <pool> "
"[<device> ...]\n")); "[<device> ...]\n"));
case HELP_STATUS: case HELP_STATUS:
return (gettext("\tstatus [--power] [-j [--json-int, " return (gettext("\tstatus [-c script1[,script2,...]] "
"--json-flat-vdevs, ...\n"
"\t --json-pool-key-guid]] [-c [script1,script2,...]] "
"[-dDegiLpPstvx] ...\n" "[-dDegiLpPstvx] ...\n"
"\t [-T d|u] [pool] [interval [count]]\n")); "\t [-j [--json-int] [--json-flat-vdevs] "
"[--json-pool-key-guid]] ...\n"
"\t [--power] [-T d|u] [pool] [interval [count]]\n"));
case HELP_UPGRADE: case HELP_UPGRADE:
return (gettext("\tupgrade\n" return (gettext("\tupgrade\n"
"\tupgrade -v\n" "\tupgrade -v\n"
@ -10980,8 +10980,10 @@ status_callback(zpool_handle_t *zhp, void *data)
} }
/* /*
* zpool status [-c [script1,script2,...]] [-dDegiLpPstvx] [--power] ... * zpool status [-c [script1,script2,...]] [-dDegiLpPstvx] ...
* [-T d|u] [pool] [interval [count]] * [-j [--json-int] [--json-flat-vdevs] ...
* [--json-pool-key-guid]] [--power] [-T d|u] ...
* [pool] [interval [count]]
* *
* -c CMD For each vdev, run command CMD * -c CMD For each vdev, run command CMD
* -d Display Direct I/O write verify errors * -d Display Direct I/O write verify errors
@ -10989,19 +10991,19 @@ status_callback(zpool_handle_t *zhp, void *data)
* -e Display only unhealthy vdevs * -e Display only unhealthy vdevs
* -g Display guid for individual vdev name. * -g Display guid for individual vdev name.
* -i Display vdev initialization status. * -i Display vdev initialization status.
* -j [...] Display output in JSON format
* --json-int Display numbers in inteeger format instead of string
* --json-flat-vdevs Display vdevs in flat hierarchy
* --json-pool-key-guid Use pool GUID as key for pool objects
* -L Follow links when resolving vdev path name. * -L Follow links when resolving vdev path name.
* -p Display values in parsable (exact) format. * -p Display values in parsable (exact) format.
* -P Display full path for vdev name. * -P Display full path for vdev name.
* --power Display vdev enclosure slot power status
* -s Display slow IOs column. * -s Display slow IOs column.
* -t Display vdev TRIM status. * -t Display vdev TRIM status.
* -T Display a timestamp in date(1) or Unix format * -T Display a timestamp in date(1) or Unix format
* -v Display complete error logs * -v Display complete error logs
* -x Display only pools with potential problems * -x Display only pools with potential problems
* -j Display output in JSON format
* --power Display vdev enclosure slot power status
* --json-int Display numbers in inteeger format instead of string
* --json-flat-vdevs Display vdevs in flat hierarchy
* --json-pool-key-guid Use pool GUID as key for pool objects
* *
* Describes the health status of all pools or some subset. * Describes the health status of all pools or some subset.
*/ */

View File

@ -37,12 +37,17 @@
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm zpool .Nm zpool
.Cm status .Cm status
.Op Fl c Ar script1 Ns Oo , Ns Ar script2 Ns ,… Oc
.Op Fl dDegiLpPstvx .Op Fl dDegiLpPstvx
.Op Fl T Sy u Ns | Ns Sy d .Oo Fl j
.Op Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns .Oo Ns Fl Fl json-int Oc
.Oo Ar pool Oc Ns .Oo Ns Fl Fl json-flat-vdevs Oc
.Oo Ns Fl Fl json-pool-key-guid Oc
.Oc
.Op Fl Fl power
.Op Fl T Ar d|u
.Op Ar pool
.Op Ar interval Op Ar count .Op Ar interval Op Ar count
.Op Fl j Op Ar --json-int, --json-flat-vdevs, --json-pool-key-guid
. .
.Sh DESCRIPTION .Sh DESCRIPTION
Displays the detailed health status for the given pools. Displays the detailed health status for the given pools.
@ -59,9 +64,7 @@ and the estimated time to completion.
Both of these are only approximate, because the amount of data in the pool and Both of these are only approximate, because the amount of data in the pool and
the other workloads on the system can change. the other workloads on the system can change.
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl -power .It Fl c Ar script1 Ns Oo , Ns Ar script2 Ns ,… Oc
Display vdev enclosure slot power status (on or off).
.It Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns
Run a script (or scripts) on each vdev and include the output as a new column Run a script (or scripts) on each vdev and include the output as a new column
in the in the
.Nm zpool Cm status .Nm zpool Cm status
@ -71,17 +74,6 @@ See the
option of option of
.Nm zpool Cm iostat .Nm zpool Cm iostat
for complete details. for complete details.
.It Fl j , -json Op Ar --json-int, --json-flat-vdevs, --json-pool-key-guid
Display the status for ZFS pools in JSON format.
Specify
.Sy --json-int
to display numbers in integer format instead of strings.
Specify
.Sy --json-flat-vdevs
to display vdevs in flat hierarchy instead of nested vdev objects.
Specify
.Sy --json-pool-key-guid
to set pool GUID as key for pool objects instead of pool names.
.It Fl d .It Fl d
Display the number of Direct I/O read/write checksum verify errors that have Display the number of Direct I/O read/write checksum verify errors that have
occurred on a top-level VDEV. occurred on a top-level VDEV.
@ -111,6 +103,18 @@ These GUIDs can be used in place of device names for the zpool
detach/offline/remove/replace commands. detach/offline/remove/replace commands.
.It Fl i .It Fl i
Display vdev initialization status. Display vdev initialization status.
.It Fl j , -json Oo Ns Fl Fl json-int Oc Oo Ns Fl Fl json-flat-vdevs Oc \
Oo Ns Fl Fl json-pool-key-guid Oc
Display the status for ZFS pools in JSON format.
Specify
.Sy --json-int
to display numbers in integer format instead of strings.
Specify
.Sy --json-flat-vdevs
to display vdevs in flat hierarchy instead of nested vdev objects.
Specify
.Sy --json-pool-key-guid
to set pool GUID as key for pool objects instead of pool names.
.It Fl L .It Fl L
Display real paths for vdevs resolving all symbolic links. Display real paths for vdevs resolving all symbolic links.
This can be used to look up the current block device name regardless of the This can be used to look up the current block device name regardless of the
@ -124,6 +128,8 @@ the path.
This can be used in conjunction with the This can be used in conjunction with the
.Fl L .Fl L
flag. flag.
.It Fl -power
Display vdev enclosure slot power status (on or off).
.It Fl s .It Fl s
Display the number of leaf vdev slow I/O operations. Display the number of leaf vdev slow I/O operations.
This is the number of I/O operations that didn't complete in This is the number of I/O operations that didn't complete in
@ -136,18 +142,18 @@ unreasonably long amount of time.
This may indicate a problem with the underlying storage. This may indicate a problem with the underlying storage.
.It Fl t .It Fl t
Display vdev TRIM status. Display vdev TRIM status.
.It Fl T Sy u Ns | Ns Sy d .It Fl T Sy d Ns | Ns Sy u
Display a time stamp. Display a time stamp.
Specify Specify
.Sy u
for a printed representation of the internal representation of time.
See
.Xr time 1 .
Specify
.Sy d .Sy d
for standard date format. for standard date format.
See See
.Xr date 1 . .Xr date 1 .
Specify
.Sy u
for a printed representation of the internal representation of time.
See
.Xr time 1 .
.It Fl v .It Fl v
Displays verbose data error information, printing out a complete list of all Displays verbose data error information, printing out a complete list of all
data errors since the last complete pool scrub. data errors since the last complete pool scrub.