From efda1a40ecc4cb16b0073a2b8a895ad28d5bfe4e Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Mon, 19 May 2003 20:45:07 +0000 Subject: [PATCH] charset/marccharset commands. SRW stuff --- doc/client.xml | 39 +++++++++++++--------- doc/yaz-client-commands.xml | 76 ++++++++++++++++++++++++++++++++++++++++--- doc/yaz-client.sgml | 10 +++--- doc/zoom.xml | 12 ++++--- 4 files changed, 108 insertions(+), 29 deletions(-) diff --git a/doc/client.xml b/doc/client.xml index 0760a4b..266bf16 100644 --- a/doc/client.xml +++ b/doc/client.xml @@ -1,9 +1,9 @@ - + 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 + 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. @@ -30,8 +30,10 @@ 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. + 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. @@ -112,26 +114,33 @@ 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 - + + 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 diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index aef3fc1..1494d01 100644 --- a/doc/yaz-client-commands.xml +++ b/doc/yaz-client-commands.xml @@ -1,5 +1,5 @@ @@ -16,8 +16,8 @@ Syntax: - [(tcp|ssl|unix)':']host - [:port][/base>] + [(tcp|ssl|unix|http)':']host + [:port][/base] @@ -25,7 +25,7 @@ quit - Ends YAZ client + Quits YAZ client @@ -358,6 +358,74 @@ + schema + schemaid + + + Specifies schema for retrieval. + Schema may be specified as an OID for Z39.50. + For SRW, schema is a simple string URI. + + + + + + charset + negotiationcharset + [outputcharset] + + + Specifies character set (encoding) for Z39.50 + negotiation / SRW encoding and/or character set for output (terminal). + + + negotiationcharset is the name + of the character set to be negotiated by the server. The special name + - for negotiationcharset + specifies no character set to be negotiated. + + + If outputcharset is given, it specifies name + of the character set of the output (on the terminal on which + YAZ client is running). To disable conversion of characters + to the output encoding, the special name - (dash) + can be used. + If the special name auto is given, YAZ client will + convert strings to the encoding of the + terminal as returned by nl_langinfo call. + + + + Since character set negotation takes effect in the Z39.50 + Initialize Request you should issue this command before + command open is used. + + + + + MARC records are not covered by Z39.50 character set negotiation. + See marccharset. + + + + + + + marccharset + charset + + + Specifies character set for retrieved MARC records so + that YAZ client can display them in a character suitable + for your display. See charset command. + If auto is given, YAZ will assume + that MARC21/USMARC is using MARC8/UTF8 and ISO-8859-1 + for all other MARC variants. + + + + + set_cclfields filename diff --git a/doc/yaz-client.sgml b/doc/yaz-client.sgml index fe1cfb5..d52cb30 100644 --- a/doc/yaz-client.sgml +++ b/doc/yaz-client.sgml @@ -1,7 +1,7 @@ ]> - + @@ -11,7 +11,7 @@ yaz-client - Z39.50 client for implementors + Z39.50/SRW client for implementors @@ -36,9 +36,9 @@ DESCRIPTION - yaz-client is a Z39.50 client (origin) with a + 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 servers (targets). + performance of Z39.50 targets and SRW servers. yaz-client-ssl is identical to @@ -46,7 +46,7 @@ If the addr is specified, the client creates - a connection to the Z39.50 target at the address. + a connection to the Z39.50/SRW target at the address. diff --git a/doc/zoom.xml b/doc/zoom.xml index 047ac7d..ff97c78 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -1,4 +1,4 @@ - + ZOOM &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is @@ -238,16 +238,18 @@ SRW Protocol behavior - The SRW protocol doesn't feature an Init Request, so + The SRW protocol doesn't feature an Inititialize Request, so the connection phase merely establishes a TCP/IP connection with the SOAP service. - None of the ZOOM connection options + Most of the ZOOM connection options do not affect SRW and they are ignored. However, future versions of &yaz; might honor implementationName and put that as part of User-Agent header for HTTP requests. - The charset, and lang - might also affect HTTP headers in future releases. + + + The charset is used in the Content-Type header + of HTTP requests. -- 1.7.10.4