Bump version to 1.4.3

[ir-tcl-moved-to-github.git] / doc / ir-set.n

diff --git a/doc/ir-set.n b/doc/ir-set.n
index 78896ea..74f0a73 100644 (file)
--- a/doc/ir-set.n
+++ b/doc/ir-set.n
@@ -1,7 +1,7 @@
-.\" Copyright (c) 1995, 1996 Index Data
+.\" Copyright (c) 1995-2004 Index Data
 .\" All rights reserved.
-.\" $Id: ir-set.n,v 1.1 1996-06-24 13:58:47 adam Exp $
-.TH ir-set N  "24 June 1996" "IrTcl" "IR Set"
+.\" $Id: ir-set.n,v 1.6 2004-04-26 09:09:06 adam Exp $
+.TH ir-set n  "24 June 1996" "IrTcl" "IR Set"
 .SH NAME
 ir-set \- IR  set
 .SH SYNOPSIS
@@ -25,7 +25,8 @@ Operations that are used to search a target:
 Sets the database(s) to be used in the following search request(s).
 .TP
 .BI "" zs " setName [" name "]"
-Sets/gets the name of the result-set to be (re)searched.
+Sets/gets the name of the result-set to be (re)searched. default name
+of result-set is \fBdefault\fR.
 .TP
 .BI "" zs " replaceIndicator [" b "]"
 Sets/gets the replace-indicator as 0 (false) or 1 (true); default is
@@ -139,7 +140,7 @@ Two special operators are supported:
 the \fB?\fR operator matches exactly one character;
 the \fB*\fR operator matches the whole item (don't care).
 The format of the data returned is determined by the \fItype\fR argument.
-If \fItype\fR is \fBfield\fR the matcing part of the record is returned
+If \fItype\fR is \fBline\fR the matcing part of the record is returned
 as a list of MARC tag specifications. Each MARC tag specification item
 consists of three elements: tag, indicator and field-list. The field-list
 part is a list of field specifications. Each field specification is a tuple
@@ -153,6 +154,11 @@ Returns the SUTRS record at the given \fIposition\fR as a single
 string token. If the record at the position is not present or is not a
 SUTRS record an error is returned.
 .TP
+.BI "" zs " getXml " position
+Returns the XML record at the given \fIposition\fR as a single
+string token. If the record at the position is not present or is not a
+XML record an error is returned.
+.TP
 .BI "" zs " getGrs " position " [" spec " " spec " " ... "]"
 Extracts information about the GRS-1 record at the specified \Iposition\fR.
 The \fIspec\fR arguments determine the parts of the GRS-1 record to
@@ -161,11 +167,22 @@ 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
-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, 
-\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.
+.TP
+.BI "" zs " getExplain " position " [" pattern " " pattern " " ... "]"
+The Explain record on the specified position is returned. See the
+manual for a detailed explanation.
 .SH "SEE ALSO"
-.BR ir-assoc "(n)"
+.BR ir-assoc "(n)", " " ir-scan "(n)"