2 $Id: yaz-client-commands.xml,v 1.3 2003-05-19 20:45:07 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
94 <varlistentry id="sortspec"><term>
95 <literal>sort</literal> <replaceable>sortspecs</replaceable>
98 <para>Sorts a result set. The sort command takes a
99 sequence of sort specifications. A sort
100 specification holds a field (sort criteria) and is followed by flags.
101 If the sort criteria includes <literal>=</literal> it is assumed
102 that the sort SortKey is of type sortAttributes using Bib-1.
103 The integer before <literal>=</literal> is
104 the attribute type and the integer following <literal>=</literal>
105 is the attribute value.
106 If no <literal>=</literal> is in the SortKey it is treated as a
107 sortfield-type of type InternationalString.
108 Flags observed are: <literal>s</literal>
109 for case sensitive, <literal>i</literal> for case insensitive,
110 <literal><</literal> for sort ascending and <literal>></literal>
116 <literal>sort+</literal>
119 <para>Same as <literal>sort</literal> but stores the sorted
120 result set in a new result set.
125 <literal>authentication</literal> <replaceable>openauth</replaceable>
128 <para>Sets up a authentication string if a server requires
129 authentication (v2 OpenStyle). The authentication string is first
130 sent to the server when the <literal>open</literal> command is
131 issued and the Z39.50 Initialize Request is sent, so this command
132 must be used before <literal>open</literal> in order to be effective.
133 A common convention for the <replaceable>authopen</replaceable> string
134 is that the username - and password is separated by a slash, e.g.
135 <literal>myusername/mysecret</literal>.
140 <literal>lslb</literal> <replaceable>n</replaceable>
143 <para>Sets the limit for when no records should be returned
144 together with the search result.
147 url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
156 <literal>ssub</literal> <replaceable>n</replaceable>
159 <para>Sets the limit for when all records should be returned with
163 url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
165 </ulink> for more details.
171 <literal>mspn</literal> <replaceable>n</replaceable>
174 <para>Sets the number of records should be returned if the
175 number of records in the result set is between the values of
176 <literal>lslb</literal> and <literal>ssub</literal>.
179 url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
187 <literal>status</literal>
190 <para>Displays the values of <literal>lslb</literal>,
191 <literal>ssub</literal> and <literal>mspn</literal>.
196 <literal>setname</literal>
199 <para>Switches named result sets on and off. Default is on.
204 <literal>cancel</literal>
207 <para>Sends a Trigger Resource Control Request to the target.
212 <literal>format</literal> <replaceable>oid</replaceable>
215 <para>Sets the preferred transfer syntax for retrieved records.
216 yaz-client supports all the record syntaxes that currently
219 url="http://lcweb.loc.gov/z3950/agency/defns/oids.html#5">
222 for more details. Commonly used records syntaxes include usmarc,
228 <literal>elements</literal> <replaceable>e</replaceable>
231 <para>Sets the element set name for the records. Many targets support
232 element sets are B (for brief) and F (for full).
237 <literal>close</literal>
240 <para>Sends a Z39.50 Close APDU and closes connection with the peer
245 <literal>querytype</literal> <replaceable>type</replaceable>
248 <para>Sets the query type as used by command <literal>find</literal>.
249 The following is supported: <literal>prefix</literal> for
250 <link linkend="PQF">Prefix Query Notation</link> (Type-1 Query);
251 <literal>ccl</literal> for CCL search (Type-2
252 Query), <literal>cql</literal> for CQL or <literal>ccl2rpn</literal> for
253 <link linkend="CCL">CCL</link> to RPN conversion (Type-1 Query).
258 <literal>attributeset</literal> <replaceable>set</replaceable>
262 Sets attribute set OID for prefix queries (RPN, Type-1).
267 <literal>refid</literal> <replaceable>id</replaceable>
270 <para>Sets reference ID for Z39.50 Request(s).
275 <literal>itemorder</literal>
276 <replaceable>type</replaceable> <replaceable>no</replaceable>
279 <para>Sends an Item Order Request using the ILL External.
280 <replaceable>type</replaceable> is either 1 or 2 which corresponds to
281 ILL-Profile 1 and 2 respectively. The <replaceable>no</replaceable>
282 is the Result Set position of the record to be ordered.
287 <literal>update</literal>
290 <para>Sends Item Update Request. This command sends a "minimal"
291 PDU Update to the target supplying the last received record from
293 If no record has been received from the target this command is ignored
294 and nothing is sent to the target.
301 <replaceable>filename</replaceable>
304 <para>Executes list of commands from
305 file <replaceable>filename</replaceable>, just like source on
313 <replaceable>args</replaceable>
316 <para>Executes command <replaceable>args</replaceable> in subshell
317 using the <literal>system</literal> call.
323 <literal>push_commande</literal>
324 <replaceable>command</replaceable>
327 <para>The push_command takes another command as its argument.
328 That command is then added to the history information (so
329 you can retrieve it later). The command itself is not
330 executed. This command only works if you have GNU readline/history
337 <literal>set_apdufile</literal>
338 <replaceable>filename</replaceable>
341 <para>Sets that APDU should be logged to file
342 <replaceable>filename</replaceable>. This command does the
343 thing as option <literal>-a</literal>.
349 <literal>set_marcdump</literal>
350 <replaceable>filename</replaceable>
353 <para>Specifies that all retrieved records should be appended ot
354 file <replaceable>filename</replaceable>. This command does the
355 thing as option <literal>-m</literal>.
361 <literal>schema</literal>
362 <replaceable>schemaid</replaceable>
365 <para>Specifies schema for retrieval.
366 Schema may be specified as an OID for Z39.50.
367 For SRW, schema is a simple string URI.
373 <literal>charset</literal>
374 <replaceable>negotiationcharset</replaceable>
375 [<replaceable>outputcharset</replaceable>]
378 <para>Specifies character set (encoding) for Z39.50
379 negotiation / SRW encoding and/or character set for output (terminal).
382 <replaceable>negotiationcharset</replaceable> is the name
383 of the character set to be negotiated by the server. The special name
384 <literal>-</literal> for <replaceable>negotiationcharset</replaceable>
385 specifies <emphasis>no</emphasis> character set to be negotiated.
388 If <replaceable>outputcharset</replaceable> is given, it specifies name
389 of the character set of the output (on the terminal on which
390 YAZ client is running). To disable conversion of characters
391 to the output encoding, the special name <literal>-</literal> (dash)
393 If the special name <literal>auto</literal> is given, YAZ client will
394 convert strings to the encoding of the
395 terminal as returned by <function>nl_langinfo</function> call.
399 Since character set negotation takes effect in the Z39.50
400 Initialize Request you should issue this command before
401 command <literal>open</literal> is used.
406 MARC records are not covered by Z39.50 character set negotiation.
407 See <literal>marccharset</literal>.
414 <literal>marccharset</literal>
415 <replaceable>charset</replaceable>
418 <para>Specifies character set for retrieved MARC records so
419 that YAZ client can display them in a character suitable
420 for your display. See <literal>charset</literal> command.
421 If <literal>auto</literal> is given, YAZ will assume
422 that MARC21/USMARC is using MARC8/UTF8 and ISO-8859-1
423 for all other MARC variants.
429 <literal>set_cclfields</literal>
430 <replaceable>filename</replaceable>
433 <para>Specifies that CCL fields should be read from file
434 file <replaceable>filename</replaceable>. This command does the
435 thing as option <literal>-c</literal>.
441 <literal>register_oid</literal>
442 <replaceable>name</replaceable>
443 <replaceable>class</replaceable>
444 <replaceable>OID</replaceable>
447 <para>This command allows you to register your own object
448 identifier - so that instead of entering a long dot-notation
449 you can use a short name instead.
450 The <replaceable>name</replaceable> is your
451 name for the OID, <replaceable>class</replaceable> is the
452 class, and <replaceable>OID</replaceable> is the raw OID in
453 dot notation. Class is one <literal>appctx</literal>,
454 <literal>absyn</literal>, <literal>attet</literal>,
455 <literal>transyn</literal>, <literal>diagset</literal>,
456 <literal>recsyn</literal>, <literal>resform</literal>,
457 <literal>accform</literal>, <literal>extserv</literal>,
458 <literal>userinfo</literal>, <literal>elemspec</literal>,
459 <literal>varset</literal>, <literal>schema</literal>,
460 <literal>tagset</literal>, <literal>general</literal>.
461 If you're in doubt use the <literal>general</literal>
468 <!-- Keep this comment at the end of the file
473 sgml-minimize-attributes:nil
474 sgml-always-quote-attributes:t
477 sgml-parent-document: "yaz.xml"
478 sgml-local-catalogs: nil
479 sgml-namecase-general:t