X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2.xml;h=16581d30123724a057577b6003ec0c0f24402f37;hb=ad6263d16ca09b91677a00c6636fc9ea4d9a840e;hp=4ed42d2dc5bc9ed2976e27948c6cdefa9623da5b;hpb=e7b20ebdb1ccd6c73bd9b5e13b9393383e62168d;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml index 4ed42d2..16581d3 100644 --- a/doc/pazpar2.xml +++ b/doc/pazpar2.xml @@ -5,10 +5,9 @@ %local; %entities; - - %common; + + %idcommon; ]> - Pazpar2 @@ -16,7 +15,7 @@ Pazpar2 - 1 + 8 @@ -27,33 +26,229 @@ pazpar2 + + + + + + + + + + + + + DESCRIPTION - + pazpar2 is the Pazpar2 Metasearch daemon + and server. + In normal operation it acts as a simple HTTP server which serves + the Pazpar2 protocol. + The HTTP listener address may be given on the command line using + option or in the main configuration + file. The main configuration must be specified using option + . + OPTIONS - + + + + + + + Enables dump of XML records to the current log file. + It is useful if stylesheets are being debugged. + + + + + + + Puts the Pazpar2 server in the background. + + + + + + + Specifies main configuration. This option must be specified + in order for Pazpar2 to operate normally. + + + + + + + + Specifies the HTTP listener binding address. + The ip + may be a hostname or @ for "any" address. + The port is an integer. + + + + + + + + Specifies log file. The log file must be specified when Pazpar2 + is running in the background (-D). + + + + + + + + Specifies PID file. If Pazpar2 is started and configured properly + the file given holds the process ID of the Pazpar2 process. + + + + + + + + + Checks parameters and configuration. No service or daemon is + started. Useful for checking a new configuration before a + Pazpar2 is restarted. + + + + In Pazpar2 1.2 and earlier releasese, option -t specified a + local target settings file. + + + + + + + + + + Makes the Pazpar2 server change user ID to the + uid given. + This, normally, requires root privilege. + + + + + + + + + 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). + + + + + + + + Sets log level (YAZ log level system). + + + + + + + + + Makes the Pazpar2 server operate in debugging mode. + This prevents Pazpar2 from making separate threads and processes. + This option should not be used in production. + + + + + + + + + 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 - + 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 + + (one line). + + + This will put pazpar2 in the background (-D), read config from from + /etc/pazpar2/pazpar2.cfg, log messages to + /var/log/pazpar2.log, create PID file + /var/run/pazpar2.pid. When the daemon is properly + started, the server will change effective user ID to nobody. + + + The server can be terminated with: + + kill `cat /var/run/pazpar2.pid` + + + + If Pazpar2 is to be debugged using GDB, we use option -X: + + cd pazpar2/src + gdb ./pazpar2 + (gdb) run -X -f ../etc/pazpar2.cfg + + FILES - + /usr/sbin/pazpar2: pazpar2 daemon + + /usr/share/pazpar2: pazpar2 shared files + + /etc/pazpar2: pazpar2 config area SEE ALSO + Pazpar2 configuration: pazpar2_conf 5 + Pazpar2 protocol: pazpar2_protocol 7