iscontrol(8): Fix synopsis, sync usage() & improve markup
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Tue, 22 Sep 2009 20:10:36 +0000 (22:10 +0200)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Mon, 28 Sep 2009 18:44:12 +0000 (20:44 +0200)
 * Note that /etc/iscsi.conf is default -c file

 * Sort options, fix synopsis & sync usage()

 * Add FILES section

 * Change example to specify non-default config file

 * Improve markup

sbin/iscontrol/iscontrol.8
sbin/iscontrol/iscontrol.c

index c0fe061..7d00733 100644 (file)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD: src/sbin/iscontrol/iscontrol.8,v 1.3 2008/11/25 07:17:11 scottl Exp $
 .\"
-.Dd September 4, 2009
+.Dd September 23, 2009
 .Dt ISCONTROL 8
 .Os
 .Sh NAME
 .Nd login/negotiator/control for an iSCSI initiator session
 .Sh SYNOPSIS
 .Nm
-.Op Fl vd
-.Oo
-.Op Fl Ar file
+.Op Fl dv
+.Op Fl c Ar file
 .Op Fl n Ar nickname
-.Oc
 .Op Fl t Ar target
-.Op Ar variable Ns = Ns Ar value
+.Op Ar variable Ns = Ns Ar value ...
 .Sh DESCRIPTION
 Internet SCSI (iSCSI) is a network protocol standard, that allows the
-use of the SCSI protocol over TCP/IP networks,
-the
+use of the SCSI protocol over TCP/IP networks, the
 .Nm
 program is the userland side of an iSCSI session, see
 .Xr iscsi_initiator 4 .
-It has 2 modes of operation, if -d (discovery session) is specified,
+It has two modes of operation, if
+.Fl d
+(discovery session) is specified,
 it will print out the
 .Em target names
 returned by the target and exit.
@@ -57,32 +56,39 @@ It will terminate/logout the session
 when a SIGHUP signal is received.
 The flags are as follows:
 .Bl -tag -width variable=value
-.It Fl v
-verbose mode.
-.It Fl d
-do a
-.Em discovery session
-and exit.
 .It Fl c Ar file
 a file containing configuration
 .Em key-options ,
 see
-.Xr iscsi.conf 5
+.Xr iscsi.conf 5 .
+Default is
+.Pa /etc/iscsi.conf
+.It Fl d
+do a
+.Em discovery session
+and exit.
 .It Fl n Ar nickname
-if
-.Sy -c file
-is specified, then search for the block named
-.Em nickname
-in that file, see
-.Xr iscsi.conf 5
+search for the block named
+.Ar nickname
+in the configuration file
+.Fl ( c ) ,
+see
+.Xr iscsi.conf 5 .
 .It Fl t Ar target
-is the target's IP address or name
+is the target's IP address or name.
+.It Fl v
+verbose mode.
 .It Ar variable Ns = Ns Ar value
 see
 .Xr iscsi.conf 5
 for the complete list of variables/options and their
 possible values.
 .El
+.Sh FILES
+.Bl -tag -width /etc/iscsi.conf -compact
+.It Pa /etc/iscsi.conf
+default configuration file
+.El
 .Sh EXAMPLES
 .Dl iscontrol -dt myiscsitarget
 .Pp
@@ -96,10 +102,10 @@ not need login/access permission, but a
 .Em full session
 certainly does.
 .Pp
-.Dl iscontrol -c /etc/iscsi.conf -n myiscsi
+.Dl iscontrol -c myiscsi.conf -n myiscsi
 .Pp
 will read options from
-.Pa /etc/iscsi.conf ,
+.Pa myiscsi.conf ,
 use the targetaddress
 found in the block nicknamed myiscsi, login and negotiate
 whatever options are specified, and start an iscsi-session.
index ca77ccc..6c1428f 100644 (file)
@@ -57,7 +57,7 @@
 #include "iscsi.h"
 #include "iscontrol.h"
 
-#define USAGE "[-v] [-d] [-c config] [-n name] [-t target] "
+#define USAGE "[-dv] [-c file] [-n nickname] [-t target] [variable=value ...]"
 #define OPTIONS        "vdc:t:n:"
 
 #ifndef DEBUG