Use memset rather than bzero (obsolete, and sometimes unavailable).

[pazpar2-moved-to-github.git] / PROTOCOL

diff --git a/PROTOCOL b/PROTOCOL
index 5e3ad07..2608c38 100644 (file)
--- a/PROTOCOL
+++ b/PROTOCOL
@@ -109,17 +109,40 @@ Output:
   <start>0</start>
   <num>2</num>
   <hit>
-    <title>How to program a computer, by Jack Collins</title>
+    <md-title>How to program a computer, by Jack Collins</md-title>
     <count>2</count> <!-- Number of merged records -->
+    <recid>6</recid>
   </hit>
   <hit>
-    <title>
+    <md-title>
   Computer processing of dynamic images from an Anger scintillation camera :
   the proceedings of a workshop /
-    </title>
+    </md-title>
+    <recid>2</recid>
   </hit>
 </show>
 
+record
+
+Retrieves a detailed record.
+
+Parameters: id -- record ID as provided by the show command
+
+Example:
+
+search.pz2?session=605047297&command=record&id=3
+
+Example output:
+
+<record>
+  <md-title>
+       The Puget Sound Region : a portfolio of thematic computer maps /
+  </md-title>
+  <md-date>1974</md-date>
+  <md-author>Mairs, John W.</md-author>
+  <md-subject>Cartography</md-subject>
+</record>
+
 termlist
 
 Retrieves term list(s)
@@ -142,7 +165,7 @@ Output:
       <name>Donald Knuth</name>
       <frequency>10</frequency>
     </term>
-    <term>
+      <term>
       <name>Robert Pirsig</name>
       <frequency>2</frequency>
     </term>
@@ -154,3 +177,16 @@ Output:
     </term>
   </list>
 </termlist>
+
+For the special termlist name "xtargets", results are returned about the targets
+which have returned the most hits. The 'term' subtree has additional elements,
+specifically a state and diagnostic field (in the example below, a target ID is
+returned in place of 'name'. This may or may not change later.
+
+<term>
+  <name>library2.mcmaster.ca</name>
+  <frequency>11734</frequency>
+  <state>Client_Idle</state>
+  <diagnostic>0</diagnostic>
+</term>
+