kata-containers/s390-tools
1
0
Fork 0
mirror of https://github.com/ibm-s390-linux/s390-tools.git synced 2026-08-05 02:14:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

lsluns: fix flawed formatting of man page

Browse Source 
The formatting in the SYNOPSIS, OPTIONS, and EXAMPLES sections was flawed
in the lsluns(8) man page:

* The comma between short and long options were erroneously formatted in
  bold, which would indicate to be typed exactly as shown. [see man(1)]

* The option parameters (e.g. adapter and port) were erroneously formatted
  in bold instead of italic text (usually displayed as underlined on the
  console), which would again indicate to be typed exactly as shown instead
  of to be replaced with the appropriate argument. [see man(1)]

* Ellipses were missing after the the options that may be specified multiple
  times (e.g. adapter and port). [see man(1)]

* Dashes in options in the SYNOPSIS and OPTIONS section needed to be
  escaped. [see man-pages(7)]

* User input in example shell sessions should have been formatted in bold.
  [see man-pages(7)]

Correct formatting based on man(7) and man-pages(7) man pages as reference.
Add proper spacing between options and their surrounding square brackets and
between the three periods of ellipses.

Signed-off-by: Jens Remus <jremus@linux.vnet.ibm.com>
Reviewed-by: Steffen Maier <maier@linux.vnet.ibm.com>
Reviewed-by: Benjamin Block <bblock@linux.vnet.ibm.com>
Signed-off-by: Michael Holzheu <holzheu@linux.vnet.ibm.com>
This commit is contained in:
Jens Remus
2017-02-13 16:57:15 +01:00
committed by Michael Holzheu
parent c993ad89c5
commit d81c423429
1 changed files with 23 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
zconf/lsluns.8
+23 -19
View File
@@ -8,12 +8,12 @@ lsluns \- list available LUNs
.SH SYNOPSIS
.B lsluns
.RB [ \-h]
.RB [ \-v]
.RB [ \-c
.IR adapter id:0.0.XXXX ]
.RB [\| \-h \|]
.RB [\| \-v \|]
.RB [\| \-c
.IR adapter\ id:0.0.XXXX \|]\ .\|.\|.
.RB [ \-p
.IR port number:0xXXXXXXXXXXXXXXXX ]
.IR port\ number:0xXXXXXXXXXXXXXXXX \|]\ .\|.\|.
.SH DESCRIPTION
.PP
@@ -25,36 +25,40 @@ limited by specifying an adapter or a port.
.SH OPTIONS
.TP
.B -h, --help
.BR \-h ", " \-\-help
Print help message and exit.
.TP
.B -v, --version
.BR \-v ", " \-\-version
Display version info and exit.
.TP
.B -c, --ccw
.BI \-c\ adapter \fR,\ \fB\-\-ccw= adapter
Shows LUNs for a specific adapter.
.TP
.B -p, --port
.BI \-p\ port \fR,\ \fB\-\-port= port
Shows LUNs for a specific port.
.TP
.B -a, --active
.BR \-a ", " \-\-active
Shows all activated LUNs. In addition information is provided
whether the LUN is encrypted or not. This is indicated with a bracketed X
right after the LUN number.
.SH EXAMPLES
.PP
.IP "lsluns"
.TP
.B "lsluns"
.RS
Shows all available LUNs.
.RE
.IP "lsluns -c 0.0.3922"
Shows all LUNs found on adapter 0.0.3922.
.IP "lsluns -p 0x5005123456789000"
Shows all LUNs for port 0x5005123456789000.
.IP "lsluns -c 0.0.3922 -p 0x5005123456789000"
Shows all LUNs for adapter 0.0.3922 and port 0x5005123456789000.
.IP "lsluns -a "
.TP
.BI "lsluns \-c " 0.0.3922
Shows all LUNs found on adapter \fI0.0.3922\fR.
.TP
.BI "lsluns \-p " 0x5005123456789000
Shows all LUNs for port \fI0x5005123456789000\fR.
.TP
.BI "lsluns \-c " 0.0.3922 " \-p " 0x5005123456789000
Shows all LUNs for adapter \fI0.0.3922\fR and port \fI0x5005123456789000\fR.
.TP
.B "lsluns -a"
adapter = 0.0.3c02
port = 0x500507630300c562
lun = 0x401040a200000000(X) /dev/sg0 Disk IBM:2107900