X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2.xml;h=7caf310bf1fed42f4dd638c99587dfe687875fe4;hb=64dccf5757a22cedd3c21ca834e3e02f39dd0504;hp=311c0c2f2d80188653e85eca6f5fcc311a906e1a;hpb=dc560101265014ac75287a9542b172cbdcbe3e8c;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml index 311c0c2..7caf310 100644 --- a/doc/pazpar2.xml +++ b/doc/pazpar2.xml @@ -1,5 +1,5 @@ - %local; @@ -8,15 +8,17 @@ %idcommon; ]> - Pazpar2 &version; + Index Data + Pazpar2 8 + System management commands @@ -30,16 +32,26 @@ + + - + + + + + + + - DESCRIPTION - pazpar2 is the Pazpar2 Metasearch daemon + + DESCRIPTION + + pazpar2 is the Pazpar2 Metasearch daemon and server. In normal operation it acts as a simple HTTP server which serves the Pazpar2 protocol. @@ -50,23 +62,31 @@ - OPTIONS - + + OPTIONS - Enables dump of XML records. It is useful if stylesheets are - being debugged. + Enables dump of XML records to the current log file. + It is useful if stylesheets are being debugged. Using this option + twice makes Pazpar2 also dump full HTTP responses. + + + This option may also be used together with option + in which case the configuration, after include processing, will be + dumped to stdout. - Puts the Pazpar2 server in the background. + + Puts the Pazpar2 server in the background. + @@ -79,6 +99,17 @@ + + + + Specifies the HTTP listener binding address. + The ip + may be a hostname or @ for "any" address. + The port is an integer. + + + + @@ -88,6 +119,17 @@ + -m timeformat + + Sets the format of time-stamps for logging. + Refer to the + + strftime(3) + man page for the format. + + + @@ -97,13 +139,38 @@ - + + + + If this option is given, HTTP requests are logged to file named + recfile and predictable sessions are enabled. + Using special argument, dash + (-), will make Pazpar2 use predictable sessions + only (no recording). + This is necessary when playing HTTP communication against pazpar2 + with the pazpar2_play program. Refer to . + + + + + + - Specifies a file or directory with alternative settings. This - overrides the settings element in the main - configuration. + Checks parameters and configuration. No service or daemon is + started. Useful for checking a new configuration before a + Pazpar2 is restarted. + + The configuration, after include processing, may also be dumped + to stdout by supplying option as well. + + + + In Pazpar2 1.2 and earlier releases, option -t specified a + local target settings file. + + @@ -113,7 +180,36 @@ Makes the Pazpar2 server change user ID to the uid given. - This, normally, require root privilege. + This, normally, requires root privilege. + + + + + + + + + Sets log level (YAZ log level system). + + + + + + + + + Shows Pazpar2 version and versions of some of the components that it + is using (ICU and YAZ). Pazpar2 will exit immediately after + displaying the version information (no daemon started). + + + + + + + + + Changes working directory to dir. @@ -129,11 +225,38 @@ + + + + + This is an option which is only recognized on Windows. It installs + Pazpar2 as a Windows Service. + + + + Pazpar2 only supports Windows Service options if Pazpar2 is + linked against YAZ 3.0.29 or later. + + + + + + + + + + This is an option which is only recognized on Windows. It removes + a Pazpar2 - Windows Service. + + + + - EXAMPLES + + EXAMPLES The Debian package of pazpar2 starts the server with: pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody @@ -163,15 +286,17 @@ - FILES + + FILES /usr/sbin/pazpar2: pazpar2 daemon - + /usr/share/pazpar2: pazpar2 shared files - + /etc/pazpar2: pazpar2 config area - SEE ALSO + + SEE ALSO Pazpar2 configuration: @@ -186,22 +311,20 @@ 7 + + Pazpar2 player: + + pazpar2_play + 1 + + -