X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fclient.xml;h=48c699df52d0e8a528849b47dcae33f186d132ae;hb=590c754f58a6fa4ca0f9050e470642eecd261031;hp=dede72e3112398179cc7bee6f74a766aa882308e;hpb=f347eed7eaf5fc499d7a56d20084184ebce4aa9e;p=yaz-moved-to-github.git diff --git a/doc/client.xml b/doc/client.xml index dede72e..48c699d 100644 --- a/doc/client.xml +++ b/doc/client.xml @@ -1,12 +1,11 @@ - + The YAZ client Introduction yaz-client is a line-mode 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 re-compilation. - Its primary purpose is to exercise the - package, and verify that the protocol works OK. + of the functionality of the Z39.50-1995 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 exercises common Z39.50 services such as search and present have more features than less common supported services, such as Extended @@ -17,15 +16,24 @@ It can be started by typing - - yaz-client [options] [zurl] - + + yaz-client + -m fname + -a fname + -c 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. + Options are prefixed by - followed by a + particular letter. The following options are supported: @@ -34,10 +42,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. @@ -67,23 +75,22 @@ 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 specifed as part of the InitRequest + The actual target will be specified as part of the InitRequest to inform the proxy about actual target. - - -u authentication + -u auth Specifies authentication. Usually the form user/password @@ -92,6 +99,15 @@ + + -k size + + Specifies the maximum messages size in kilobytes. + The default maximum messages for the YAZ client is 1024 + (1 MB). + + + In order to connect to Index Data's test Z39.50 server on @@ -108,6 +124,14 @@ 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 -k 5120 unix:/tmp/yaz + Commands @@ -125,7 +149,6 @@ open zurl - o Opens a connection to a server. The syntax for zurl is the same as described @@ -135,15 +158,14 @@ Syntax: - [(tcp|ssl)':']host - [:port][/base>] + [(tcp|ssl|unix)':']host + [:port][/base>] quit - q Ends YAZ client @@ -424,7 +446,7 @@ Executes list of commands from file filename, just like source on - some UNIX shells. + most UNIX shells. @@ -440,6 +462,83 @@ + + push_commande + command + + + 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. + + + + + + set_apdufile + filename + + + Sets that APDU should be logged to file + filename. This command does the + thing as option -a. + + + + + + set_marcdump + filename + + + Specifies that all retrieved records should be appended ot + file filename. This command does the + thing as option -m. + + + + + + set_cclfields + filename + + + Specifies that CCL fields should be read from file + file filename. This command does the + thing as option -c. + + + + + + register_oid + name + class + OID + + + 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 appctx, + absyn, attet, + transyn, diagset, + recsyn, resform, + accform, extserv, + userinfo, elemspec, + varset, schema, + tagset, general. + If you're in doubt use the general + class. + + + + Searching