[stgt] [PATCH] tgt-admin: update manpage and htmlpage
FUJITA Tomonori
fujita.tomonori at lab.ntt.co.jp
Thu Jul 29 03:23:28 CEST 2010
Generate update manpage and htmlpage from xml.
Signed-off-by: FUJITA Tomonori <fujita.tomonori at lab.ntt.co.jp>
---
doc/htmlpages/tgt-admin.8.html | 106 ++++++++++++++++++++++++++--------------
doc/manpages/tgt-admin.8 | 93 ++++++++++++++++++----------------
2 files changed, 118 insertions(+), 81 deletions(-)
diff --git a/doc/htmlpages/tgt-admin.8.html b/doc/htmlpages/tgt-admin.8.html
index d954750..63f462b 100644
--- a/doc/htmlpages/tgt-admin.8.html
+++ b/doc/htmlpages/tgt-admin.8.html
@@ -1,18 +1,17 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgt-admin</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tgt-admin.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgt-admin — Linux SCSI Target Configuration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtadm</code> [-e --execute] [--delete <value>] [--offline <value>] [--ready <value>] [-s --show] [-c --conf <file>] [--ignore-errors] [-f --force] [-p --pretend] [--dump] [-v --verbose] [-h --help]</p></div></div><div class="refsect1" lang="en"><a name="id2476073"></a><h2>DESCRIPTION</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgt-admin</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tgt-admin.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgt-admin — Linux SCSI Target Configuration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgt-admin</code> [-e --execute] [--delete <value>] [--offline <value>] [--ready <value>] [-s --show] [-C --control-port <NNNN>] [-c --conf <file>] [--ignore-errors] [-f --force] [-p --pretend] [--dump] [-v --verbose] [-h --help]</p></div></div><div class="refsect1" lang="en"><a name="id514662"></a><h2>DESCRIPTION</h2><p>
tgt-admin is a utility which allows a persistent configuration of targets and luns.
It uses tgtadm commands to create, delete and show targets.
- </p></div><div class="refsect1" lang="en"><a name="id2476086"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">-e, --execute</code></span></dt><dd><p>
- Read /etc/tgt/targets.conf and execute tgtadm commands.
- If the target already exists, it won't be processed.
- See --update.
+ </p></div><div class="refsect1" lang="en"><a name="id514672"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">-e, --execute</code></span></dt><dd><p>
+ Read /etc/tgt/targets.conf and execute tgtadm commands.
+ If the target already exists, it won't be processed.
+ See --update.
</p></dd><dt><span class="term"><code class="option">-d, --delete <value></code></span></dt><dd><p>
- Delete all or selected targets.
- The target will be deleted only if it's not used (no initiator
- is connected to it).
-
- If you want to delete targets which are in use, you have to add
- the "--force" flag.
-
+ Delete all or selected targets.
+ The target will be deleted only if it's not used (no initiator
+ is connected to it).
+ </p><p>
+ If you want to delete targets which are in use, you have to add
+ the "--force" flag.
</p><pre class="screen">
Example usage:
--delete ALL - delete all targets
@@ -21,44 +20,50 @@ Example usage:
--delete iqn.2008-08.com.example:some.target
- delete this target
</pre><p>
-
</p></dd><dt><span class="term"><code class="option">--offline</code></span></dt><dd><p>
Put all or selected targets in offline state.
-
</p><pre class="screen">
Example usage:
--offline ALL - offline all targets
- --offline tid=4 - offline target 4 (target with tid 4)
- --offline iqn.2008-08.com.example:some.target - offline this target
+ --offline tid=4 - offline target 4
+ (target with tid 4)
+ --offline iqn.2008-08.com.example:some.target
+ - offline this target
</pre><p>
-
</p></dd><dt><span class="term"><code class="option">--ready</code></span></dt><dd><p>
- Put all or selected targets in ready state.
- </p><pre class="screen">
+ Put all or selected targets in ready state.
+ </p><pre class="screen">
Example usage:
--ready ALL - ready all targets
- --ready tid=4 - ready target 4 (target with tid 4)
- --ready iqn.2008-08.com.example:some.target - ready this target
- </pre><p>
+ --ready tid=4 - ready target 4
+ (target with tid 4)
+ --ready iqn.2008-08.com.example:some.target
+ - ready this target
+ </pre><p>
</p></dd><dt><span class="term"><code class="option">--update <value></code></span></dt><dd><p>
- Update all or selected targets.
- The target will be updated only if it's not used (no initiator
- is connected to it).
-
- If you want to update targets which are in use, you have to add
- "--force" flag.
-
- </p><pre class="screen">
+ Update all or selected targets.
+ The target will be updated only if it's not used (no initiator
+ is connected to it).
+ </p><p>
+ If you want to update targets which are in use, you have to add
+ "--force" flag.
+ </p><pre class="screen">
Example usage:
--update ALL - ready all targets
- --update tid=4 - ready target 4 (target with tid 4)
- --update iqn.2008-08.com.example:some.target - update this target
- </pre><p>
+ --update tid=4 - ready target 4
+ (target with tid 4)
+ --update iqn.2008-08.com.example:some.target
+ - update this target
+ </pre><p>
</p></dd><dt><span class="term"><code class="option">-s, --show</code></span></dt><dd><p>
Show all the targets.
+ </p></dd><dt><span class="term"><code class="option">-C, --control-port <NNNN></code></span></dt><dd><p>
+ It is possible to run multiple concurrent instances of
+ tgtd on a host. This argument is used to control which
+ instance the tgt-admin command will operate on.
</p></dd><dt><span class="term"><code class="option">-c, --conf <configuration file></code></span></dt><dd><p>
- Specify an alternative configuration file instead of
- /etc/tgt/target.conf, which is the default.
+ Specify an alternative configuration file instead of
+ /etc/tgt/target.conf, which is the default.
</p></dd><dt><span class="term"><code class="option">--ignore-errors</code></span></dt><dd><p>
Continue even if tgtadm exits with non-zero code.
</p></dd><dt><span class="term"><code class="option">-f, --force</code></span></dt><dd><p>
@@ -74,9 +79,36 @@ Example usage:
Increase verbosity (show tgtadm commands used).
</p></dd><dt><span class="term"><code class="option">-h, --help</code></span></dt><dd><p>
Display a list of available options and exit.
- </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476335"></a><h2>SEE ALSO</h2><p>
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id514912"></a><h2>CONFIGURATION FILE SYNTAX</h2><p>
+ The defualt configuration file is /etc/tgt/target.conf. It defines all
+ the targets and their properties.
+ The configuration file is in XML format and uses tags.
+ Configuration file contains several target blocks, where each block
+ contains target's properties such as storage devices,
+ initator ACL and authorization information. You can include other
+ config files using:
+ include /etc/tgt/xen/*.conf.
+ </p><div class="variablelist"><dl><dt><span class="term"><code class="option">backing-store</code></span></dt><dd><p>
+ Defines a virtual device on the target.
+ </p></dd><dt><span class="term"><code class="option">direct-store</code></span></dt><dd><p>
+ Defines a direct mapped device with the same properties
+ as the physical device (such as VENDOR_ID, SERIAL_NUM, etc.)
+ </p></dd><dt><span class="term"><code class="option">initiator-address</code></span></dt><dd><p>
+ Allows connections only from the specified IP
+ address. Defaults to ALL if no "initiator-address" is specified.
+ </p></dd><dt><span class="term"><code class="option">incominguser</code></span></dt><dd><p>
+ Define iscsi incoming authentication setting. If no
+ "incominguser" is specified, it is not used.
+ </p></dd><dt><span class="term"><code class="option">outgoinguser</code></span></dt><dd><p>
+ Define iscsi outgoing authentication setting. If no
+ "outgoinguser" is specified, it is not used.
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id515009"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">/etc/tgt/targets.conf</code></span></dt><dd><p>
+ Configuration file for tgt-admin.
+ </p></dd><dt><span class="term"><code class="option">/usr/share/doc/tgt/targets.conf.example</code></span></dt><dd><p>
+ Example configuration file for tgt-admin.
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id515044"></a><h2>SEE ALSO</h2><p>
tgtd(8), tgtadm(8), tgtimg(8), tgt-setup-lun(8).
<a class="ulink" href="http://stgt.sourceforge.net/" target="_top">http://stgt.sourceforge.net/</a>
- </p></div><div class="refsect1" lang="en"><a name="id2476350"></a><h2>REPORTING BUGS</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id515057"></a><h2>REPORTING BUGS</h2><p>
Report bugs to <stgt at vger.kernel.org>
</p></div></div></body></html>
diff --git a/doc/manpages/tgt-admin.8 b/doc/manpages/tgt-admin.8
index 2356d20..e6c6b06 100644
--- a/doc/manpages/tgt-admin.8
+++ b/doc/manpages/tgt-admin.8
@@ -1,35 +1,35 @@
.\" Title: tgt-admin
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\" Date: 03/31/2010
+.\" Date: 07/29/2010
.\" Manual:
.\" Source:
.\"
-.TH "TGT\-ADMIN" "8" "03/31/2010" "" ""
+.TH "TGT\-ADMIN" "8" "07/29/2010" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-tgt-admin - Linux SCSI Target Configuration Tool
+tgt-admin \- Linux SCSI Target Configuration Tool
.SH "SYNOPSIS"
-.HP 7
-\fBtgtadm\fR [\-e\ \-\-execute] [\-\-delete\ <value>] [\-\-offline\ <value>] [\-\-ready\ <value>] [\-s\ \-\-show] [\-c\ \-\-conf\ <file>] [\-\-ignore\-errors] [\-f\ \-\-force] [\-p\ \-\-pretend] [\-\-dump] [\-v\ \-\-verbose] [\-h\ \-\-help]
+.HP 10
+\fBtgt\-admin\fR [\-e\ \-\-execute] [\-\-delete\ <value>] [\-\-offline\ <value>] [\-\-ready\ <value>] [\-s\ \-\-show] [\-C\ \-\-control\-port\ <NNNN>] [\-c\ \-\-conf\ <file>] [\-\-ignore\-errors] [\-f\ \-\-force] [\-p\ \-\-pretend] [\-\-dump] [\-v\ \-\-verbose] [\-h\ \-\-help]
.SH "DESCRIPTION"
.PP
-tgt\-admin is a utility which allows a persistent configuration of targets and luns\. It uses tgtadm commands to create, delete and show targets\.
+tgt\-admin is a utility which allows a persistent configuration of targets and luns\&. It uses tgtadm commands to create, delete and show targets\&.
.SH "OPTIONS"
.PP
\fB\-e, \-\-execute\fR
.RS 4
-Read /etc/tgt/targets\.conf and execute tgtadm commands\. If the target already exists, it won\'t be processed\. See \-\-update\.
+Read /etc/tgt/targets\&.conf and execute tgtadm commands\&. If the target already exists, it won\'t be processed\&. See \-\-update\&.
.RE
.PP
\fB\-d, \-\-delete <value>\fR
.RS 4
-Delete all or selected targets\. The target will be deleted only if it\'s not used (no initiator is connected to it)\.
+Delete all or selected targets\&. The target will be deleted only if it\'s not used (no initiator is connected to it)\&.
.sp
-If you want to delete targets which are in use, you have to add the "\-\-force" flag\.
+If you want to delete targets which are in use, you have to add the "\-\-force" flag\&.
.sp
.RS 4
.nf
@@ -37,7 +37,7 @@ Example usage:
\-\-delete ALL \- delete all targets
\-\-delete tid=4 \- delete target 4
(target with tid 4)
- \-\-delete iqn\.2008\-08\.com\.example:some\.target
+ \-\-delete iqn\&.2008\-08\&.com\&.example:some\&.target
\- delete this target
.fi
@@ -47,7 +47,7 @@ Example usage:
.PP
\fB\-\-offline\fR
.RS 4
-Put all or selected targets in offline state\.
+Put all or selected targets in offline state\&.
.sp
.RS 4
.nf
@@ -55,7 +55,7 @@ Example usage:
\-\-offline ALL \- offline all targets
\-\-offline tid=4 \- offline target 4
(target with tid 4)
- \-\-offline iqn\.2008\-08\.com\.example:some\.target
+ \-\-offline iqn\&.2008\-08\&.com\&.example:some\&.target
\- offline this target
.fi
@@ -65,7 +65,7 @@ Example usage:
.PP
\fB\-\-ready\fR
.RS 4
-Put all or selected targets in ready state\.
+Put all or selected targets in ready state\&.
.sp
.RS 4
.nf
@@ -73,7 +73,7 @@ Example usage:
\-\-ready ALL \- ready all targets
\-\-ready tid=4 \- ready target 4
(target with tid 4)
- \-\-ready iqn\.2008\-08\.com\.example:some\.target
+ \-\-ready iqn\&.2008\-08\&.com\&.example:some\&.target
\- ready this target
.fi
@@ -83,9 +83,9 @@ Example usage:
.PP
\fB\-\-update <value>\fR
.RS 4
-Update all or selected targets\. The target will be updated only if it\'s not used (no initiator is connected to it)\.
+Update all or selected targets\&. The target will be updated only if it\'s not used (no initiator is connected to it)\&.
.sp
-If you want to update targets which are in use, you have to add "\-\-force" flag\.
+If you want to update targets which are in use, you have to add "\-\-force" flag\&.
.sp
.RS 4
.nf
@@ -93,7 +93,7 @@ Example usage:
\-\-update ALL \- ready all targets
\-\-update tid=4 \- ready target 4
(target with tid 4)
- \-\-update iqn\.2008\-08\.com\.example:some\.target
+ \-\-update iqn\&.2008\-08\&.com\&.example:some\&.target
\- update this target
.fi
@@ -103,91 +103,96 @@ Example usage:
.PP
\fB\-s, \-\-show\fR
.RS 4
-Show all the targets\.
+Show all the targets\&.
+.RE
+.PP
+\fB\-C, \-\-control\-port <NNNN>\fR
+.RS 4
+It is possible to run multiple concurrent instances of tgtd on a host\&. This argument is used to control which instance the tgt\-admin command will operate on\&.
.RE
.PP
\fB\-c, \-\-conf <configuration file>\fR
.RS 4
-Specify an alternative configuration file instead of /etc/tgt/target\.conf, which is the default\.
+Specify an alternative configuration file instead of /etc/tgt/target\&.conf, which is the default\&.
.RE
.PP
\fB\-\-ignore\-errors\fR
.RS 4
-Continue even if tgtadm exits with non\-zero code\.
+Continue even if tgtadm exits with non\-zero code\&.
.RE
.PP
\fB\-f, \-\-force\fR
.RS 4
-Force some operations even if the target is in use\.
+Force some operations even if the target is in use\&.
.RE
.PP
\fB\-p, \-\-pretend\fR
.RS 4
-Only print tgtadm options which would be used; don\'t execute any actions\. Assumes \-v\.
+Only print tgtadm options which would be used; don\'t execute any actions\&. Assumes \-v\&.
.RE
.PP
\fB\-\-dump\fR
.RS 4
-Dump current tgtd configuration\. Note: does not include detailed parameters, like write caching\.
+Dump current tgtd configuration\&. Note: does not include detailed parameters, like write caching\&.
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
-Increase verbosity (show tgtadm commands used)\.
+Increase verbosity (show tgtadm commands used)\&.
.RE
.PP
\fB\-h, \-\-help\fR
.RS 4
-Display a list of available options and exit\.
+Display a list of available options and exit\&.
.RE
.SH "CONFIGURATION FILE SYNTAX"
.PP
-The defualt configuration file is /etc/tgt/target\.conf\. It defines all the targets and their properties\. The configuration file is in XML format and uses tags\. Configuration file contains several target blocks, where each block contains target\'s properties such as storage devices, initator ACL and authorization information\. You can include other config files using: include /etc/tgt/xen/*\.conf\.
+The defualt configuration file is /etc/tgt/target\&.conf\&. It defines all the targets and their properties\&. The configuration file is in XML format and uses tags\&. Configuration file contains several target blocks, where each block contains target\'s properties such as storage devices, initator ACL and authorization information\&. You can include other config files using: include /etc/tgt/xen/*\&.conf\&.
.PP
\fBbacking\-store\fR
.RS 4
-Defines a virtual device on the target\.
+Defines a virtual device on the target\&.
.RE
.PP
\fBdirect\-store\fR
.RS 4
-Defines a direct mapped device with the same properties as the physical device (such as VENDOR_ID, SERIAL_NUM, etc\.)
+Defines a direct mapped device with the same properties as the physical device (such as VENDOR_ID, SERIAL_NUM, etc\&.)
.RE
.PP
\fBinitiator\-address\fR
.RS 4
-Allows connections only from the specified IP address\. Defaults to ALL if no "initiator\-address" is specified\.
+Allows connections only from the specified IP address\&. Defaults to ALL if no "initiator\-address" is specified\&.
.RE
.PP
\fBincominguser\fR
.RS 4
-Define iscsi incoming authentication setting\. If no "incominguser" is specified, it is not used\.
+Define iscsi incoming authentication setting\&. If no "incominguser" is specified, it is not used\&.
.RE
.PP
\fBoutgoinguser\fR
.RS 4
-Define iscsi outgoing authentication setting\. If no "outgoinguser" is specified, it is not used\.
+Define iscsi outgoing authentication setting\&. If no "outgoinguser" is specified, it is not used\&.
.sp
.RS 4
.nf
Example configuration file:
-<target iqn\.2007\-04\.com\.example:san\.monitoring>
+<target iqn\&.2007\-04\&.com\&.example:san\&.monitoring>
backing\-store /dev/san/monitoring
# if no "incominguser" is specified, it is not used
incominguser backup secretpass12
# defaults to ALL if no "initiator\-address" is specified
-initiator\-address 192\.168\.1\.2
+initiator\-address 192\&.168\&.1\&.2
</target>
-<target iqn\.2007\-02\.com\.example:san\.xen1>
+<target iqn\&.2007\-02\&.com\&.example:san\&.xen1>
backing\-store /dev/san/xen1\-disk1 # LUN1
direct\-store /dev/san/xen1\-disk2 # LUN2
-initiator\-address 192\.168\.1\.2 # Allowed IP
-initiator\-address 192\.168\.5\.6 # Allowed IP
+initiator\-address 192\&.168\&.1\&.2 # Allowed IP
+initiator\-address 192\&.168\&.5\&.6 # Allowed IP
incominguser user1 secretpass12
incominguser user2 secretpass23
@@ -195,11 +200,11 @@ incominguser user2 secretpass23
outgoinguser userA secretpassA
</target>
-<target iqn\.2007\-02\.com\.example:san\.xen2>
+<target iqn\&.2007\-02\&.com\&.example:san\&.xen2>
backing\-store /dev/san/xen2
</target>
-<target iqn\.2007\-06\.com\.example:san\.vmware1>
+<target iqn\&.2007\-06\&.com\&.example:san\&.vmware1>
backing\-store /dev/san/vmware1
</target>
@@ -208,19 +213,19 @@ backing\-store /dev/san/vmware1
.RE
.SH "FILES"
.PP
-\fB/etc/tgt/targets\.conf\fR
+\fB/etc/tgt/targets\&.conf\fR
.RS 4
-Configuration file for tgt\-admin\.
+Configuration file for tgt\-admin\&.
.RE
.PP
-\fB/usr/share/doc/tgt/targets\.conf\.example\fR
+\fB/usr/share/doc/tgt/targets\&.conf\&.example\fR
.RS 4
-Example configuration file for tgt\-admin\.
+Example configuration file for tgt\-admin\&.
.RE
.SH "SEE ALSO"
.PP
-tgtd(8), tgtadm(8), tgtimg(8), tgt\-setup\-lun(8)\.
+tgtd(8), tgtadm(8), tgtimg(8), tgt\-setup\-lun(8)\&.
\fI\%http://stgt.sourceforge.net/\fR
.SH "REPORTING BUGS"
.PP
-Report bugs to <stgt at vger\.kernel\.org>
+Report bugs to <stgt at vger\&.kernel\&.org>
--
1.6.5
--
To unsubscribe from this list: send the line "unsubscribe stgt" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
More information about the stgt
mailing list