From e44e073beb75899cf954c94667b412f86009ef16 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 21 Nov 2007 09:04:46 +0000 Subject: [PATCH] Man pages in Reference section. All man pages are combined in one Reference section, manref.xml, which is extracted via XSLT from each individual man page. --- doc/.cvsignore | 1 + doc/Makefile.am | 12 ++- doc/client.xml | 220 ------------------------------------------- doc/entities.ent | 4 +- doc/installation.xml | 6 +- doc/introduction.xml | 4 +- doc/yaz-client-commands.xml | 4 +- doc/yaz-client-man.xml | 67 ++++++++++--- doc/yaz-icu-man.xml | 4 +- doc/yaz-ztest-man.xml | 12 +-- doc/yaz.xml | 14 ++- 11 files changed, 87 insertions(+), 261 deletions(-) delete mode 100644 doc/client.xml diff --git a/doc/.cvsignore b/doc/.cvsignore index 944ada6..f80be9c 100644 --- a/doc/.cvsignore +++ b/doc/.cvsignore @@ -16,3 +16,4 @@ local.ent htmlhelp.hhp toc.hhc std-oid-table.xml +manref.xml diff --git a/doc/Makefile.am b/doc/Makefile.am index 6b54e5b..aa6fb8e 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,13 +1,13 @@ -## $Id: Makefile.am,v 1.84 2007-11-12 11:13:05 adam Exp $ +## $Id: Makefile.am,v 1.85 2007-11-21 09:04:46 adam Exp $ SUBDIRS = common XMLFILES=bookinfo.xml introduction.xml installation.xml \ indexdata.xml \ asn.xml tools.xml odr.xml comstack.xml frontend.xml license.xml \ - future.xml client.xml ziffy.xml zoom.xml credits.xml gfs-options.xml \ + future.xml ziffy.xml zoom.xml credits.xml gfs-options.xml \ yaz.xml yaz-client-commands.xml soap.xml gfs-virtual.xml gfs-synopsis.xml \ - std-oid-table.xml + std-oid-table.xml manref.xml HTMLFILES = index.html @@ -84,6 +84,12 @@ yazj.pdf: pdfjadetex yazj.tex >/dev/null pdfjadetex yazj.tex >/dev/null +manref.xml: $(REFFILES) $(srcdir)/common/stripref.xsl + rm -f manref.xml + for i in $(REFFILES); do \ + xsltproc $(srcdir)/common/stripref.xsl $(srcdir)/$$i | sed 1d >>manref.xml; \ + done + apilayer.png: tgif -print -xbm apilayer.obj xbmtopbm apilayer.png diff --git a/doc/client.xml b/doc/client.xml deleted file mode 100644 index d874fe1..0000000 --- a/doc/client.xml +++ /dev/null @@ -1,220 +0,0 @@ - - The YAZ client - Introduction - - yaz-client is a line-mode Z39.50/SRU 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. - Commands that exercises common Z39.50 services such as search and present - have more features than less common supported services, such as Extended - Services (ItemOrder, ItemUpdate,..). - - - Invoking the YAZ client - - It can be started by typing - - - yaz-client - -m fname - -a fname - -c fname - -q fname - -v level - -p target - -u auth - -k size - zurl - - - - in a UNIX shell / WIN32 console. The zurl, - specifies a Z39.50/SRU host and, if specified, the client first tries to - establish connection with the Z39.50/SRU target. - - - Options are prefixed by - followed by a - particular letter. - - - The following options are supported: - - - - -m fname - - 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. - - - - -a fname - - Pretty-print log of APDUs sent and received is appended - to the file fname. - If fname is - (minus) - the APDU log is written to stderr. - - - - -c fname - - Sets the filename for CCL fields to - fname. If this option is not given the - YAZ client reads CCL fields from file default.bib. - - - - -q fname - - Sets the filename for CQL fields to - fname. If this option is not given the - YAZ client reads CQL fields from file - /usr/local/share/yaz/etc/pqf.properties. - - - - -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. - - - - -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 specified as part of the InitRequest - to inform the proxy about actual target. - - - - -u auth - - Specifies authentication. Usually the form - user/password - is used. This option does the same thing as the - auth command. - - - - - -k size - - Specifies the maximum messages size in kilobytes. - The default maximum message size for the YAZ client is 1024 - (1 MB). - - - - - - 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 could type - - yaz-client bagel.indexdata.dk:210/marc - - - - The same server is also a SRU service. Connect to it via HTTP - as follows: - - yaz-client http://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 - - - - 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 - - When the YAZ client has read options and connected to a target, if given, - it will display Z> and await your command. - Commands are executed by hitting the return key. - You can always issue the command ? to see the list - of available commands. - - - The commands are (the letters in parenthesis are short - names for the commands): - - - &yaz-client-commands; - - - Searching - - 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 - - For the full specification of the Prefix Query see the section - Prefix Query Format. - - - - - diff --git a/doc/entities.ent b/doc/entities.ent index b57035d..8cc700f 100644 --- a/doc/entities.ent +++ b/doc/entities.ent @@ -1,10 +1,9 @@ - + - @@ -21,6 +20,7 @@ + ODR"> COMSTACK"> diff --git a/doc/installation.xml b/doc/installation.xml index 4fecb5f..35b0a4f 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Compilation and Installation Introduction @@ -287,7 +287,7 @@ client/yaz-client Z39.50 client for testing the protocol. - See chapter + See chapter YAZ client for more information. @@ -627,7 +627,7 @@ bin/yaz-client.exe &yaz; Z39.50 client application. It's a WIN32 console application. - See chapter YAZ client for more + See chapter YAZ client for more information. diff --git a/doc/introduction.xml b/doc/introduction.xml index 90ff777..8f8ce2d 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -97,7 +97,7 @@ - describes how to use the &yaz; Z39.50 + describes how to use the &yaz; Z39.50 client. If you're developer and wish to test your server or a server from another party, you might find this chapter useful. diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index 64a25f0..52a2bd8 100644 --- a/doc/yaz-client-commands.xml +++ b/doc/yaz-client-commands.xml @@ -1,5 +1,5 @@ @@ -33,7 +33,7 @@ Sends a Search Request using the query given. By default the query is assumed to be PQF. See command - querytype. + querytype for more information. diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index 1114339..42eb323 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -8,7 +8,7 @@ %idcommon; ]> - + YAZ @@ -38,6 +38,7 @@ + addr @@ -137,7 +138,10 @@ -p 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. @@ -154,6 +158,21 @@ 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 @@ -176,6 +195,38 @@ &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 @@ -194,18 +245,6 @@ 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. - diff --git a/doc/yaz-icu-man.xml b/doc/yaz-icu-man.xml index 369ca15..033defa 100644 --- a/doc/yaz-icu-man.xml +++ b/doc/yaz-icu-man.xml @@ -8,8 +8,8 @@ %idcommon; ]> - - + + YAZ &version; diff --git a/doc/yaz-ztest-man.xml b/doc/yaz-ztest-man.xml index d0317bd..a0fde75 100644 --- a/doc/yaz-ztest-man.xml +++ b/doc/yaz-ztest-man.xml @@ -11,7 +11,7 @@ ]> - + YAZ @@ -70,16 +70,6 @@ yaz-<version>/include/yaz/backend.h - Retrieval Facility - - Refer to the "Retrieval Facility" in the YAZ manual - - - CQL to RPN conversions - - Refer to the "Specification of CQL to RPN mappings" in YAZ manual. - - SEE ALSO diff --git a/doc/yaz.xml b/doc/yaz.xml index 81a0f04..d81bef7 100644 --- a/doc/yaz.xml +++ b/doc/yaz.xml @@ -1,5 +1,5 @@ - + + Reference + + + The material in this chapter is drawn directly from the individual + manual entries. + + + &manref; + + List of Object Identifiers These is a list of object identifiers that are built into YAZ. -- 1.7.10.4