Commit 4e3dc91e authored by Mateusz Piotrowski's avatar Mateusz Piotrowski
Browse files

sesutil.8: Polish

- Use right mdoc macros
- Fix synopsis. Some of the optional command modifiers were not optional
  after all.
- Sort options

MFC after:	1 week
parent 604bc078
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd December 12, 2019 .Dd July 5, 2022
.Dt SESUTIL 8 .Dt SESUTIL 8
.Os .Os
.Sh NAME .Sh NAME
...@@ -34,13 +34,25 @@ ...@@ -34,13 +34,25 @@
.Nm .Nm
.Cm fault .Cm fault
.Op Fl u Ar /dev/sesN .Op Fl u Ar /dev/sesN
.Aq Ar disk | Ar sesid | Li all .Ar disk Ns | Ns Cm all
.Op on | off .Cm on Ns | Ns Cm off
.Nm
.Cm fault
.Fl u Ar /dev/sesN
.Sm off
.Ar sesid
.Sm on
.Cm on Ns | Ns Cm off
.Nm .Nm
.Cm locate .Cm locate
.Op Fl u Ar /dev/sesN .Op Fl u Ar /dev/sesN
.Aq Ar disk | Ar sesid | Li all .Ar disk Ns | Ns Cm all
.Op on | off .Cm on Ns | Ns Cm off
.Nm
.Cm locate
.Fl u Ar /dev/sesN
.Ar sesid
.Cm on Ns | Ns Cm off
.Nm .Nm
.Cm map .Cm map
.Op Fl -libxo Ar options .Op Fl -libxo Ar options
...@@ -61,22 +73,16 @@ Services (SES) devices. ...@@ -61,22 +73,16 @@ Services (SES) devices.
.Pp .Pp
List of supported commands: List of supported commands:
.Bl -tag -width indent .Bl -tag -width indent
.It Fl -libxo .It Cm fault Oo Fl u Ar /dev/sesN Oc Ar disk Ns | Ns Cm all Cm on Ns | Ns Cm off
Generate output via
.Xr libxo 3
in a selection of different human and machine readable formats.
See
.Xr xo_parse_args 3
.It Cm fault Oo Fl u Ar /dev/sesN Oc Ao Ar disk | Li all Ac Op on | off
Change the state of the external fault LED associated with Change the state of the external fault LED associated with
.Ar disk . .Ar disk .
.Ar disk .Ar disk
can be the device name of the disk, like can be the device name of the disk, like
.Cm da12 , .Ql da12 ,
or or
.Ql all . .Cm all
to indicate all disks attached to SES controllers. to indicate all disks attached to SES controllers.
.It Cm fault Fl u Ar /dev/sesN Ar sesid Op on | off .It Cm fault Fl u Ar /dev/sesN Ar sesid Cm on Ns | Ns Cm off
Change the state of the external fault LED associated with an element Change the state of the external fault LED associated with an element
connected to the SES controller. connected to the SES controller.
.Ar sesid .Ar sesid
...@@ -84,16 +90,16 @@ must be the element ID of a valid item attached to the controller. ...@@ -84,16 +90,16 @@ must be the element ID of a valid item attached to the controller.
Use the Use the
.Cm map .Cm map
command to list the elements attached to a controller. command to list the elements attached to a controller.
.It Cm locate Oo Fl u Ar /dev/sesN Oc Ao Ar disk | Li all Ac Op on | off .It Cm locate Oo Fl u Ar /dev/sesN Oc Ar disk Ns | Ns Cm all Cm on Ns | Ns Cm off
Change the state of the external locate LED associated with Change the state of the external locate LED associated with
.Ar disk . .Ar disk .
.Ar disk .Ar disk
can be the device name of the disk, like can be the device name of the disk, like
.Cm da12 , .Ql da12 ,
or or
.Ql all . .Cm all
to indicate all disks attached to SES controllers. to indicate all disks attached to SES controllers.
.It Cm locate Fl u Ar /dev/sesN Ar sesid Op on | off .It Cm locate Fl u Ar /dev/sesN Ar sesid Cm on Ns | Ns Cm off
Change the state of the external locate LED associated with an element Change the state of the external locate LED associated with an element
connected to the SES controller. connected to the SES controller.
.Ar sesid .Ar sesid
...@@ -101,22 +107,32 @@ must be the element ID of a valid item attached to the controller. ...@@ -101,22 +107,32 @@ must be the element ID of a valid item attached to the controller.
Use the Use the
.Cm map .Cm map
command to list the elements attached to a controller. command to list the elements attached to a controller.
.It Cm show Op Fl u Ar /dev/sesN .It Cm map Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
Display user-friendly summary of specified Display a map of all elements connected to the specified
.Xr ses 4 .Xr ses 4
controller. controller.
If no controller is specified, all controllers are mapped. If no controller is specified, all controllers are mapped.
.It Cm map Op Fl u Ar /dev/sesN .It Cm show Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
Display a map of all elements connected to the specified Display user-friendly summary of specified
.Xr ses 4 .Xr ses 4
controller. controller.
If no controller is specified, all controllers are mapped. If no controller is specified, all controllers are mapped.
.It Cm status Op Fl u Ar /dev/sesN .It Cm status Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
Display the status of the specified Display the status of the specified
.Xr ses 4 .Xr ses 4
controller. controller.
If no controller is specified, the status of each controller is returned. If no controller is specified, the status of each controller is returned.
.El .El
.Pp
Common options:
.Bl -tag -width indent
.It Fl -libxo Ar options
Generate output via
.Xr libxo 3
in a selection of different human and machine readable formats.
See
.Xr xo_parse_args 3
.El
.Sh EXAMPLES .Sh EXAMPLES
Turn off all locate LEDs: Turn off all locate LEDs:
.Pp .Pp
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment