Initial commit
[yaz4j-moved-to-github.git] / dependencies / yaz-2.1.28 / doc / zoomsh.1
1 .\"     Title: zoomsh
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
4 .\"      Date: 09/04/2006
5 .\"    Manual: 
6 .\"    Source: YAZ 2.1.28
7 .\"
8 .TH "ZOOMSH" "1" "09/04/2006" "YAZ 2.1.28" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 zoomsh \- ZOOM shell
15 .SH "SYNOPSIS"
16 .HP 7
17 \fBzoomsh\fR [commands...]
18 .SH "DESCRIPTION"
19 .PP
20
21 \fBzoomsh\fR
22 is a ZOOM client with a simple command line interface. The client demonstrates the ZOOM API and is useful for testing targets.
23 .PP
24 You may pass one or more commands to
25 \fBzoomsh\fR. These commands are invoked first.
26 .SH "EXAMPLES"
27 .PP
28 If you start the
29 \fByaz\-ztest\fR
30 in one console you can use the ZOOM shell as follows:
31 .sp
32 .RS 3n
33 .nf
34 $ zoomsh
35 ZOOM>connect localhost:9999
36 ZOOM>search computer
37 localhost:9999: 7 hits
38 ZOOM>show 0 1
39 1 Default USmarc
40 001    11224466 
41 003 DLC
42 005 00000000000000.0
43 008 910710c19910701nju           00010 eng  
44 010    $a    11224466 
45 040    $a DLC $c DLC
46 050 00 $a 123\-xyz
47 100 10 $a Jack Collins
48 245 10 $a How to program a computer
49 260 1  $a Penguin
50 263    $a 8710
51 300    $a p. cm.
52 ZOOM>quit
53
54     
55 .fi
56 .RE
57 .sp
58 .PP
59 You can also achieve the same result by passing the commands as arguments on a single command line:
60 .PP
61
62 $ zoomsh "connect localhost:9999" "search computer"
63 "show 0 1" quit
64 .SH "COMMANDS"
65 .TP 3n
66 connect \fIzurl\fR
67 Connects to the target given by
68 \fIzurl\fR.
69 .TP 3n
70 close [\fIzurl\fR]
71 Closes connection to target given by
72 \fIzurl\fR
73 or all targets if
74 \fIzurl\fR
75 was omitted.
76 .TP 3n
77 show [\fIstart\fR [\fIcount\fR]]
78 Displays
79 count
80 records starting at offset given by
81 \fIstart\fR. First records has offset 0 (unlike the Z39.50 protocol).
82 .TP 3n
83 quit
84 Quits
85 \fBzoomsh\fR.
86 .TP 3n
87 set \fIname\fR [\fIvalue\fR]
88 Sets option
89 \fIname\fR
90 to
91 \fIvalue\fR.
92 .TP 3n
93 get \fIname\fR
94 Prints value of option
95 \fIname\fR.
96 .TP 3n
97 help
98 Prints list of available commands.
99 .SH "SEE ALSO"
100 .PP
101
102 \fByaz\fR(7),
103 \fByaz\-ztest\fR(8),
104 .PP
105 Section "Building clients with ZOOM" in the YAZ manual.
106 .PP
107
108 [1]\&\fIZOOM home page\fR.
109 .SH "REFERENCES"
110 .TP 3
111 1.\ ZOOM home page
112 \%http://zoom.z3950.org/