Added scan man page.

diff --git a/doc/ir-assoc.n b/doc/ir-assoc.n
index 35ed5b8..de28453 100644 (file)
--- a/doc/ir-assoc.n
+++ b/doc/ir-assoc.n
@@ -1,6 +1,6 @@
 .\" Copyright (c) 1995, 1996 Index Data
 .\" All rights reserved.
 .\" Copyright (c) 1995, 1996 Index Data
 .\" All rights reserved.

-.\" $Id: ir-assoc.n,v 1.1 1996-06-24 13:58:45 adam Exp $
+.\" $Id: ir-assoc.n,v 1.2 1996-06-24 16:24:38 adam Exp $

 .TH ir-assoc N  "24 June 1996" "IrTcl" "IR Association"
 .SH NAME
 ir \- IR association 
 .TH ir-assoc N  "24 June 1996" "IrTcl" "IR Association"
 .SH NAME
 ir \- IR association 

@@ -119,4 +119,4 @@ Gets the the user-information-field; this should be inspected when
 the connection is rejected by the target (\fBinitResult\fR returns 0).
 
 .SH "SEE ALSO"
 the connection is rejected by the target (\fBinitResult\fR returns 0).
 
 .SH "SEE ALSO"

-.BR ir-set "(n)"
+.BR ir-set "(n)", " " ir-scan "(n)"

diff --git a/doc/ir-scan.n b/doc/ir-scan.n
new file mode 100644 (file)
index 0000000..c23b913
--- /dev/null
+++ b/doc/ir-scan.n
@@ -0,0 +1,61 @@
+.\" Copyright (c) 1995, 1996 Index Data
+.\" All rights reserved.
+.\" $Id: ir-scan.n,v 1.1 1996-06-24 16:24:39 adam Exp $
+.TH ir-scan N  "24 June 1996" "IrTcl" "IR Scan"
+.SH NAME
+ir-scan \- IR scan
+.SH SYNOPSIS
+.BI "ir-scan " zs " " za
+.sp
+.SH DESCRIPTION
+The Tcl command
+.B ir-scan
+creates an IR scan object \fIzs\fR that belongs to the IR association \fIza\fR.
+The ir-scan describes a scan object and the scan terms returned by a target.
+When a scan object is created it contains no scan terms (yet).
+When scan terms are returned by the target they are automatically stored
+at their logical positions. 
+.SH SCAN REQUEST
+Operations that are used to scan (browse) a target:
+.TP
+.BI "" za " databaseNames " db1 " " db2 " " ...
+Sets the database(s) to be used in the following scan request(s).
+.TP
+.BI "" zs " scan " query
+Sends a scan request. The \fIquery\fR must follow the RPN-query syntax.
+.TP
+.BI "" zs " stepSize [" size "]"
+Sets/gets the step-size to be used in the following scan requests. Default
+is 0.
+.TP
+.BI "" zs " numberOfTermsRequested [" number "]"
+Sets/gets the number-of-terms-requested used in the following scan requests.
+Defaults to 20.
+.TP
+.BI "" zs " preferredPositionInResponse [" position "]"
+Sets/gets the preferred-position-in-response. Defaults to 1.
+.SH SCAN RESPONSE
+Operations used to handle the scan-response:
+.TP
+.BI "" zs " scanStatus"
+Returns the scan status (integer).
+.TP
+.BI "" zs " numberOfEntriesReturned"
+Returns the number-of-entries returned by the target.
+.TP
+.BI "" zs " positionOfTerm"
+Returns position-of-term.
+.TP
+.BI "" zs " stepSize"
+Returns the step-size of the terms returned by the target.
+.TP
+.BI "" zs " scanLine " position
+Returns information about the scan-term at the given \fIposition\fR.
+If the first token returned is \fBSD\fR the rest of the scan term
+describes a surrogate diagnostic message and the three tokens that follow
+are error-code, error-message and additional-information respectively; if
+the first token is \fBT\fR the rest is a normal scan term and two tokens
+that follow are the token itself and the number of occurrences; finally, if
+no scan term is available at the position, the empty string is returned.
+.SH "SEE ALSO"
+.BR ir-assoc "(n)" , " " ir-set "(n)"

diff --git a/doc/ir-set.n b/doc/ir-set.n
index 78896ea..0bf1e90 100644 (file)
--- a/doc/ir-set.n
+++ b/doc/ir-set.n
@@ -1,6 +1,6 @@
 .\" Copyright (c) 1995, 1996 Index Data
 .\" All rights reserved.
 .\" Copyright (c) 1995, 1996 Index Data
 .\" All rights reserved.

-.\" $Id: ir-set.n,v 1.1 1996-06-24 13:58:47 adam Exp $
+.\" $Id: ir-set.n,v 1.2 1996-06-24 16:24:39 adam Exp $

 .TH ir-set N  "24 June 1996" "IrTcl" "IR Set"
 .SH NAME
 ir-set \- IR  set
 .TH ir-set N  "24 June 1996" "IrTcl" "IR Set"
 .SH NAME
 ir-set \- IR  set

