If specified, logging of protocol packages will be appended to the file given. If filename is specified as -, the output is written to stdout.

If specified, YAZ will dump BER data in readable notation to the file specified. If filename is specified as - the output is written to stdout.

If specified, CCL configuration will be read from the file given.

If specified, YAZ will dump BER data for all PDUs sent and received to individual files, named dump.DDD.raw, where DDD is 001, 002, 003, ...

Reads commands from cmdfile. When this option is used, YAZ client does not read .yazclientrc from current directory or home directory.

Sets preferred messages and maximum record size for Initialize Request in kilobytes. Default value is 65536 (64 MB).

If specified, retrieved records will be appended to the file given.

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 the actual target.

If specified, CQL configuration will be read from the file given.

If displaycharset is given, it specifies name of the character set of the output (on the terminal on which YAZ client is running).

If specified, the auth string will be used for authentication.

Prints YAZ version.

Makes the YAZ client print hex dumps of packages sent and received on standard output.

Opens a connection to a server. The syntax for zurl is the same as described above for connecting from the command line.

Syntax:

[(tcp|ssl|unix|http)':']host [:port][/base]

Quits YAZ client

Sends a Search Request using the query given. By default the query is assumed to be PQF. See command querytype for more information.

Deletes result set with name setname on the server.

Sets the name(s) of the database(s) to search. One or more databases may be specified, separated by blanks. This command overrides the database given in zurl.

Fetches records by sending a Present Request from the start position given by start and a number of records given by number, from the result set resultset. If start is not given, then the client will fetch from the position of the last retrieved record plus 1. If number is not given, then one record will be fetched at a time. If resultset is not given, the most recently retrieved result set is used.

Scans database index for a term. The syntax resembles the syntax for find. If you want to scan for the word water you could write

      scan water
     

but if you want to scan only in, say the title field, you would write

      scan @attr 1=4 water
     

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 = it is assumed that the SortKey is of type sortAttributes using Bib-1: in this case the integer before = is the attribute type and the integer following = is the attribute value. If no = character is in the criterion, it is treated as a sortfield of type InternationalString. The flags word of each sort specification must consist of s for case sensitive or i for case insensitive, and < for ascending order or > for descending order.

Example using sort criterion with attributes use=local-number and structure=numeric and ascending flag: 1=12,4=109 <

Another example with "Title" sort field and descending flag: Title >

Same as sort but stores the sorted result set in a new result set.

Sets up an authentication string if a server requires authentication (v2 OpenStyle). The authentication string is first sent to the server when the open command is issued and the Z39.50 Initialize Request is sent, so this command must be used before open in order to be effective. A common convention for the authopen string is that the username - and password is separated by a slash, e.g. myusername/mysecret.

Selects Web Service method and version. Must be one of post, get, soap (default) or solr. 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

This command displays status and values for many settings.

Sets the limit for when no records should be returned together with the search result. See the Z39.50 standard on set bounds for more details.

Sets the limit for when all records should be returned with the search result. See the Z39.50 standard on set bounds for more details.

Sets the number of records that should be returned if the number of records in the result set is between the values of lslb and ssub. See the Z39.50 standard on set bounds for more details.

Displays the values of lslb, ssub and mspn.

Switches named result sets on and off. Default is on.

Sends a Trigger Resource Control Request to the target.

Specifies requested facets to be used in search. The notation is specified in Section 8, “Facets”.

Sets the preferred transfer syntax for retrieved records. yaz-client supports all the record syntaxes that currently are registered. See Z39.50 Record Syntax Identifiers for more details. Commonly used records syntaxes include usmarc, sutrs and xml.

Sets the element set name for the records. Many targets support element sets B (for brief) and F (for full).

Sends a Z39.50 Close APDU and closes connection with the peer

Sets the query type as used by command find. The following is supported: prefix for Prefix Query Notation (Type-1 Query); ccl for CCL search (Type-2 Query), cql for CQL (Type-104 search with CQL OID), ccl2rpn for CCL to RPN conversion (Type-1 Query), cql2rpn for CQL to RPN conversion (Type-1 Query).

Sets attribute set OID for prefix queries (RPN, Type-1).

Sets reference ID for Z39.50 Request(s).

Sends an Item Order Request using the ILL External. type is either 1 or 2 which corresponds to ILL-Profile 1 and 2 respectively. The no is the Result Set position of the record to be ordered.

Sends Item Update Request. The action argument must be the action type: one of insert, replace, delete and update. The second argument, recid, 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 quoted 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.

Executes list of commands from file filename, just like 'source' on most UNIX shells. A single dot (.) can be used as an alternative.

Executes command args in subshell using the system call.

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.

Sets that APDU should be logged to file filename. Another way to achieve APDU log is by using command-line option -a.

Specifies whether YAZ client automatically reconnects if the target closes connection (Z39.50 only).

flag must be either on or off.

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 off is used, YAZ client does not attempt to receive packages automatically. These will have to be manually received when command wait_response is used.

flag must be either on or off.

Specifies that all retrieved records should be appended to file filename. This command does the same thing as option -m.

Specifies schema for retrieval. Schema may be specified as an OID for Z39.50. For SRU, schema is a simple string URI.

Specifies character set (encoding) for Z39.50 negotiation / SRU encoding and/or character set for output (terminal).

negotiationcharset is the name of the character set to be negotiated by the server. The special name - for negotiationcharset specifies no character set to be negotiated.

If displaycharset 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 - (dash) can be used. If the special name auto is given, YAZ client will convert strings to the encoding of the terminal as returned by nl_langinfo call.

If marccharset is given, it specifies name of the character set of retrieved MARC records from server. See also marccharset command.

Specifies character set for negotiation (Z39.50). The argument is the same as second argument for command charset.

Specifies character set for output (display). The argument is the same as second argument for command charset.

Specifies character set for retrieved MARC records so that YAZ client can display them in a character suitable for your display. See charset command. If auto 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 charset.

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.

Specifies that CCL fields should be read from file file filename. This command does the same thing as option -c.

Specifies that CQL fields should be read from file file filename. This command does the same thing as option -q.

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 name is your name for the OID, class is the class, and OID is the raw OID in dot notation. Class is one of: appctx, absyn, attet, transyn, diagset, recsyn, resform, accform, extserv, userinfo, elemspec, varset, schema, tagset, general. If you're in doubt use the general class.

This command registers a TAB completion string for the command given.

This command makes YAZ client sleep (be idle) for the number of seconds given.

This command makes YAZ client wait for a number of response packages from target. If number is omitted, 1 is assumed.

This command is rarely used and is only useful if command set_auto_wait is set to off.

Sends XML Extended Services request using the OID and doc given.

This command sets Z39.50 version for negotiation. Should be used before open. By default 3 (version 3) is used.

This command sets Z39.50 options for negotiation. Should be used before open.

The following options are supported: search, present, delSet, resourceReport, triggerResourceCtrl, resourceCtrl, accessCtrl, scan, sort, extendedServices, level_1Segmentation, level_2Segmentation, concurrentOperations, namedResultSets, encapsulation, resultCount, negotiationModel, duplicationDetection, queryType104, pQESCorrection, stringSchema.