-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[
<!ENTITY % local SYSTEM "local.ent">
%local;
<refentryinfo>
<productname>Pazpar2</productname>
<productnumber>&version;</productnumber>
+ <info><orgname>Index Data</orgname></info>
</refentryinfo>
+
<refmeta>
<refentrytitle>Pazpar2</refentrytitle>
<manvolnum>8</manvolnum>
+ <refmiscinfo class="manual">System management commands</refmiscinfo>
</refmeta>
<refnamediv>
<arg choice="opt"><option>-f <replaceable>config</replaceable></option></arg>
<arg choice="opt"><option>-h <replaceable>ip:port</replaceable></option></arg>
<arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
+ <arg choice="opt"><option>-m <replaceable>timeformat</replaceable></option></arg>
<arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
- <arg choice="opt"><option>-t <replaceable>path</replaceable></option></arg>
- <arg choice="opt"><option>-T <replaceable>session_timeout</replaceable></option></arg>
+ <arg choice="opt"><option>-R <replaceable>recfile</replaceable></option></arg>
+ <arg choice="opt"><option>-t</option></arg>
<arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
+ <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
<arg choice="opt"><option>-V</option></arg>
+ <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
<arg choice="opt"><option>-X</option></arg>
<arg choice="opt"><option>-install</option></arg>
<arg choice="opt"><option>-remove</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
- <refsect1><title>DESCRIPTION</title>
- <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pazpar2</command> is the Pazpar2 Metasearch daemon
and server.
In normal operation it acts as a simple HTTP server which serves
the Pazpar2 protocol.
</para>
</refsect1>
- <refsect1><title>OPTIONS</title>
- <para></para>
+ <refsect1>
+ <title>OPTIONS</title>
<variablelist>
<varlistentry>
Enables dump of XML records to the current log file.
It is useful if stylesheets are being debugged.
</para>
+ <para>
+ This option may also be used together with option <option>-t</option>
+ in which case the configuration, after include processing, will be
+ dumped to stdout.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D</option></term>
<listitem>
- <para>Puts the Pazpar2 server in the background.</para>
+ <para>
+ Puts the Pazpar2 server in the background.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
+ <term>-m <replaceable>timeformat</replaceable></term>
+ <listitem><para>
+ Sets the format of time-stamps for logging.
+ Refer to the
+ <ulink
+ url="http://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html">
+ strftime(3)</ulink>
+ man page for the format.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-p <replaceable>pidfile</replaceable></option></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
-
<varlistentry>
- <term><option>-t <replaceable>path</replaceable></option></term>
+ <term><option>-R <replaceable>recfile</replaceable></option></term>
<listitem>
<para>
- Specifies a file or directory with alternative settings. This
- overrides the <literal>settings</literal> element in the main
- configuration.
+ If this option is given, HTTP requests are logged to file named
+ <replaceable>recfile</replaceable>.
</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><option>-T <replaceable>session_timeout</replaceable></option></term>
+ <term><option>-t</option></term>
<listitem>
<para>
- Specifies a Pazpar2 HTTP session timeout. This
- overrides the default value of 60 seconds which is to low for some broken browser.
+ Checks parameters and configuration. No service or daemon is
+ started. Useful for checking a new configuration before a
+ Pazpar2 is restarted.
+ </para>
+ <para>
+ The configuration, after include processing, may also be dumped
+ to stdout by supplying option <option>-d</option> as well.
</para>
+ <note>
+ <para>
+ In Pazpar2 1.2 and earlier releases, option -t specified a
+ local target settings file.
+ </para>
+ </note>
</listitem>
</varlistentry>
</varlistentry>
<varlistentry>
+ <term><option>-v <replaceable>level</replaceable></option></term>
+ <listitem>
+ <para>
+ Sets log level (YAZ log level system).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-V</option></term>
<listitem>
<para>
Shows Pazpar2 version and versions of some of the components that it
- is using (ICU and YAZ). Pazpar2 will not exit immediately after
+ is using (ICU and YAZ). Pazpar2 will exit immediately after
displaying the version information (no daemon started).
</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-w <replaceable>dir</replaceable></option></term>
+ <listitem>
+ <para>
+ Changes working directory to <replaceable>dir</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-X</option></term>
<listitem>
<para>
<term><option>-install</option></term>
<listitem>
<para>
- This is an option which is only recognized on Windows. It installs
- Pazpar2 as a Windows Service.
+ This is an option which is only recognized on Windows. It installs
+ Pazpar2 as a Windows Service.
</para>
<note>
- <para>
- Pazpar2 only supports Windows Service options if Pazpar2 is
- linked against YAZ 3.0.29 or later.
- </para>
+ <para>
+ Pazpar2 only supports Windows Service options if Pazpar2 is
+ linked against YAZ 3.0.29 or later.
+ </para>
</note>
</listitem>
</varlistentry>
<term><option>-remove</option></term>
<listitem>
<para>
- This is an option which is only recognized on Windows. It removes
- a Pazpar2 - Windows Service.
+ This is an option which is only recognized on Windows. It removes
+ a Pazpar2 - Windows Service.
</para>
</listitem>
</varlistentry>
</refsect1>
- <refsect1><title>EXAMPLES</title>
+ <refsect1>
+ <title>EXAMPLES</title>
<para>The Debian package of pazpar2 starts the server with:
<screen>
pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
</para>
</refsect1>
- <refsect1><title>FILES</title>
+ <refsect1>
+ <title>FILES</title>
<para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
-
+
<para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
-
+
<para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
</refsect1>
- <refsect1><title>SEE ALSO</title>
+ <refsect1>
+ <title>SEE ALSO</title>
<para>
Pazpar2 configuration:
<citerefentry>
</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
+mode: nxml
+nxml-child-indent: 1
End:
-->