File: client.invoking.html

package info (click to toggle)
yaz 2.1.18-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 11,988 kB
  • ctags: 11,045
  • sloc: xml: 109,719; ansic: 41,566; sh: 10,625; makefile: 1,115; tcl: 380; yacc: 288
file content (493 lines) | stat: -rw-r--r-- 6,898 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Invoking the YAZ client</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="YAZ User's Guide and Reference"
HREF="yaz.html"><LINK
REL="UP"
TITLE="The YAZ client"
HREF="client.html"><LINK
REL="PREVIOUS"
TITLE="The YAZ client"
HREF="client.html"><LINK
REL="NEXT"
TITLE="Commands"
HREF="client.commands.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="common/style1.css"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>YAZ User's Guide and Reference</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="client.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 5. The YAZ client</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="client.commands.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="client.invoking"
>Invoking the YAZ client</A
></H1
><P
>&#13;    It can be started by typing
   </P
><P
><B
CLASS="command"
>yaz-client</B
>  [-m <TT
CLASS="replaceable"
><I
>fname</I
></TT
>] [-a <TT
CLASS="replaceable"
><I
>fname</I
></TT
>] [-c <TT
CLASS="replaceable"
><I
>fname</I
></TT
>] [-q <TT
CLASS="replaceable"
><I
>fname</I
></TT
>] [-v <TT
CLASS="replaceable"
><I
>level</I
></TT
>] [-p <TT
CLASS="replaceable"
><I
>target</I
></TT
>] [-u <TT
CLASS="replaceable"
><I
>auth</I
></TT
>] [-k <TT
CLASS="replaceable"
><I
>size</I
></TT
>] [zurl]</P
><P
>&#13;    in a UNIX shell / WIN32 console. The <TT
CLASS="replaceable"
><I
>zurl</I
></TT
>,
    specifies a Z39.50/SRW host and, if specified, the client first tries to
    establish connection with the Z39.50/SRW target.
   </P
><P
>&#13;    Options are prefixed by <TT
CLASS="literal"
>-</TT
> followed by a
    particular letter.
    </P
><P
>&#13;    The following options are supported:
   </P
><P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><TT
CLASS="literal"
>-m</TT
> <TT
CLASS="replaceable"
><I
>fname</I
></TT
></DT
><DD
><P
>All retrieved transfer records are appended to file
       <TT
CLASS="replaceable"
><I
>fname</I
></TT
>. All records as returned by a
       target(s) in Search Responses and Present Responses are appended
       verbatim to the file.
      </P
></DD
><DT
><TT
CLASS="literal"
>-a</TT
> <TT
CLASS="replaceable"
><I
>fname</I
></TT
></DT
><DD
><P
>Pretty-print log of APDUs sent and received is appended
       to the file <TT
CLASS="replaceable"
><I
>fname</I
></TT
>.
       If <TT
CLASS="replaceable"
><I
>fname</I
></TT
> is <TT
CLASS="literal"
>-</TT
> (minus)
       the APDU log is written to <TT
CLASS="literal"
>stderr</TT
>.
      </P
></DD
><DT
><TT
CLASS="literal"
>-c</TT
> <TT
CLASS="replaceable"
><I
>fname</I
></TT
></DT
><DD
><P
>Sets the filename for CCL fields to
       <TT
CLASS="replaceable"
><I
>fname</I
></TT
>. If this option is not given the
       YAZ client reads CCL fields from file <TT
CLASS="literal"
>default.bib</TT
>.
      </P
></DD
><DT
><TT
CLASS="literal"
>-q</TT
> <TT
CLASS="replaceable"
><I
>fname</I
></TT
></DT
><DD
><P
>Sets the filename for CQL fields to
       <TT
CLASS="replaceable"
><I
>fname</I
></TT
>. If this option is not given the
       YAZ client reads CQL fields from file
       <TT
CLASS="literal"
>/usr/local/share/yaz/etc/pqf.properties</TT
>.
      </P
></DD
><DT
><TT
CLASS="literal"
>-v</TT
> <TT
CLASS="replaceable"
><I
>level</I
></TT
></DT
><DD
><P
>Sets the LOG level to <TT
CLASS="replaceable"
><I
>level</I
></TT
>.
       Level is a sequence of tokens separated by comma. Each token
       is a integer or a named LOG item - one of 
       <TT
CLASS="literal"
>fatal</TT
>,
       <TT
CLASS="literal"
>debug</TT
>,
       <TT
CLASS="literal"
>warn</TT
>,
       <TT
CLASS="literal"
>log</TT
>,
       <TT
CLASS="literal"
>malloc</TT
>,
       <TT
CLASS="literal"
>all</TT
>,
       <TT
CLASS="literal"
>none</TT
>.
      </P
></DD
><DT
><TT
CLASS="literal"
>-p</TT
> <TT
CLASS="replaceable"
><I
>target</I
></TT
></DT
><DD
><P
>Specifies proxy address. When set YAZ client will
       connect to a proxy on the address and port given. 
       The actual target will be specified as part of the InitRequest
       to inform the proxy about actual target.
      </P
></DD
><DT
><TT
CLASS="literal"
>-u</TT
> <TT
CLASS="replaceable"
><I
>auth</I
></TT
></DT
><DD
><P
>Specifies authentication. Usually the form
       <TT
CLASS="replaceable"
><I
>user</I
></TT
>/<TT
CLASS="replaceable"
><I
>password</I
></TT
>
       is used. This option does the same thing as the
       <TT
CLASS="literal"
>auth</TT
> command.
      </P
></DD
><DT
><TT
CLASS="literal"
>-k</TT
> <TT
CLASS="replaceable"
><I
>size</I
></TT
></DT
><DD
><P
>Specifies the maximum messages size in kilobytes.
       The default maximum message size for the YAZ client is 1024
       (1 MB).
      </P
></DD
></DL
></DIV
><P
>&#13;    In order to connect to Index Data's test Z39.50 server on
    <TT
CLASS="literal"
>bagel.indexdata.dk</TT
>, port 210 and with the
    database name <TT
CLASS="literal"
>marc</TT
>, one could type
    <PRE
CLASS="screen"
>&#13;     yaz-client bagel.indexdata.dk:210/marc
    </PRE
>
   </P
><P
>&#13;    The same server is also a SOAP SRW service. Connect to it via HTTP
    as follows:
    <PRE
CLASS="screen"
>&#13;     yaz-client http://bagel.indexdata.dk:210/marc
    </PRE
>
   </P
><P
>&#13;    In order to enable APDU log and connect to localhost, port 210 (default)
    and database Default (default) you'd write:
    <PRE
CLASS="screen"
>&#13;     yaz-client -a - localhost
    </PRE
>
   </P
><P
>&#13;    The following command connects to a local server via UNIX
    socket <TT
CLASS="filename"
>/tmp/yaz</TT
> and sets maximum message size to
    5 MB.
   <PRE
CLASS="screen"
>&#13;    yaz-client -k 5120 unix:/tmp/yaz
   </PRE
> 
   </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="client.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="yaz.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="client.commands.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>The YAZ client</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="client.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Commands</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>