[stgt] [PATCH 2/2] Update the tgtd manpage to describe what types of devices tgtd can emulate
FUJITA Tomonori
fujita.tomonori at lab.ntt.co.jp
Sat Oct 2 13:02:28 CEST 2010
From: Ronnie Sahlberg <ronniesahlberg at gmail.com>
Signed-off-by: Ronnie Sahlberg <ronniesahlberg at gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori at lab.ntt.co.jp>
---
doc/htmlpages/tgtd.8.html | 32 ++++++++++---
doc/manpages/tgtd.8 | 111 ++++++++++++++++++++++++++++++++++-----------
doc/tgtd.8.xml | 19 +++++++-
3 files changed, 125 insertions(+), 37 deletions(-)
diff --git a/doc/htmlpages/tgtd.8.html b/doc/htmlpages/tgtd.8.html
index 16b6c55..2e31297 100644
--- a/doc/htmlpages/tgtd.8.html
+++ b/doc/htmlpages/tgtd.8.html
@@ -1,7 +1,17 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgtd</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="tgtd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgtd — The SCSI Target Daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtd</code> </p></div><div class="cmdsynopsis"><p><code class="command">tgtd</code> [-C --control-port <INTEGER>] [-d --debug <INTEGER>] [-f --foregound] [-h --help] [--iscsi <...>]</p></div></div><div class="refsect1" lang="en"><a name="id2475959"></a><h2>DESCRIPTION</h2><p>
- Tgtd is a SCSI Target daemon. It can be used to provide iSCSI target
- service to a network.
- </p></div><div class="refsect1" lang="en"><a name="id2475970"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-d --debug <INTEGER></span></dt><dd><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgtd</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="tgtd"><a name="tgtd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgtd — The SCSI Target Daemon</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtd</code> </p></div><div class="cmdsynopsis"><p><code class="command">tgtd</code> [-C --control-port <INTEGER>] [-d --debug <INTEGER>] [-f --foregound] [-h --help] [--iscsi <...>]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id283058"></a><h2>DESCRIPTION</h2><p>
+ Tgtd is a SCSI Target daemon. It can be used to provide SCSI target
+ service to a network. The most common service is iSCSI but other services are also
+ supported.
+ </p></div><div class="refsect1" title="Device types"><a name="id283068"></a><h2>Device types</h2><p>
+ Tgtd provides support for both emulated and passthrough of real devices.
+ </p></div><pre class="screen">
+ Tgtd can emulate the following types of devices:
+
+ disk : Normal disk device. Emulates a SCSI harddisk.
+ tape : Tape device. Emulates a SCSI tape drive.
+ cd : CD device. Emulates a SCSI DVD burner.
+ changer : Media changer. Emulate the changer device for a virtual tape library or DVD jukebox.
+ </pre><div class="refsect1" title="OPTIONS"><a name="id283085"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-d --debug <INTEGER></span></dt><dd><p>
Set to non-zero value to activate additional debugging messages to
be logged.
</p></dd><dt><span class="term">-f --foreground</span></dt><dd><p>
@@ -18,20 +28,26 @@
</p></dd><dt><span class="term">--iscsi <...></span></dt><dd><p>
ISCSI specific options.
See the ISCSI section below for options specific to this frontend.
- </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476058"></a><h2>ISCSI options</h2><p>
+ </p></dd></dl></div></div><div class="refsect1" title="ISCSI options"><a name="id283167"></a><h2>ISCSI options</h2><p>
These parameters apply only to the iSCSI frontend.
- </p><div class="refsect2" lang="en"><a name="id2476067"></a><h3>portal=<ip-address[:port]></h3><p>
+ </p><div class="refsect2" title="portal=<ip-address[:port]>"><a name="id283175"></a><h3>portal=<ip-address[:port]></h3><p>
This option is used to bind tgtd to a specific ip-address/portal and/or
port. By default tgtd will bind to port 3260 on the wildcard address.
+ The ip-address part (before the ":") can be missing to designate the
+ wildcard address with a none-default port.
</p><p>
Example: to bind tgtd to a specific address and port
</p><pre class="screen">
tgtd --iscsi portal=192.0.2.1:3260
</pre><p>
- </p></div></div><div class="refsect1" lang="en"><a name="id2476091"></a><h2>SEE ALSO</h2><p>
+ Example: to bind tgtd to any address but a none-default port
+ </p><pre class="screen">
+ tgtd --iscsi portal=:3251
+ </pre><p>
+ </p></div></div><div class="refsect1" title="SEE ALSO"><a name="id283204"></a><h2>SEE ALSO</h2><p>
tgtadm(8), tgt-admin(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="id2476106"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+ </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id283218"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
This program is free software; you can redistribute it and/or modify<br>
it under the terms of the GNU General Public License as published by<br>
the Free Software Foundation; either version 2 of the License, or (at<br>
diff --git a/doc/manpages/tgtd.8 b/doc/manpages/tgtd.8
index 6db034f..d9c9336 100644
--- a/doc/manpages/tgtd.8
+++ b/doc/manpages/tgtd.8
@@ -1,88 +1,145 @@
+'\" t
.\" Title: tgtd
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\" Date: 03/04/2010
-.\" Manual:
-.\" Source:
+.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Date: 10/02/2010
+.\" Manual: [FIXME: manual]
+.\" Source: [FIXME: source]
+.\" Language: English
.\"
-.TH "TGTD" "8" "03/04/2010" "" ""
+.TH "TGTD" "8" "10/02/2010" "[FIXME: source]" "[FIXME: manual]"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-tgtd - The SCSI Target Daemon
+tgtd \- The SCSI Target Daemon
.SH "SYNOPSIS"
-.HP 5
+.HP \w'\fBtgtd\fR\ 'u
\fBtgtd\fR
-.HP 5
-\fBtgtd\fR [\-C\ \-\-control\-port\ <INTEGER>] [\-d\ \-\-debug\ <INTEGER>] [\-f\ \-\-foregound] [\-h\ \-\-help] [\-\-iscsi\ <\.\.\.>]
+.HP \w'\fBtgtd\fR\ 'u
+\fBtgtd\fR [\-C\ \-\-control\-port\ <INTEGER>] [\-d\ \-\-debug\ <INTEGER>] [\-f\ \-\-foregound] [\-h\ \-\-help] [\-\-iscsi\ <\&.\&.\&.>]
.SH "DESCRIPTION"
.PP
-Tgtd is a SCSI Target daemon\. It can be used to provide iSCSI target service to a network\.
+Tgtd is a SCSI Target daemon\&. It can be used to provide SCSI target service to a network\&. The most common service is iSCSI but other services are also supported\&.
+.SH "DEVICE TYPES"
+.PP
+Tgtd provides support for both emulated and passthrough of real devices\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ Tgtd can emulate the following types of devices:
+
+ disk : Normal disk device\&. Emulates a SCSI harddisk\&.
+ tape : Tape device\&. Emulates a SCSI tape drive\&.
+ cd : CD device\&. Emulates a SCSI DVD burner\&.
+ changer : Media changer\&. Emulate the changer device for a virtual tape library or DVD jukebox\&.
+
+.fi
+.if n \{\
+.RE
+.\}
.SH "OPTIONS"
.PP
\-d \-\-debug <INTEGER>
.RS 4
-Set to non\-zero value to activate additional debugging messages to be logged\.
+Set to non\-zero value to activate additional debugging messages to be logged\&.
.RE
.PP
\-f \-\-foreground
.RS 4
-Run the daemon in the foreground\.
+Run the daemon in the foreground\&.
.RE
.PP
\-h \-\-help
.RS 4
-Print help text to the screen\.
+Print help text to the screen\&.
.RE
.PP
\-C \-\-control\-port <INTEGER>
.RS 4
-This comamnd is used to specify the control port to use for this instance of tgtd\. This allows to run multiple instances of TGTD on a host\.
+This comamnd is used to specify the control port to use for this instance of tgtd\&. This allows to run multiple instances of TGTD on a host\&.
.sp
-TGTADM has a matching argument to control which instance to connect to\.
+TGTADM has a matching argument to control which instance to connect to\&.
.RE
.PP
-\-\-iscsi <\.\.\.>
+\-\-iscsi <\&.\&.\&.>
.RS 4
-ISCSI specific options\. See the ISCSI section below for options specific to this frontend\.
+ISCSI specific options\&. See the ISCSI section below for options specific to this frontend\&.
.RE
.SH "ISCSI OPTIONS"
.PP
-These parameters apply only to the iSCSI frontend\.
+These parameters apply only to the iSCSI frontend\&.
.SS "portal=<ip\-address[:port]>"
.PP
-This option is used to bind tgtd to a specific ip\-address/portal and/or port\. By default tgtd will bind to port 3260 on the wildcard address\.
+This option is used to bind tgtd to a specific ip\-address/portal and/or port\&. By default tgtd will bind to port 3260 on the wildcard address\&. The ip\-address part (before the ":") can be missing to designate the wildcard address with a none\-default port\&.
.PP
Example: to bind tgtd to a specific address and port
.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ tgtd \-\-iscsi portal=192\&.0\&.2\&.1:3260
+
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Example: to bind tgtd to any address but a none\-default port
+.sp
+.if n \{\
.RS 4
+.\}
.nf
- tgtd \-\-iscsi portal=192\.0\.2\.1:3260
+ tgtd \-\-iscsi portal=:3251
.fi
+.if n \{\
.RE
+.\}
.sp
.SH "SEE ALSO"
.PP
-tgtadm(8), tgt\-admin(8), tgtimg(8), tgt\-setup\-lun(8)\.
-\fI\%http://stgt.sourceforge.net/\fR
+tgtadm(8), tgt\-admin(8), tgtimg(8), tgt\-setup\-lun(8)\&.
+\m[blue]\fB\%http://stgt.sourceforge.net/\fR\m[]
.SH "COPYRIGHT/LICENSE"
.sp
+.if n \{\
.RS 4
+.\}
.nf
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
-your option) any later version\.
+your option) any later version\&.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\. See the GNU
-General Public License for more details\.
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU
+General Public License for more details\&.
You should have received a copy of the GNU General Public License
-along with this program; if not, see http://www\.gnu\.org/licenses/\.
+along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
.fi
+.if n \{\
.RE
+.\}
diff --git a/doc/tgtd.8.xml b/doc/tgtd.8.xml
index 2635a8f..ce734ce 100644
--- a/doc/tgtd.8.xml
+++ b/doc/tgtd.8.xml
@@ -30,12 +30,27 @@
<refsect1><title>DESCRIPTION</title>
<para>
- Tgtd is a SCSI Target daemon. It can be used to provide iSCSI target
- service to a network.
+ Tgtd is a SCSI Target daemon. It can be used to provide SCSI target
+ service to a network. The most common service is iSCSI but other services are also
+ supported.
</para>
</refsect1>
+ <refsect1><title>Device types</title>
+ <para>
+ Tgtd provides support for both emulated and passthrough of real devices.
+ </para>
+ </refsect1>
+ <screen format="linespecific">
+ Tgtd can emulate the following types of devices:
+
+ disk : Normal disk device. Emulates a SCSI harddisk.
+ tape : Tape device. Emulates a SCSI tape drive.
+ cd : CD device. Emulates a SCSI DVD burner.
+ changer : Media changer. Emulate the changer device for a virtual tape library or DVD jukebox.
+ </screen>
+
<refsect1>
<title>OPTIONS</title>
--
1.7.1
--
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