Hannes Reinecke: iscsid and iscsiadm manpages, initial revision

git-svn-id: svn://svn.berlios.de/open-iscsi@404 d7303112-9cec-0310-bdd2-e83a94d6c2b6

2 files changed, 223 insertions, 0 deletions

diff --git a/doc/iscsiadm.8 b/doc/iscsiadm.8
new file mode 100644
index 0000000..e03f8f0
--- /dev/null
+++ b/doc/iscsiadm.8
@@ -0,0 +1,137 @@
+.TH ISCSID 8 "July 2005" "" "Linux Administrator's Manual"

+.SH NAME

+iscsiadm \- Open-iSCSI Configuration Utility

+.SH SYNOPSIS

+.BI iscsiadm

+[OPTIONS]

+.SH "DESCRIPTION"

+Open-iSCSI persistent configuration is implemented as a DBM database

+available on all Linux installations.

+.p

+The database contains two tables:

+.TP

+Discovery table (discovery.db);

+.TP

+Node table (node.db).

+.PD

+.PP

+The regular place for iSCSI database files is in

+.I /var/db/iscsi/*.db

+.PP

+The iscsiadm utility is a command-line tool to manage (update, delete,

+insert, query) the persistent database.

+.PP

+The utility presents set of operations that a user can perform 

+on iSCSI nodes, sessions, connections, and discovery records.

+.PP

+Note that some of the iSCSI Node and iSCSI Discovery operations 

+do not require iSCSI daemon (iscsid) loaded.

+

+.SH OPTIONS

+.TP

+.B \-m, \-\-mode \fIop

+specify operational mode.

+.I op

+is either

+.I discovery

+or

+.I node

+.TP

+.B \-m discovery

+display all discovery records from the internal persistent discovery

+database.

+.TP

+.B \-m discovery \-\-type=\fItype\fB \-\-portal=\fIip:port\fB \-\-login

+perform

+.I type

+discovery for target portal with ip-address 

+.I ip

+and port 

+.I port

+\. Initiate Login for each discovered target if --login is specific.

+.TP

+.B \-m discovery \-\-record=\fIid\fB \-\-login

+ perform discovery based on record 

+.I id

+in database.

+.TP

+.B \-m discovery \-\-record=\fIid\fB \-\-op=\fIop\fB \-\-name=\fIname\fB \-\-value=\fIvalue

+perform specific DB operation 

+.I op

+for specific discovery record with 

+.I id

+\. It could be one of:

+.I new

+, 

+.I delete

+, 

+.I update

+ or 

+.I show

+\. In case of

+.I update

+, you have to provide 

+.I name

+ and 

+.I value

+you wish to update

+.TP

+.B \-m node

+display all discovered nodes from internal persistent discovery

+database

+.TP

+.B \-m node \-\-record=\fIid\fB [ \-\-login | \-\-logout ]

+.TP

+.B \-m node \-\-record=\fIid\fB \-\-op=\fIop\fB [\-\-name=\fIname\fB \-\-value=\fIvalue\fB]

+perform specific DB operation 

+.I op

+for specific node with record 

+.I id

+\. It could be one of:

+.I new

+, 

+.I delete

+, 

+.I update

+ or 

+.I show

+\. In case of

+.I update

+, you have to provide 

+.I name

+and 

+.I value

+you wish to update

+.TP

+.B \-m session

+display all active sessions and connections

+.TP

+.B \-m session \-\-record=[\fIid\fB[\fI:cid\fB]] [\-\-logout]

+perform operation for specific session with record

+.I id

+or display statistics if no operation specified. Operation will affect

+one connection only if

+.I \:cid

+is specified

+.TP

+.B \-d, \-\-debug \fIdebuglevel

+print debugging information

+.TP

+.B -V, --version

+display version and exit

+.TP

+.B -h, --help

+display this help and exit

+

+.SH FILES

+.TP

+/var/db/iscsi/*.db

+Open-iSCSI persistent configuration database

+

+.SH "SEE ALSO"

+.BR iscsid (8)

+.BR iscsid.conf (5)

+

+.SH AUTHORS

+Alex Aizman <itn780@yahoo.com>

+Dmitry Yusupov <dmitry_yus@yahoo.com>

diff --git a/doc/iscsid.8 b/doc/iscsid.8
new file mode 100644
index 0000000..68d8f6d
--- /dev/null
+++ b/doc/iscsid.8
@@ -0,0 +1,86 @@
+.TH ISCSID 8 "July 2005" "" "Linux Administrator's Manual"

+.SH NAME

+iscsid \- Open-iSCSI daemon

+.SH SYNOPSIS

+.BI iscsid

+[OPTION]

+.SH "DESCRIPTION"

+The

+.B iscsid

+implements the control path of iSCSI protocol, plus some management

+facilities. For example, the daemon could be configured to automatically 

+re-start discovery at startup, based on the contents of persistent 

+iSCSI database.

+.SH OPTIONS

+.TP

+.BI [-c|--config=]\fIconfig\-file\fP

+Read configuration from

+.I config\-file

+rather than the default

+.I /etc/iscsid.conf

+file.

+.TP

+.BI [-i|--initiatorname=]\fIiname\-file\fP

+Read initiator name from

+.I iname\-file

+rather than the default

+.I /etc/initiatorname.iscsi

+file.

+.TP

+.BI [-f|--foreground]

+run

+.B iscsid

+in the foreground.

+.TP

+.BI [-d|--debug]

+print debugging information.

+.TP

+.BI [-u|--uid=]\fIuid\fP

+run under user ID

+.I uid

+(default is the current user ID)

+.TP

+.BI [-g|--gid=]\fIgid\fP

+run under user group ID

+.I gid

+(default is the current user group ID).

+.TP

+.BI [-p|--pid=]\fIpid\-file\fP

+write process ID to

+.I pid\-file

+rather than the default

+.I /var/run/iscsid.pid

+.TP

+.BI [-h|--help]

+display this help and exit

+.TP

+.BI [-v|--version]

+display version and exit.

+

+.SH FILES

+.TP

+/etc/iscsid.conf

+The configuration file read by

+.B iscsid

+and

+.B iscsiadm

+on startup.

+.TP

+/etc/initiatorname.iscsi

+The file containing the iSCSI initiatorname

+and initiatoralias read by

+.B iscsid

+and

+.B iscsiadm

+on startup.

+.TP

+/var/db/iscsi/*.db

+Open-iSCSI persistent configuration database

+

+.SH "SEE ALSO"

+.BR iscsiadm (8)

+.BR iscsid.conf (5)

+

+.SH AUTHORS

+Alex Aizman <itn780@yahoo.com>

+Dmitry Yusupov <dmitry_yus@yahoo.com>