'\" t
.\"     Title: refdbsru
.\"    Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 2005-10-16
.\"    Manual: RefDB Manual
.\"    Source: RefDB Manual
.\"  Language: English
.\"
.TH "REFDBSRU" "1" "2005\-10\-16" "RefDB Manual" "RefDB Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
refdbsru \- CGI script providing SRU access to RefDB databases
.SH "SYNOPSIS"
.HP \w'\fBrefdbsru\fR\ 'u
\fBrefdbsru\fR
.SH "DESCRIPTION"
.PP
refdbsru is a CGI script which turns your web server into a proxy RefDB server providing SRU (Search and Retrieve via URL) access\&. Anyone with a web browser or some other tool capable of sending HTTP requests can query your RefDB databases\&. This script is not intended to be run by users\&. It is invoked by your web server\&.
.PP
The output of the script is a XML document as described in the SRU standard\&.
.SH "CONFIGURATION"
.PP
\fBrefdbsru\fR
evaluates the file
refdbsrurc
to initialize itself\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
The parameters starting with "zeerex_" do not actually influence how the script operates\&. They provide some of the site\-specific information which appears in the SRU
\fBexplain\fR
output\&.
.sp .5v
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&refdbsrurc
.TS
allbox tab(:);
lB lB lB.
T{
Variable
T}:T{
Default
T}:T{
Comment
T}
.T&
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l.
T{
logfile
T}:T{
/var/log/refdbsru\&.log
T}:T{
The full path of a custom log file\&. This is used only if logdest is set appropriately\&.
T}
T{
logdest
T}:T{
1
T}:T{
The destination of the log information\&. 0 = print to stderr; 1 = use the syslog facility; 2 = use a custom logfile\&. The latter needs a proper setting of logfile\&.
T}
T{
loglevel
T}:T{
6
T}:T{
The log level up to which messages will be sent\&. A low setting (0) allows only the most important messages, a high setting (7) allows all messages including debug messages\&. \-1 means nothing will be logged\&.
T}
T{
serverip
T}:T{
127\&.0\&.0\&.1
T}:T{
The IP address or hostname of the machine where refdbd runs\&. Use the default (localhost) address if the clients and refdbs run on the same machine\&.
T}
T{
port
T}:T{
9734
T}:T{
The port on which refdbd listens\&. Change this for all clients and the server if this value interferes with another program using this port\&.
T}
T{
timeout
T}:T{
180
T}:T{
The timeout in seconds\&. After this time has elapsed, a stalled connection is taken down\&. Increase this value if you encounter frequent timeout errors due to high network traffic or refdbd overload\&.
T}
T{
username
T}:T{
login name
T}:T{
The username which is used for authentication with the database server\&.
T}
T{
passwd
T}:T{
\ \&
T}:T{
The password which is used for authentication with the database server\&.
T}
T{
pdfroot
T}:T{
(none)
T}:T{
This value will be used as the root of the paths to PDF or Postscript offprints that can be specified with the AV field in a RIS dataset\&. The path should not rely on shell expansion, e\&.g\&. use /home/me/literature/ instead of ~/literature/\&. The pdfroot allows you to shorten the paths that you enter for each dataset and to maintain a certain portability if you have to move the offprints to a different directory or want to access them remotely\&. The html output routine will concatenate the relative path of each dataset with the pdfroot to construct the link to the offprint\&. Instead of a local path name you can specify an URL starting with http:// or ftp:// if your offprints are accessible through a web server or ftp server\&.
T}
T{
cssurl
T}:T{
(none)
T}:T{
In spite of the parameter name, this may be the URL either of a Cascading Style Sheet (CSS) file, or of a XSLT file\&. This file, if specified, is used to format the SRU output in the web browser\&.
T}
T{
dbserver
T}:T{
(none)
T}:T{
This is the name of the database engine that refdbd uses (currently either mysql, pgsql, sqlite, or sqlite3)\&. refdbsru can obtain this value at runtime, but it has to send one additional query per searchRetrieve or scan operation\&. If you provide the value here instead, response times will be faster\&.
T}
T{
zeerex_host
T}:T{
www\&.change\&.me
T}:T{
The hostname of the computer that runs your web server and refdbsru
T}
T{
zeerex_port
T}:T{
80
T}:T{
The port that your web server listens to\&.
T}
T{
zeerex_database
T}:T{
cgi\-bin/refdbsru
T}:T{
The path section of the URL which provides SRU access to your database, without the leading slash\&. zeerex_host, a slash, and this option combined make up the URL which a user has to type into his web browser to access your SRU service\&.
T}
T{
zeerex_databaseInfo_title
T}:T{
Reference Database
T}:T{
A public name of your database\&.
T}
T{
zeerex_databaseInfo_description
T}:T{
A reference database
T}:T{
A brief description of your database\&.
T}
T{
zeerex_databaseInfo_author
T}:T{
Your Name
T}:T{
The name of the person who is in charge of running the database\&.
T}
T{
zeerex_databaseInfo_contact
T}:T{
your@email
T}:T{
How to contact the database maintainer\&. Usually the email address\&.
T}
.TE
.sp 1
.SH "ENVIRONMENT"
.PP
As a CGI script, refdbsru evaluates a variety of environment variables that the web server provides\&. These are:
.PP
REQUEST_METHOD
.RS 4
Either GET or POST
.RE
.PP
QUERY_STRING
.RS 4
The query string proper in a GET request\&.
.RE
.PP
PATH_INFO
.RS 4
This value, if present, is used as the name of a database (other than the preconfigured default database)\&.
.RE
.SH "FILES"
.PP
PREFIX/etc/refdb/refdbsrurc
.RS 4
The global configuration file of refdbsru\&.
.RE
.SH "SEE ALSO"
.PP
\fBRefDB\fR
(7)
.PP
\fBrefdb\-sruserver\fR
(1)
.PP
\fIRefDB manual (local copy) \fR
PREFIX/share/doc/refdb\-<version>/refdb\-manual/index\&.html
.PP
\fIRefDB manual (web) \fR
<\m[blue]\fBhttp://refdb\&.sourceforge\&.net/manual/index\&.html\fR\m[]>
.PP
\fIRefDB on the web \fR
<\m[blue]\fBhttp://refdb\&.sourceforge\&.net/\fR\m[]>
.PP
\fISRU (Search and Retrieve via URL) \fR
<\m[blue]\fBhttp://www\&.loc\&.gov/standards/sru/\fR\m[]>
.SH "AUTHOR"
.PP
refdbsru was written by Markus Hoenicka <markus@mhoenicka\&.de>\&.