X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-client-man.xml;h=6186110f636bcdfeb916e575763d518c3440ffe5;hb=df6700d5c88cff54c491ad2a1ae7d8426f92f044;hp=ba3b9bb3254120cd22f44c11ce8512a6849a6001;hpb=c6e47cbbff56f39f6d81b079ebaeac41d793d4d9;p=yaz-moved-to-github.git diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index ba3b9bb..6186110 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -1,7 +1,14 @@ - + + %local; + + %entities; + + %common; ]> - + @@ -17,20 +24,16 @@ yaz-client - + - + + + + - - - addr - - - - yaz-client-ssl - + addr @@ -43,37 +46,37 @@ performance of Z39.50 targets and SRW servers. - yaz-client-ssl is identical to - yaz-client except that it supports SSL transport. - - If the addr is specified, the client creates - a connection to the Z39.50/SRW target at the address. + a connection to the Z39.50/SRW target at the address given. - + + When yaz-client is invoked it attemps to read the + following files: + $HOME/.yazclientrc (home directory, Unix only) and + .yazclientrc (current directory - any platform) + For those files that are readable, the YAZ client executes commands + in those files. See COMMANDS section for description of commands. + + OPTIONS - -m filename - - If specified, retrieved MARC (ISO2709) records will - be appended to the file given. - - - -a filename If specified, logging of protocol packages will be appended - file given. The special filename - - (dash) denotes standard output. + file given. If filename is + specified as -, the output is written + to stdout. - -u auth + -b filename - If specified, the auth string - will be used for authentication. + 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. @@ -84,13 +87,27 @@ - -q filename + -d dump - If specified, CQL 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, .. + + + + -k size + + Sets preferred messages and maximum record size for Initialize + Request in kilobytes. Default value is 1024 (1 MB). + + + + -m filename + + If specified, retrieved records will be appended to the file given. - -p addr @@ -98,22 +115,33 @@ given. - - -k size + -q filename - Sets preferred messages and maximum record size for Initialize - Request in kilobytes. Default value is 1024 (1 MB). + If specified, CQL configuration will be read from + the file given. - - -x - - Makes the YAZ client print hex dumps of packages sent and received - on standard output. + -u auth + + If specified, the auth string + will be used for authentication. + + -V + + Prints YAZ version. + + + + -x + + Makes the YAZ client print hex dumps of packages sent and received + on standard output. + + @@ -127,6 +155,12 @@ yaz-<version>/client/client.c + + .yazclientrc + + + $HOME/.yazclientrc + SEE ALSO @@ -145,7 +179,7 @@ Section "Common Command Language" in the YAZ manual. - Section "Common QUery Language" in the YAZ manual. + Section "Common Query Language" in the YAZ manual.