Updated for YAZ 1.7. HTML output tidy up. Added LOC target.
[egate.git] / kernel / default.res
1 # Email gateway - general kernel resources
2 # $Id: default.res,v 1.32 2001/02/26 14:32:36 adam Exp $
3 #
4 # Important directories, programs, etc.
5 gw.reply.mta: /usr/lib/sendmail
6 gw.reply.tmp.prefix: gwr
7 gw.reply.tmp.dir: /tmp
8 #gw.path: /home/adam/egate/kernel
9 gw.marc.log: marc.log
10 gw.timeout: 30
11 gw.resultset: 1
12 gw.persist: 1
13 gw.max.process: 3
14
15 # Retrieval settings
16 gw.ignore.which: 0
17 gw.default.show: 10
18 gw.max.show: 100
19
20 # Target definitions
21 gw.portno: 210
22 gw.hostname: localhost
23 gw.bibset: default.bib
24 gw.target.loc: loc.res
25 gw.target.drewdb: drewdb.res
26 gw.target.bagel: bagel.res
27 gw.databases:
28
29 # Language definitions
30 gw.lang.dk: lang.dk.res
31 gw.lang.uk: lang.uk.res
32
33 # Messages
34 gw.msg.subject: Your Z39.50 Query...
35 gw.msg.greeting: Europagate Email-Z39.50 gateway
36 gw.msg.cont: Session continued...
37 gw.msg.from: Email-Z39.50 gateway
38 gw.err.nullbody: Empty body
39 ccl.command.find: find f
40 ccl.command.show: show s
41 ccl.command.base: base b
42 ccl.command.help: help h
43 ccl.command.info: info i
44 ccl.command.continue: continue
45 ccl.command.status: status
46 ccl.command.def: def
47 ccl.command.account: account
48 ccl.token.and: and
49 ccl.token.or: or
50 ccl.token.not: not andnot
51 ccl.token.set: set s
52
53 # Diagnostic Conditions
54 gw.bib1.diag.1: Permanent system error
55 gw.bib1.diag.2: Temporary system error
56 gw.bib1.diag.3: Unsupported search
57 gw.bib1.diag.4: Terms only exclusion (stop) words
58 gw.bib1.diag.5: Too many argument words
59 gw.bib1.diag.6: Too many boolean operators
60 gw.bib1.diag.7: Too many truncated words
61 gw.bib1.diag.8: Too many incomplete subfields
62 gw.bib1.diag.9: Truncated words too short
63 gw.bib1.diag.10: Invalid format for record number (search term)
64 gw.bib1.diag.11: Too many characters in search statement
65 gw.bib1.diag.12: Too many records retrieved
66 gw.bib1.diag.13: Present request out of range
67 gw.bib1.diag.14: System error in presenting records
68 gw.bib1.diag.15: Record no authorized to be sent intersystem
69 gw.bib1.diag.16: Record exceeds Preferred-message-size
70 gw.bib1.diag.17: Record exceeds Maximum-record-size
71 gw.bib1.diag.18: Result set not supported as a search term
72 gw.bib1.diag.19: Only single result set as search term supported
73 gw.bib1.diag.20: Only ANDing of a single result set as search term supported
74 gw.bib1.diag.21: Result set exists and replace indicator off
75 gw.bib1.diag.22: Result set naming not supported
76 gw.bib1.diag.23: Combination of specified databases not supported
77 gw.bib1.diag.24: Element set names not supported
78 gw.bib1.diag.25: Specified element set name not valid for specified database
79 gw.bib1.diag.26: Only a single element set name supported
80 gw.bib1.diag.27: Result set no longer exists - unilaterally deleted by target
81 gw.bib1.diag.28: Result set is in use
82 gw.bib1.diag.29: One of the specified databases is locked
83 gw.bib1.diag.30: Specified result set does not exist
84 gw.bib1.diag.31: Resources exhausted - no results available
85 gw.bib1.diag.32: Resources exhausted - unpredictable partial results available
86 gw.bib1.diag.33: Resources exhausted - valid subset of results available
87 gw.bib1.diag.100: Unspecified error
88 gw.bib1.diag.101: Access-control failure
89 gw.bib1.diag.102: Security challenge required but could not be
90  issued - request terminated
91 gw.bib1.diag.103: Security challenge required but could not be
92  issued - record not included
93 gw.bib1.diag.104: Security challenge failed - record not included
94 gw.bib1.diag.105: Terminated by negative continue response
95 gw.bib1.diag.106: No abstract syntaxes agreed to for this record
96 gw.bib1.diag.107: Query type not supported
97 gw.bib1.diag.108: Malformed query
98 gw.bib1.diag.109: Database unavailable
99 gw.bib1.diag.110: Operator unsupported
100 gw.bib1.diag.111: Too many databases specified
101 gw.bib1.diag.112: Too many result sets created
102 gw.bib1.diag.113: Unsupported attribute type
103 gw.bib1.diag.114: Unsupported Use attribute
104 gw.bib1.diag.115: Unsupported value for Use attribute
105 gw.bib1.diag.116: Use attribute required but not supplied
106 gw.bib1.diag.117: Unsupported Relation attribute
107 gw.bib1.diag.118: Unsupported Structure attribute
108 gw.bib1.diag.119: Unsupported Position attribute
109 gw.bib1.diag.120: Unsupported Truncation attribute
110 gw.bib1.diag.121: Unsupported Attribute Set
111 gw.bib1.diag.122: Unsupported Completeness attribute
112 gw.bib1.diag.123: Unsupported attribute combination
113 gw.bib1.diag.124: Unsupported coded value for term
114 gw.bib1.diag.125: Malformed search term
115 gw.bib1.diag.126: Illegal term value for attribute
116 gw.bib1.diag.127: Unparsable format for un-normalized value
117 gw.bib1.diag.128: Illegal result set name
118 gw.bib1.diag.129: Proximity search of sets not supported
119 gw.bib1.diag.130: Illegal result set in proximity search
120 gw.bib1.diag.131: Unsupported proximity relation
121 gw.bib1.diag.132: Unsupported proximity unit code
122
123 # Help messages
124 gw.help.target: Command:\n
125  \ttarget <host>[:<port>]\n
126  \n
127  The target command selects exactly one target <host>. The <host>
128  is a normal internet domain hostname. The optional <port> argument
129  specifies the port number to use. Normally, this does not need to be
130  specified.
131  \n
132 gw.help.base: Command:\n
133  \tbase <base1> <base2> ...\n
134  \n
135  The base command selects one or more databases. However, some 
136  targets do not allow the selection of more than one database.
137  \n
138 gw.help.find: Command:\n
139  \tfind <query>\n\n
140  The find command issues a search request based on the specified
141  <query>. A query consists of one or more <search-element>s separated
142  by boolean operators <bool-operator>, i.e.:\n
143  \tquery = search-element bool-operator search-element ...\n\n
144  There are three boolean operators (| means or):\n
145  \tbool-operator = and | or | not\n\n
146  A search-element has three forms. The first and simplest is
147  when it consists of one or more search-terms as in:\n
148  \t<search-element> = <search-term> ...\n\n
149  In the second form, qualifiers are specified:\n
150  \t<search-element> = <qualifier> <relation> <search-term> ...\n\n
151  A qualifier directs the search to a specified index register. The
152  relation is:\n
153  \t<relation> = > | < | >= | <= | = | <>\n\n
154  The third type of <search-element> is the result-set reference:\n
155  \t<search-element> = s=<name>\n\n
156  Parentheses may be used to create recursive definitions.\n\n
157  Some examples, may be in order:\n
158  \tfind network\n
159  This query consists of one <search-element>, which in turn consists of
160  one <search-term>. The query searches for the word "network".\n\n
161  \tfind computer network\n
162  This is the same as above, but there are two search terms. The
163  phrase "computer network" is searched.\n\n
164  \tfind ti=computer and au=knuth or donald\n
165  There are three <search-element>s. The first and second <search-element>
166  use qualifiers; the last one doesn't. The search is equivalent to:\n
167  \tfind (ti=computer and au=knuth) or donald\n
168  If the 'or' is to be applied to "knuth" and "donald", one could use:\n
169  \tfind ti=computer and (au=knuth or donald)\n\n
170  \tfind computer and s=2\n
171  Here, the <search-term> "computer" is and'ed with result-set "2".\n
172 gw.help.show: Command:\n
173  \tshow <show-spec> ...\n\n
174  The show command retrieves records. A <show-spec> is a combination
175  of record position specifications and a presentation format
176  specification. A show command with no <show-spec> retrieves
177  10 records and displays them in the full format. A show-spec
178  of the form:\n
179  \tf = <type>\n
180  sets the the format to <type>. Currently, there are three formats:
181  0 - full, 1 - medium, 2 compact format. Record positions can
182  be specified by the form:\n
183  \tp = <from> - <to>\n
184  Here <from> and <to> are two integers specifying the record
185  positions.\n
186  Example:\n
187  \tshow p=2-7 p=9-10 f=1\n
188  Records 2 through 7 and 9-10 are shown in format 1.\n
189 gw.help.def:\n
190  \tdef <setting> <value>\n
191  The def command sets/gets various settings. Setting is one of:
192  \tf - display format to be used in show\n
193  \tautoshow - number of records to show after a find\n
194  \tdefaultshow - number of records to retrieve in a show command\n
195  \tlang - conversation language\n
196  \n
197  \treset - resets the settings to their defaults values\n
198  \tshow - show current settings\n
199 gw.help.account:\n
200  \taccount <account>\n
201  Sets authentication string. Necessary for some targets.\n
202 gw.help.status:\n
203  \tstatus\n
204  Displays information about previous result sets and how they were obtained.\n
205 gw.help.general: You 
206  have triggered the "help"-information on the Email gateway. \n\n
207  This service is the first official release of a Email service
208  which acts as a Z39.50-client (origin). \n\n
209  With this service you can connect to several Z39.50-targets. Your Email
210  body consists of one or more commands. Each command must start on column
211  zero; otherwise it will be ignored. Also, everything AFTER the first
212  empty line in your body is ignored. Thus, you probably do not have to
213  delete your signature in the end.\n\n
214  All your requests will be logged. Hopefully you will get a reply with
215  the result of your queries in a minute or two. If you don't something
216  probably went wrong. Hopefully, we will be able to see what went wrong
217  by examining the log files.\n\n
218  This is what you do:\n
219  * First you must select a target (i.e. a host with a Z39.50-interface
220  to one or more databases) with the "target" command. For example:\n
221  \ttarget dranet.dra.com\n
222  * Second, select the databases in which you wish to search, with the
223  "base" command. For example:\n
224  \tbase drewdb\n\n
225  * Now you are ready to issue real queries by using the "find"-command.
226  The query consists of one or more search words. You can perform boolean
227  searches by using the operators "and", "or" and "not". For example:\n
228  \tfind computer and knuth\n
229  If the target supports it, you may also direct the search to special
230  indexes by using qualfiers. For example, the following query will search
231  for "computer" in the "title"-index and "knuth" in the "normal" index:\n
232  \tfind ti=computer and knuth\n\n
233  * If the query succeeds, you will be informed with the number of hits.
234  To display the records use the "show"-command.\n