View | Details | Raw Unified | Return to bug 19462
Collapse All | Expand All

(-)a/debian/docs/koha-common.xml (+12 lines)
Lines 155-160 Link Here
155
    </variablelist>
155
    </variablelist>
156
    </refsect2>
156
    </refsect2>
157
157
158
    <refsect2>
159
      <title>Elasticsearch-related</title>
160
        <variablelist>
161
          <varlistentry>
162
            <term><option>koha-elasticsearch</option></term>
163
            <listitem>
164
              <para>Manage Elasticsearch-related tasks for Koha instances.</para>
165
            </listitem>
166
          </varlistentry>
167
        </variablelist>
168
    </refsect2>
169
158
    <refsect2><title>E-mail</title>
170
    <refsect2><title>E-mail</title>
159
    <variablelist>
171
    <variablelist>
160
172
(-)a/debian/docs/koha-elasticsearch.xml (-1 / +100 lines)
Line 0 Link Here
0
- 
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-elasticsearch</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-elasticsearch">
12
13
  <refmeta>
14
    <refentrytitle>koha-elasticsearch</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-elasticsearch</refname>
20
    <refpurpose>Manage Elasticsearch-related tasks for Koha instances.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsect1><title>Description</title>
25
  <para>Provides Elasticsearch-related tasks for Koha instances. An action needs to
26
        be passed.</para>
27
  </refsect1>
28
29
30
  <refsynopsisdiv>
31
    <cmdsynopsis>
32
      <command>koha-elasticsearch --rebuild</command>
33
      <arg>-b|--biblios</arg>
34
      <arg>-a|--authorities</arg>
35
      <arg>-v|--verbose</arg>
36
      <arg>-c n|--commit n</arg>
37
      <arg>-v|--verbose</arg>
38
      <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
39
    </cmdsynopsis>
40
  </refsynopsisdiv>
41
42
  <refsect1><title>Actions</title>
43
  <variablelist>
44
    <varlistentry>
45
      <term><option>--rebuild</option></term>
46
      <listitem>
47
        <para>Makes <refname>koha-elasticsearch</refname> rebuild Elasticsearch indexes based on the parameters.
48
              By default it rebuilds both authority and bibliographic records. This behaviour can be controlled
49
              with the <option>-a</option> and <option>-b</option> parameters.
50
        </para>
51
      </listitem>
52
    </varlistentry>
53
  </variablelist>
54
  </refsect1>
55
56
  <refsect1><title>Options</title>
57
  <variablelist>
58
    <varlistentry>
59
      <term><option>-a</option></term>
60
      <listitem>
61
        <para>In conjunction with <option>--rebuild</option>, it triggers authority record reindexing.</para>
62
      </listitem>
63
    </varlistentry>
64
    <varlistentry>
65
      <term><option>-b</option></term>
66
      <listitem>
67
        <para>In conjunction with <option>--rebuild</option> it triggers bibliographic record reindexing.</para>
68
      </listitem>
69
    </varlistentry>
70
    <varlistentry>
71
      <term><option>-c, --commit</option></term>
72
      <listitem>
73
        <para>Specifies how many records will be batched up before they are added to Elasticsearch (default: 5000).
74
              Higher values lead to better performance, but take more RAM.</para>
75
      </listitem>
76
    </varlistentry>
77
    <varlistentry>
78
      <term><option>-v, --verbose</option></term>
79
      <listitem>
80
        <para>Be verbose. Useful for debugging indexing problems.</para>
81
      </listitem>
82
    </varlistentry>
83
    <varlistentry>
84
      <term><option>-h, --help</option></term>
85
      <listitem>
86
        <para>Display usage information.</para>
87
      </listitem>
88
    </varlistentry>
89
  </variablelist>
90
  </refsect1>
91
92
  <refsect1><title>See also</title>
93
  <simplelist type="inline">
94
    <member><command>koha-rebuild-zebra(8)</command></member>
95
  </simplelist>
96
  </refsect1>
97
98
</refentry>
99
100
</article>

Return to bug 19462