next up previous contents
Next: User documentation Up: The SMART self-documentation Previous: Interpreting a SMART man

Some useful SMART actions

donalde$ docsmart inter
DESCRIPTION:
Local hierarchy table giving interactive top level procedures

FULL DESCRIPTION:
Procedure table mapping a string procedure name to procedure addresses.
As top-level procedures, these procedures are responsible for setting
trace conditions, and for determining other execution time constraints,
such as when execution should stop (eg, if global_end is exceeded).
These procedures are the main user interactive procedures, with all
sorts of user-level commands available.
Return UNDEF if error, else 1.

donalde$ docsmart print
DESCRIPTION:
Top level procedure to print object in to file out via procedure proc

FULL DESCRIPTION:
A top-level entry point to print one object into the file out.
The procedure "proc" will be called by proc (in, out, inst),
and will know how to interpret the names "in" and "out".
If "out" is not a valid file name (eg "-") then print to stdout.

donalde$ docsmart proc 
DESCRIPTION:
print entire procedure hierarchy

FULL DESCRIPTION:
Print the entire procedure hierarchy.
Output to go into file "out_file" (if not VALID_FILE, then stdout).

donalde$ docsmart convert
DESCRIPTION:
Top level procedure to convert object in to object out via procedure proc

FULL DESCRIPTION:
A top-level entry point to enable the conversion of one object into
another.  The procedure "proc" will be called by proc (in, out, inst),
and will know how to interpret the names "in" and "out".

donalde$ docsmart retrieve
DESCRIPTION:
Match whole query versus doc collection using inverted search

FULL DESCRIPTION:
Take a vector query given by in_retrieval, and match it against every
document in doc_file in turn, calling a ctype dependant matching
function given by the procedure index.ctype.N.inv_sim for ctype N.
The similarity of all docs to the query is returned in
results->full_results.  The top similarities are kept track of by
inv_sim and are returned in results->top_results.
Return UNDEF if error, else 1.

donalde$ docsmart index.doc
DESCRIPTION:
index a document vector given its text location

FULL DESCRIPTION:
Get a preparsed text (via preparse) from the text indicated by textdisp.
Then index that preparsed text obtaining a vector vec using the
procedure indicated by index_pp.
Return UNDEF if error, else 1



Christian Meunier
1999-05-02