yaz-client-ssl.1

harvest是一个下载html网页得机器人

.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <[e-mail]>.
.TH "YAZ-CLIENT" "1" "04 September 2003" "" ""
.SH NAME
yaz-client \- Z39.50/SRW client for implementors
.SH SYNOPSIS

\fByaz-client\fR [ \fB-m \fIfilename\fB\fR]  [ \fB-a \fIfilename\fB\fR]  [ \fB-c \fIfilename\fB\fR]  [ \fB-q \fIfilename\fB\fR]  [ \fB-p \fIaddr\fB\fR]  [ \fB-u \fIauth\fB\fR]  [ \fB-k \fIsize\fB\fR]  [ \fBaddr\fR] 


\fByaz-client-ssl\fR [ \fBoption\fR\fI ...\fR]  [ \fBaddr\fR] 

.SH "DESCRIPTION"
.PP
\fByaz-client\fR is a Z39.50/SRW client (origin) with a
simple command line interface that allows you to test behavior and
performance of Z39.50 targets and SRW servers.
.PP
\fByaz-client-ssl\fR is identical to
\fByaz-client\fR except that it supports SSL transport.
.PP
If the \fIaddr\fR is specified, the client creates
a connection to the Z39.50/SRW target at the address.
.SH "OPTIONS"
.TP
\fB-m \fIfilename\fB\fR
If specified, retrieved MARC (ISO2709) records will
be appended to the file given.
.TP
\fB-a \fIfilename\fB\fR
If specified, logging of protocol packages will be appended
file given. The special filename -
(dash) denotes standard output.
.TP
\fB-u \fIauth\fB\fR
If specified, the \fIauth\fR string
will be used for authentication.
.TP
\fB-c \fIfilename\fB\fR
If specified, CCL configuration will be read from
the file given.
.TP
\fB-q \fIfilename\fB\fR
If specified, CQL configuration will be read from
the file given.
.TP
\fB-p \fIaddr\fB\fR
If specified, the client will use the proxy at the address
given.
.SH "COMMANDS"
.PP
The YAZ client accepts the following commands.
.TP
\fB   open \fIzurl\fB \fR
Opens a connection to a server. The syntax for
\fIzurl\fR is the same as described
above for connecting from the command line.

Syntax:

[(tcp|ssl|unix|http)':']\fIhost\fR
[:\fIport\fR][/\fIbase\fR]
.TP
\fB   quit \fR
Quits YAZ client
.TP
\fB   f \fIquery\fB\fR
Sends a Search Request using the \fIquery\fR
given.
.TP
\fB   delete \fIsetname\fB\fR
Deletes result set with name \fIsetname\fR
on the server.
.TP
\fB   base \fIbase1\fB \fIbase2\fB ... \fR
Sets the name(s) of the database(s) to search. One or more
databases may be specified separated by blanks. This commands overrides
the database given in \fIzurl\fR.
.TP
\fB   show  [\fIstart\fB[+\fInumber\fB]] \fR
Fetches records by sending a Present Request from the start
position given by
\fIstart\fR
a number of records given by \fInumber\fR. If
\fIstart\fR is not given, then the client
will fetch from position of the last retrieved record plus 1. If
\fInumber\fR is not given, then one record will
be fetched at a time.
.TP
\fB   scan \fIterm\fB \fR
Scans
database index for a term. The syntax resembles the syntax
for find.
If you want to scan for the word water you could
write

.nf
    scan water
   
.fi

but if you want to scan only in, say the title field, you would write

.nf
    scan @attr 1=4 water
   
.fi
.TP
\fB   sort \fIsortspecs\fB \fR
Sorts a result set. The sort command takes a
sequence of sort specifications. A sort
specification holds a field (sort criteria) and is followed by flags.
If the sort criteria includes = it is assumed
that the sort SortKey is of type sortAttributes using Bib-1.
The integer before = is
the attribute type and the integer following =
is the attribute value.
If no = is in the SortKey it is treated as a
sortfield-type of type InternationalString.
Flags observed are: s
for case sensitive, i for case insensitive,
< for sort ascending and >
for sort descending.
.TP
\fB   sort+ \fR
Same as sort but stores the sorted
result set in a new result set.
.TP
\fB   authentication \fIopenauth\fB \fR
Sets up a authentication string if a server requires
authentication (v2 OpenStyle). The authentication string is first
sent to the server when the open command is
issued and the Z39.50 Initialize Request is sent, so this command
must be used before open in order to be effective.
A common convention for the \fIauthopen\fR string
is that the username - and password is separated by a slash, e.g.
myusername/mysecret.
.TP
\fB   lslb \fIn\fB \fR
Sets the limit for when no records should be returned
together with the search result.
See the
Z39.50 standard
 <URL:http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6>
for more details.
.TP
\fB   ssub \fIn\fB \fR
Sets the limit for when all records should be returned with
the search result.
See the
Z39.50 standard
 <URL:http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6> for more details.
.TP
\fB   mspn \fIn\fB \fR
Sets the number of records should be returned if the
number of records in the result set is between the values of
lslb and ssub.
See the
Z39.50 standard
 <URL:http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6>
