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

(-)a/debian/docs/koha-common.xml (+206 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-common</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-common">
12
13
  <refmeta>
14
    <refentrytitle>koha-common</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-common</refname>
20
    <refpurpose>Create and manage Koha instances.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsect1><title>Description</title>
25
    <para>koha-common provides a number of scripts for creating and administering Koha instances. It is meant for sites that provide Koha hosting, and serves several sites from the same host.</para>
26
  </refsect1>
27
28
  <refsect1><title>Commands</title>
29
    <para>The following commands are available after when koha-common has been installed. See individual manual pages for each command for optios and other details related to their usage.</para>
30
31
    <refsect2><title>Administer instances</title>
32
    <variablelist>
33
34
      <varlistentry>
35
        <term><option>koha-disable</option></term>
36
        <listitem>
37
          <para>Disable a Koha instance.</para>
38
        </listitem>
39
      </varlistentry>
40
41
      <varlistentry>
42
        <term><option>koha-enable</option></term>
43
        <listitem>
44
          <para>Enable a Koha instance. New instances are enabled by default. You only need this command if you have previously disabled a site with koha-disable.</para>
45
        </listitem>
46
      </varlistentry>
47
48
      <varlistentry>
49
        <term><option>koha-restore</option></term>
50
        <listitem>
51
          <para>Restore a Koha site from a dump (from koha-dump).</para>
52
        </listitem>
53
      </varlistentry>
54
55
      <varlistentry>
56
        <term><option>koha-dump</option></term>
57
        <listitem>
58
          <para>Dump all contents and configs for a Koha site.</para>
59
        </listitem>
60
      </varlistentry>
61
62
      <varlistentry>
63
        <term><option>koha-remove</option></term>
64
        <listitem>
65
          <para>Remove a Koha instance.</para>
66
        </listitem>
67
      </varlistentry>
68
    </variablelist>
69
    </refsect2>
70
71
    <refsect2><title>Database-related</title>
72
    <variablelist>
73
74
      <varlistentry>
75
        <term><option>koha-dump-defaults</option></term>
76
        <listitem>
77
          <para>Create default contents from an existing Koha site.</para>
78
        </listitem>
79
      </varlistentry>
80
81
      <varlistentry>
82
        <term><option>koha-upgrade-schema</option></term>
83
        <listitem>
84
          <para>Upgrade the DB schema for Koha instances. Done automatically on package upgrades.</para>
85
        </listitem>
86
      </varlistentry>
87
88
      <varlistentry>
89
        <term><option>koha-reset-passwd</option></term>
90
        <listitem>
91
          <para>Reset password for a user in a Koha instance.</para>
92
        </listitem>
93
      </varlistentry>
94
95
      <varlistentry>
96
        <term><option>koha-mysql</option></term>
97
        <listitem>
98
          <para>Provide an interactive mysql shell set up for the specified koha instance.</para>
99
        </listitem>
100
      </varlistentry>
101
    </variablelist>
102
    </refsect2>
103
104
    <refsect2><title>Zebra-related</title>
105
    <variablelist>
106
107
      <varlistentry>
108
        <term><option>koha-start-zebra</option></term>
109
        <listitem>
110
          <para>Start Zebra for named Koha instances.</para>
111
        </listitem>
112
      </varlistentry>
113
114
      <varlistentry>
115
        <term><option>koha-restart-zebra</option></term>
116
        <listitem>
117
          <para>Restart Zebra for named Koha instances.</para>
118
        </listitem>
119
      </varlistentry>
120
121
      <varlistentry>
122
        <term><option>koha-rebuild-zebra</option></term>
123
        <listitem>
124
          <para>Rebuild the Zebra database for a Koha instance.</para>
125
        </listitem>
126
      </varlistentry>
127
128
      <varlistentry>
129
        <term><option>koha-stop-zebra</option></term>
130
        <listitem>
131
          <para>Stop Zebra for named Koha instances.</para>
132
        </listitem>
133
      </varlistentry>
134
    </variablelist>
135
    </refsect2>
136
137
    <refsect2><title>E-mail</title>
138
    <variablelist>
139
140
      <varlistentry>
141
        <term><option>koha-email-enable</option></term>
142
        <listitem>
143
          <para>Turn on the email for a Koha instance.</para>
144
        </listitem>
145
      </varlistentry>
146
147
      <varlistentry>
148
        <term><option>koha-email-disable</option></term>
149
        <listitem>
150
          <para>Turn off the email for a Koha instance.</para>
151
        </listitem>
152
      </varlistentry>
153
    </variablelist>
154
    </refsect2>
155
156
    <refsect2><title>Misc</title>
157
    <variablelist>
158
159
      <varlistentry>
160
        <term><option>koha-upgrade-to-3.4</option></term>
161
        <listitem>
162
          <para>Performs the necessary changes to upgrade a Koha system from 3.2 to 3.4. If no instance names are provided, this will run it on all of them.</para>
163
        </listitem>
164
      </varlistentry>
165
    </variablelist>
166
    </refsect2>
167
168
    <refsect2><title>Utilities</title>
169
    <variablelist>
170
171
      <varlistentry>
172
        <term><option>koha-create-dirs</option></term>
173
        <listitem>
174
          <para>Create dirs for a Koha instance.</para>
175
        </listitem>
176
      </varlistentry>
177
178
      <varlistentry>
179
        <term><option>koha-list</option></term>
180
        <listitem>
181
          <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
182
        </listitem>
183
      </varlistentry>
184
185
      <varlistentry>
186
        <term><option>koha-foreach</option></term>
187
        <listitem>
188
          <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
189
        </listitem>
190
      </varlistentry>
191
    </variablelist>
192
    </refsect2>
193
  </refsect1>
194
  
195
  <refsect1><title>Bugs</title>
196
  <para>The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves.</para>
197
  <para>Bugs can be reported here: <uri>http://bugs.koha-community.org/bugzilla3/</uri></para>
198
  </refsect1>
199
200
  <refsect1><title>About Koha</title>
201
  <para>Koha is the first free software library automation package. In use worldwide, its development is steered by a growing community of users collaborating to achieve their technology goals. Koha’s feature set continues to evolve and expand to meet the needs of its user base.</para>
202
  </refsect1>
203
204
</refentry>
205
206
</article>
(-)a/debian/docs/koha-create-dirs.xml (+43 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-create-dirs</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-create-dirs">
12
13
  <refmeta>
14
    <refentrytitle>koha-create-dirs</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-create-dirs</refname>
20
    <refpurpose>Create dirs for a Koha instance.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-create-dirs</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Create dirs for a Koha instance.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-foreach(8)</command></member>
37
    <member><command>koha-list(8)</command></member>
38
  </simplelist>
39
  </refsect1>
40
  
41
</refentry>
42
43
</article>
(-)a/debian/docs/koha-disable.xml (+45 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-disable</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-disable">
12
13
  <refmeta>
14
    <refentrytitle>koha-disable</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-disable</refname>
20
    <refpurpose>Disable a Koha instance.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-disable</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Disable a Koha instance.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-dump(8)</command></member>
37
    <member><command>koha-enable(8)</command></member>
38
    <member><command>koha-remove(8)</command></member>
39
    <member><command>koha-restore(8)</command></member>
40
  </simplelist>
41
  </refsect1>
42
  
43
</refentry>
44
45
</article>
(-)a/debian/docs/koha-dump-defaults.xml (+44 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-dump-defaults</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-dump-defaults">
12
13
  <refmeta>
14
    <refentrytitle>koha-dump-defaults</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-dump-defaults</refname>
20
    <refpurpose>Create default contents from an existing Koha site.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-dump-defaults</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Create default contents from an existing Koha site.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-mysql(8)</command></member>
37
    <member><command>koha-reset-passwd(8)</command></member>
38
    <member><command>koha-upgrade-schema(8)</command></member>
39
  </simplelist>
40
  </refsect1>
41
  
42
</refentry>
43
44
</article>
(-)a/debian/docs/koha-dump.xml (+45 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-dump</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-dump">
12
13
  <refmeta>
14
    <refentrytitle>koha-dump</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-dump</refname>
20
    <refpurpose>Dump all contents and configs for a Koha site.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-dump</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Dump all contents and configs for a Koha site.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-disable(8)</command></member>
37
    <member><command>koha-enable(8)</command></member>
38
    <member><command>koha-remove(8)</command></member>
39
    <member><command>koha-restore(8)</command></member>
40
  </simplelist>
41
  </refsect1>
42
  
43
</refentry>
44
45
</article>
(-)a/debian/docs/koha-email-disable.xml (+42 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-email-disable</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-email-disable">
12
13
  <refmeta>
14
    <refentrytitle>koha-email-disable</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-email-disable</refname>
20
    <refpurpose>Turn off the email for a Koha instance.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-email-disable</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Turn off the email for a Koha instance.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-email-enable(8)</command></member>
37
  </simplelist>
38
  </refsect1>
39
  
40
</refentry>
41
42
</article>
(-)a/debian/docs/koha-email-enable.xml (+42 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-email-enable</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-email-enable">
12
13
  <refmeta>
14
    <refentrytitle>koha-email-enable</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-email-enable</refname>
20
    <refpurpose>Turn on the email for a Koha instance.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-email-enable</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Turn on the email for a Koha instance.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-email-disable(8)</command></member>
37
  </simplelist>
38
  </refsect1>
39
  
40
</refentry>
41
42
</article>
(-)a/debian/docs/koha-enable.xml (+45 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-enable</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-enable">
12
13
  <refmeta>
14
    <refentrytitle>koha-enable</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-enable</refname>
20
    <refpurpose>Enable a Koha instance. New instances are enabled by default. You only need this command if you have previously disabled a site with koha-disable.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-enable</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Enable a Koha instance. New instances are enabled by default. You only need this command if you have previously disabled a site with koha-disable.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-disable(8)</command></member>
37
    <member><command>koha-dump(8)</command></member>
38
    <member><command>koha-remove(8)</command></member>
39
    <member><command>koha-restore(8)</command></member>
40
  </simplelist>
41
  </refsect1>
42
  
43
</refentry>
44
45
</article>
(-)a/debian/docs/koha-foreach.xml (+43 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-foreach</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-foreach">
12
13
  <refmeta>
14
    <refentrytitle>koha-foreach</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-foreach</refname>
20
    <refpurpose>Run a command for each Koha instance. Takes the same arguments as koha-list.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-list</command> <arg><option>--enabled</option></arg> <arg><option>--email</option>|<option>--noemail</option></arg> <arg><option>command</option></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-create-dirs(8)</command></member>
37
    <member><command>koha-list(8)</command></member>
38
  </simplelist>
39
  </refsect1>
40
  
41
</refentry>
42
43
</article>
(-)a/debian/docs/koha-list.xml (+73 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-list</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-list">
12
13
  <refmeta>
14
    <refentrytitle>koha-list</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-list</refname>
20
    <refpurpose>Lists Koha instances, optionally only those that are enabled or have email turned on.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-list</command> <arg><option>--enabled</option></arg> <arg><option>--email</option></arg> <arg><option>-h</option></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
  
30
  <refsect1><title>Options</title>
31
  <para>The filtering options can be combined, and you probably want to do this (except --email and --noemail, that's just silly.)</para>
32
  <variablelist> 
33
    <varlistentry>
34
      <term><option>--enabled</option></term>
35
      <listitem>
36
        <para>Only show instances that are enabled.</para>
37
      </listitem>
38
    </varlistentry>
39
    <varlistentry>
40
      <term><option>--email</option></term>
41
      <listitem>
42
        <para>Only show instances that have email enabled.</para>
43
      </listitem>
44
    </varlistentry>
45
    <varlistentry>
46
      <term><option>--noemail</option></term>
47
      <listitem>
48
        <para>Only show instances that do not have email enabled.</para>
49
      </listitem>
50
    </varlistentry>
51
    <varlistentry>
52
      <term><option>-h</option></term>
53
      <listitem>
54
        <para>This help.</para>
55
      </listitem>
56
    </varlistentry>
57
  </variablelist>
58
  </refsect1>
59
60
  <refsect1><title>Description</title>
61
  <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
62
  </refsect1>
63
  
64
  <refsect1><title>See also</title>
65
  <simplelist type="inline">
66
    <member><command>koha-create-dirs(8)</command></member>
67
    <member><command>koha-foreach(8)</command></member>
68
  </simplelist>
69
  </refsect1>
70
  
71
</refentry>
72
73
</article>
(-)a/debian/docs/koha-mysql.xml (+44 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-mysql</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-mysql">
12
13
  <refmeta>
14
    <refentrytitle>koha-mysql</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-mysql</refname>
20
    <refpurpose>Provide an interactive mysql shell set up for the specified koha instance.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Provide an interactive mysql shell set up for the specified koha instance.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-dump-defaults(8)</command></member>
37
    <member><command>koha-reset-passwd(8)</command></member>
38
    <member><command>koha-upgrade-schema(8)</command></member>
39
  </simplelist>
40
  </refsect1>
41
  
42
</refentry>
43
44
</article>
(-)a/debian/docs/koha-rebuild-zebra.xml (+67 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-rebuild-zebra</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-rebuild-zebra">
12
13
  <refmeta>
14
    <refentrytitle>koha-rebuild-zebra</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-rebuild-zebra</refname>
20
    <refpurpose>Rebuild the Zebra database for a Koha instance.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-rebuild-zebra</command> <arg><option>-u</option>|<option>--usmarc</option></arg> <arg><option>-f</option>|<option>--full</option></arg> <arg><option>...</option></arg> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
  
30
  <refsect1><title>Options</title>
31
  <variablelist> 
32
    <varlistentry>
33
      <term><option>-u, --usmarc</option></term>
34
      <listitem>
35
        <para>Runs the process as USMARC rather than the default of MARCXML.</para>
36
      </listitem>
37
    </varlistentry>
38
    <varlistentry>
39
      <term><option>-f, --full</option></term>
40
      <listitem>
41
        <para>Does a reindex of the whole collection.</para>
42
      </listitem>
43
    </varlistentry>
44
    <varlistentry>
45
      <term><option>-...</option></term>
46
      <listitem>
47
        <para>Anything else is passed directly to rebuild_zebra. This is useful in particular for -v.</para>
48
      </listitem>
49
    </varlistentry>
50
  </variablelist>
51
  </refsect1>
52
53
  <refsect1><title>Description</title>
54
  <para>Rebuild the Zebra database for a Koha instance.</para>
55
  </refsect1>
56
  
57
  <refsect1><title>See also</title>
58
  <simplelist type="inline">
59
    <member><command>koha-restart-zebra(8)</command></member>
60
    <member><command>koha-start-zebra(8)</command></member>
61
    <member><command>koha-stop-zebra(8)</command></member>
62
  </simplelist>
63
  </refsect1>
64
  
65
</refentry>
66
67
</article>
(-)a/debian/docs/koha-remove.xml (-4 / +13 lines)
Lines 17-36 Link Here
17
17
18
  <refnamediv>
18
  <refnamediv>
19
    <refname>koha-remove</refname>
19
    <refname>koha-remove</refname>
20
    <refpurpose>Remove one or more Koha instance(s).</refpurpose>
20
    <refpurpose>Remove a Koha instance.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
22
  </refnamediv>
23
23
24
  <refsynopsisdiv>
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
25
    <cmdsynopsis>
26
      <command>koha-remove</command>
26
      <command>koha-remove</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
      <arg choice="req" rep="repeat">instancename</arg>
28
    </cmdsynopsis>
27
    </cmdsynopsis>
29
  </refsynopsisdiv>
28
  </refsynopsisdiv>
30
29
31
  <refsect1><title>Description</title>
30
  <refsect1><title>Description</title>
32
  <para>Remove one or more Koha instance(s). This removes all files associated with a Koha instance.</para>
31
  <para>Remove a Koha instance.</para>
33
  </refsect1>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-disable(8)</command></member>
37
    <member><command>koha-dump(8)</command></member>
38
    <member><command>koha-enable(8)</command></member>
39
    <member><command>koha-restore(8)</command></member>
40
  </simplelist>
41
  </refsect1>
42
  
34
</refentry>
43
</refentry>
35
44
36
</article>
45
</article>
(-)a/debian/docs/koha-reset-passwd.xml (+44 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-reset-passwd</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-reset-passwd">
12
13
  <refmeta>
14
    <refentrytitle>koha-reset-passwd</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-reset-passwd</refname>
20
    <refpurpose>Reset password for a user in a Koha instance.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-reset-passwd</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> <arg choice="req" rep="norepeat">username</arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Reset password for a user in a Koha instance.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-dump-defaults(8)</command></member>
37
    <member><command>koha-mysql(8)</command></member>
38
    <member><command>koha-upgrade-schema(8)</command></member>
39
  </simplelist>
40
  </refsect1>
41
  
42
</refentry>
43
44
</article>
(-)a/debian/docs/koha-restart-zebra.xml (+44 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-restart-zebra</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-restart-zebra">
12
13
  <refmeta>
14
    <refentrytitle>koha-restart-zebra</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-restart-zebra</refname>
20
    <refpurpose>Restart Zebra for named Koha instances.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-restart-zebra</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Restart Zebra for named Koha instances.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-rebuild-zebra(8)</command></member>
37
    <member><command>koha-start-zebra(8)</command></member>
38
    <member><command>koha-stop-zebra(8)</command></member>
39
  </simplelist>
40
  </refsect1>
41
  
42
</refentry>
43
44
</article>
(-)a/debian/docs/koha-restore.xml (+45 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-restore</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-restore">
12
13
  <refmeta>
14
    <refentrytitle>koha-restore</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-restore</refname>
20
    <refpurpose>Restore a Koha site from a dump (from koha-dump).</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-restore</command> <arg choice="req"><option>sqldump</option></arg> <arg choice="req"><option>configdump</option></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Restore a Koha site from a dump (from koha-dump).</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-disable(8)</command></member>
37
    <member><command>koha-dump(8)</command></member>
38
    <member><command>koha-enable(8)</command></member>
39
    <member><command>koha-remove(8)</command></member>
40
  </simplelist>
41
  </refsect1>
42
  
43
</refentry>
44
45
</article>
(-)a/debian/docs/koha-start-zebra.xml (+44 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-start-zebra</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-start-zebra">
12
13
  <refmeta>
14
    <refentrytitle>koha-start-zebra</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-start-zebra</refname>
20
    <refpurpose>Start Zebra for named Koha instances.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-start-zebra</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Start Zebra for named Koha instances.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-rebuild-zebra(8)</command></member>
37
    <member><command>koha-restart-zebra(8)</command></member>
38
    <member><command>koha-stop-zebra(8)</command></member>
39
  </simplelist>
40
  </refsect1>
41
  
42
</refentry>
43
44
</article>
(-)a/debian/docs/koha-stop-zebra.xml (+44 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-stop-zebra</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-stop-zebra">
12
13
  <refmeta>
14
    <refentrytitle>koha-stop-zebra</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-stop-zebra</refname>
20
    <refpurpose>Stop Zebra for named Koha instances.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-stop-zebra</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Stop Zebra for named Koha instances.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-rebuild-zebra(8)</command></member>
37
    <member><command>koha-restart-zebra(8)</command></member>
38
    <member><command>koha-start-zebra(8)</command></member>
39
  </simplelist>
40
  </refsect1>
41
  
42
</refentry>
43
44
</article>
(-)a/debian/docs/koha-upgrade-schema.xml (+44 lines)
Line 0 Link Here
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-upgrade-schema</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-upgrade-schema">
12
13
  <refmeta>
14
    <refentrytitle>koha-upgrade-schema</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-upgrade-schema</refname>
20
    <refpurpose>Upgrade the DB schema for Koha instances. Done automatically on package upgrades.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-upgrade-schema</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Upgrade the DB schema for Koha instances. Done automatically on package upgrades.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
    <member><command>koha-dump-defaults(8)</command></member>
37
    <member><command>koha-mysql(8)</command></member>
38
    <member><command>koha-reset-passwd(8)</command></member>
39
  </simplelist>
40
  </refsect1>
41
  
42
</refentry>
43
44
</article>
(-)a/debian/docs/koha-upgrade-to-3.4.xml (-1 / +41 lines)
Line 0 Link Here
0
- 
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-upgrade-to-3.4</title>
3
<info>
4
<productname>Koha</productname> is the first free software library automation package.
5
<author>
6
  <orgname>The Koha Communnity</orgname>
7
  <uri>http://koha-community.org/</uri>
8
</author>
9
</info>
10
11
<refentry xml:id="koha-upgrade-to-3.4">
12
13
  <refmeta>
14
    <refentrytitle>koha-upgrade-to-3.4</refentrytitle>
15
    <manvolnum>8</manvolnum>
16
  </refmeta>
17
18
  <refnamediv>
19
    <refname>koha-upgrade-to-3.4</refname>
20
    <refpurpose>Performs the necessary changes to upgrade a Koha system from 3.2 to 3.4. If no instance names are provided, this will run it on all of them.</refpurpose>
21
    <refclass>UNIX/Linux</refclass>
22
  </refnamediv>
23
24
  <refsynopsisdiv>
25
    <cmdsynopsis>
26
      <command>koha-upgrade-to-3.4</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
27
    </cmdsynopsis>
28
  </refsynopsisdiv>
29
30
  <refsect1><title>Description</title>
31
  <para>Performs the necessary changes to upgrade a Koha system from 3.2 to 3.4. If no instance names are provided, this will run it on all of them.</para>
32
  </refsect1>
33
  
34
  <refsect1><title>See also</title>
35
  <simplelist type="inline">
36
  </simplelist>
37
  </refsect1>
38
  
39
</refentry>
40
41
</article>

Return to bug 4877