X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-client-man.xml;h=d519970cd4fd284ba6fbb3d2f25da3be7cfdc4f8;hp=ba3b9bb3254120cd22f44c11ce8512a6849a6001;hb=e8c3333a9418ef060e9ba1e34f069ea635a534da;hpb=c6e47cbbff56f39f6d81b079ebaeac41d793d4d9 diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index ba3b9bb..d519970 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -1,79 +1,107 @@ - + + %local; + + %entities; + + %idcommon; ]> - + + YAZ + &version; + Index Data + yaz-client 1 + Commands yaz-client - Z39.50/SRW client for implementors + Z39.50/SRU client for implementors yaz-client - - - - - - + + + + + + + + + + + + - addr - - - - yaz-client-ssl - - addr + server-addr - DESCRIPTION - - yaz-client is a Z39.50/SRW client (origin) with a - simple command line interface that allows you to test behavior and - 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. - - + DESCRIPTION + + yaz-client is a + Z39.50/SRU + client (origin) with a simple command line interface that allows + you to test behavior and performance of Z39.50 targets and SRU servers. + + + From YAZ version 4.1.0 yaz-client may also operate as a + SOLR Web Service + client. + + + If the server-addr is specified, the client creates + a connection to the Z39.50/SRU target at the address given. + + + When yaz-client is started it tries to read + commands from one of the following files: + + + Command file if it is given by option -f. + + + .yazclientrc in current working directory. + + + .yazclientrc in the user's home directory. + The value of the HOME is used to determine + the home directory. Normally, HOME is only set + on POSIX systems such as Linux, FreeBSD, Solaris. + + + + 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,18 +112,21 @@ - -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, .. - -p addr + -f cmdfile - If specified, the client will use the proxy at the address - given. + Reads commands from cmdfile. When + this option is used, YAZ client does not read .yazclientrc + from current directory or home directory. @@ -103,17 +134,74 @@ -k size Sets preferred messages and maximum record size for Initialize - Request in kilobytes. Default value is 1024 (1 MB). + Request in kilobytes. Default value is 65536 (64 MB). - - -x - - Makes the YAZ client print hex dumps of packages sent and received - on standard output. + -m filename + + If specified, retrieved records will be appended to the file given. + + -p proxy-addr + + 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 actual target. + + + + -q filename + + If specified, CQL configuration will be read from + the file given. + + + + -t displaycharset + + If displaycharset is given, it specifies name of the character set of the + output (on the terminal on which YAZ client is running). + + + + -u auth + + If specified, the auth string + will be used for authentication. + + + + -v level + + Sets the LOG level to level. + 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. + + + + -V + + Prints YAZ version. + + + + -x + + Makes the YAZ client print hex dumps of packages sent and received + on standard output. + + @@ -123,10 +211,48 @@ &yaz-client-commands; + EXAMPLE + + The simplest example of a Prefix Query would be something like + + f knuth + + or + + f "donald knuth" + + In those queries no attributes was specified. + This leaves it up to the server what fields to search but + most servers will search in all fields. Some servers does not + support this feature though, and require that some attributes + are defined. To add one attribute you could do: + + f @attr 1=4 computer + + where we search in the title field, since the use(1) is title(4). + If we want to search in the author field and + in the title field, and in the title field using right truncation + it could look something like this: + + f @and @attr 1=1003 knuth @attr 1=4 @attr 5=1 computer + + Finally using a mix of Bib-1 and GILS attributes could look + something like this: + + f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather + + + FILES yaz-<version>/client/client.c + + $HOME/.yazclientrc + + + $HOME/.yazclient.history + SEE ALSO @@ -134,18 +260,10 @@ yaz 7 - - - Section "The YAZ Client" in the YAZ manual. - - - Section "Prefix Query Format" in the YAZ manual. - - - Section "Common Command Language" in the YAZ manual. - - - Section "Common QUery Language" in the YAZ manual. + + bib1-attr + 7 +