From f4aa1406e883728944dc92421841c77d0ee9fcde Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Thu, 19 Sep 2002 21:06:50 +0000 Subject: [PATCH] Added man pages zebraidx(1), zebrasrv(8) --- debian/rules | 2 +- doc/Makefile.am | 16 ++++-- doc/zebra.xml.in | 3 +- doc/zebraidx-man.sgml | 109 +++++++++++++++++++++++++++++++++++++++ doc/zebraidx-options.xml | 128 ++++++++++++++++++++++++++++++++++++++++++++++ doc/zebraidx.xml | 112 +--------------------------------------- doc/zebrasrv-man.sgml | 84 ++++++++++++++++++++++++++++++ 7 files changed, 338 insertions(+), 116 deletions(-) create mode 100644 doc/zebraidx-man.sgml create mode 100644 doc/zebraidx-options.xml create mode 100644 doc/zebrasrv-man.sgml diff --git a/debian/rules b/debian/rules index 5a8ae97..1f548bd 100755 --- a/debian/rules +++ b/debian/rules @@ -102,7 +102,7 @@ binary-arch: build install dh_fixperms -a dh_installdeb -p idzebra - dh_undocumented -p idzebra zebraidx.1 zebrasrv.1 + dh_installman -p idzebra doc/zebraidx.1 doc/zebrasrv.8 dh_shlibdeps -p idzebra $(LOCAL_LINK) cat debian/postinst >> debian/idzebra/DEBIAN/postinst diff --git a/doc/Makefile.am b/doc/Makefile.am index b2cf38d..93b7d0b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,7 +1,8 @@ -## $Id: Makefile.am,v 1.12 2002-09-16 22:23:22 adam Exp $ +## $Id: Makefile.am,v 1.13 2002-09-19 21:06:50 adam Exp $ docdir=$(datadir)/doc/@PACKAGE@ doc_DATA = zebra.html zebra.pdf +man_MANS = zebraidx.1 zebrasrv.8 SUPPORTFILES = \ zebrahtml.dsl.in \ @@ -20,13 +21,20 @@ XMLFILES = \ recordmodel.xml \ license.xml \ indexdata.xml - -EXTRA_DIST = $(SUPPORTFILES) $(XMLFILES) zebra.pdf + +EXTRA_DIST = $(SUPPORTFILES) $(XMLFILES) zebra.pdf \ + $(man_MANS) zebraidx-man.sgml zebrasrv-man.sgml install-data-hook: for f in $(srcdir)/*.html; do \ $(INSTALL_DATA) $$f $(DESTDIR)$(docdir)/$$f; \ - done + done + +zebraidx.1: zebraidx-man.sgml zebraidx-options.xml + cd $(srcdir); docbook2man zebraidx-man.sgml + +zebrasrv.8: zebrasrv-man.sgml + cd $(srcdir); docbook2man zebrasrv-man.sgml zebra.html: $(XMLFILES) jade -E14 -d zebrahtml.dsl -t sgml xml.dcl zebra.xml diff --git a/doc/zebra.xml.in b/doc/zebra.xml.in index d08de6f..b9980d9 100644 --- a/doc/zebra.xml.in +++ b/doc/zebra.xml.in @@ -11,8 +11,9 @@ + ]> - + Zebra - User's Guide and Reference diff --git a/doc/zebraidx-man.sgml b/doc/zebraidx-man.sgml new file mode 100644 index 0000000..369b62c --- /dev/null +++ b/doc/zebraidx-man.sgml @@ -0,0 +1,109 @@ + +]> + + + + + zebraidx + 1 + + + + zebraidx + Zebra Administrative Tool + + + + + zebraidx + + + + + + + + + + + + + command + file + + + DESCRIPTION + + zebraidx allows you to insert, delete or updates + records in Zebra. zebraidx accepts a set options + (see below) and exactly one command (mandatory). + + + + COMMANDS + + + update file ... + + Reads records from locations given by file + and updates the register accordingly (to be in sync). + + + + delete file ... + + Reads records from locations given by file + and deletes the corresponding records in the register. + + + + commit + + Commit changes. Only allowed when shadow registers + are enabled. + + + + clean + + Clean shadow files and "forget" changes. + + + + + OPTIONS + &zebraidx-options; + + FILES + + zebra.cfg + + + SEE ALSO + + + zebrasrv + 8 + + + + Section "Administrating Zebra" in the Zebra manual. + + + + + diff --git a/doc/zebraidx-options.xml b/doc/zebraidx-options.xml new file mode 100644 index 0000000..11aab92 --- /dev/null +++ b/doc/zebraidx-options.xml @@ -0,0 +1,128 @@ + + + + + -t type + + + Update all files as type. Currently, the + types supported are text and + grs.subtype. + If no subtype is provided for the GRS + (General Record Structure) type, the canonical input format + is assumed (see ). + Generally, it is probably advisable to specify the record types + in the zebra.cfg file (see + ), to avoid confusion at + subsequent updates. + + + + + -c config-file + + + Read the configuration file + config-file instead of + zebra.cfg. + + + + + -g group + + + Update the files according to the group + settings for group + (see ). + + + + + -d database + + + The records located should be associated with the database name + database for access through the Z39.50 server. + + + + + + -l file + + + Write log messages to file instead + of stderr. + + + + + + -m mbytes + + + Use mbytes of memory before flushing + keys to background storage. This setting affects performance when + updating large databases. + + + + + -n + + + Disable the use of shadow registers for this operation + (see ). + + + + + -s + + + Show analysis of the indexing process. The maintenance + program works in a read-only mode and doesn't change the state + of the index. This options is very useful when you wish to test a + new profile. + + + + + -V + + + Show Zebra version. + + + + + -v level + + + Set the log level to level. + level should be one of + none, debug, and + all. + + + + + diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml index c399dd9..9cad1f5 100644 --- a/doc/zebraidx.xml +++ b/doc/zebraidx.xml @@ -1,5 +1,5 @@ - + Running the Maintenance Interface (zebraidx) @@ -15,115 +15,7 @@ Options: - - - - -t type - - - Update all files as type. Currently, the - types supported are text and - grs.subtype. - If no subtype is provided for the GRS - (General Record Structure) type, the canonical input format - is assumed (see ). - Generally, it is probably advisable to specify the record types - in the zebra.cfg file (see - ), to avoid confusion at - subsequent updates. - - - - - -c config-file - - - Read the configuration file - config-file instead of - zebra.cfg. - - - - - -g group - - - Update the files according to the group - settings for group - (see ). - - - - - -d database - - - The records located should be associated with the database name - database for access through the Z39.50 server. - - - - - - -l file - - - Write log messages to file instead - of stderr. - - - - - - -m mbytes - - - Use mbytes of memory before flushing - keys to background storage. This setting affects performance when - updating large databases. - - - - - -n - - - Disable the use of shadow registers for this operation - (see ). - - - - - -s - - - Show analysis of the indexing process. The maintenance - program works in a read-only mode and doesn't change the state - of the index. This options is very useful when you wish to test a - new profile. - - - - - -V - - - Show Zebra version. - - - - - -v level - - - Set the log level to level. - level should be one of - none, debug, and - all. - - - - + &zebraidx-options; diff --git a/doc/zebrasrv-man.sgml b/doc/zebrasrv-man.sgml new file mode 100644 index 0000000..e0ee72b --- /dev/null +++ b/doc/zebrasrv-man.sgml @@ -0,0 +1,84 @@ + + + + + + zebrasrv + 8 + + + + zebrasrv + Zebra Server + + + + + zebrasrv + + + + + + + + + + + listener-spec + + + DESCRIPTION + + zebrasrv is a Z39.50 server for Zebra. + On Unix you can run the server from the command line - and put it + in the background. It may also operate under the inet daemon. + On WIN32 you can run the server as a console application or + as a WIN32 Service. + + + + OPTIONS + + The options for zebrasrv are the same + as those for YAZ' yaz-ztest. + Option -c specifies a Zebra configuration + file - if omitted zebra.cfg is read. + + + FILES + + zebra.cfg + + + SEE ALSO + + + zebraidx + 1 + , + + yaz-ztest + 8 + + + + Section "The Z39.50 Server" in the Zebra manual. + + + + + -- 1.7.10.4