<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@


	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Christian</firstname>">
  <!ENTITY dhsurname   "<surname>Hofstaedtler</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>2009-10-09</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>ch+debian-packages@zeha.at</email>">
  <!ENTITY dhusername  "Christian Hofstaedtler">
  <!ENTITY dhucpackage "<refentrytitle>sphinxsearch</refentrytitle>">
  <!ENTITY dhpackage   "sphinxsearch">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2009</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>indexer</refname>

    <refpurpose>fulltext index generator</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>indexer</command>
      <arg><option>--config <replaceable>CONFIGFILE</replaceable></option></arg>
      <arg><option>--rotate</option></arg>
      <group>
        <arg><option>--noprogress</option></arg>
        <arg><option>--quiet</option></arg>
      </group>
      <group>
        <arg><option>--all</option></arg>
        <arg rep='repeat'><replaceable>INDEX</replaceable></arg>
      </group>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>indexer</command>
      <arg choice='req'>--buildstops <replaceable>OUTPUTFILE</replaceable> <replaceable>COUNT</replaceable></arg>
      <arg><option>--config <replaceable>CONFIGFILE</replaceable></option></arg>
      <group>
        <arg><option>--noprogress</option></arg>
        <arg><option>--quiet</option></arg>
      </group>
      <group>
        <arg><option>--all</option></arg>
        <arg rep='repeat'><replaceable>INDEX</replaceable></arg>
      </group>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>indexer</command>
      <arg choice='req'>--merge <replaceable>MAIN_INDEX</replaceable> <replaceable>DELTA_INDEX</replaceable></arg>
      <arg><option>--config <replaceable>CONFIGFILE</replaceable></option></arg>
      <arg><option>--rotate</option></arg>
      <group>
        <arg><option>--noprogress</option></arg>
        <arg><option>--quiet</option></arg>
      </group>
    </cmdsynopsis>
 
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>Sphinx is a collection of programs that aim to provide high 
      quality fulltext search. <command>indexer</command> fetches all
      documents from the configured sources and creates the index data
      files.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
      Instead, it has documentation in HTML format, see below.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.  For a complete description, see the
      HTML documentation.</para>

    <variablelist>

      <varlistentry>
        <term><option>--config</option>
        </term>
        <listitem>
          <para>Specify an alternate configuration file to use.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--all</option>
        </term>
        <listitem>
          <para>Causes <command>indexer</command> to (re-)index all indexes, instead of the specified ones.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--quiet</option>
        </term>
        <listitem>
          <para>Suppress all non-error output.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--noprogress</option>
        </term>
        <listitem>
          <para>Suppress progress information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--rotate</option>
        </term>
        <listitem>
          <para>Writes index data files as INDEX.new files and sends a SIGHUP to searchd, causing it to rotate the index files.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>search (1), searchd (1).</para>

    <para>Sphinx and it's programs are documented fully by the <citetitle>Spinx reference manual</citetitle> available 
      in /usr/share/doc/sphinxsearch.</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


