next up previous contents
Next: Some useful SMART actions Up: The SMART self-documentation Previous: Using the docsmart documentation

Interpreting a SMART man page

Let's say you want to want to use the 'print' SMART action, but dont know how to use it. You fire up docsmart, and ask:

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

PROCEDURE:
print (unused1, unused2, inst)
  char *unused1;
  char *unused2;
  int inst;
init_print (spec, unused)
close_print(inst)

HIERARCHY:
print.print.print

USES:
  "print.proc"
  "print.in"
  "print.out"
  "print.trace"

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.

ALGORITHM:

BUGS AND WARNINGS:

---8<---snip---8<---

This page tell you that the print function is contained in the print.print.* hierarchy. The function itself is used to print a single object to the output.

The parameters to the function refer to the parameters sent to the print() function, and are a set of three standard parameters that any function in the hierarchy can accept. Each function uses its parameter in a context-defined way, and any value passed is correct as long as the caller and callee agree on the meaning of the parameter.

The Uses section of the docsmart man page describes the values of the spec file that can be consulted by the function as part of its work.



Christian Meunier
1999-05-02