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> |