Wrote more documentation.

diff --git a/doc/egate.sgml b/doc/egate.sgml
index fcadabe..05e2cb2 100644 (file)
--- a/doc/egate.sgml
+++ b/doc/egate.sgml
@@ -1,13 +1,13 @@
 <!doctype linuxdoc system>
 
 <!--
-  $Id: egate.sgml,v 1.1 1995/07/03 12:58:17 adam Exp $
+  $Id: egate.sgml,v 1.2 1995/07/05 08:22:37 adam Exp $
 -->
 
 <article>
 <title>Email/Z39.50 gateway guide
 <author>Europagate, 1995
-<date>$Revision: 1.1 $
+<date>$Revision: 1.2 $
 <abstract>
 This document describes a Email server that provides access to the
 Z39.50 protocol.
@@ -101,8 +101,10 @@ In this example the mail user name was <tt/es/ and the LIBDIR was
 
 The ES system can operate with or without the monitor. When using
 the monitor the number of simultanous running kernels can be
-controlled. If the <tt>eti</tt> program is started with option
-<tt>--</tt> it will operate without the monitor.
+controlled. If the <tt>eti</tt> program is started with 
+two dashes (<tt>--</tt>) it will operate without the monitor and
+the options specified after the two dashes are transferred to the
+kernel.
 
 <sect1>With the monitor
 
@@ -145,10 +147,10 @@ The eti program accepts the following options:
 <tag><tt>-l </tt>log</tag> The log file. If absent stderr is used.
 <tag><tt>-d</tt></tag> Turns on debugging.
 <tag><tt>-c </tt>dir</tag> Sets current directory to dir.
+<tag><tt>-H</tt></tag> Help message.
 <tag><tt>--</tt></tag> Indicates that the eti program should contact the
