ZOOMSH(1) Commands ZOOMSH(1)NAME
zoomsh - ZOOM shell
SYNOPSIS
zoomsh [-e] [-v loglevel] [commands...]
DESCRIPTION
zoomsh is a ZOOM client with a simple command line interface. The client demonstrates the ZOOM API and is useful for testing targets.
You may pass one or more commands to zoomsh. These commands are invoked first.
OPTIONS -e
Makes zoomsh stop processing commands as soon as an error occur. The exit code of zoomsh is 1 if error occurs; 0 otherwise.
-v loglevel
Sets YAZ log level.
EXAMPLES
If you start the yaz-ztest in one console you can use the ZOOM shell as follows:
$ zoomsh
ZOOM>connect localhost:9999
ZOOM>search computer
localhost:9999: 7 hits
ZOOM>show 0 1
1 Default USmarc
001 11224466
003 DLC
005 00000000000000.0
008 910710c19910701nju 00010 eng
010 $a 11224466
040 $a DLC $c DLC
050 00 $a 123-xyz
100 10 $a Jack Collins
245 10 $a How to program a computer
260 1 $a Penguin
263 $a 8710
300 $a p. cm.
ZOOM>quit
You can also achieve the same result by passing the commands as arguments on a single command line:
$ zoomsh "connect localhost:9999" "search computer" "show 0 1" quit
COMMANDS
connect zurl
Connects to the target given by zurl.
close [zurl]
Closes connection to target given by zurl or all targets if zurl was omitted.
show [start [count]]
Displays count records starting at offset given by start. First records has offset 0 (unlike the Z39.50 protocol).
quit
Quits zoomsh.
set name [value]
Sets option name to value.
get name
Prints value of option name.
help
Prints list of available commands.
SEE ALSO yaz(7), yaz-ztest(8),
Section "Building clients with ZOOM" in the YAZ manual.
ZOOM home page[1].
NOTES
1. ZOOM home page
http://zoom.z3950.org/
YAZ 4.2.30 04/16/2012 ZOOMSH(1)
Check Out this Related Man Page
YAZ_CONNECT(3) 1 YAZ_CONNECT(3)yaz_connect - Prepares for a connection to a Z39.50 serverSYNOPSIS
mixed yaz_connect (string $zurl, [mixed $options])
DESCRIPTION
This function returns a connection resource on success, zero on failure.
yaz_connect(3) prepares for a connection to a Z39.50 server. This function is non-blocking and does not attempt to establish a connection -
it merely prepares a connect to be performed later when yaz_wait(3) is called.
Note
The YAZ proxy is a freely available Z39.50 proxy.
PARAMETERS
o $zurl
- A string that takes the form host[:port][/database]. If port is omitted, port 210 is used. If database is omitted Default is
used.
o $options
- If given as a string, it is treated as the Z39.50 V2 authentication string (OpenAuth). If given as an array, the contents of
the array serves as options.
o user
- Username for authentication.
o group
- Group for authentication.
o password
- Password for authentication.
o cookie
- Cookie for session (YAZ proxy).
o proxy
- Proxy for connection (YAZ proxy).
o persistent
- A boolean. If TRUE the connection is persistent; If FALSE the connection is not persistent. By default connections are
persistent.
Note
If you open a persistent connection, you won't be able to close it later with yaz_close(3).
o piggyback
- A boolean. If TRUE piggyback is enabled for searches; If FALSE piggyback is disabled. By default piggyback is enabled.
Enabling piggyback is more efficient and usually saves a network-round-trip for first time fetches of records. However, a
few Z39.50 servers do not support piggyback or they ignore element set names. For those, piggyback should be disabled.
o charset
- A string that specifies character set to be used in Z39.50 language and character set negotiation. Use strings such as:
ISO-8859-1, UTF-8, UTF-16. Most Z39.50 servers do not support this feature (and thus, this is ignored). Many servers use
the ISO-8859-1 encoding for queries and messages. MARC21/USMARC records are not affected by this setting.
o preferredMessageSize
- An integer that specifies the maximum byte size of all records to be returned by a target during retrieval. See the
Z39.50 standard for more information.
Note
This option is supported in PECL YAZ 1.0.5 or later.
o maximumRecordSize
- An integer that specifies the maximum byte size of a single record to be returned by a target during retrieval. This
entity is referred to as Exceptional-record-size in the Z39.50 standard.
Note
This option is supported in PECL YAZ 1.0.5 or later.
RETURN VALUES
A connection resource on success, FALSE on error.
CHANGELOG
+--------+------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+------------------------------------+
| 4.1.0 | |
| | |
| | The parameter $options was added. |
| | |
+--------+------------------------------------+
SEE ALSO yaz_close(3).
PHP Documentation Group YAZ_CONNECT(3)