X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2.xml;h=19e39ec8778ee5d09b9b932ddb8f1e6d89cfa670;hb=70a80d7e26ed2257d4b5a683bfa2a4a93e2fdb4c;hp=a409402a96e79154d1320877d71e5126ff584ac3;hpb=0ef3f55d13097b1cc912c19c3ffb122010462a35;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml index a409402..19e39ec 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,30 @@ - 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. + + + 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. + @@ -74,7 +93,18 @@ Specifies main configuration. This option must be specified - in order for pazpar2 to operate normally. + 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. @@ -82,28 +112,59 @@ - Specifies log file. The log file must be specified when pazpar2 + 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. + 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. + - + - 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. + + @@ -111,9 +172,38 @@ - Specifies that pazpar2 change user to the + 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. @@ -122,9 +212,35 @@ - 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. + 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. @@ -133,15 +249,48 @@ - EXAMPLES - None yet + + 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 - + + FILES + /usr/sbin/pazpar2: pazpar2 daemon + + /usr/share/pazpar2: pazpar2 shared files + + /etc/pazpar2: pazpar2 config area - SEE ALSO + + SEE ALSO Pazpar2 configuration: @@ -150,7 +299,7 @@ - Pazpar2 protocol:. + Pazpar2 protocol: pazpar2_protocol 7 @@ -160,18 +309,9 @@ -