X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Fir-set.n;h=2e10d3c5e4b57c6f016fd15cace3a1f38fa347dd;hb=c3b761ad33e5eeb44ed15adb7765157560776037;hp=0bf1e90fcb4bde7016345c9c5e2c8daca976c921;hpb=0d087b0c2c1f3eff36fad7f1e78e2b8438ea7258;p=ir-tcl-moved-to-github.git diff --git a/doc/ir-set.n b/doc/ir-set.n index 0bf1e90..2e10d3c 100644 --- a/doc/ir-set.n +++ b/doc/ir-set.n @@ -1,6 +1,6 @@ .\" Copyright (c) 1995, 1996 Index Data .\" All rights reserved. -.\" $Id: ir-set.n,v 1.2 1996-06-24 16:24:39 adam Exp $ +.\" $Id: ir-set.n,v 1.4 1997-04-13 19:01:44 adam Exp $ .TH ir-set N "24 June 1996" "IrTcl" "IR Set" .SH NAME ir-set \- IR set @@ -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 @@ -174,5 +175,9 @@ 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)", " " ir-scan "(n)"