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

(-)a/debian/docs/koha-z3950-responder.xml (-1 / +141 lines)
Line 0 Link Here
0
- 
1
<article xmlns='http://docbook.org/ns/docbook'>
2
<title>koha-z3950-responder</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>https://koha-community.org/</uri>
8
    </author>
9
</info>
10
11
<refentry xml:id="koha-z3950-responder">
12
13
    <refmeta>
14
        <refentrytitle>koha-z3950-responder</refentrytitle>
15
        <manvolnum>8</manvolnum>
16
    </refmeta>
17
18
    <refnamediv>
19
        <refname>koha-z3950-responder</refname>
20
        <refpurpose>Manage the Z39.50/SRU daemons for your Koha instances</refpurpose>
21
        <refclass>UNIX/Linux</refclass>
22
    </refnamediv>
23
24
    <refsynopsisdiv>
25
        <cmdsynopsis>
26
            <command>koha-z3950-responder</command>
27
            <group choice="opt">
28
                <arg choice="plain">--start</arg>
29
                <arg choice="plain">--stop</arg>
30
                <arg choice="plain">--restart</arg>
31
            </group>
32
            <group choice="opt">
33
                <arg choice="plain">--enable</arg>
34
                <arg choice="plain">--disable</arg>
35
            </group>
36
            <group choice="opt">
37
                <arg choice="plain">--debugger</arg>
38
                <arg choice="plain">--debugger-key <replaceable>key</replaceable></arg>
39
                <arg choice="plain">--debugger-location <replaceable>host</replaceable>:<replaceable>port</replaceable></arg>
40
                <arg choice="plain">--debugger-path <replaceable>path</replaceable></arg>
41
            </group>
42
            <group choice="opt">
43
                <arg choice="plain">--quiet</arg>
44
                <arg choice="plain">-q</arg>
45
            </group>
46
            <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
47
        </cmdsynopsis>
48
        <cmdsynopsis>
49
            <command>koha-z3950-responder</command>
50
            <group choice="opt">
51
                <arg choice="plain">--help</arg>
52
                <arg choice="plain">-h</arg>
53
            </group>
54
        </cmdsynopsis>
55
    </refsynopsisdiv>
56
57
    <refsect1><title>Options</title>
58
        <variablelist>
59
            <varlistentry>
60
                <term><option>--start</option></term>
61
                <listitem>
62
                    <para>Start the Z39.50/SRU daemon for the specified instance(s)</para>
63
                </listitem>
64
            </varlistentry>
65
            <varlistentry>
66
                <term><option>--stop</option></term>
67
                <listitem>
68
                    <para>Stop the Z39.50/SRU daemon for the specified instance(s)</para>
69
                </listitem>
70
            </varlistentry>
71
            <varlistentry>
72
                <term><option>--restart</option></term>
73
                <listitem>
74
                    <para>Restart the Z39.50/SRU daemon for the specified instance(s)</para>
75
                </listitem>
76
            </varlistentry>
77
            <varlistentry>
78
                <term><option>--enable</option></term>
79
                <listitem>
80
                    <para>Enable Z39.50/SRU for the specified instance(s)</para>
81
                </listitem>
82
            </varlistentry>
83
            <varlistentry>
84
                <term><option>--disable</option></term>
85
                <listitem>
86
                    <para>Disable Z39.50/SRU for the specified instance(s)</para>
87
                </listitem>
88
            </varlistentry>
89
            <varlistentry>
90
                <term><option>--debugger</option></term>
91
                <listitem>
92
                    <para>Enable running Z39.50/SRU in debug mode</para>
93
                </listitem>
94
            </varlistentry>
95
            <varlistentry>
96
                <term><option>--debugger-key <replaceable>key</replaceable></option></term>
97
                <listitem>
98
                    <para>Specify the debugger key the IDE is expecting</para>
99
                </listitem>
100
            </varlistentry>
101
            <varlistentry>
102
                <term><option>--debugger-location <replaceable>host</replaceable>:<replaceable>port</replaceable></option></term>
103
                <listitem>
104
                    <para>Specify the host:port for your debugger tool (defaults to localhost:9000)</para>
105
                </listitem>
106
            </varlistentry>
107
            <varlistentry>
108
                <term><option>--debugger-path <replaceable>path</replaceable></option></term>
109
                <listitem>
110
                    <para>Specify the path for the debugger library</para>
111
                </listitem>
112
            </varlistentry>
113
            <varlistentry>
114
                <term><option>--quiet</option> | <option>-q</option></term>
115
                <listitem>
116
                    <para>Make the script quiet about non existent instance names (useful for calling from other scripts)</para>
117
                </listitem>
118
            </varlistentry>
119
            <varlistentry>
120
                <term><option>--help</option> | <option>-h</option></term>
121
                <listitem>
122
                    <para>Display help for this command</para>
123
                </listitem>
124
            </varlistentry>
125
        </variablelist>
126
    </refsect1>
127
128
    <refsect1><title>Description</title>
129
        <para>This script lets you manage the Z39.50/SRU daemons for your Koha instances.</para>
130
    </refsect1>
131
132
    <refsect1><title>See also</title>
133
        <simplelist type="inline">
134
            <member><command>koha-rebuild-zebra(8)</command></member>
135
            <member><command>koha-zebra(8)</command></member>
136
        </simplelist>
137
    </refsect1>
138
139
</refentry>
140
141
</article>

Return to bug 31964