Update the documentation for the --debug flag to iscsi-ls

Signed-off-by: Ronnie Sahlberg <ronniesahlberg@gmail.com>
This commit is contained in:
Ronnie Sahlberg
2017-06-03 11:36:04 -07:00
parent fb45f0343e
commit 6d6cb515fb
3 changed files with 13 additions and 11 deletions

View File

@@ -1,13 +1,13 @@
'\" t '\" t
.\" Title: iscsi-ls .\" Title: iscsi-ls
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 03/24/2014 .\" Date: 06/03/2017
.\" Manual: iscsi-ls: list iSCSI targets and LUNs .\" Manual: iscsi-ls: list iSCSI targets and LUNs
.\" Source: iscsi-ls .\" Source: iscsi-ls
.\" Language: English .\" Language: English
.\" .\"
.TH "ISCSI\-LS" "1" "03/24/2014" "iscsi\-ls" "iscsi\-ls: list iSCSI targets" .TH "ISCSI\-LS" "1" "06/03/2017" "iscsi\-ls" "iscsi\-ls: list iSCSI targets"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@@ -33,7 +33,7 @@ iscsi-ls \- Utility to list iSCSI targets and LUNs
.HP \w'\fBiscsi\-ls\ [\ OPTIONS\ ]\ <ISCSI\-PORTAL>\fR\ 'u .HP \w'\fBiscsi\-ls\ [\ OPTIONS\ ]\ <ISCSI\-PORTAL>\fR\ 'u
\fBiscsi\-ls [ OPTIONS ] <ISCSI\-PORTAL>\fR \fBiscsi\-ls [ OPTIONS ] <ISCSI\-PORTAL>\fR
.HP \w'\fBiscsi\-ls\fR\ 'u .HP \w'\fBiscsi\-ls\fR\ 'u
\fBiscsi\-ls\fR [\-i\ \-\-initiator\-name=<IQN>] [\-s\ \-\-show\-luns] [\-d\ \-\-debug=<INTEGER>] [\-?\ \-\-help] [\-\-usage] \fBiscsi\-ls\fR [\-i\ \-\-initiator\-name=<IQN>] [\-s\ \-\-show\-luns] [\-d\ \-\-debug] [\-?\ \-\-help] [\-\-usage]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
iscsi\-ls is a utility to list all targets and LUNs for an iSCSI portal\&. iscsi\-ls is a utility to list all targets and LUNs for an iSCSI portal\&.
@@ -75,9 +75,9 @@ In addition to listing all the targets at the specified portal also list all the
In order to display the type of LUN iscsi\-ls need to be able to perform a normal login on the targets\&. If the target is using access\-control you will need to specify an initiator\-name that allows normal logins to the target\&. In order to display the type of LUN iscsi\-ls need to be able to perform a normal login on the targets\&. If the target is using access\-control you will need to specify an initiator\-name that allows normal logins to the target\&.
.RE .RE
.PP .PP
\-d \-\-debug=<INTEGER> \-d \-\-debug
.RS 4 .RS 4
Debug level\&. Print debug information\&.
.RE .RE
.PP .PP
\-? \-\-help \-? \-\-help

View File

@@ -23,7 +23,7 @@
<command>iscsi-ls</command> <command>iscsi-ls</command>
<arg choice="opt">-i --initiator-name=&lt;IQN&gt;</arg> <arg choice="opt">-i --initiator-name=&lt;IQN&gt;</arg>
<arg choice="opt">-s --show-luns</arg> <arg choice="opt">-s --show-luns</arg>
<arg choice="opt">-d --debug=&lt;INTEGER&gt;</arg> <arg choice="opt">-d --debug</arg>
<arg choice="opt">-? --help</arg> <arg choice="opt">-? --help</arg>
<arg choice="opt">--usage</arg> <arg choice="opt">--usage</arg>
</cmdsynopsis> </cmdsynopsis>
@@ -101,10 +101,10 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry><term>-d --debug=&lt;INTEGER&gt;</term> <varlistentry><term>-d --debug</term>
<listitem> <listitem>
<para> <para>
Debug level. Print debug information.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

View File

@@ -319,14 +319,16 @@ void discoveryconnect_cb(struct iscsi_context *iscsi, int status, void *command_
void print_usage(void) void print_usage(void)
{ {
fprintf(stderr, "Usage: iscsi-ls [-?|--help] [--usage] [-i|--initiator-name=iqn-name]\n" fprintf(stderr, "Usage: iscsi-ls [-?|--help] [-d|--debug] "
"\t\t[-s|--show-luns] <iscsi-portal-url>\n"); "[--usage] [-i|--initiator-name=iqn-name]\n"
"\t\t[-s|--show-luns] <iscsi-portal-url>\n");
} }
void print_help(void) void print_help(void)
{ {
fprintf(stderr, "Usage: iscsi-ls [OPTION...] <iscsi-url>\n"); fprintf(stderr, "Usage: iscsi-ls [OPTION...] <iscsi-url>\n");
fprintf(stderr, " -i, --initiator-name=iqn-name Initiatorname to use\n"); fprintf(stderr, " -i, --initiator-name=iqn-name Initiatorname to use\n");
fprintf(stderr, " -d, --debug Print debug information\n");
fprintf(stderr, " -s, --show-luns Show the luns for each target\n"); fprintf(stderr, " -s, --show-luns Show the luns for each target\n");
fprintf(stderr, " --url Output targets in URL format\n"); fprintf(stderr, " --url Output targets in URL format\n");
fprintf(stderr, " (does not work with -s)\n"); fprintf(stderr, " (does not work with -s)\n");