node-zoom

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>yaz-client</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="reference.html" title="Reference"><link rel="prev" href="reference.html" title="Reference"><link rel="next" href="yaz-ztest.html" title="yaz-ztest"></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">yaz-client</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="reference.html">Prev</a>�</td><th width="60%" align="center">Reference</th><td width="20%" align="right">�<a accesskey="n" href="yaz-ztest.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="yaz-client"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2>yaz-client — Z39.50/SRU client for implementors</div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><code class="command">yaz-client</code> [<code class="option">-a <code>apdulog</code></code>] [<code class="option">-b <code>berdump</code></code>] [<code class="option">-c <code>cclfile</code></code>] [<code class="option">-d <code>dump</code></code>] [<code class="option">-f <code>cmdfile</code></code>] [<code class="option">-k <code>size</code></code>] [<code class="option">-m <code>marclog</code></code>] [<code class="option">-p <code>proxy-addr</code></code>] [<code class="option">-q <code>cqlfile</code></code>] [<code class="option">-t <code>dispcharset</code></code>] [<code class="option">-u <code>auth</code></code>] [<code class="option">-v <code>loglevel</code></code>] [<code class="option">-V</code>] [<code class="option">-x</code>] [server-addr]</div></div><div class="refsect1"><a name="idp51512464"></a><h2>DESCRIPTION</h2> yaz-client is a <a class="ulink" href="http://www.loc.gov/z3950/agency/" target="_top">Z39.50</a>/<a class="ulink" href="http://www.loc.gov/standards/sru/" target="_top">SRU</a> client (origin) with a simple command line interface that allows you to test behavior and performance of Z39.50 targets and SRU servers. From YAZ version 4.1.0 yaz-client may also operate as a <a class="ulink" href="http://lucene.apache.org/solr/" target="_top">Solr</a> Web Service client. If the <code>server-addr</code> is specified, the client creates a connection to the Z39.50/SRU target at the address given. When yaz-client is started it tries to read commands from one of the following files: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> Command file if it is given by option -f. </li><li class="listitem"> <code class="filename">.yazclientrc</code> in current working directory. </li><li class="listitem"> <code class="filename">.yazclientrc</code> in the user's home directory. The value of the <code class="literal">HOME</code> is used to determine the home directory. Normally, <code class="literal">HOME</code> is only set on POSIX systems such as Linux, FreeBSD, Solaris. </li></ul></div> </div><div class="refsect1"><a name="idp51524784"></a><h2>OPTIONS</h2><div class="variablelist"><dl class="variablelist"><dt>-a <code>filename</code></dt><dd> If specified, logging of protocol packages will be appended file given. If <code>filename</code> is specified as <code class="literal">-</code>, the output is written to <code class="literal">stdout</code>. </dd><dt>-b <code>filename</code></dt><dd> If specified, YAZ will dump BER data in readable notation to the file specified. If <code>filename</code> is specified as <code class="literal">-</code> the output is written to <code class="literal">stdout</code>. </dd><dt>-c <code>filename</code></dt><dd> If specified, CCL configuration will be read from the file given. </dd><dt>-d <code>dump</code></dt><dd> If specified, YAZ will dump BER data for all PDUs sent and received to individual files, named <code>dump</code>.DDD.<code class="literal">raw</code>, where DDD is 001, 002, 003, .. </dd><dt>-f <code>cmdfile</code></dt><dd> Reads commands from <code>cmdfile</code>. When this option is used, YAZ client does not read .yazclientrc from current directory or home directory. </dd><dt>-k <code>size</code></dt><dd> Sets preferred messages and maximum record size for Initialize Request in kilobytes. Default value is 65536 (64 MB). </dd><dt>-m <code>filename</code></dt><dd> If specified, retrieved records will be appended to the file given. </dd><dt>-p <code>proxy-addr</code></dt><dd> If specified, the client will use the proxy at the address given. YAZ client will connect to a proxy on the address and port given. The actual target will be specified as part of the InitRequest to inform the proxy about actual target. </dd><dt>-q <code>filename</code></dt><dd> If specified, CQL configuration will be read from the file given. </dd><dt>-t <code>displaycharset</code></dt><dd> If displaycharset is given, it specifies name of the character set of the output (on the terminal on which YAZ client is running). </dd><dt>-u <code>auth</code></dt><dd> If specified, the <code>auth</code> string will be used for authentication. </dd><dt> <code class="literal">-v</code> <code>level</code> </dt><dd>Sets the LOG level to <code>level</code>. Level is a sequence of tokens separated by comma. Each token is a integer or a named LOG item - one of <code class="literal">fatal</code>, <code class="literal">debug</code>, <code class="literal">warn</code>, <code class="literal">log</code>, <code class="literal">malloc</code>, <code class="literal">all</code>, <code class="literal">none</code>. </dd><dt>-V</dt><dd> Prints YAZ version. </dd><dt>-x</dt><dd> Makes the YAZ client print hex dumps of packages sent and received on standard output. </dd></dl></div></div><div class="refsect1"><a name="idp51561136"></a><h2>COMMANDS</h2> The YAZ client accepts the following commands. <div class="variablelist"><dl class="variablelist"><dt><a name="command-open"></a> <code class="literal">open </code><code>zurl</code> </dt><dd>Opens a connection to a server. The syntax for <code>zurl</code> is the same as described above for connecting from the command line. Syntax: [<code class="literal">(tcp|ssl|unix|http)':'</code>]<code>host</code> [:<code>port</code>][/<code>base</code>] </dd><dt> <code class="literal">quit</code> </dt><dd>Quits YAZ client</dd><dt><a name="command-find"></a> <code class="literal">find </code><code>query</code></dt><dd>Sends a Search Request using the <code>query</code> given. By default the query is assumed to be PQF. See command <a class="link" href="yaz-client.html#command-querytype">querytype</a> for more information. </dd><dt> <code class="literal">delete</code> <code>setname</code></dt><dd>Deletes result set with name <code>setname</code> on the server.</dd><dt> <code class="literal">base </code><code>base1</code> <code>base2</code> ... </dt><dd>Sets the name(s) of the database(s) to search. One or more databases may be specified separated by blanks. This commands overrides the database given in <code>zurl</code>. </dd><dt> <code class="literal">show </code> [<code>start</code>[+<code>number</code>]] </dt><dd>Fetches records by sending a Present Request from the start position given by <code>start</code> a number of records given by <code>number</code>. If <code>start</code> is not given, then the client will fetch from position of the last retrieved record plus 1. If <code>number</code> is not given, then one record will be fetched at a time. </dd><dt> <code class="literal">scan</code> <code>term</code> </dt><dd>Scans database index for a term. The syntax resembles the syntax for <a class="link" href="yaz-client.html#command-find"><code class="literal">find</code></a>. If you want to scan for the word <code class="literal">water</code> you could write <pre class="screen"> scan water </pre> but if you want to scan only in, say the title field, you would write <pre class="screen"> scan @attr 1=4 water </pre></dd><dt> <code class="literal">setscan</code> <code>set</code> <code>term</code> </dt><dd>Scans database index for a term within a result set. This is similar to the scan command but has a result set as its first argument. </dd><dt> <code class="literal">scanpos</code> <code>pos</code> </dt><dd> Sets preferred position for scan. This value is used in next scan. By default position is 1. </dd><dt> <code class="literal">scansize</code> <code>size</code> </dt><dd> Sets number of entries to be returned by scan. Default number of entries is 20. </dd><dt> <code class="literal">scanstep</code> <code>step</code> </dt><dd> Set step-size for scan. This value is used in next scan sent to the target. By default step-size is 0. </dd><dt><a name="sortspec"></a> <code class="literal">sort</code> <code>sortspecs</code> </dt><dd>Sorts a result set. The sort command takes a sequence of space-separated sort specifications, with each sort specification consisting of two space-separated words (so that the whole specification list is made up of an even number of words). The first word of each specification holds a field (sort criterion) and the second holds flags. If the sort criterion includes <code class="literal">=</code> it is assumed that the <code class="literal">SortKey</code> is of type <code class="literal">sortAttributes</code> using Bib-1: in this case the integer before <code class="literal">=</code> is the attribute type and the integer following <code class="literal">=</code> is the attribute value. If no <code class="literal">=</code> character is in the criterion, it is treated as a sortfield of type InternationalString. The flags word of each sort specification must consist of <code class="literal">s</code> for case sensitive or <code class="literal">i</code> for case insensitive, and <code class="literal"><</code> for ascending order or <code class="literal">></code> for descending order. </dd><dt> <code class="literal">sort+</code> </dt><dd>Same as <code class="literal">sort</code> but stores the sorted result set in a new result set. </dd><dt> <code class="literal">authentication</code> <code>openauth</code> </dt><dd>Sets up a authentication string if a server requires authentication (v2 OpenStyle). The authentication string is first sent to the server when the <a class="link" href="yaz-client.html#command-open"><code class="literal">open</code></a> command is issued and the Z39.50 Initialize Request is sent, so this command must be used before <code class="literal">open</code> in order to be effective. A common convention for the <code>authopen</code> string is that the username - and password is separated by a slash, e.g. <code class="literal">myusername/mysecret</code>. </dd><dt> <code class="literal">sru</code> <code>method</code> <code>version</code> </dt><dd>Selects Web Service method and version. Must be one of <code class="literal">post</code>, <code class="literal">get</code>, <code class="literal">soap</code> (default) or <code class="literal">solr</code>. Version should be either 1.1, 1.2 or 2.0 for SRU. Other versions are allowed - for testing purposes (version negotiation with SRU server). The version is currently not used for Solr Web Services </dd><dt> <code class="literal">list_all</code> </dt><dd>This command displays status and values for many settings. </dd><dt> <code class="literal">lslb</code> <code>n</code> </dt><dd>Sets the limit for when no records should be returned together with the search result. See the <a class="ulink" href="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6" target="_top"> Z39.50 standard on set bounds </a> for more details. </dd><dt> <code class="literal">ssub</code> <code>n</code> </dt><dd>Sets the limit for when all records should be returned with the search result. See the <a class="ulink" href="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6" target="_top"> Z39.50 standard on set bounds </a> for more details. </dd><dt> <code class="literal">mspn</code> <code>n</code> </dt><dd>Sets the number of records should be returned if the number of records in the result set is between the values of <code class="literal">lslb</code> and <code class="literal">ssub</code>. See the <a class="ulink" href="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6" target="_top"> Z39.50 standard on set bounds </a> for more details. </dd><dt> <code class="literal">status</code> </dt><dd>Displays the values of <code class="literal">lslb</code>, <code class="literal">ssub</code> and <code class="literal">mspn</code>. </dd><dt> <code class="literal">setname</code> </dt><dd>Switches named result sets on and off. Default is on. </dd><dt> <code class="literal">cancel</code> </dt><dd>Sends a Trigger Resource Control Request to the target. </dd><dt> <code class="literal">format</code> <code>oid</code> </dt><dd>Sets the preferred transfer syntax for retrieved records. yaz-client supports all the record syntaxes that currently are registered. See <a class="ulink" href="http://www.loc.gov/z3950/agency/defns/oids.html#5" target="_top"> Z39.50 Record Syntax Identifiers </a> for more details. Commonly used records syntaxes include usmarc, sutrs and xml. </dd><dt> <code class="literal">elements</code> <code>e</code> </dt><dd>Sets the element set name for the records. Many targets support element sets are B (for brief) and F (for full). </dd><dt> <code class="literal">close</code> </dt><dd>Sends a Z39.50 Close APDU and closes connection with the peer </dd><dt><a name="command-querytype"></a> <code class="literal">querytype</code> <code>type</code> </dt><dd>Sets the query type as used by command <a class="link" href="yaz-client.html#command-find"><code class="literal">find</code></a>. The following is supported: <code class="literal">prefix</code> for <a class="link" href="tools.html#PQF" title="1.1.�Prefix Query Format">Prefix Query Notation</a> (Type-1 Query); <code class="literal">ccl</code> for CCL search (Type-2 Query), <code class="literal">cql</code> for CQL (Type-104 search with CQL OID), <code class="literal">ccl2rpn</code> for <a class="link" href="tools.html#CCL" title="1.2.�CCL">CCL</a> to RPN conversion (Type-1 Query). <code class="literal">cql2rpn</code> for CQL to RPN conversion (Type-1 Query). </dd><dt> <code class="literal">attributeset</code> <code>set</code> </dt><dd> Sets attribute set OID for prefix queries (RPN, Type-1). </dd><dt> <code class="literal">refid</code> <code>id</code> </dt><dd>Sets reference ID for Z39.50 Request(s). </dd><dt> <code class="literal">itemorder</code> <code>type</code> <code>no</code> </dt><dd>Sends an Item Order Request using the ILL External. <code>type</code> is either 1 or 2 which corresponds to ILL-Profile 1 and 2 respectively. The <code>no</code> is the Result Set position of the record to be ordered. </dd><dt> <code class="literal">update</code> <code>action</code> <code>recid</code> <code>doc</code> </dt><dd>Sends Item Update Request. The <code>action</code> argument must be the action type: one of <code class="literal">insert</code>, <code class="literal">replace</code>, <code class="literal">delete</code> and <code class="literal">update</code>. The second argument, <code>recid</code>, is the record identifier (any string). Third argument which is optional is the record document for the request. If doc is preceded with "<", then the following characters are treated as a filename with the records to be updated. Otherwise doc is treated as a document itself. The doc may also be quited in double quotes. If doc is omitted, the last received record (as part of present response or piggybacked search response) is used for the update. </dd><dt> <code class="literal">source</code> <code>filename</code> </dt><dd>Executes list of commands from file <code>filename</code>, just like source on most UNIX shells. A single dot (<code class="literal">.</code>) can be used as an alternative. </dd><dt> <code class="literal">!</code> <code>args</code> </dt><dd>Executes command <code>args</code> in subshell using the <code class="literal">system</code> call. </dd><dt> <code class="literal">push_command</code> <code>command</code> </dt><dd>The push_command takes another command as its argument. That command is then added to the history information (so you can retrieve it later). The command itself is not executed. This command only works if you have GNU readline/history enabled. </dd><dt> <code class="literal">set_apdufile</code> <code>filename</code> </dt><dd>Sets that APDU should be logged to file <code>filename</code>. Another way to achieve APDU log is by using command-line option <code class="literal">-a</code>. </dd><dt> <code class="literal">set_auto_reconnect</code> <code>flag</code> </dt><dd>Specifies whether YAZ client automatically reconnect if target closes connection (Z39.50 only). <code>flag</code> must be either <code class="literal">on</code> or <code class="literal">off</code>. </dd><dt><a name="command-set-auto-wait"></a> <code class="literal">set_auto_wait</code> <code>flag</code> </dt><dd>Specifies whether YAZ client should wait for response protocol packages after a request. By default YAZ client waits (on) for response packages immediately after a command (find, show) has been issued. If <code class="literal">off</code> is used, YAZ client does not attempt to receive packages automatically. These will have to be manually received when command <a class="link" href="yaz-client.html#command-wait-response"> <code class="literal">wait_response</code> </a> is used. <code>flag</code> must be either <code class="literal">on</code> or <code class="literal">off</code>. </dd><dt> <code class="literal">set_marcdump</code> <code>filename</code> </dt><dd>Specifies that all retrieved records should be appended to file <code>filename</code>. This command does the thing as option <code class="literal">-m</code>. </dd><dt> <code class="literal">schema</code> <code>schemaid</code> </dt><dd>Specifies schema for retrieval. Schema may be specified as an OID for Z39.50. For SRU, schema is a simple string URI. </dd><dt><a name="command-charset"></a> <code class="literal">charset</code> <code>negotiationcharset</code> [<code>displaycharset</code>] [[<code>marccharset</code>]] </dt><dd>Specifies character set (encoding) for Z39.50 negotiation / SRU encoding and/or character set for output (terminal). <code>negotiationcharset</code> is the name of the character set to be negotiated by the server. The special name <code class="literal">-</code> for <code>negotiationcharset</code> specifies no character set to be negotiated. If <code>displaycharset</code> is given, it specifies name of the character set of the output (on the terminal on which YAZ client is running). To disable conversion of characters to the output encoding, the special name <code class="literal">-</code> (dash) can be used. If the special name <code class="literal">auto</code> is given, YAZ client will convert strings to the encoding of the terminal as returned by <code class="function">nl_langinfo</code> call. If <code>marcharset</code> is given, it specifies name of the character set of retrieved MARC records from server. See also <code class="literal">marcharset</code> command. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3> Since character set negotiation takes effect in the Z39.50 Initialize Request you should issue this command before command <a class="link" href="yaz-client.html#command-open"><code class="literal">open</code></a> is used. </div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3> MARC records are not covered by Z39.50 character set negotiation, so that's why there is a separate character that must be known in order to do meaningful conversion(s). </div></dd><dt> <code class="literal">negcharset</code> <code>charset</code> </dt><dd>Specifies character set for negotiation (Z39.50). The argument is the same as second argument for command <a class="link" href="yaz-client.html#command-charset"><code class="literal">charset</code></a>. </dd><dt> <code class="literal">displaycharset</code> <code>charset</code> </dt><dd>Specifies character set for output (display). The argument is the same as second argument for command <a class="link" href="yaz-client.html#command-charset"><code class="literal">charset</code></a>. </dd><dt> <code class="literal">marccharset</code> <code>charset</code> </dt><dd>Specifies character set for retrieved MARC records so that YAZ client can display them in a character suitable for your display. See <code class="literal">charset</code> command. If <code class="literal">auto</code> is given, YAZ will assume that MARC21/USMARC is using MARC8/UTF8 and ISO-8859-1 for all other MARC variants. The charset argument is the same as third argument for command <a class="link" href="yaz-client.html#command-charset"><code class="literal">charset</code></a>. </dd><dt> <code class="literal">querycharset</code> <code>charset</code> </dt><dd>Specifies character set for query terms for Z39.50 RPN queries and Z39.50 Scan Requests (termListAndStartPoint). This is a pure client-side conversion which converts from displayCharset to queryCharset. </dd><dt> <code class="literal">set_cclfile</code> <code>filename</code> </dt><dd>Specifies that CCL fields should be read from file file <code>filename</code>. This command does the thing as option <code class="literal">-c</code>. </dd><dt> <code class="literal">set_cqlfile</code> <code>filename</code> </dt><dd>Specifies that CQL fields should be read from file file <code>filename</code>. This command does the thing as option <code class="literal">-q</code>. </dd><dt> <code class="literal">register_oid</code> <code>name</code> <code>class</code> <code>OID</code> </dt><dd>This command allows you to register your own object identifier - so that instead of entering a long dot-notation you can use a short name instead. The <code>name</code> is your name for the OID, <code>class</code> is the class, and <code>OID</code> is the raw OID in dot notation. Class is one <code class="literal">appctx</code>, <code class="literal">absyn</code>, <code class="literal">attet</code>, <code class="literal">transyn</code>, <code class="literal">diagset</code>, <code class="literal">recsyn</code>, <code class="literal">resform</code>, <code class="literal">accform</code>, <code class="literal">extserv</code>, <code class="literal">userinfo</code>, <code class="literal">elemspec</code>, <code class="literal">varset</code>, <code class="literal">schema</code>, <code class="literal">tagset</code>, <code class="literal">general</code>. If you're in doubt use the <code class="literal">general</code> class. </dd><dt> <code class="literal">register_tab</code> <code>command</code> <code>string</code> </dt><dd>This command registers a TAB completion string for the command given. </dd><dt> <code class="literal">sleep</code> <code>seconds</code> </dt><dd>This command makes YAZ client sleep (be idle) for the number of seconds given. </dd><dt><a name="command-wait-response"></a> <code class="literal">wait_response</code> [ <code>number</code>] </dt><dd>This command makes YAZ client wait for a number of response packages from target. If <code>number</code> is omitted, 1 is assumed. This command is rarely used and is only useful if command <a class="link" href="yaz-client.html#command-set-auto-wait"> <code class="literal">set_auto_wait</code> </a> is set to off. </dd><dt><a name="command-xmles"></a> <code class="literal">xmles</code> <code>OID</code> <code>doc</code> </dt><dd>Sends XML Extended Services request using the OID and doc given. </dd><dt> <code class="literal">zversion</code> <code>ver</code> </dt><dd>This command sets Z39.50 version for negotiation. Should be used before <a class="link" href="yaz-client.html#command-open"><code class="literal">open</code></a>. By default 3 (version 3) is used. </dd><dt> <code class="literal">options</code> <code>op1 op2..</code> </dt><dd>This command sets Z39.50 options for negotiation. Should be used before <a class="link" href="yaz-client.html#command-open"><code class="literal">open</code></a>. The following options are supported: <code class="literal">search</code>, <code class="literal">present</code>, <code class="literal">delSet</code>, <code class="literal">resourceReport</code>, <code class="literal">triggerResourceCtrl</code>, <code class="literal">resourceCtrl</code>, <code class="literal">accessCtrl</code>, <code class="literal">scan</code>, <code class="literal">sort</code>, <code class="literal">extendedServices</code>, <code class="literal">level_1Segmentation</code>, <code class="literal">level_2Segmentation</code>, <code class="literal">concurrentOperations</code>, <code class="literal">namedResultSets</code>, <code class="literal">encapsulation</code>, <code class="literal">resultCount</code>, <code class="literal">negotiationModel</code>, <code class="literal">duplicationDetection</code>, <code class="literal">queryType104</code>, <code class="literal">pQESCorrection</code>, <code class="literal">stringSchema</code>. </dd></dl></div></div><div class="refsect1"><a name="idp51813872"></a><h2>EXAMPLE</h2> The simplest example of a Prefix Query would be something like <pre class="screen"> f knuth </pre> or <pre class="screen"> f "donald knuth" </pre> In those queries no attributes was specified. This leaves it up to the server what fields to search but most servers will search in all fields. Some servers does not support this feature though, and require that some attributes are defined. To add one attribute you could do: <pre class="screen"> f @attr 1=4 computer </pre> where we search in the title field, since the use(1) is title(4). If we want to search in the author field and in the title field, and in the title field using right truncation it could look something like this: <pre class="screen"> f @and @attr 1=1003 knuth @attr 1=4 @attr 5=1 computer </pre> Finally using a mix of Bib-1 and GILS attributes could look something like this: <pre class="screen"> f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather </pre> </div><div class="refsect1"><a name="idp51819680"></a><h2>FILES</h2> <code class="filename">yaz-<version>/client/client.c</code> <code class="filename">$HOME/.yazclientrc</code> <code class="filename">$HOME/.yazclient.history</code> </div><div class="refsect1"><a name="idp51823600"></a><h2>SEE ALSO</h2> yaz(7) bib1-attr(7) </div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="reference.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="reference.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="yaz-ztest.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Reference�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�yaz-ztest</td></tr></table></div></body></html>