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