doc/zebraidx-options.xml

   1 <!--
   2    $Id: zebraidx-options.xml,v 1.3 2003-12-03 13:57:16 adam Exp $
   3    Options for zebraidx.
   4    Included in both manual and man page for zebraidx
   5 -->
   6 <variablelist>
   7
   8  <varlistentry>
   9   <term>-t <replaceable>type</replaceable></term>
  10   <listitem>
  11    <para>
  12     Update all files as <replaceable>type</replaceable>. Currently, the
  13     types supported are <literal>text</literal> and
  14     <literal>grs</literal><replaceable>.subtype</replaceable>.
  15     If no <replaceable>subtype</replaceable> is provided for the GRS
  16     (General Record Structure) type, the canonical input format
  17     is assumed (see &ref-local-representation;).
  18     Generally, it is probably advisable to specify the record types
  19     in the <literal>zebra.cfg</literal> file (see
  20     &ref-record-types;), to avoid confusion at
  21     subsequent updates.
  22    </para>
  23   </listitem>
  24  </varlistentry>
  25  <varlistentry>
  26   <term>-c <replaceable>config-file</replaceable></term>
  27   <listitem>
  28    <para>
  29     Read the configuration file
  30     <replaceable>config-file</replaceable> instead of
  31     <literal>zebra.cfg</literal>.
  32    </para>
  33   </listitem>
  34  </varlistentry>
  35  <varlistentry>
  36   <term>-g <replaceable>group</replaceable></term>
  37   <listitem>
  38    <para>
  39     Update the files according to the group
  40     settings for <replaceable>group</replaceable>
  41     (see &ref-configuration-file;).
  42    </para>
  43   </listitem>
  44  </varlistentry>
  45  <varlistentry>
  46   <term>-d <replaceable>database</replaceable></term>
  47   <listitem>
  48    <para>
  49     The records located should be associated with the database name
  50     <replaceable>database</replaceable> for access through the Z39.50 server.
  51    </para>
  52   </listitem>
  53  </varlistentry>
  54
  55  <varlistentry>
  56   <term>-l <replaceable>file</replaceable></term>
  57   <listitem>
  58    <para>
  59     Write log messages to <replaceable>file</replaceable> instead
  60     of <literal>stderr</literal>.
  61    </para>
  62   </listitem>
  63  </varlistentry>
  64
  65  <varlistentry>
  66   <term>-m <replaceable>mbytes</replaceable></term>
  67   <listitem>
  68    <para>
  69     Use <replaceable>mbytes</replaceable> of memory before flushing
  70     keys to background storage. This setting affects performance when
  71     updating large databases.
  72    </para>
  73   </listitem>
  74  </varlistentry>
  75  <varlistentry>
  76   <term>-L</term>
  77   <listitem>
  78    <para>
  79     Makes zebraidx skip symbolic links. By default, zebraidx follows
  80     them.
  81    </para>
  82   </listitem>
  83  </varlistentry>
  84  <varlistentry>
  85   <term>-n</term>
  86   <listitem>
  87    <para>
  88     Disable the use of shadow registers for this operation
  89     (see &ref-shadow-registers;).
  90    </para>
  91   </listitem>
  92  </varlistentry>
  93  <varlistentry>
  94   <term>-s</term>
  95   <listitem>
  96    <para>
  97     Show analysis of the indexing process. The maintenance
  98     program works in a read-only mode and doesn't change the state
  99     of the index. This options is very useful when you wish to test a
 100     new profile.
 101    </para>
 102   </listitem>
 103  </varlistentry>
 104  <varlistentry>
 105   <term>-V</term>
 106   <listitem>
 107    <para>
 108     Show Zebra version.
 109    </para>
 110   </listitem>
 111  </varlistentry>
 112  <varlistentry>
 113   <term>-v <replaceable>level</replaceable></term>
 114   <listitem>
 115    <para>
 116     Set the log level to <replaceable>level</replaceable>.
 117     <replaceable>level</replaceable> should be one of
 118     <literal>none</literal>, <literal>debug</literal>, and
 119     <literal>all</literal>.
 120    </para>
 121   </listitem>
 122  </varlistentry>
 123 </variablelist>
 124 <!-- Keep this comment at the end of the file
 125 Local variables:
 126 mode: sgml
 127 sgml-omittag:t
 128 sgml-shorttag:t
 129 sgml-minimize-attributes:nil
 130 sgml-always-quote-attributes:t
 131 sgml-indent-step:1
 132 sgml-indent-data:t
 133 sgml-parent-document: "zebra.xml"
 134 sgml-local-catalogs: nil
 135 sgml-namecase-general:t
 136 End:
 137 -->