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=9959754e00bd1f1ea322c5266ce6cb8253d99be6;hb=e8c3333a9418ef060e9ba1e34f069ea635a534da;hpb=23403c6f31b26b0e819a47980c42f3fc8c57d84d diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index 9959754..d519970 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -1,56 +1,86 @@ - - %common; - + + %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 + + + + 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. - - - If the addr is specified, the client creates - a connection to the Z39.50/SRW target at the address given. - + 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. + - 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. + 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. + + @@ -90,11 +120,21 @@ where DDD is 001, 002, 003, .. + + + -f cmdfile + + Reads commands from cmdfile. When + this option is used, YAZ client does not read .yazclientrc + from current directory or home directory. + + + -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). @@ -104,10 +144,13 @@ - -p addr + -p proxy-addr If specified, the client will use the proxy at the address - given. + 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. @@ -118,12 +161,34 @@ + -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 @@ -146,15 +211,47 @@ &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 - .yazclientrc + $HOME/.yazclientrc - $HOME/.yazclientrc + $HOME/.yazclient.history SEE ALSO @@ -163,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 +