X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fclient.xml;h=06f750726c101d7c1a55102761c05044a68cee8d;hb=5a0004a1d8cdf8258c8b823d9026939411d2238f;hp=d7d60e6b3ac08fa19e711eb05493d55105073c99;hpb=fe4182bf1ca7bebcb3172cde916d4467c2154e7b;p=yaz-moved-to-github.git diff --git a/doc/client.xml b/doc/client.xml index d7d60e6..06f7507 100644 --- a/doc/client.xml +++ b/doc/client.xml @@ -1,31 +1,42 @@ - - The YAZ client - Introduction + + The YAZ client + Introduction - yaz-client is a linemode Z39.50 client. It supports a fair amount - of the functionality of the Z39.50-1995 standard, but some things you - need to enable or disable by recompilation. - Its primary purpose is to exercise the - package, and verify that the protocol works OK. + yaz-client is a line-mode Z39.50/SRW client. It supports a fair amount + of the functionality of the Z39.50v3 standard. + Its primary purpose is to exercise the package, and verify that + the protocol works OK. For the same reason some commands offers more functionality than others. - Commands that exercies common Z39.50 services such as search and present + Commands that exercises common Z39.50 services such as search and present have more features than less common supported services, such as Extended Services (ItemOrder, ItemUpdate,..). - Invoking the YAZ client + Invoking the YAZ client It can be started by typing - - yaz-client [options] [zurl] - + + yaz-client + -m fname + -a fname + -c fname + -q fname + -v level + -p target + -u auth + -k size + zurl + + in a UNIX shell / WIN32 console. The zurl, - specifies a Z39.50 host and, if specified, the client first tries to - establish connection with the Z39.50 target on the host. - Options are, as usual, are prefixed by - followed - by a particular letter. + specifies a Z39.50/SRW host and, if specified, the client first tries to + establish connection with the Z39.50/SRW target. + + + Options are prefixed by - followed by a + particular letter. The following options are supported: @@ -34,10 +45,10 @@ -m fname - ISO2709 records are appended to file - fname. All records as returned by a target(s) - in Search Responses and Present Responses are appended verbatim to - the file. + All retrieved transfer records are appended to file + fname. All records as returned by a + target(s) in Search Responses and Present Responses are appended + verbatim to the file. @@ -58,40 +69,93 @@ + -q fname + + Sets the filename for CQL fields to + fname. If this option is not given the + YAZ client reads CQL fields from file + /usr/local/share/yaz/etc/pqf.properties. + + + -v level Sets the LOG level to level. - Level is a sequence of tokens separated by comman. Each token + Level is a sequence of tokens separated by comma. Each token is a integer or a named LOG item - one of fatal, debug, warn, log, + malloc, all, none. + + -p target + + Specifies proxy address. When set 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. + + + + -u auth + + Specifies authentication. Usually the form + user/password + is used. This option does the same thing as the + auth command. + + + + + -k size + + Specifies the maximum messages size in kilobytes. + The default maximum message size for the YAZ client is 1024 + (1 MB). + + + In order to connect to Index Data's test Z39.50 server on bagel.indexdata.dk, port 210 and with the - database name marc, one would have to type + database name marc, one could type + + yaz-client bagel.indexdata.dk:210/marc + + + + The same server is also a SOAP SRW service. Connect to it via HTTP + as follows: + + yaz-client http://bagel.indexdata.dk:210/marc + - - yaz-client bagel.indexdata.dk:210/marc - In order to enable APDU log and connect to localhost, port 210 (default) and database Default (default) you'd write: - + + yaz-client -a - localhost + + + + The following command connects to a local server via UNIX + socket /tmp/yaz and sets maximum message size to + 5 MB. - yaz-client -a - localhost - + yaz-client -k 5120 unix:/tmp/yaz + + - YAZ client commands + Commands When the YAZ client has read options and connected to a target, if given, - it will display Z > and away your command. + it will display Z> and await your command. Commands are executed by hitting the return key. You can always issue the command ? to see the list of available commands. @@ -100,299 +164,11 @@ The commands are (the letters in parenthesis are short names for the commands): - - - open zurl - - o - - Opens a connection to a server. The syntax for - zurl is the same as described - above for connecting from the command line. - - - Syntax: - - - [(tcp|osi)':'<[tsel/]]host[:port][/base>] - - - - - quit - - q - - Ends YAZ client - - - - f query - f - - Sends Search Request using the query - given. - - - - - delete setname - - Deletes result set with name setname - on the server. - - - - base base1 - base2 ... - - - 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 zurl. - - - - - show [start[+number]] - - s - - Fetches records by sending a Present Request from the start - position given by - start - a number of records given by number. If - start is not given the client will - fetch from position of the last retrieved record plus 1. If - number is not given one record will be - fetched at a time. - - - - - scan term - - - 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 - - - - - sort sortspecs - - - Sorts a result set. The sort command takes a sequence of - sort specifications. A sort - specification holds a field (sort criteria) and is followed by flags. - If the sort criteria includes = it is assumed - that the sort SortKey is of type sortAttributes using Bib-1. - The integer before = is - the attribute type and the integer following = - is the attribute value. - If no = is in the SortKey it is treated as a - sortfield-type of type InternationalString. - Flags observed are: s - for case sensitive, i for case insensitive, - < for sort ascending and > - for sort descending. - - - - - sort+ - - - Same as sort but stores the sorted - result set in a new result set. - - - - - authentication openauth - - - Sets up a 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. - - - - - lslb n - - - Sets the limit for when no records should be returned - together with the search result. - See the - - Z39.50 standard - - for more details. - - - - - ssub n - - - Sets the limit for when all records should be returned with - the search result. - See the - - Z39.50 standard - for more details. - - - - - - mspn n - - - Sets the number of records 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 - - for more details. - - - - - status - - - Displays the values of lslb, - ssub and mspn. - - - - - setname - - - Switches named result sets on and off. Default is on. - - - - - cancel - - - Sends a Trigger Resource Control Request to the target. - - - - - format oid - - - Sets the preferred transfer syntax for retrieved records. - yaz-client supports all the record syntaxes that currently - are registered. See - - Z39.50 Standard - - for more details. Commonly used records syntaxes include usmarc, - sutrs, grs1 and xml. - - - - - elements e - - - Sets the element set name for the records. Many targets support - element sets are B (for brief) and F (for full). - - - - - close - - - Sends a Z39.50 Close APDU and closes connection with the peer - - - - - querytype type - - - 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) or ccl2rpn for - CCL to RPN conversion (Type-1 Query). - - - - - attributeset set - - - - Sets attribute set OID for prefix queries (RPN, Type-1). - - - - - refid id - - - Sets reference ID for Z39.50 Request(s). - - - - - itemorder - type no - - - Sends an Item Order Request using the ILL External. - type is either 1 or 2 which correponds to - ILL-Profile 1 and 2 respectively. The no - is the Result Set position of the record to be ordered. - - - - - update - - - Sends Item Update Request. This command sends a "minimal" - PDU to the target supplying the last received record from the target. - If no record has been received from the target this command is ignored - and nothing is sent to the target. - - - - + &yaz-client-commands; + - Searching + Searching The simplest example of a Prefix Query would be something like @@ -422,7 +198,7 @@ f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather - For the full specifiction of the Prefix Query see the section + For the full specification of the Prefix Query see the section Prefix Query Format. @@ -438,7 +214,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: -->