-kernel (and not the monitor. All options are this one are transferred
+kernel (and not the monitor. All options after this one are transferred
 to the kernel
-<tag><tt>-H</tt></tag> Help message.
 </descrip>
 
 <sect1>monitor
@@ -188,19 +190,16 @@ alternate file on the command line.
 
 <sect>Managing the system
 
+<sect1>Summary of files
 <p>
 
-<sect1>Files
-
-<p>
 To maintain the ES you need to know the files it uses. These are:
 <descrip>
 <tag>*.res</tag> Resource files with several settings that control
  how the system operates, such as definition of targets, messages, etc.
-<tag>lang.*.res</tag> Resource file for a particular langauge.
 <tag>*.bib</tag> Bib-1 attribute mapping files. These files describe
  the mapping between CCL and the RPN query.
-<tag>user.db</tag> Database of users. Only the eti process access
+<tag>user.db</tag> Database of users. Only the eti process accesses
  this file.
 <tag>user.*.r</tag> Resource file for a user &mdash; accessed by the kernel
  &mdash; only created when the user uses the <tt>def</tt> command.
@@ -210,7 +209,7 @@ To maintain the ES you need to know the files it uses. These are:
 </descrip>
 
 The ES system is mostly managed by resource files. The following
-resource files are enclosed with the ES:
+are example resource files that comes with the ES:
 <descrip>
 <tag><tt>default.res</tt></tag> General resource with reasonable defaults. 
  This file is read by the monitor and the kernel.
@@ -222,17 +221,39 @@ resource files are enclosed with the ES:
 <tag><tt>lang.dk.res</tt></tag> Resource file for danish conversation.
 </descrip>
 
-<sect1>General resources
+<sect1>Resources
 
 <p>
-Most general resources can be found in default.res. Some of the
-resources may be changed (overridden) by the user, while others may be
-overriden by individual target defintions.
+Most general resources should be set in the file <tt>default.res</tt>. 
+Some of the resources may be changed (overridden) by the user, while 
+others may be overridden by individual target defintions. 
+The complete scenario is depicted below:
+<tscreen><verb>
+       +-------------+
+       | default.res |
+       +-------------+
+              |          +--------------+
+              |<---------| "target.res" | 
+              |          +--------------+
+              |
+              |          +--------------+
+              |<---------| user.x.res   |
+              |          +--------------+
+              |
+              |          +--------------+
+              |<---------| "lang.res"   |
+              |          +--------------+
+              |
+              |          +--------------+
+              |<---------| "override"   |
+              |          +--------------+
+            result
+</verb></tscreen>
 
-<p>
 The following table lists general resources:
 <descrip>
-<tag>gw.reply.mta</tag> Name of MTA program.
+<tag>gw.reply.mta</tag> Name of MTA program &mdash; default
+ <tt>/usr/lib/sendmail</tt>.
 <tag>gw.reply.tmp.prefix</tag> Prefix of temporary files used by the ES.
 <tag>gw.reply.tmp.dir</tag> Name of directory with temporary files.
 <tag>gw.marc.log</tag> If this resource is specified, retrieved MARC
@@ -241,8 +262,8 @@ The following table lists general resources:
  kernel exists, the Z39.50 persistency layer will reconnect when
  necessary.
 <tag>gw.resultset</tag> If this setting is 1, the Z39.50 client will
- use named result sets. If 0, the Z39.50 will always use Default as
- result-set name.
+ use named result sets. If 0, the Z39.50 system will always use 
+ <tt/Default/ as result-set name.
 <tag>gw.persist</tag> If this setting 1, the persistency is enabled;
  disabled otherwise.
 <tag>gw.max.process</tag> This settings is the maximum number of
@@ -253,15 +274,60 @@ The following table lists general resources:
  database record in ISO2709 format. If 0, the ES will use the
  record type.
 <tag>gw.default.show</tag> Default number of records to retrieve and display
- when using the show command. This setting may be changed by the user.
+ when using the show command. This setting may be changed by the user
+ with the <tt>def defaultshow</tt> command.
 <tag>gw.max.show</tag> This setting specifies the maximum number of
  records the user may retrieve in one show command &mdash; default 100.
 <tag>gw.autoshow</tag> Number of records to retrieve in a find
- command &mdash; default 0. This setting may be changed by the user.
+ command &mdash; default 0. This setting may be changed by the user by
+ the <tt>def autoshow</tt> command.
 <tag>gw.display.format</tag> Default display format. This setting may
- be changed by the user.
+ be changed by the user by the <tt>def f</tt> command.
 <tag>gw.language</tag> Current language. This setting may be
-changed by the user.
+changed by the user with the <tt>def lang</tt> command. When the 
+ langauge is set to something, say x, then the resource gw.lang.x 
+ should hold a name of a resource file read by the kernel.
+<tag>gw.lang.<em/x/</tag> Specifies name of resource file for 
+ language <em/x/.
+<tag>gw.target.<em/name/ </tag> Name of resource file of target
+ <em/name/.
+<tag>gw.portno</tag> Z39.50 target port number &mdash; default 210.
+<tag>gw.hostname</tag> Z39.50 target host name.
+<tag>gw.bibset</tag> Name of file with Bib-1 attribute mapping.
+<tag>gw.databases</tag> Available databases on target.
+<tag>gw.description</tag> Description of a target. This message
+ is returned to the user when the connection is established with the
+ target.
+</descrip>
+
+<sect1>Messages
+
+<p>
+There are several resource settings that deal with language 
+dependencies. These fall into the following categories that
+depend on the resource name prefixes:
+<descrip>
+<tag>gw.msg</tag> Miscellaneous messages.
+<tag>gw.err</tag> Error messages.
+<tag>gw.bib1.diag.<em/no/</tag> Diagnostic error message indicated by
+ <em/no/.
+<tag>gw.help</tag> Help/description of various commands.
+<tag>ccl.command</tag> CCL command names.
+<tag>ccl.token</tag> CCL tokens names.
 </descrip>
 
+Refer to the sample files, <tt>default.res</tt>, <tt>lang.uk.res</tt>
+and <tt>lang.dk.res</tt> for all available settings.
+
+<sect1>Target definitions
+
+<p>
+To add a target definition, <em/mytarget/, you need to make a resource 
+entry in <tt>default.res</tt> called <tt>gw.target.</tt><em>mytarget</em>.
+The value of this resource is the name of a resource file &mdash; for 
+example <em>mytarget</em><tt>.res</tt>. The resource file should at least
+define the resources: <tt/gw.hostname/, <tt/gw.databases/ and 
+<tt/gw.description/. The user only needs to use the command
+<tt>target </tt><em>mytarget</em> to use the target.
+
 </article>