From 248747ef40e38e5f4801d5403ee055f7f0156733 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Fri, 5 Sep 2003 10:50:33 +0000 Subject: [PATCH] Separate zebraidx-commands document. Mention create&drop zebraidx commands --- doc/Makefile.am | 8 ++-- doc/zebra.xml.in | 3 +- doc/zebraidx-commands.xml | 71 ++++++++++++++++++++++++++++++++ doc/zebraidx-man.sgml | 98 +++++++++++++++++---------------------------- doc/zebraidx.xml | 85 ++++++++++++--------------------------- 5 files changed, 141 insertions(+), 124 deletions(-) create mode 100644 doc/zebraidx-commands.xml diff --git a/doc/Makefile.am b/doc/Makefile.am index 725e24c..546d07b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.21 2003-05-19 21:38:40 adam Exp $ +## $Id: Makefile.am,v 1.22 2003-09-05 10:50:33 adam Exp $ docdir=$(datadir)/doc/@PACKAGE@ SUPPORTFILES = \ @@ -19,7 +19,8 @@ XMLFILES = \ recordmodel.xml \ license.xml \ indexdata.xml \ - zebraidx-options.xml + zebraidx-options.xml \ + zebraidx-commands.xml HTMLFILES = \ administration.html apps.html configuration-file.html data-model.html \ @@ -44,8 +45,9 @@ EXTRA_DIST = $(XMLFILES) $(SUPPORTFILES) $(REFFILES) \ $(doc_DATA) $(EPSFILES) $(man_MANS) $(REFFILES) \ zvrank.txt marc_indexing.xml -zebraidx.1: zebraidx-man.sgml zebraidx-options.xml +zebraidx.1: zebraidx-man.sgml zebraidx-options.xml zebraidx-commands.xml if test ! -f zebraidx-options.xml ; then ln -s $(srcdir)/zebraidx-options.xml .; fi + if test ! -f zebraidx-commands.xml ; then ln -s $(srcdir)/zebraidx-commands.xml .; fi docbook2man $(srcdir)/zebraidx-man.sgml zebrasrv.8: zebrasrv-man.sgml diff --git a/doc/zebra.xml.in b/doc/zebra.xml.in index eb2f099..9623fd0 100644 --- a/doc/zebra.xml.in +++ b/doc/zebra.xml.in @@ -14,6 +14,7 @@ + '> '> ]> - + Zebra - User's Guide and Reference diff --git a/doc/zebraidx-commands.xml b/doc/zebraidx-commands.xml new file mode 100644 index 0000000..deea484 --- /dev/null +++ b/doc/zebraidx-commands.xml @@ -0,0 +1,71 @@ + + + + update directory + + + Update the register with the files contained in + directory. + If no directory is provided, a list of files is read from + stdin. + See . + + + + + delete directory + + + Remove the records corresponding to the files found under + directory from the register. + + + + + commit + + + Write the changes resulting from the last update + commands to the register. This command is only available if the use of + shadow register files is enabled + (see ). + + + + + clean + + Clean shadow files and "forget" changes. + + + + create database + + Create database. + + + + drop database + + Drop database (delete database). + + + + diff --git a/doc/zebraidx-man.sgml b/doc/zebraidx-man.sgml index 87fdf3e..d3e5216 100644 --- a/doc/zebraidx-man.sgml +++ b/doc/zebraidx-man.sgml @@ -1,5 +1,6 @@ + Zebra - User's Guide and Reference"> @@ -14,7 +15,7 @@ %ref-head; Safe Updating - Using Shadow Registers %ref-tail;"> ]> - + @@ -26,7 +27,7 @@ zebraidx Zebra Administrative Tool - + zebraidx @@ -46,66 +47,41 @@ 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). - - - + + 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. - - + &zebraidx-commands; + + + OPTIONS + &zebraidx-options; + + FILES + + zebra.cfg + + + SEE ALSO + + + zebrasrv + 8 + + + + See "shadow registers" in Zebra manual + + + See "administration" in Zebra manual + + + Running the Maintenance Interface (zebraidx) The following is a complete reference to the command line interface to the zebraidx application. - + Syntax + - - $ zebraidx [options] command [directory] ... - + + zebraidx + + + + + + + + + + + + + command + file + - Options: - &zebraidx-options; - Commands - - - - - - - update directory - - - Update the register with the files contained in - directory. - If no directory is provided, a list of files is read from - stdin. - See . - - - - - delete directory - - - Remove the records corresponding to the files found under - directory from the register. - - - - - commit - - - Write the changes resulting from the last update - commands to the register. This command is only available if the use of - shadow register files is enabled - (see ). - - - - + &zebraidx-commands; + + + + Options: + &zebraidx-options; -- 1.7.10.4