node-zoom

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>6.�Application Invocation</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="YAZ User's Guide and Reference"><link rel="up" href="server.html" title="Chapter�4.�Generic server"><link rel="prev" href="server.backendfunctions.html" title="5.�The Backend Functions"><link rel="next" href="server.vhosts.html" title="7.�GFS Configuration and Virtual Hosts"></head><body><link rel="stylesheet" type="text/css" href="common/style1.css"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.�Application Invocation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="server.backendfunctions.html">Prev</a>�</td><th width="60%" align="center">Chapter�4.�Generic server</th><td width="20%" align="right">�<a accesskey="n" href="server.vhosts.html">Next</a></td></tr></table><hr></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="server.invocation"></a>6.�Application Invocation</h2></div></div></div> The finished application has the following invocation syntax (by way of <code class="function">statserv_main()</code>): <div class="cmdsynopsis"><code class="command">application</code> [<code class="option">-install</code>] [<code class="option">-installa</code>] [<code class="option">-remove</code>] [<code class="option">-a <code>file</code></code>] [<code class="option">-v <code>level</code></code>] [<code class="option">-l <code>file</code></code>] [<code class="option">-u <code>uid</code></code>] [<code class="option">-c <code>config</code></code>] [<code class="option">-f <code>vconfig</code></code>] [<code class="option">-C <code>fname</code></code>] [<code class="option">-t <code>minutes</code></code>] [<code class="option">-k <code>kilobytes</code></code>] [<code class="option">-K</code>] [<code class="option">-d <code>daemon</code></code>] [<code class="option">-w <code>dir</code></code>] [<code class="option">-p <code>pidfile</code></code>] [<code class="option">-r <code>kilobytes</code></code>] [<code class="option">-ziDSTV1</code>] [listener-spec...]</div> The options are: <div class="variablelist"><dl class="variablelist"><dt><code class="literal">-a </code> <code>file</code></dt><dd> Specify a file for dumping PDUs (for diagnostic purposes). The special name <code class="literal">-</code> (dash) sends output to <code class="literal">stderr</code>. </dd><dt><code class="literal">-S</code></dt><dd> Don't fork or make threads on connection requests. This is good for debugging, but not recommended for real operation: Although the server is asynchronous and non-blocking, it can be nice to keep a software malfunction (okay then, a crash) from affecting all current users. </dd><dt><code class="literal">-1</code></dt><dd> Like <code class="literal">-S</code> but after one session the server exits. This mode is for debugging only. </dd><dt><code class="literal">-T</code></dt><dd> Operate the server in threaded mode. The server creates a thread for each connection rather than a fork a process. Only available on UNIX systems that offers POSIX threads. </dd><dt><code class="literal">-s</code></dt><dd> Use the SR protocol (obsolete). </dd><dt><code class="literal">-z</code></dt><dd> Use the Z39.50 protocol (default). This option and <code class="literal">-s</code> complement each other. You can use both multiple times on the same command line, between listener-specifications (see below). This way, you can set up the server to listen for connections in both protocols concurrently, on different local ports. </dd><dt><code class="literal">-l </code><code>file</code></dt><dd>The logfile. </dd><dt><code class="literal">-c </code><code>config</code></dt><dd>A user option that serves as a specifier for some sort of configuration, usually a filename. The argument to this option is transferred to member <code class="literal">configname</code> of the <code class="literal">statserv_options_block</code>. </dd><dt><code class="literal">-f </code><code>vconfig</code></dt><dd>This specifies an XML file that describes one or more YAZ frontend virtual servers. </dd><dt><code class="literal">-C </code><code>fname</code></dt><dd>Sets SSL certificate file name for server (PEM). </dd><dt><code class="literal">-v </code><code>level</code></dt><dd> The log level. Use a comma-separated list of members of the set {fatal,debug,warn,log,malloc,all,none}. </dd><dt><code class="literal">-u </code><code>uid</code></dt><dd> Set user ID. Sets the real UID of the server process to that of the given user. It's useful if you aren't comfortable with having the server run as root, but you need to start it as such to bind a privileged port. </dd><dt><code class="literal">-w </code><code>dir</code></dt><dd> The server changes to this directory during before listening on incoming connections. This option is useful when the server is operating from the inetd daemon (see <code class="literal">-i</code>). </dd><dt> <code class="literal">-p </code><code>pidfile</code> </dt><dd> Specifies that the server should write its Process ID to file given by <code>pidfile</code>. A typical location would be <code class="filename">/var/run/yaz-ztest.pid</code>. </dd><dt><code class="literal">-i</code></dt><dd> Use this to make the the server run from the inetd server (UNIX only). </dd><dt><code class="literal">-D</code></dt><dd> Use this to make the server put itself in the background and run as a daemon. If neither <code class="literal">-i</code> nor <code class="literal">-D</code> is given, the server starts in the foreground. </dd><dt><code class="literal">-install</code></dt><dd> Use this to install the server as an NT service (Windows NT/2000/XP only). Control the server by going to the Services in the Control Panel. </dd><dt><code class="literal">-installa</code></dt><dd> Use this to install the server as an NT service and mark it as "auto-start. Control the server by going to the Services in the Control Panel. </dd><dt><code class="literal">-remove</code></dt><dd> Use this to remove the server from the NT services (Windows NT/2000/XP only). </dd><dt><code class="literal">-t </code><code>minutes</code></dt><dd> Idle session timeout, in minutes. </dd><dt><code class="literal">-k </code><code>size</code></dt><dd> Maximum record size/message size, in kilobytes. </dd><dt><code class="literal">-K</code></dt><dd> Forces no-keepalive for HTTP sessions. By default GFS will keep sessions alive for HTTP 1.1 sessions (as defined by the standard). Using this option will force GFS to close the connection for each operation. </dd><dt><code class="literal">-r </code><code>size</code></dt><dd> Maximum size of log file before rotation occurs, in kilobytes. Default size is 1048576 k (=1 GB). </dd><dt> <code class="literal">-d </code><code>daemon</code> </dt><dd> Set name of daemon to be used in hosts access file. See hosts_access(5) and tcpd(8). </dd><dt><code class="literal">-m </code><code>time-format</code></dt><dd> Sets the format of time-stamps in the log-file. Specify a string in the input format to <code class="literal">strftime()</code>. </dd><dt><code class="literal">-V </code></dt><dd> Display YAZ version and exit. </dd></dl></div> A listener specification consists of a transport mode followed by a colon (:) followed by a listener address. The transport mode is either <code class="literal">tcp</code>, <code class="literal">unix:</code> or <code class="literal">ssl</code>. For TCP and SSL, an address has the form <pre class="synopsis"> hostname | IP-number [: portnumber] </pre> The port number defaults to 210 (standard Z39.50 port). For UNIX, the address is the filename of socket. For TCP/IP and SSL, the special hostnames <code class="literal">@</code>, maps to <code class="literal">IN6ADDR_ANY_INIT</code> with IPV4 binding as well (bindv6only=0), The special hostname <code class="literal">@4</code> binds to <code class="literal">INADDR_ANY</code> (IPV4 only listener). The special hostname <code class="literal">@6</code> binds to <code class="literal">IN6ADDR_ANY_INIT</code> with bindv6only=1 (IPV6 only listener). <div class="example"><a name="server.example.running.unix"></a>Example�4.1.�Running the GFS on Unix<div class="example-contents"> Assuming the server application <code>appname</code> is started as root, the following will make it listen on port 210. The server will change identity to <code class="literal">nobody</code> and write its log to <code class="filename">/var/log/app.log</code>. <pre class="screen"> application -l /var/log/app.log -u nobody tcp:@:210 </pre> The server will accept Z39.50 requests and offer SRU service on port 210. </div></div> <div class="example"><a name="server.example.apache.sru"></a>Example�4.2.�Setting up Apache as SRU Frontend<div class="example-contents"> If you use <a class="ulink" href="http://httpd.apache.org/" target="_top">Apache</a> as your public web server and want to offer HTTP port 80 access to the YAZ server on 210, you can use the <a class="ulink" href="http://httpd.apache.org/docs/mod/mod_proxy.html#proxypass" target="_top"> <code class="literal">ProxyPass</code></a> directive. If you have virtual host <code class="literal">srw.mydomain</code> you can use the following directives in Apache's httpd.conf: <pre class="screen"> <VirtualHost *> ErrorLog /home/srw/logs/error_log TransferLog /home/srw/logs/access_log ProxyPass / http://srw.mydomain:210/ </VirtualHost> </pre> The above for the Apache 1.3 series. </div></div> <div class="example"><a name="server.example.local.access"></a>Example�4.3.�Running a server with local access only<div class="example-contents"> Servers that is only being accessed from the local host should listen on UNIX file socket rather than a Internet socket. To listen on <code class="filename">/tmp/mysocket</code> start the server as follows: <pre class="screen"> application unix:/tmp/mysocket </pre> </div></div> </div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="server.backendfunctions.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="server.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="server.vhosts.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5.�The Backend Functions�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�7.�GFS Configuration and Virtual Hosts</td></tr></table></div></body></html>