Man page for JP IS daemon, some little fixes.

diff --git a/org.glite.jp.index/Makefile b/org.glite.jp.index/Makefile
index c0324e3..797d03c 100644 (file)
--- a/org.glite.jp.index/Makefile
+++ b/org.glite.jp.index/Makefile
@@ -50,10 +50,10 @@ daemon:=glite-jp-indexd
 examples:=glite-jpis-test glite-jpis-client
 test:=run-test.sh
 test_files:=dump1.sql simple_query.in simple_query.out complex_query.in complex_query.out authz.out 
-MANS1:=glite-jpis-client.1
+MANS1:=glite-jpis-client.1 glite-jp-indexd.8
 MANS8:=
 MANS:=${MANS1} ${MANS8}
-HTMLS:=glite-jpis-client.html
+HTMLS:=glite-jpis-client.html glite-jp-indexd.html
 is_prefix:=jpis_
 is_client_prefix:=jpis_client_
 ps_prefix:=jpps_

diff --git a/org.glite.jp.index/doc/README b/org.glite.jp.index/doc/README
index 6294074..6261664 100644 (file)
--- a/org.glite.jp.index/doc/README
+++ b/org.glite.jp.index/doc/README
@@ -27,7 +27,7 @@ user jpis.
 
 JP-IS interactions:
 
-- JP primary storage - feedins data from primary storage to the IS according
+- JP primary storage - feedings data from primary storage to the IS according
   to particular IS instance administrator needs (expressed by IS configuration)
 
 - IS user query interface - implements IS service for end users
@@ -96,10 +96,10 @@ GLITE_JPIS_PS               - location of JP-PS server (_required parameter_)
 GLITE_JPIS_DEBUG       - setting to '-d' forces the daemon not to daemonize 
 GLITE_JPIS_QT          - defines query type 
                        'hist' ... history query
-                       'cont' ... continuaous query
-                       'both' ... compination of previous types
+                       'cont' ... continuous query
+                       'both' ... combination of previous types
 GLITE_JPIS_AUTH                - setting to '-n' forces the daemon not to check
-                       authorization
+                       authorisation
 GLITE_JPIS_PORT        - used port (default 8902)
 GLITE_JPIS_DB          - database connection string 
                        (default jpis/@localhost:jpis1)