@@ -161,11 +161,18 @@ be extracted. The \fIspec\fR masks the GRS-1 tag at the first level
 second-level, and so on.
 Each \fIspec\fR has the format \fB(\fItag-set\fB,\fItag-value\fB)\fR, where
 \fItag-type\fR specifies the tag set and the \fItag-value\fR specifies the
 second-level, and so on.
 Each \fIspec\fR has the format \fB(\fItag-set\fB,\fItag-value\fB)\fR, where
 \fItag-type\fR specifies the tag set and the \fItag-value\fR specifies the

-tag value. The GRS-1 record is returned as a Tcl list. Each element consists
-of 5 elements: \fItag-set\fR, \fItag-type\fR, \fItag-value\fR,
-\fIdata-type\fR, \fIdata\fR. The \fItype-type\fR is either \fBnumeric\fR or
-\fBstring\fR. The \fIdata-type\fR is one of: \fBoctets\fR, \fBnumeric\fR,
+tag value.
+The GRS-1 record is returned as a Tcl list. Each element in the
+list consists of a list with 5 (sub) elements: \fItag-set\fR,
+\fItag-type\fR, \fItag-value\fR, \fIdata-type\fR, \fIdata\fR.
+The \fItype-type\fR is either \fBnumeric\fR or \fBstring\fR.
+The \fIdata-type\fR is one of: \fBoctets\fR, \fBnumeric\fR,

 \fBext\fR, \fBstring\fR, \fBbool\fR, \fBintUnit\fR, \fBempty\fR, 
 \fBext\fR, \fBstring\fR, \fBbool\fR, \fBintUnit\fR, \fBempty\fR, 

-\fBnotRequested\fR, \fBdiagnostic\fR or \fBsubtree\fR. 
+\fBnotRequested\fR, \fBdiagnostic\fR or \fBsubtree\fR.
+If \fIdata-type\fR is \fBnumeric\fR or \fBstring\fR then \fIdata\fR is
+encoded as a single Tcl token. The \fIdata-type\fR \fBbool\fR is encoded
+as 0 or 1 for false and true respectively. If the \fIdata-type\fR is
+\fBsubtree\fR the \fIdata\fR is a sub-list. In all other cases, the
+\fIdata\fR is the empty string.

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-.BR ir-assoc "(n)"
+.BR ir-assoc "(n)", " " ir-scan "(n)"

diff --git a/doc/ir-tcl.sgml b/doc/ir-tcl.sgml
index 6f8ea6b..f320d0b 100644 (file)
--- a/doc/ir-tcl.sgml
+++ b/doc/ir-tcl.sgml
@@ -1,14 +1,14 @@
 <!doctype linuxdoc system>
 
 <!--
 <!doctype linuxdoc system>
 
 <!--

-  $Id: ir-tcl.sgml,v 1.18 1996-02-21 15:55:00 quinn Exp $
+  $Id: ir-tcl.sgml,v 1.19 1996-06-24 16:24:39 adam Exp $

 -->
 
 <article>
 <title>IrTcl User's Guide and Reference 
 <author><htmlurl url="http://www.indexdata.dk/" name="Index Data">,
 <tt><htmlurl url="mailto:info@index.ping.dk" name="info@index.ping.dk"></tt>
 -->
 
 <article>
 <title>IrTcl User's Guide and Reference 
 <author><htmlurl url="http://www.indexdata.dk/" name="Index Data">,
 <tt><htmlurl url="mailto:info@index.ping.dk" name="info@index.ping.dk"></tt>

-<date>$Revision: 1.18 $
+<date>$Revision: 1.19 $

 <abstract>
 This document describes IrTcl -- an information retrieval toolkit for
 Tcl and Tk that provides access to the Z39.50/SR protocol.
 <abstract>
 This document describes IrTcl -- an information retrieval toolkit for
 Tcl and Tk that provides access to the Z39.50/SR protocol.

@@ -96,6 +96,11 @@ To install the programs and support files type:
 $ make install
 </verb></tscreen>
 
 $ make install
 </verb></tscreen>
 

+If you wish to install man pages type:
+<tscreen><verb>
+$ make install.man
+</verb></tscreen>
+

 Summary of files installed (the names refer to the Makefile variables):
 
 <descrip>
 Summary of files installed (the names refer to the Makefile variables):
 
 <descrip>

@@ -1141,7 +1146,7 @@ been created.
 <sect>License
 
 <p>
 <sect>License
 
 <p>

-Copyright &copy; 1995, Index Data.
+Copyright &copy; 1995-1996, Index Data.

 
 Permission to use, copy, modify, distribute, and sell this software and
 its documentation, in whole or in part, for any purpose, is hereby granted,
 
 Permission to use, copy, modify, distribute, and sell this software and
 its documentation, in whole or in part, for any purpose, is hereby granted,