for more details.
.TP
\fB   status \fR
Displays the values of lslb,
ssub and mspn.
.TP
\fB   setname \fR
Switches named result sets on and off. Default is on.
.TP
\fB   cancel \fR
Sends a Trigger Resource Control Request to the target.
.TP
\fB   format \fIoid\fB \fR
Sets the preferred transfer syntax for retrieved records.
yaz-client supports all the record syntaxes that currently
are registered. See
Z39.50 Standard
 <URL:http://lcweb.loc.gov/z3950/agency/defns/oids.html#5>
for more details. Commonly used records syntaxes include usmarc,
sutrs, grs1 and xml.
.TP
\fB   elements \fIe\fB \fR
Sets the element set name for the records. Many targets support
element sets are B (for brief) and F (for full).
.TP
\fB   close \fR
Sends a Z39.50 Close APDU and closes connection with the peer
.TP
\fB   querytype \fItype\fB \fR
Sets the query type as used by command find.
The following is supported:
prefix for
Prefix Query Notation (Type-1 Query);
ccl for CCL search (Type-2 Query),
cql for CQL (Type-104 search with CQL OID),
ccl2rpn for
CCL to RPN conversion (Type-1 Query).
cql2rpn for
CQL to RPN conversion (Type-1 Query).
.TP
\fB   attributeset \fIset\fB \fR
Sets attribute set OID for prefix queries (RPN, Type-1).
.TP
\fB   refid \fIid\fB \fR
Sets reference ID for Z39.50 Request(s).
.TP
\fB   itemorder \fItype\fB \fIno\fB \fR
Sends an Item Order Request using the ILL External. 
\fItype\fR is either 1 or 2 which corresponds to
ILL-Profile 1 and 2 respectively. The \fIno\fR
is the Result Set position of the record to be ordered.
.TP
\fB   update \fR
Sends Item Update Request. This command sends a "minimal"
PDU Update to the target supplying the last received record from
the target.
If no record has been received from the target this command is ignored
and nothing is sent to the target.
.TP
\fB   . \fIfilename\fB \fR
Executes list of commands from
file \fIfilename\fR, just like source on
most UNIX shells.
.TP
\fB   ! \fIargs\fB \fR
Executes command \fIargs\fR in subshell
using the system call.
.TP
\fB   push_commande \fIcommand\fB \fR
The push_command takes another command as its argument.
That command is then added to the history information (so
you can retrieve it later). The command itself is not
executed. This command only works if you have GNU readline/history
enabled.
.TP
\fB   set_apdufile \fIfilename\fB \fR
Sets that APDU should be logged to file
\fIfilename\fR. This command does the
thing as option -a.
.TP
\fB   set_marcdump \fIfilename\fB \fR
Specifies that all retrieved records should be appended ot
file \fIfilename\fR. This command does the
thing as option -m.
.TP
\fB   schema \fIschemaid\fB \fR
Specifies schema for retrieval.
Schema may be specified as an OID for Z39.50.
For SRW, schema is a simple string URI.
.TP
\fB   charset \fInegotiationcharset\fB [\fIoutputcharset\fB] \fR
Specifies character set (encoding) for Z39.50
negotiation / SRW encoding and/or character set for output (terminal).

\fInegotiationcharset\fR is the name
of the character set to be negotiated by the server. The special name
- for \fInegotiationcharset\fR
specifies \fBno\fR character set to be negotiated.

If \fIoutputcharset\fR is given, it specifies name
of the character set of the output (on the terminal on which
YAZ client is running). To disable conversion of characters
to the output encoding, the special name - (dash)
can be used.
If the special name auto is given, YAZ client will
convert strings to the encoding of the
terminal as returned by \fBnl_langinfo\fR call.
.sp
.RS
.B "Note:"
Since character set negotation takes effect in the Z39.50
Initialize Request you should issue this command before
command open is used.
.RE
.sp
.RS
.B "Note:"
MARC records are not covered by Z39.50 character set negotiation.
See marccharset.
.RE
.TP
\fB   marccharset \fIcharset\fB \fR
Specifies character set for retrieved MARC records so
that YAZ client can display them in a character suitable
for your display. See charset command.
If auto is given, YAZ will assume
that MARC21/USMARC is using MARC8/UTF8 and ISO-8859-1
for all other MARC variants.
.TP
\fB   set_cclfields \fIfilename\fB \fR
Specifies that CCL fields should be read from file
file \fIfilename\fR. This command does the
thing as option -c.
.TP
\fB   set_cqlfields \fIfilename\fB \fR
Specifies that CQL fields should be read from file
file \fIfilename\fR. This command does the
thing as option -q.
.TP
\fB   register_oid \fIname\fB \fIclass\fB \fIOID\fB \fR
This command allows you to register your own object
identifier - so that instead of entering a long dot-notation
you can use a short name instead.
The \fIname\fR is your
name for the OID, \fIclass\fR is the
class, and \fIOID\fR is the raw OID in
dot notation. Class is one appctx,
absyn, attet,
transyn, diagset,
recsyn, resform,
accform, extserv,
userinfo, elemspec,
varset, schema,
tagset, general.
If you're in doubt use the general
class.
.SH "FILES"
.PP
\fIyaz-<version>/client/client.c\fR
.SH "SEE ALSO"
.PP
\fByaz\fR(7)
.PP
Section "The YAZ Client" in the YAZ manual.
.PP
Section "Prefix Query Format" in the YAZ manual.
.PP
Section "Common Command Language" in the YAZ manual.
.PP
Section "Common QUery Language" in the YAZ manual.