/usr/share/doc/refdb/refdb-manual/re04.html is in refdb-doc 1.0.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>refdbsru</title><link rel="stylesheet" type="text/css" href="manual.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="RefDB handbook" /><link rel="up" href="ch12.html" title="Chapter 12. The application server" /><link rel="prev" href="re03.html" title="refdb" /><link rel="next" href="re05.html" title="refdb-sruserver" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">refdbsru</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re03.html">Prev</a> </td><th width="60%" align="center">Chapter 12. The application server</th><td width="20%" align="right"> <a accesskey="n" href="re05.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="refentry-refdbsru"></a><div class="titlepage"></div><div class="refnamediv"><a id="refdbsru-name"></a><h2>Name</h2><p>refdbsru — CGI script providing SRU access to RefDB databases</p></div><div class="refsynopsisdiv"><a id="refdbsru-synopsis"></a><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">refdbsru</code> </p></div></div><div class="refsect1"><a id="refdbsru-description"></a><h2>Description</h2><p>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.</p><p>The output of the script is a XML document as described in the SRU standard.</p></div><div class="refsect1"><a id="refdbsru-configuration"></a><h2>Configuration</h2><p><span class="command"><strong>refdbsru</strong></span> evaluates the file <code class="filename">refdbsrurc</code> to initialize itself.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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 <span class="command"><strong>explain</strong></span> output.</p></div><div class="table"><a id="idp69397744"></a><p class="title"><strong>Table 12.2. refdbsrurc</strong></p><div class="table-contents"><table summary="refdbsrurc" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Variable</th><th>Default</th><th>Comment</th></tr></thead><tbody><tr><td>logfile</td><td>/var/log/refdbsru.log</td><td>The full path of a custom log file. This is used only if logdest is set appropriately.</td></tr><tr><td>logdest</td><td>1</td><td>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.</td></tr><tr><td>loglevel</td><td>6</td><td>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.</td></tr><tr><td>serverip</td><td>127.0.0.1</td><td>The IP address or hostname of the machine where <span class="application">refdbd</span> runs. Use the default (localhost) address if the clients and refdbs run on the same machine.</td></tr><tr><td>port</td><td>9734</td><td>The port on which <span class="application">refdbd</span> listens. Change this for all clients and the server if this value interferes with another program using this port.</td></tr><tr><td>timeout</td><td>180</td><td>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.</td></tr><tr><td>username</td><td>login name</td><td>The username which is used for authentication with the database server.</td></tr><tr><td>passwd</td><td> </td><td>The password which is used for authentication with the database server.</td></tr><tr><td>pdfroot</td><td>(none)</td><td>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 <code class="filename">/home/me/literature/</code> instead of <code class="filename">~/literature/</code>. The <a class="link" href="ch08s10.html" title="Use pdfroot">pdfroot</a> 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.</td></tr><tr><td>cssurl</td><td>(none)</td><td>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.</td></tr><tr><td>dbserver</td><td>(none)</td><td>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.</td></tr><tr><td>zeerex_host</td><td>www.change.me</td><td>The hostname of the computer that runs your web server and refdbsru</td></tr><tr><td>zeerex_port</td><td>80</td><td>The port that your web server listens to.</td></tr><tr><td>zeerex_database</td><td>cgi-bin/refdbsru</td><td>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.</td></tr><tr><td>zeerex_databaseInfo_title</td><td>Reference Database</td><td>A public name of your database.</td></tr><tr><td>zeerex_databaseInfo_description</td><td>A reference database</td><td>A brief description of your database.</td></tr><tr><td>zeerex_databaseInfo_author</td><td>Your Name</td><td>The name of the person who is in charge of running the database.</td></tr><tr><td>zeerex_databaseInfo_contact</td><td>your@email</td><td>How to contact the database maintainer. Usually the email address.</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="refsect1"><a id="refdbsru-environment"></a><h2>Environment</h2><p>As a CGI script, refdbsru evaluates a variety of environment variables that the web server provides. These are:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">REQUEST_METHOD</span></dt><dd><p>Either GET or POST</p></dd><dt><span class="term">QUERY_STRING</span></dt><dd><p>The query string proper in a GET request.</p></dd><dt><span class="term">PATH_INFO</span></dt><dd><p>This value, if present, is used as the name of a database (other than the preconfigured default database).</p></dd></dl></div></div><div class="refsect1"><a id="refdbsru-files"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">PREFIX/etc/refdb/refdbsrurc</code></span></dt><dd><p>The global configuration file of refdbsru.</p></dd></dl></div></div><div class="refsect1"><a id="refdbsru-see_also"></a><h2>See also</h2><p><span class="emphasis"><em>RefDB</em></span> (7)</p><p><span class="emphasis"><em>refdb-sruserver</em></span> (1)</p><p><span class="emphasis"><em>RefDB manual (local copy) </em></span> PREFIX/share/doc/refdb-<version>/refdb-manual/index.html</p><p><span class="emphasis"><em>RefDB manual (web) </em></span> <<a class="ulink" href="http://refdb.sourceforge.net/manual/index.html" target="_top">http://refdb.sourceforge.net/manual/index.html</a>></p><p><span class="emphasis"><em>RefDB on the web </em></span> <<a class="ulink" href="http://refdb.sourceforge.net/" target="_top">http://refdb.sourceforge.net/</a>></p><p><span class="emphasis"><em>SRU (Search and Retrieve via URL) </em></span> <<a class="ulink" href="http://www.loc.gov/standards/sru/" target="_top">http://www.loc.gov/standards/sru/</a>></p></div><div class="refsect1"><a id="refdbsru-author"></a><h2>Author</h2><p>refdbsru was written by Markus Hoenicka <markus@mhoenicka.de>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">refdb </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> refdb-sruserver</td></tr></table></div></body></html>
|