Author: sandervanderburg
Date: Tue Nov 2 19:05:13 2010
New Revision: 24577
URL: https://svn.nixos.org/websvn/nix/?rev=24577&sc=1
Log:
Added manual page for disnix-soap-client
Added:
disnix/DisnixWebService/trunk/doc/disnix-soap-client.xml
Modified:
disnix/DisnixWebService/trunk/build.xml
disnix/DisnixWebService/trunk/doc/Makefile
disnix/DisnixWebService/trunk/doc/index.xml
Modified: disnix/DisnixWebService/trunk/build.xml
==============================================================================
--- disnix/DisnixWebService/trunk/build.xml Tue Nov 2 18:38:09 2010
(r24576)
+++ disnix/DisnixWebService/trunk/build.xml Tue Nov 2 19:05:13 2010
(r24577)
@@ -128,7 +128,15 @@
</copy>
</target>
- <target name="install" depends="install.service, install.client,
install.doc" />
+ <target name="install.man">
+ <mkdir dir="${PREFIX}/share/man/man1" />
+
+ <copy toDir="${PREFIX}/share/man/man1">
+ <fileset dir="${basedir}/doc" includes="*.1" />
+ </copy>
+ </target>
+
+ <target name="install" depends="install.service, install.client,
install.doc, install.man" />
<target name="clean">
<delete file="DisnixConnection.jar" />
Modified: disnix/DisnixWebService/trunk/doc/Makefile
==============================================================================
--- disnix/DisnixWebService/trunk/doc/Makefile Tue Nov 2 18:38:09 2010
(r24576)
+++ disnix/DisnixWebService/trunk/doc/Makefile Tue Nov 2 19:05:13 2010
(r24577)
@@ -14,7 +14,9 @@
MANUAL_SRCS = index.xml introduction.xml
-all: index.html
+MANS = disnix-soap-client.1
+
+all: index.html man
version.txt:
echo -n $(VERSION) > version.txt
@@ -23,6 +25,9 @@
$(XMLLINT) --noout --nonet --xinclude --noxincludenode --relaxng
$(docbookrng)/docbook.rng $<
touch $@
+man $(MANS): $(MANUAL_SRCS) manual.is-valid
+ $(XSLTPROC) --nonet --xinclude $(docbookxsl)/manpages/docbook.xsl
index.xml
+
index.html: $(MANUAL_SRCS) manual.is-valid
$(XSLTPROC) --nonet --xinclude --output index.html \
$(docbookxsl)/html/docbook.xsl index.xml
Added: disnix/DisnixWebService/trunk/doc/disnix-soap-client.xml
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ disnix/DisnixWebService/trunk/doc/disnix-soap-client.xml Tue Nov 2
19:05:13 2010 (r24577)
@@ -0,0 +1,283 @@
+<refentry xmlns="http://docbook.org/ns/docbook";
+ xmlns:xlink="http://www.w3.org/1999/xlink";
+ xmlns:xi="http://www.w3.org/2001/XInclude";
+ xml:id="sec-disnix-soap-client">
+
+ <refmeta>
+ <refentrytitle>disnix-soap-client</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="source">Disnix</refmiscinfo>
+ <refmiscinfo class="version"><xi:include href="version.txt"
parse="text" /></refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>disnix-soap-client</refname>
+ <refpurpose>Provides access to the disnix-service through the
SOAP protocol</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>disnix-soap-client</command>
+ <arg choice="req"><option>--target</option>
<replaceable>targetEPR</replaceable></arg>
+ <arg
choice="req"><replaceable>operation</replaceable></arg>
+ <arg><replaceable>options</replaceable></arg>
+ <arg><replaceable>Nix_store_path</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>
+ The command <command>disnix-soap-client</command>
provides remote access to a <command>disnix-service</command> instance running
+ on a machine in the network by the SOAP protocol used
by web services. This allows the user to perform remote deployment
+ operations on a target machine through SOAP.
+ </para>
+ <para>
+ In most cases this command is not used directly, but is
used by specifying the <option>--interface</option> option
+ for a Disnix command-line utility (such as
<command>disnix-env</command>) or by setting the
<replaceable>DISNIX_CLIENT_INTERFACE</replaceable>
+ environment variable. By using one of those properties,
the Disnix tools will use the given interface instead
+ of the standard <command>disnix-client</command> which
only provides loopback access.
+ </para>
+ </refsection>
+
+ <refsection>
+ <title>Operations</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>--import</option></term>
+ <listitem>
+ <para>
+ Imports a given closure into
the Nix store of the target machine. Optionally,
+ it transfers the closure from
this machine to the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--export</option></term>
+ <listitem>
+ <para>
+ Exports the closure of a given
Nix store path of the target machine into a file,
+ and optionally downloads it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--print-invalid</option></term>
+ <listitem>
+ <para>
+ Prints all the paths that are
not valid in the Nix store of the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--realise</option></term>
+ <listitem>
+ <para>
+ Realises the given store
derivation on the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--set</option></term>
+ <listitem>
+ <para>
+ Creates a Disnix profile only
containing the given derivation on the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--query-installed</option></term>
+ <listitem>
+ <para>
+ Queries all the installed
services on the given target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--query-requisites</option></term>
+ <listitem>
+ <para>
+ Queries all the requisites
(intra-dependencies) of the given services on the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--collect-garbage</option></term>
+ <listitem>
+ <para>
+ Collects garbage on the given
target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--activate</option></term>
+ <listitem>
+ <para>
+ Activates the given service on
the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--deactivate</option></term>
+ <listitem>
+ <para>
+ Deactivates the given service
on the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--lock</option></term>
+ <listitem>
+ <para>
+ Acquires a lock on a Disnix
profile of the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--unlock</option></term>
+ <listitem>
+ <para>
+ Release the lock on a Disnix
profile of the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>Options</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-t</option>,
<option>--target</option></term>
+ <listitem>
+ <para>
+ Specifies the URL of the web
service interface used to connect to the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <refsection>
+ <title>Import operation</title>
+
+ <variablelist>
+ <varlistentry>
+
<term><option>--localfile</option></term>
+ <listitem>
+ <para>
+ Specifies that the
given closure is stored locally,
+ so that it will be
transfered to the target machine first.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+
<term><option>--remotefile</option></term>
+ <listitem>
+ <para>
+ Specifies that the
given closure is stored remotely,
+ so that it does not
have to be transfered to the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>Export operation</title>
+
+ <variablelist>
+ <varlistentry>
+
<term><option>--localfile</option></term>
+ <listitem>
+ <para>
+ Specifies that the
exported closure should be stored locally.
+ This option does not
download the closure.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+
<term><option>--remotefile</option></term>
+ <listitem>
+ <para>
+ Specifies that the
exported closure should be stored remotely.
+ This option downloads
the closure from the target machine.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>Set operation/Query installed operation</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-p</option>,
<option>--profile</option></term>
+ <listitem>
+ <para>
+ Specifies the name of
the profile that should be used. Defaults to: default
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>Collect garbage operation</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-d</option>,
<option>--delete-old</option></term>
+ <listitem>
+ <para>
+ Specifies that also the
older generations of the profiles have to be deleted.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>Activation/Deactivation operation</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>--type</option></term>
+ <listitem>
+ <para>
+ Specifies the
activation module that should be used, such as
+ <command>echo</command>
or <command>process</command>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+
<term><option>--arguments</option></term>
+ <listitem>
+ <para>
+ Specifies the arguments
passed to the activation module,
+ which is a string with
key=value pairs.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>Lock/Unlock operation</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-p</option>,
<option>--profile</option></term>
+ <listitem>
+ <para>
+ Specifies the name of
the profile that should be used. Defaults to: default.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ </refsection>
+</refentry>
\ No newline at end of file
Modified: disnix/DisnixWebService/trunk/doc/index.xml
==============================================================================
--- disnix/DisnixWebService/trunk/doc/index.xml Tue Nov 2 18:38:09 2010
(r24576)
+++ disnix/DisnixWebService/trunk/doc/index.xml Tue Nov 2 19:05:13 2010
(r24577)
@@ -2,7 +2,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude";>
<info>
- <title>Disnix WebService User's Guide</title>
+ <title>Disnix Web Service User's Guide</title>
<subtitle>Draft (Version <xi:include href="version.txt" parse="text"
/>)</subtitle>
@@ -31,7 +31,7 @@
<xi:include href="introduction.xml" />
<xi:include href="installation.xml" />
- <!-- <appendix>
+ <appendix>
<title>Command Reference</title>
<section>
@@ -39,6 +39,6 @@
<xi:include href="disnix-soap-client.xml" />
</section>
- </appendix> -->
+ </appendix>
</book>
_______________________________________________
nix-commits mailing list
[email protected]
http://mail.cs.uu.nl/mailman/listinfo/nix-commits
