[Glibc-bsd-commits] r3725 - in trunk/istgt/debian: . patches

Arno Töll atoell-guest at alioth.debian.org
Fri Oct 7 18:07:19 UTC 2011 

Author: atoell-guest
Date: 2011-10-07 18:07:18 +0000 (Fri, 07 Oct 2011)
New Revision: 3725

Added:
   trunk/istgt/debian/patches/add-istgtcontrol-manpage
Modified:
   trunk/istgt/debian/changelog
   trunk/istgt/debian/manpages
   trunk/istgt/debian/patches/series
   trunk/istgt/debian/rules
Log:
Write manpages for the istgtcontrol command

Modified: trunk/istgt/debian/changelog
===================================================================
--- trunk/istgt/debian/changelog	2011-10-07 13:00:38 UTC (rev 3724)
+++ trunk/istgt/debian/changelog	2011-10-07 18:07:18 UTC (rev 3725)
@@ -1,8 +1,10 @@
 istgt (0.4~20110928-2) UNRELEASED; urgency=low
 
   * NOT RELEASED YET
+  * Add patch `add-istgtcontrol-manpage' which adds a manpage for the
+    istgtcontrol command.
 
- -- Arno Töll <debian at toell.net>  Fri, 07 Oct 2011 10:58:27 -0400
+ -- Arno Töll <debian at toell.net>  Fri, 07 Oct 2011 19:55:45 +0200
 
 istgt (0.4~20110928-1) unstable; urgency=low
 

Modified: trunk/istgt/debian/manpages
===================================================================
--- trunk/istgt/debian/manpages	2011-10-07 13:00:38 UTC (rev 3724)
+++ trunk/istgt/debian/manpages	2011-10-07 18:07:18 UTC (rev 3725)
@@ -1 +1,2 @@
 doc/istgt.1
+doc/istgtcontrol.1

Added: trunk/istgt/debian/patches/add-istgtcontrol-manpage
===================================================================
--- trunk/istgt/debian/patches/add-istgtcontrol-manpage	                        (rev 0)
+++ trunk/istgt/debian/patches/add-istgtcontrol-manpage	2011-10-07 18:07:18 UTC (rev 3725)
@@ -0,0 +1,209 @@
+Description: Add istgtcontrol manpage
+ Add the manpages for the istgtcontrol.1 command. Modified files:
+ .
+ * doc/istgtcontrol.1.in - new file
+ * doc/Makefile.in - change Makefile to make use of the Makefile
+ Forwarded: Yes
+ Author: Arno Töll <debian at toell.net>
+ Applied-Upstream: not yet
+ Last-Update: 2010-10-07
+
+--- a/doc/Makefile.in
++++ b/doc/Makefile.in
+@@ -19,22 +19,24 @@
+ 
+ source   = 
+ header   = 
+-document = QUICKSTART QUICKSTART.jp istgt.1.in
++document = QUICKSTART QUICKSTART.jp
+ sample   = 
++MANPAGES = $(patsubst %.1.in, %.1, $(wildcard *.1.in))
+ 
+ DISTDIR = $(top_srcdir)/`cat $(top_srcdir)/distdir`
+ DISTFILES = Makefile.in \
+ 	$(header) $(source) \
+ 	$(document) $(sample)
++DISTFILES += $(MANPAGES)
+ 
+ #########################################################################
+ 
+-all: istgt.1
++all: $(MANPAGES)
+ 
+-istgt.1:
++$(MANPAGES):
+ 	$(SED) -e 's:%%PREFIX%%:$(prefix):g' \
+ 		-e 's:%%CONFIGDIR%%:$(configdir):g' \
+-		-e 's:%%MEDIADIR%%:$(mediadir):g' < istgt.1.in > $@
++		-e 's:%%MEDIADIR%%:$(mediadir):g' < $(patsubst %.1, %.1.in, $@) > $@
+ 
+ dist: $(DISTFILES)
+ 	mkdir $(DISTDIR)/$(subdir)
+@@ -44,9 +46,13 @@
+ 	done
+ 
+ install: install-dirs
+-	install -c -m 0644 istgt.1 $(DESTDIR)$(mandir)/man1/
+-	-rm -f $(DESTDIR)$(mandir)/man1/istgt.1.gz
+-	gzip -9 $(DESTDIR)$(mandir)/man1/istgt.1
++	set -e
++	for file in $(MANPAGES) ; \
++	do \
++		install -c -m 0644 $$file $(DESTDIR)$(mandir)/man1/ ; \
++		rm -f $(DESTDIR)$(mandir)/man1/$$file.gz ; \
++		gzip -9 $(DESTDIR)$(mandir)/man1/$$file ; \
++	done
+ 
+ install-doc: install-doc-dirs
+ 	install -c -m 0644 $(top_srcdir)/README $(DESTDIR)$(datadir)/doc/istgt/
+@@ -61,7 +67,7 @@
+ 	mkdir -p $(DESTDIR)$(datadir)/doc/istgt
+ 
+ clean:
+-	-rm -f istgt.1
++	-rm -f $(MANPAGES)
+ 	-rm -f a.out *.o *.core
+ 	-rm -f *~
+ 
+--- /dev/null
++++ b/doc/istgtcontrol.1.in
+@@ -0,0 +1,139 @@
++.TH istgtcontrol 1 "Oct 07, 2011" "istgtcontrol"
++.SH NAME
++istgtcontrol \- istgt iSCSI target command utility
++.SH SYNOPSIS
++.B istgtcontrol
++[options] <command> [<file>]
++.SH DESCRIPTION
++\fBistgtcontrol\fP is a command and control utility for \fBistgt\fP(1).
++It can be used to query and change the status of a local or remote
++\fBistgt\fP instance.
++.PP
++\fBistgtcontrol\fP supports the commands denoted below to interact with
++the \fBistgt\fP instance. By default it connects and authenticates to
++the iSCSI target portal specified in the \fBistgtcontrol.conf\fP
++configuration file and uses CHAP credentials denoted there, if any.
++Both can be overridden by using the respecitve command line arguments.
++.SH COMMANDS
++
++\fBistgtcontrol\fP understands the following commands which can be
++forwarded to \fBistgt\fP:
++
++.TP
++.BI "noop"
++Do not actually do anything, but test responsiveness of the portal and
++test CHAP credentials only.
++.TP
++.BI "version"
++Retrieve the \fBistgt\fP version number providing the iSCSI
++portal \fBistgtcontrol\fP connected to.
++.TP
++.BI "list"
++List all, or the specified targets only, which shared by the portal.
++.TP
++.BI "load"
++Load a new media to the specified unit. This command issues the same
++command as if a drive tray had been closed on a SCSI device.
++
++.TP
++.BI "unload"
++Unload a media from the specified unit. This command issues the same
++command as if the drive tray had been opened from a SCSI device.
++
++.TP
++.BI "change" " \fIfile\fP"
++Change the loaded media by the specified unit. This command is
++equivalent as if a new media (for example a DVD-ROM or tape cartridge) had
++been inserted in the SCSI drive. The "\fIfile\fP" argument is interpreted
++as filename to be loaded.
++
++.TP
++.BI "reset"
++Reset the specified LUN of the portal.
++.TP
++.BI "info"
++Display all connections of the portal
++
++.SH OPTIONS
++.TP
++.BI \-c " \fIconfig\fP"
++Use specified file as configuration file instead of the default file.
++.TP
++
++.BI -h " \fIhost\fP"
++Override the target portal by the specified host name or IP address. This
++defaults to "localhost" if no other host was specified in the
++configuration file.
++.TP
++.BI -p " \fIport\fP"
++Override the target portal port by the specified port number. This defaults
++to "3261" if no other port was specified in the configuration file.
++.TP
++.BI -t " \fItarget\fP"
++Specifies the target IQN which should be affected by the command given.
++There may be a default given in the configuration file. 
++.TP
++.BI -l " \fIlun\fP"
++Specifies the target LUN which should be affected by the command given.
++This defaults to "0" unless another default was provided in the configuration
++file.
++.TP
++.BI -f " \fIflags\fP"
++Specifies flags passed to the portal when loading a new media. This
++defaults to "ro". Supported \fIflags\fP are: "ro", "rw", "extend" and
++"dynamic".
++.TP
++.BI -s " \fIsize\fP"
++Specifies the size of the meda to be loaded. The default is to auto-detect the
++media size.
++.TP
++.BI -q
++Quiet mode, supress non-critical outputs.
++.TP
++.BI -v
++Verbose mode, gives more output during operations.
++.TP
++.BI -A " \fImethod\fP"
++Sets the preferred authentication method for logging in to the portal. This
++overrides any method specified in the configuration file. Supported
++methods are either CHAP/Mutual or CHAP/Auto.
++.TP
++.BI -U " \fIuser\fP"
++Sets the user to authenticate on the portal. This overrides any username
++specified in the configuration file.
++.TP
++.BI -S " \fIsecret\fP"
++Set the secret used to authenticate on the portal. This overrides any
++secret specified in the configuration file.
++.TP
++.BI -M " \fImuser\fP"
++Set the mutual authentication user. This overrides any user specified in
++the configuration file.
++.TP
++.BI -R " \fImsecret\fP"
++Set the mutual authentication secret. This overrides any secret
++specified in the configuration file.
++.TP
++.BI -H
++Display a brief usage summary and exit.
++.TP
++.BI -V
++Display the \fBistgtcontrol\fP version number and exit.
++.TP
++
++
++.SH FILES
++.PD 0
++.TP
++.I %%CONFIGDIR%%/istgtcontrol.conf
++Configuration file
++
++.PD
++.SH SEE ALSO
++\fBistgt\fP(1)
++.PD
++.SH AUTHORS
++Daisuke Aoyama <aoyama at peach.ne.jp>
++
++This manual page was written by Arno Töll (<debian at toell.net>) for the Debian
++GNU/kFreeBSD system (but may be used by others).

Modified: trunk/istgt/debian/patches/series
===================================================================
--- trunk/istgt/debian/patches/series	2011-10-07 13:00:38 UTC (rev 3724)
+++ trunk/istgt/debian/patches/series	2011-10-07 18:07:18 UTC (rev 3725)
@@ -1 +1,2 @@
 fix-installdir.patch
+add-istgtcontrol-manpage

Modified: trunk/istgt/debian/rules
===================================================================
--- trunk/istgt/debian/rules	2011-10-07 13:00:38 UTC (rev 3724)
+++ trunk/istgt/debian/rules	2011-10-07 18:07:18 UTC (rev 3725)
@@ -18,7 +18,7 @@
 	dh_install
 	rm -f debian/istgt/etc/rc.d/istgt
 	rmdir debian/istgt/etc/rc.d
-	rm -f debian/istgt/usr/man/man1/istgt.1.gz
+	rm -f debian/istgt/usr/man/man1/istgt*.gz
 	rmdir debian/istgt/usr/man/man1 debian/istgt/usr/man
 	rm -f debian/istgt/etc/istgt/*.conf.sample
 	install -m 0644 -t debian/istgt/etc/istgt debian/README.configuration

More information about the Glibc-bsd-commits mailing list