dh_fixperms -a
dh_installdeb -p idzebra
- dh_undocumented -p idzebra zebraidx.1 zebrasrv.1
+ dh_installman -p idzebra doc/zebraidx.1 doc/zebrasrv.8
dh_shlibdeps -p idzebra $(LOCAL_LINK)
cat debian/postinst >> debian/idzebra/DEBIAN/postinst
-## $Id: Makefile.am,v 1.12 2002-09-16 22:23:22 adam Exp $
+## $Id: Makefile.am,v 1.13 2002-09-19 21:06:50 adam Exp $
docdir=$(datadir)/doc/@PACKAGE@
doc_DATA = zebra.html zebra.pdf
+man_MANS = zebraidx.1 zebrasrv.8
SUPPORTFILES = \
zebrahtml.dsl.in \
recordmodel.xml \
license.xml \
indexdata.xml
-
-EXTRA_DIST = $(SUPPORTFILES) $(XMLFILES) zebra.pdf
+
+EXTRA_DIST = $(SUPPORTFILES) $(XMLFILES) zebra.pdf \
+ $(man_MANS) zebraidx-man.sgml zebrasrv-man.sgml
install-data-hook:
for f in $(srcdir)/*.html; do \
$(INSTALL_DATA) $$f $(DESTDIR)$(docdir)/$$f; \
- done
+ done
+
+zebraidx.1: zebraidx-man.sgml zebraidx-options.xml
+ cd $(srcdir); docbook2man zebraidx-man.sgml
+
+zebrasrv.8: zebrasrv-man.sgml
+ cd $(srcdir); docbook2man zebrasrv-man.sgml
zebra.html: $(XMLFILES)
jade -E14 -d zebrahtml.dsl -t sgml xml.dcl zebra.xml
<!ENTITY chap-recordmodel SYSTEM "recordmodel.xml">
<!ENTITY app-license SYSTEM "license.xml">
<!ENTITY app-indexdata SYSTEM "indexdata.xml">
+ <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
]>
-<!-- $Id: zebra.xml.in,v 1.9 2002-08-30 01:17:10 mike Exp $ -->
+<!-- $Id: zebra.xml.in,v 1.10 2002-09-19 21:06:51 adam Exp $ -->
<book id="zebra">
<bookinfo>
<title>Zebra - User's Guide and Reference</title>
--- /dev/null
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
+]>
+<!-- $Id: zebraidx-man.sgml,v 1.1 2002-09-19 21:06:51 adam Exp $ -->
+<refentry id="zebraidx">
+
+ <refmeta>
+ <refentrytitle>zebraidx</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>zebraidx</refname>
+ <refpurpose>Zebra Administrative Tool</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>zebraidx</command>
+ <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
+ <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
+ <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
+ <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
+ <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
+ <arg choice="opt"><option>-n</option></arg>
+ <arg choice="opt"><option>-s</option></arg>
+ <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
+ <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
+ <arg choice="opt"><option>-L</option></arg>
+ <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
+ <arg choice="opt"><option>-v</option></arg>
+ <arg choice="req"><replaceable>command</replaceable></arg>
+ <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
+ </cmdsynopsis>
+
+ <refsect1><title>DESCRIPTION</title>
+ <para>
+ <command>zebraidx</command> allows you to insert, delete or updates
+ records in Zebra. <command>zebraidx</command> accepts a set options
+ (see below) and exactly one command (mandatory).
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>COMMANDS</title>
+ <variablelist>
+ <varlistentry>
+ <term>update <replaceable>file ...</replaceable></term>
+ <listitem><para>
+ Reads records from locations given by <replaceable>file</replaceable>
+ and updates the register accordingly (to be in sync).
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>delete <replaceable>file ...</replaceable></term>
+ <listitem><para>
+ Reads records from locations given by <replaceable>file</replaceable>
+ and deletes the corresponding records in the register.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>commit</term>
+ <listitem><para>
+ Commit changes. Only allowed when shadow registers
+ are enabled.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>clean</term>
+ <listitem><para>
+ Clean shadow files and "forget" changes.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ <refsect1>
+ <title>OPTIONS</title>
+ &zebraidx-options;
+ </refsect1>
+ <refsect1><title>FILES</title>
+ <para>
+ <filename>zebra.cfg</filename>
+ </para>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>zebrasrv</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ <para>
+ Section "Administrating Zebra" in the Zebra manual.
+ </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->
--- /dev/null
+<!--
+ $Id: zebraidx-options.xml,v 1.1 2002-09-19 21:06:51 adam Exp $
+ Options for zebraidx.
+ Included in both manual and man page for zebraidx
+-->
+<variablelist>
+
+ <varlistentry>
+ <term>-t <replaceable>type</replaceable></term>
+ <listitem>
+ <para>
+ Update all files as <replaceable>type</replaceable>. Currently, the
+ types supported are <literal>text</literal> and
+ <literal>grs</literal><replaceable>.subtype</replaceable>.
+ If no <replaceable>subtype</replaceable> is provided for the GRS
+ (General Record Structure) type, the canonical input format
+ is assumed (see <xref linkend="local-representation"/>).
+ Generally, it is probably advisable to specify the record types
+ in the <literal>zebra.cfg</literal> file (see
+ <xref linkend="record-types"/>), to avoid confusion at
+ subsequent updates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-c <replaceable>config-file</replaceable></term>
+ <listitem>
+ <para>
+ Read the configuration file
+ <replaceable>config-file</replaceable> instead of
+ <literal>zebra.cfg</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-g <replaceable>group</replaceable></term>
+ <listitem>
+ <para>
+ Update the files according to the group
+ settings for <replaceable>group</replaceable>
+ (see <xref linkend="configuration-file"/>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-d <replaceable>database</replaceable></term>
+ <listitem>
+ <para>
+ The records located should be associated with the database name
+ <replaceable>database</replaceable> for access through the Z39.50 server.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-l <replaceable>file</replaceable></term>
+ <listitem>
+ <para>
+ Write log messages to <replaceable>file</replaceable> instead
+ of <literal>stderr</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-m <replaceable>mbytes</replaceable></term>
+ <listitem>
+ <para>
+ Use <replaceable>mbytes</replaceable> of memory before flushing
+ keys to background storage. This setting affects performance when
+ updating large databases.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-n</term>
+ <listitem>
+ <para>
+ Disable the use of shadow registers for this operation
+ (see <xref linkend="shadow-registers"/>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-s</term>
+ <listitem>
+ <para>
+ Show analysis of the indexing process. The maintenance
+ program works in a read-only mode and doesn't change the state
+ of the index. This options is very useful when you wish to test a
+ new profile.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-V</term>
+ <listitem>
+ <para>
+ Show Zebra version.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-v <replaceable>level</replaceable></term>
+ <listitem>
+ <para>
+ Set the log level to <replaceable>level</replaceable>.
+ <replaceable>level</replaceable> should be one of
+ <literal>none</literal>, <literal>debug</literal>, and
+ <literal>all</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document: "zebra.xml"
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->
<chapter id="zebraidx">
- <!-- $Id: zebraidx.xml,v 1.2 2002-04-10 14:47:49 heikki Exp $ -->
+ <!-- $Id: zebraidx.xml,v 1.3 2002-09-19 21:06:51 adam Exp $ -->
<title>Running the Maintenance Interface (zebraidx)</title>
<para>
</screen>
Options:
- <variablelist>
-
- <varlistentry>
- <term>-t <replaceable>type</replaceable></term>
- <listitem>
- <para>
- Update all files as <replaceable>type</replaceable>. Currently, the
- types supported are <literal>text</literal> and
- <literal>grs</literal><replaceable>.subtype</replaceable>.
- If no <replaceable>subtype</replaceable> is provided for the GRS
- (General Record Structure) type, the canonical input format
- is assumed (see <xref linkend="local-representation"/>).
- Generally, it is probably advisable to specify the record types
- in the <literal>zebra.cfg</literal> file (see
- <xref linkend="record-types"/>), to avoid confusion at
- subsequent updates.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-c <replaceable>config-file</replaceable></term>
- <listitem>
- <para>
- Read the configuration file
- <replaceable>config-file</replaceable> instead of
- <literal>zebra.cfg</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-g <replaceable>group</replaceable></term>
- <listitem>
- <para>
- Update the files according to the group
- settings for <replaceable>group</replaceable>
- (see <xref linkend="configuration-file"/>).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-d <replaceable>database</replaceable></term>
- <listitem>
- <para>
- The records located should be associated with the database name
- <replaceable>database</replaceable> for access through the Z39.50 server.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-l <replaceable>file</replaceable></term>
- <listitem>
- <para>
- Write log messages to <replaceable>file</replaceable> instead
- of <literal>stderr</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-m <replaceable>mbytes</replaceable></term>
- <listitem>
- <para>
- Use <replaceable>mbytes</replaceable> of memory before flushing
- keys to background storage. This setting affects performance when
- updating large databases.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-n</term>
- <listitem>
- <para>
- Disable the use of shadow registers for this operation
- (see <xref linkend="shadow-registers"/>).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-s</term>
- <listitem>
- <para>
- Show analysis of the indexing process. The maintenance
- program works in a read-only mode and doesn't change the state
- of the index. This options is very useful when you wish to test a
- new profile.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-V</term>
- <listitem>
- <para>
- Show Zebra version.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-v <replaceable>level</replaceable></term>
- <listitem>
- <para>
- Set the log level to <replaceable>level</replaceable>.
- <replaceable>level</replaceable> should be one of
- <literal>none</literal>, <literal>debug</literal>, and
- <literal>all</literal>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
+ &zebraidx-options;
</para>
<para>
--- /dev/null
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!-- $Id: zebrasrv-man.sgml,v 1.1 2002-09-19 21:06:51 adam Exp $ -->
+<refentry id="zebrasrv">
+
+ <refmeta>
+ <refentrytitle>zebrasrv</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>zebrasrv</refname>
+ <refpurpose>Zebra Server</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>zebrasrv</command>
+ <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
+ <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
+ <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
+ <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
+ <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
+ <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
+ <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
+ <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
+ <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
+ <arg choice="opt"><option>-ziST1</option></arg>
+ <arg choice="opt" rep="repeat">listener-spec</arg>
+ </cmdsynopsis>
+
+ <refsect1><title>DESCRIPTION</title>
+ <para>
+ <command>zebrasrv</command> is a Z39.50 server for Zebra.
+ On Unix you can run the server from the command line - and put it
+ in the background. It may also operate under the inet daemon.
+ On WIN32 you can run the server as a console application or
+ as a WIN32 Service.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+ <para>
+ The options for <command>zebrasrv</command> are the same
+ as those for YAZ' <command>yaz-ztest</command>.
+ Option <literal>-c</literal> specifies a Zebra configuration
+ file - if omitted <filename>zebra.cfg</filename> is read.
+ </para>
+ </refsect1>
+ <refsect1><title>FILES</title>
+ <para>
+ <filename>zebra.cfg</filename>
+ </para>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>zebraidx</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>yaz-ztest</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ <para>
+ Section "The Z39.50 Server" in the Zebra manual.
+ </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->
projects / idzebra-moved-to-github.git / commitdiff