2 $Id: yaz-client-commands.xml,v 1.5 2004-09-22 19:22:08 adam Exp $
3 Commands for YAZ client.
4 Included in both manual and man page for yaz-client.
8 <literal>open </literal><replaceable>zurl</replaceable>
11 <para>Opens a connection to a server. The syntax for
12 <replaceable>zurl</replaceable> is the same as described
13 above for connecting from the command line.
19 [<literal>(tcp|ssl|unix|http)':'</literal>]<replaceable>host</replaceable>
20 [:<replaceable>port</replaceable>][/<replaceable>base</replaceable>]
25 <literal>quit</literal>
28 <para>Quits YAZ client</para>
32 <literal>f </literal><replaceable>query</replaceable></term>
34 <para>Sends a Search Request using the <replaceable>query</replaceable>
40 <literal>delete</literal> <replaceable>setname</replaceable></term>
42 <para>Deletes result set with name <replaceable>setname</replaceable>
47 <literal>base </literal><replaceable>base1</replaceable>
48 <replaceable>base2</replaceable> ...
51 <para>Sets the name(s) of the database(s) to search. One or more
52 databases may be specified separated by blanks. This commands overrides
53 the database given in <replaceable>zurl</replaceable>.
58 <literal>show </literal>
59 [<replaceable>start</replaceable>[+<replaceable>number</replaceable>]]
62 <para>Fetches records by sending a Present Request from the start
64 <replaceable>start</replaceable>
65 a number of records given by <replaceable>number</replaceable>. If
66 <replaceable>start</replaceable> is not given, then the client
67 will fetch from position of the last retrieved record plus 1. If
68 <replaceable>number</replaceable> is not given, then one record will
74 <literal>scan</literal> <replaceable>term</replaceable>
78 database index for a term. The syntax resembles the syntax
79 for <literal>find</literal>.
80 If you want to scan for the word <literal>water</literal> you could
87 but if you want to scan only in, say the title field, you would write
95 <literal>scanpos</literal> <replaceable>pos</replaceable>
99 Sets preferred position for scan. This value
100 is used in next scan. By default position is 1.
105 <literal>scanstep</literal> <replaceable>step</replaceable>
109 Set step-size for scan. This value is used in next scan
110 sent to the target. By default step-size is 0.
114 <varlistentry id="sortspec"><term>
115 <literal>sort</literal> <replaceable>sortspecs</replaceable>
118 <para>Sorts a result set. The sort command takes a
119 sequence of sort specifications. A sort
120 specification holds a field (sort criteria) and is followed by flags.
121 If the sort criteria includes <literal>=</literal> it is assumed
122 that the sort SortKey is of type sortAttributes using Bib-1.
123 The integer before <literal>=</literal> is
124 the attribute type and the integer following <literal>=</literal>
125 is the attribute value.
126 If no <literal>=</literal> is in the SortKey it is treated as a
127 sortfield-type of type InternationalString.
128 Flags observed are: <literal>s</literal>
129 for case sensitive, <literal>i</literal> for case insensitive,
130 <literal><</literal> for sort ascending and <literal>></literal>
136 <literal>sort+</literal>
139 <para>Same as <literal>sort</literal> but stores the sorted
140 result set in a new result set.
145 <literal>authentication</literal> <replaceable>openauth</replaceable>
148 <para>Sets up a authentication string if a server requires
149 authentication (v2 OpenStyle). The authentication string is first
150 sent to the server when the <literal>open</literal> command is
151 issued and the Z39.50 Initialize Request is sent, so this command
152 must be used before <literal>open</literal> in order to be effective.
153 A common convention for the <replaceable>authopen</replaceable> string
154 is that the username - and password is separated by a slash, e.g.
155 <literal>myusername/mysecret</literal>.
160 <literal>lslb</literal> <replaceable>n</replaceable>
163 <para>Sets the limit for when no records should be returned
164 together with the search result.
167 url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
176 <literal>ssub</literal> <replaceable>n</replaceable>
179 <para>Sets the limit for when all records should be returned with
183 url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
185 </ulink> for more details.
191 <literal>mspn</literal> <replaceable>n</replaceable>
194 <para>Sets the number of records should be returned if the
195 number of records in the result set is between the values of
196 <literal>lslb</literal> and <literal>ssub</literal>.
199 url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
207 <literal>status</literal>
210 <para>Displays the values of <literal>lslb</literal>,
211 <literal>ssub</literal> and <literal>mspn</literal>.
216 <literal>setname</literal>
219 <para>Switches named result sets on and off. Default is on.
224 <literal>cancel</literal>
227 <para>Sends a Trigger Resource Control Request to the target.
232 <literal>format</literal> <replaceable>oid</replaceable>
235 <para>Sets the preferred transfer syntax for retrieved records.
236 yaz-client supports all the record syntaxes that currently
239 url="http://lcweb.loc.gov/z3950/agency/defns/oids.html#5">
242 for more details. Commonly used records syntaxes include usmarc,
248 <literal>elements</literal> <replaceable>e</replaceable>
251 <para>Sets the element set name for the records. Many targets support
252 element sets are B (for brief) and F (for full).
257 <literal>close</literal>
260 <para>Sends a Z39.50 Close APDU and closes connection with the peer
265 <literal>querytype</literal> <replaceable>type</replaceable>
268 <para>Sets the query type as used by command <literal>find</literal>.
269 The following is supported:
270 <literal>prefix</literal> for
271 <link linkend="PQF">Prefix Query Notation</link> (Type-1 Query);
272 <literal>ccl</literal> for CCL search (Type-2 Query),
273 <literal>cql</literal> for CQL (Type-104 search with CQL OID),
274 <literal>ccl2rpn</literal> for
275 <link linkend="CCL">CCL</link> to RPN conversion (Type-1 Query).
276 <literal>cql2rpn</literal> for
277 CQL to RPN conversion (Type-1 Query).
282 <literal>attributeset</literal> <replaceable>set</replaceable>
286 Sets attribute set OID for prefix queries (RPN, Type-1).
291 <literal>refid</literal> <replaceable>id</replaceable>
294 <para>Sets reference ID for Z39.50 Request(s).
299 <literal>itemorder</literal>
300 <replaceable>type</replaceable> <replaceable>no</replaceable>
303 <para>Sends an Item Order Request using the ILL External.
304 <replaceable>type</replaceable> is either 1 or 2 which corresponds to
305 ILL-Profile 1 and 2 respectively. The <replaceable>no</replaceable>
306 is the Result Set position of the record to be ordered.
311 <literal>update</literal>
314 <para>Sends Item Update Request. This command sends a "minimal"
315 PDU Update to the target supplying the last received record from
317 If no record has been received from the target this command is ignored
318 and nothing is sent to the target.
325 <replaceable>filename</replaceable>
328 <para>Executes list of commands from
329 file <replaceable>filename</replaceable>, just like source on
337 <replaceable>args</replaceable>
340 <para>Executes command <replaceable>args</replaceable> in subshell
341 using the <literal>system</literal> call.
347 <literal>push_commande</literal>
348 <replaceable>command</replaceable>
351 <para>The push_command takes another command as its argument.
352 That command is then added to the history information (so
353 you can retrieve it later). The command itself is not
354 executed. This command only works if you have GNU readline/history
361 <literal>set_apdufile</literal>
362 <replaceable>filename</replaceable>
365 <para>Sets that APDU should be logged to file
366 <replaceable>filename</replaceable>. This command does the
367 thing as option <literal>-a</literal>.
373 <literal>set_marcdump</literal>
374 <replaceable>filename</replaceable>
377 <para>Specifies that all retrieved records should be appended ot
378 file <replaceable>filename</replaceable>. This command does the
379 thing as option <literal>-m</literal>.
385 <literal>schema</literal>
386 <replaceable>schemaid</replaceable>
389 <para>Specifies schema for retrieval.
390 Schema may be specified as an OID for Z39.50.
391 For SRW, schema is a simple string URI.
397 <literal>charset</literal>
398 <replaceable>negotiationcharset</replaceable>
399 [<replaceable>outputcharset</replaceable>]
402 <para>Specifies character set (encoding) for Z39.50
403 negotiation / SRW encoding and/or character set for output (terminal).
406 <replaceable>negotiationcharset</replaceable> is the name
407 of the character set to be negotiated by the server. The special name
408 <literal>-</literal> for <replaceable>negotiationcharset</replaceable>
409 specifies <emphasis>no</emphasis> character set to be negotiated.
412 If <replaceable>outputcharset</replaceable> is given, it specifies name
413 of the character set of the output (on the terminal on which
414 YAZ client is running). To disable conversion of characters
415 to the output encoding, the special name <literal>-</literal> (dash)
417 If the special name <literal>auto</literal> is given, YAZ client will
418 convert strings to the encoding of the
419 terminal as returned by <function>nl_langinfo</function> call.
423 Since character set negotation takes effect in the Z39.50
424 Initialize Request you should issue this command before
425 command <literal>open</literal> is used.
430 MARC records are not covered by Z39.50 character set negotiation.
431 See <literal>marccharset</literal>.
438 <literal>marccharset</literal>
439 <replaceable>charset</replaceable>
442 <para>Specifies character set for retrieved MARC records so
443 that YAZ client can display them in a character suitable
444 for your display. See <literal>charset</literal> command.
445 If <literal>auto</literal> is given, YAZ will assume
446 that MARC21/USMARC is using MARC8/UTF8 and ISO-8859-1
447 for all other MARC variants.
453 <literal>set_cclfields</literal>
454 <replaceable>filename</replaceable>
457 <para>Specifies that CCL fields should be read from file
458 file <replaceable>filename</replaceable>. This command does the
459 thing as option <literal>-c</literal>.
465 <literal>set_cqlfields</literal>
466 <replaceable>filename</replaceable>
469 <para>Specifies that CQL fields should be read from file
470 file <replaceable>filename</replaceable>. This command does the
471 thing as option <literal>-q</literal>.
477 <literal>register_oid</literal>
478 <replaceable>name</replaceable>
479 <replaceable>class</replaceable>
480 <replaceable>OID</replaceable>
483 <para>This command allows you to register your own object
484 identifier - so that instead of entering a long dot-notation
485 you can use a short name instead.
486 The <replaceable>name</replaceable> is your
487 name for the OID, <replaceable>class</replaceable> is the
488 class, and <replaceable>OID</replaceable> is the raw OID in
489 dot notation. Class is one <literal>appctx</literal>,
490 <literal>absyn</literal>, <literal>attet</literal>,
491 <literal>transyn</literal>, <literal>diagset</literal>,
492 <literal>recsyn</literal>, <literal>resform</literal>,
493 <literal>accform</literal>, <literal>extserv</literal>,
494 <literal>userinfo</literal>, <literal>elemspec</literal>,
495 <literal>varset</literal>, <literal>schema</literal>,
496 <literal>tagset</literal>, <literal>general</literal>.
497 If you're in doubt use the <literal>general</literal>
504 <!-- Keep this comment at the end of the file
509 sgml-minimize-attributes:nil
510 sgml-always-quote-attributes:t
513 sgml-parent-document: "yaz.xml"
514 sgml-local-catalogs: nil
515 sgml-namecase-general:t