diff --git a/org.glite.jp.index/doc/glite-jp-indexd.sgml b/org.glite.jp.index/doc/glite-jp-indexd.sgml
new file mode 100644 (file)
index 0000000..3a28aac
--- /dev/null
+++ b/org.glite.jp.index/doc/glite-jp-indexd.sgml
@@ -0,0 +1,279 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+
+<refentry id='glitejpindexd'>
+
+       <refmeta>
+               <refentrytitle>glite-jp-indexd</refentrytitle>
+               <manvolnum>8</manvolnum>
+               <refmiscinfo>EU EGEE Project</refmiscinfo>
+       </refmeta>
+
+       <refnamediv id='name'>
+               <refname>glite-jp-indexd</refname>
+               <refpurpose>daemon providing subset of data from Job Provenance</refpurpose>
+       </refnamediv>
+
+       <refsynopsisdiv id='synopsis'>
+               <cmdsynopsis>
+                       <command>glite-jp-indexd</command>
+
+                       <arg><group choice='plain'>
+                               <arg>-h</arg>
+                               <arg>--help</arg>
+                       </group></arg>
+
+                       <arg><group choice='plain'>
+                               <arg>-s</arg>
+                               <arg>--ps-server</arg>
+                       </group> <replaceable>HOST:PORT</replaceable></arg>
+
+                       <arg>-d</arg>
+
+                       <arg><group choice='plain'>
+                               <arg>-q</arg>
+                               <arg>--query-type</arg>
+                       </group><group choice='plain'>
+                               <arg>hist</arg>
+                               <arg>cont</arg>
+                               <arg>both</arg>
+                       </group></arg>
+
+                       <arg><group choice='plain'>
+                               <arg>-n</arg>
+                               <arg>--no-auth</arg>
+                       </group></arg>
+
+                       <arg><group choice='plain'>
+                               <arg>-m</arg>
+                               <arg>--mysql</arg>
+                       </group> <replaceable>USER/PASSWORD@HOST:DBNAME</replaceable></arg>
+
+                       <arg><group choice='plain'>
+                               <arg>-p</arg>
+                               <arg>--port</arg>
+                       </group> <replaceable>PORT</replaceable></arg>
+
+                       <arg><group choice='plain'>
+                               <arg>-i</arg>
+                               <arg>--pidfile</arg>
+                       </group> <replaceable>FILE.PID</replaceable></arg>
+
+                       <arg><group choice='plain'>
+                               <arg>-o</arg>
+                               <arg>--logfile</arg>
+                       </group> <replaceable>FILE.LOG</replaceable></arg>
+
+               </cmdsynopsis>
+       </refsynopsisdiv>
+
+       <refsect1>
+               <title>DESCRIPTION</title>
+               <para>
+<command>glite-jp-index</command> is stand-alone daemon which is using MySQL database. It provides subset of attributes and jobs from Job Provenance.
+               </para>
+       </refsect1>
+
+       <refsect1>
+               <title>OPTIONS</title>
+
+               <para>
+With no options you get simple usage message as with <option>-h</option>.
+               </para>
+
+               <variablelist>
+                       <varlistentry>
+                               <term><option>-s</option>|<option>--ps-server</option></term>
+                               <listitem><para>
+Primary storage server address
+(http://<replaceable>HOSTNAME:PORT</replaceable>).
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term><option>-d</option>|<option>--debug</option></term>
+                               <listitem><para>
+Don't run as daemon, additional diagnostics.
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term><option>-q</option>|<option>--query-type</option></term>
+                               <listitem><para>
+Type of query: <option>hist</option>, <option>cont</option> or <option>both</option> (default: <option>history</option>).
+                               </para>
+                               <variablelist>
+                                       <varlistentry>
+                                               <term>hist</term>
+                                               <listitem><para>history query</para></listitem>
+                                       </varlistentry>
+                                       <varlistentry>
+                                               <term>cont</term>
+                                               <listitem><para>continuous query</para></listitem>
+                                       </varlistentry>
+                                       <varlistentry>
+                                               <term>both</term>
+                                               <listitem><para>combination of previous types</para></listitem>
+                                       </varlistentry>
+                               </variablelist>
+                               </listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term><option>-n</option>|<option>--no-auth</option></term>
+                               <listitem><para>
+Don't check user identity with result owner.
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term><option>-m</option>|<option>--mysql</option></term>
+                               <listitem><para>
+Database connect string: <replaceable>USER/PASSWORD@HOST:DBNAME</replaceable> (default: <option>jpis/@localhost:jpis1</option>).
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term><option>-p</option>|<option>--port</option></term>
+                               <listitem><para>
+Port to listen (default: <option>8902</option>).
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term><option>-i</option>|<option>--pidfile</option></term>
+                               <listitem><para>
+File to store master pid (default: <filename>/var/run/glite-jp-indexd.pid</filename> or <filename>$HOME/glite-jp-indexd.pid</filename>).
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term><option>-o</option>|<option>--logfile</option></term>
+                               <listitem><para>
+File to store logs (default: <filename>/var/run/glite-jp-indexd.log</filename> or <filename>$HOME/glite-jp-indexd.log</filename>).
+                               </para></listitem>
+                       </varlistentry>
+               </variablelist>
+
+               <para>
+Other parameters will be configurable in close future. Its current hard-coded values are in <filename>org.glite.jp.index/src/conf.[ch]</filename>.
+               </para>
+       </refsect1>
+
+       <refsect1>
+               <title>Starting the daemon</title>
+               <para>
+Preferred way of starting the daemon is using start-up script (<filename>config/startup</filename>). It loads <filename>glite.conf</filename> file (personal version may be stored in <filename>~/.glite.conf</filename>) where many variables may be set to configure the daemon. The script takes following variables:
+               </para>
+
+               <variablelist>
+                       <varlistentry>
+                               <term>GLITE_JPIS_PS</term>
+                               <listitem><para>
+Location of JP-PS server (_required parameter_), for example http://umbar.ics.muni.cz:8901.
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>GLITE_JPIS_DEBUG</term>
+                               <listitem><para>
+Setting to '-d' forces the daemon not to daemonize.
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>GLITE_JPIS_QT</term>
+                               <listitem><para>
+Defines query type (see <option>-q</option> parameter).
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>GLITE_JPIS_AUTH</term>
+                               <listitem><para>
+Setting to '-n' forces the daemon not to check authorisation.
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>GLITE_JPIS_PORT</term>
+                               <listitem><para>
+Used port (default is 8902).
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>GLITE_JPIS_DB</term>
+                               <listitem><para>
+Database connection string, see <option>-m</option> parameter.
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>GLITE_JPIS_LOGFILE</term>
+                               <listitem><para>
+Log file (default in startup script is <filename>$GLITE_LOCATION_VAR/log/glite-jp-indexd.log</filename>).
+                               </para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>GLITE_JPIS_PIDFILE</term>
+                               <listitem><para>
+Pid file (default is in startup script is <filename>$GLITE_LOCATION_VAR/run/glite-jp-indexd.pid</filename>).
+                               </para></listitem>
+                       </varlistentry>
+               </variablelist>
+       </refsect1>
+
+       <refsect1>
+               <title>RETURN VALUE</title>
+               <variablelist>
+                       <varlistentry>
+                               <term>0</term>
+                               <listitem><para>Success start.</para></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>1</term>
+                               <listitem><para>
+Error (database or network initialisation for example).
+                               </para></listitem>
+                       </varlistentry>
+               </variablelist>
+       </refsect1>
+
+       <refsect1>
+               <title>EXAMPLES</title>
+               <variablelist>
+                       <varlistentry>
+                               <term>configure file for startup script</term>
+                               <listitem><programlisting>GLITE_LOCATION_VAR=/opt/glite/var
+GLITE_JPIS_DB=jpis/@localhost:jpis1
+GLITE_JPIS_PORT=8902
+GLITE_JPIS_LOGFILE=$GLITE_LOCATION_VAR/run/glite-jp-indexd.log
+GLITE_JPIS_PIDFILE=$GLITE_LOCATION_VAR/run/glite-jp-indexd.pid
+GLITE_JPIS_DEBUG=0
+GLITE_JPIS_PS=JPPS:8901
+GLITE_JPIS_QT=cont
+</programlisting></listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term><command>glite-jp-indexd -s JPPS:8901 -i $HOME/jpis.log -o $HOME/jpis.pid</command></term>
+                               <listitem><para>
+Manual run of the JP index server. Use local MySQL database, communicates with Job Provenance on JPPS:8901, listen on default port, store logs and pid to given files.
+                               </para></listitem>
+                       </varlistentry>
+               </variablelist>
+       </refsect1>
+
+       <refsect1>
+               <title>SEE ALSO</title>
+               <para>glite-jpis-client(1)</para>
+       </refsect1>
+
+       <refsect1>
+               <title>AUTHOR</title>
+               <para>EU DataGrid Work Package 1, CESNET group.</para>
+       </refsect1>
+
+</refentry>

diff --git a/org.glite.jp.index/doc/glite-jpis-client.sgml b/org.glite.jp.index/doc/glite-jpis-client.sgml
index fb6d8ba..0593485 100644 (file)
--- a/org.glite.jp.index/doc/glite-jpis-client.sgml
+++ b/org.glite.jp.index/doc/glite-jpis-client.sgml
@@ -1,9 +1,11 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
 
 <refentry id='glitejpisclient'>
+
        <refmeta>
                <refentrytitle>glite-jpis-client</refentrytitle>
                <manvolnum>1</manvolnum>
+               <refmiscinfo>EU EGEE Project</refmiscinfo>
        </refmeta>
 
        <refnamediv id='name'>
@@ -183,4 +185,9 @@ parameters from stdin and show results in non-XML form.
                <para>glite-jp-indexd(8)</para>
        </refsect1>
 
+       <refsect1>
+               <title>AUTHOR</title>
+               <para>EU DataGrid Work Package 1, CESNET group.</para>
+       </refsect1>
+
 </refentry>