tgtd

From b518519f1fc6019a1c3dfa4df2b1b566bd3d8210 Mon Sep 17 00:00:00 2001 From: Ronnie Sahlberg Date: Wed, 17 Feb 2010 11:07:20 +1100 Subject: [PATCH] Add documentation about the tgtd daemon in XSLT format. If xsltproc is available, use this tool to compile this XSLT file into both a manpage and a html page for tgtd. Add a directory doc/htmlpages to store html versions of manpages. These could go to /usr/share/doc/tgt ? Check in both generated file, man and html, so that they are still available on systems where xsltproc is not available to build them. Signed-off-by: Ronnie Sahlberg --- doc/Makefile | 17 ++++++- doc/htmlpages/tgtd.8.html | 40 +++++++++++++++ doc/manpages/tgtd.8 | 81 +++++++++++++++++++++++++++++ doc/tgtd.8.xml | 123 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 260 insertions(+), 1 deletions(-) create mode 100644 doc/htmlpages/tgtd.8.html create mode 100644 doc/manpages/tgtd.8 create mode 100644 doc/tgtd.8.xml diff --git a/doc/Makefile b/doc/Makefile index f7cdfd3..77b6f87 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,10 +2,15 @@ mandir ?= $(PREFIX)/share/man docdir ?= $(PREFIX)/share/doc/tgt MANPAGES = manpages/tgtadm.8 manpages/tgt-admin.8 \ - manpages/tgt-setup-lun.8 + manpages/tgt-setup-lun.8 manpages/tgtd.8 + DOCS = README.fcoe README.ibmvstgt README.iscsi README.iser \ README.lu_configuration README.mmc tmf.txt +XSLTPROC = /usr/bin/xsltproc +XMLMAN = manpages/tgtd.8 +XMLHTML = htmlpages/tgtd.8.html + .PHONY:all all: @@ -19,3 +24,13 @@ install: $(MANPAGES) $(DOCS) .PHONY: clean clean: +manpages/tgtd.8: tgtd.8.xml + -test -z "$(XSLTPROC)" || $(XSLTPROC) -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< + +htmlpages/tgtd.8.html: tgtd.8.xml + -test -z "$(XSLTPROC)" || $(XSLTPROC) -o $@ http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< + +xmlman: $(XMLMAN) + +xmlhtml: $(XMLHTML) + diff --git a/doc/htmlpages/tgtd.8.html b/doc/htmlpages/tgtd.8.html new file mode 100644 index 0000000..3e93d42 --- /dev/null +++ b/doc/htmlpages/tgtd.8.html @@ -0,0 +1,40 @@ +tgtd

Name

tgtd — The SCSI Target Daemon

Synopsis

tgtd

tgtd [-d --debug <INTEGER>] [-f --foregound] [-h --help] [--iscsi <...>]

DESCRIPTION

+ Tgtd is a SCSI Target daemon. It can be used to provide iSCSI target + service to a network. +

OPTIONS

-d --debug <INTEGER>: + Set to non-zero value to activate additional debugging messages to + be logged. +
-f --foreground: + Run the daemon in the foreground. +
-h --help: + Print help text to the screen. +
--iscsi <...>: + ISCSI specific options. + See the ISCSI section below for options specific to this frontend. +

ISCSI options

+ These parameters apply only to the iSCSI frontend. +

portal=<ip-address[:port]>

+ 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. +

+ Example: to bind tgtd to a specific address and port +

+	tgtd --iscsi portal=192.0.2.1:3260
+

+

SEE ALSO

+ tgtadm(8), tgt-admin(8), tgt-setup-lun(8). + http://stgt.sourceforge.net/ +

COPYRIGHT/LICENSE

+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.
+
+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.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, see http://www.gnu.org/licenses/.
+

diff --git a/doc/manpages/tgtd.8 b/doc/manpages/tgtd.8 new file mode 100644 index 0000000..a7100bc --- /dev/null +++ b/doc/manpages/tgtd.8 @@ -0,0 +1,81 @@ +.\" Title: tgtd +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.73.2 +.\" Date: 02/17/2010 +.\" Manual: +.\" Source: +.\" +.TH "TGTD" "8" "02/17/2010" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +tgtd - The SCSI Target Daemon +.SH "SYNOPSIS" +.HP 5 +\fBtgtd\fR +.HP 5 +\fBtgtd\fR [\-d\ \-\-debug\ ] [\-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\. +.SH "OPTIONS" +.PP +\-d \-\-debug +.RS 4 +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\. +.RE +.PP +\-h \-\-help +.RS 4 +Print help text to the screen\. +.RE +.PP +\-\-iscsi <\.\.\.> +.RS 4 +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\. +.SS "portal=" +.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\. +.PP +Example: to bind tgtd to a specific address and port +.sp +.RS 4 +.nf + tgtd \-\-iscsi portal=192\.0\.2\.1:3260 + +.fi +.RE +.sp +.SH "SEE ALSO" +.PP +tgtadm(8), tgt\-admin(8), tgt\-setup\-lun(8)\. +\fI\%http://stgt.sourceforge.net/\fR +.SH "COPYRIGHT/LICENSE" +.sp +.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\. + +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\. + +You should have received a copy of the GNU General Public License +along with this program; if not, see http://www\.gnu\.org/licenses/\. +.fi +.RE diff --git a/doc/tgtd.8.xml b/doc/tgtd.8.xml new file mode 100644 index 0000000..9200c46 --- /dev/null +++ b/doc/tgtd.8.xml @@ -0,0 +1,123 @@ + + + + + + tgtd + 8 + + + + + tgtd + The SCSI Target Daemon + + + + + tgtd + + + + tgtd + -d --debug <INTEGER> + -f --foregound + -h --help + --iscsi <...> + + + + + DESCRIPTION + + Tgtd is a SCSI Target daemon. It can be used to provide iSCSI target + service to a network. + + + + + + OPTIONS + + + -d --debug <INTEGER> + + + Set to non-zero value to activate additional debugging messages to + be logged. + + + + + -f --foreground + + + Run the daemon in the foreground. + + + + + -h --help + + + Print help text to the screen. + + + + + --iscsi <...> + + + ISCSI specific options. + See the ISCSI section below for options specific to this frontend. + + + + + + + + ISCSI options + + These parameters apply only to the iSCSI frontend. + + + portal=<ip-address[:port]> + + 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. + + + Example: to bind tgtd to a specific address and port + + tgtd --iscsi portal=192.0.2.1:3260 + + + + + + + SEE ALSO + + tgtadm(8), tgt-admin(8), tgt-setup-lun(8). + + + + + COPYRIGHT/LICENSE + +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. + +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. + +You should have received a copy of the GNU General Public License +along with this program; if not, see http://www.gnu.org/licenses/. + + + -- 1.5.4.3