debian/docs/koha-indexer.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-indexer</title>
   3 <info>
   4 <productname>Koha</productname> is the first free software library automation package.
   5 <author>
   6   <orgname>The Koha Community</orgname>
   7   <uri>http://koha-community.org/</uri>
   8 </author>
   9 </info>
  10
  11 <refentry xml:id="koha-indexer">
  12
  13   <refmeta>
  14     <refentrytitle>koha-indexer</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-indexer</refname>
  20     <refpurpose>Manage the indexer daemon for Koha instances.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-indexer</command>
  27       <arg choice="req"><option>--start</option>|<option>--stop</option>|<option>--restart</option>|<option>--status</option>|<option>--help</option>|<option>-h</option>|<option>--quiet</option>|<option>-q</option></arg>
  28       <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <refsect1><title>Options</title>
  33
  34   <variablelist>
  35
  36     <varlistentry>
  37       <term><option>--start</option></term>
  38       <listitem>
  39         <para>Start the indexer daemon for the desired Koha instances.</para>
  40       </listitem>
  41     </varlistentry>
  42
  43     <varlistentry>
  44       <term><option>--stop</option></term>
  45       <listitem>
  46         <para>Stop the indexer daemon for the desired Koha instances.</para>
  47       </listitem>
  48     </varlistentry>
  49
  50     <varlistentry>
  51       <term><option>--restart</option></term>
  52       <listitem>
  53         <para>Restart the indexer daemon for the desired Koha instances.</para>
  54       </listitem>
  55     </varlistentry>
  56
  57     <varlistentry>
  58       <term><option>--status</option></term>
  59       <listitem>
  60         <para>Show the status of the indexer for the specified instances.</para>
  61       </listitem>
  62     </varlistentry>
  63
  64     <varlistentry>
  65       <term><option>--quiet|-q</option></term>
  66       <listitem>
  67         <para>Make the script quiet about non existent instance names. Useful when calling <command>koha-indexer</command> from another scripts.</para>
  68       </listitem>
  69     </varlistentry>
  70
  71     <varlistentry>
  72       <term><option>--help|-h</option></term>
  73       <listitem>
  74         <para>Show usage information.</para>
  75       </listitem>
  76     </varlistentry>
  77
  78   </variablelist>
  79   </refsect1>
  80
  81   <refsect1><title>Description</title>
  82     <para>The <command>koha-indexer</command> script lets you manage your Koha instances indexer daemon.</para>
  83   </refsect1>
  84
  85   <refsect1><title>See also</title>
  86   <simplelist type="inline">
  87     <member><command>/etc/default/koha-common</command></member>
  88   </simplelist>
  89   </refsect1>
  90
  91 </refentry>
  92
  93 </article>