X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2.xml;h=7caf310bf1fed42f4dd638c99587dfe687875fe4;hb=64dccf5757a22cedd3c21ca834e3e02f39dd0504;hp=825db7a88a3b5d25e4390905ad982a9cf03c2cd2;hpb=b4edc17e33ad611f70f231072bedcd2ab6415476;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml index 825db7a..7caf310 100644 --- a/doc/pazpar2.xml +++ b/doc/pazpar2.xml @@ -1,60 +1,330 @@ - %local; %entities; - - %common; + + %idcommon; ]> - - pazpar2 + Pazpar2 &version; + Index Data + Pazpar2 - 1 + 8 + System management commands pazpar2 - High-performance, user-interface independtent metasearching - middleware + Metasearch daemon. pazpar2 + + + + + + + + + + + + + + + + - DESCRIPTION + + 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 - + + OPTIONS + + + + + + + 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. + + + + + + + + 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). + + + + + -m timeformat + + Sets the format of time-stamps for logging. + Refer to the + + strftime(3) + man page for the format. + + + + + + + Specifies PID file. If Pazpar2 is started and configured properly + the file given holds the process ID of the Pazpar2 process. + + + + + + + + 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 . + + + - EXAMPLES - + + + + + 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. + + + + + + + + + + Makes the Pazpar2 server change user ID to the + uid given. + 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. + + + + + + + + + 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. + + + + - FILES + + + + + 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 + + + + Pazpar2 player: + + pazpar2_play + 1 + + +