mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2025-01-13 03:30:34 +03:00
Minor fixes in zpool iostat -c documentation (#6370)
- Use nested [] notation to denote optional script list elements - Fix space before comma after smarctl(8) - Fix typo and formatting error in reference to -v option - Fix spelling errors Reviewed-by: Giuseppe Di Natale <dinatale2@llnl.gov> Reviewed-by: George Melikov <mail@gmelikov.ru> Reviewed-by: Tony Hutter <hutter2@llnl.gov> Signed-off-by: Ned Bass <bass6@llnl.gov> Closes #6370
This commit is contained in:
parent
4265a9293e
commit
7a8ed6b8b7
@ -1456,7 +1456,7 @@ values, use the
|
|||||||
.Fl p
|
.Fl p
|
||||||
flag.
|
flag.
|
||||||
.Bl -tag -width Ds
|
.Bl -tag -width Ds
|
||||||
.It Fl c Op Ar SCRIPT1 , Ar SCRIPT2 ...
|
.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 iostat
|
.Nm zpool Cm iostat
|
||||||
@ -1470,8 +1470,8 @@ ZPOOL_SCRIPTS_PATH environment variable. A privileged user can run
|
|||||||
if they have the ZPOOL_SCRIPTS_AS_ROOT
|
if they have the ZPOOL_SCRIPTS_AS_ROOT
|
||||||
environment variable set. If a script requires the use of a privileged
|
environment variable set. If a script requires the use of a privileged
|
||||||
command, like
|
command, like
|
||||||
.Xr smartctl 8
|
.Xr smartctl 8 ,
|
||||||
, then it's recommended you allow the user access to it in
|
then it's recommended you allow the user access to it in
|
||||||
.Pa /etc/sudoers
|
.Pa /etc/sudoers
|
||||||
or add the user to the
|
or add the user to the
|
||||||
.Pa /etc/sudoers.d/zfs
|
.Pa /etc/sudoers.d/zfs
|
||||||
@ -1481,8 +1481,8 @@ If
|
|||||||
.Fl c
|
.Fl c
|
||||||
is passed without a script name, it prints a list of all scripts.
|
is passed without a script name, it prints a list of all scripts.
|
||||||
.Fl c
|
.Fl c
|
||||||
also sets verbose mode (
|
also sets verbose mode
|
||||||
.Fl c ).
|
.No ( Ns Fl v Ns No ).
|
||||||
.Pp
|
.Pp
|
||||||
Script output should be in the form of "name=value". The column name is
|
Script output should be in the form of "name=value". The column name is
|
||||||
set to "name" and the value is set to "value". Multiple lines can be
|
set to "name" and the value is set to "value". Multiple lines can be
|
||||||
@ -1912,7 +1912,7 @@ and automatically import it.
|
|||||||
.It Xo
|
.It Xo
|
||||||
.Nm
|
.Nm
|
||||||
.Cm status
|
.Cm status
|
||||||
.Op Fl c Op Ar SCRIPT1 , Ar SCRIPT2 ...
|
.Op Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ...
|
||||||
.Op Fl gLPvxD
|
.Op Fl gLPvxD
|
||||||
.Op Fl T Sy u Ns | Ns Sy d
|
.Op Fl T Sy u Ns | Ns Sy d
|
||||||
.Oo Ar pool Oc Ns ...
|
.Oo Ar pool Oc Ns ...
|
||||||
@ -1931,7 +1931,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 c Op Ar SCRIPT1 , Ar SCRIPT2 ...
|
.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
|
||||||
@ -2322,11 +2322,11 @@ by setting
|
|||||||
.El
|
.El
|
||||||
.Bl -tag -width "ZPOOL_SCRIPTS_AS_ROOT"
|
.Bl -tag -width "ZPOOL_SCRIPTS_AS_ROOT"
|
||||||
.It Ev ZPOOL_SCRIPTS_AS_ROOT
|
.It Ev ZPOOL_SCRIPTS_AS_ROOT
|
||||||
Allow a privilaged user to run the
|
Allow a privileged user to run the
|
||||||
.Nm zpool status/iostat
|
.Nm zpool status/iostat
|
||||||
with the
|
with the
|
||||||
.Fl c
|
.Fl c
|
||||||
option. Normally, only unprivilaged users are allowed to run
|
option. Normally, only unprivileged users are allowed to run
|
||||||
.Fl c .
|
.Fl c .
|
||||||
.El
|
.El
|
||||||
.Bl -tag -width "ZPOOL_SCRIPTS_PATH"
|
.Bl -tag -width "ZPOOL_SCRIPTS_PATH"
|
||||||
|
Loading…
Reference in New Issue
Block a user