pman

Finds and displays reference manual pages.

Synopsis

pman [-M path] operator_name ... pman [-M path] -k keyword ...

Description

pman displays information about Pandore operators from the reference manuals. It displays complete manual pages about an operator selected by name, or one-line summaries for several operators selected by keyword.

Manual pages must be HTML files and must be included in a subdirectory named operatorPxx where xxx is a number. For example /usr/local/operatorP0.

Parameters

-k keyword ... prints out one-line summaries from the table of contents of Pandore.
-M directory specifies an alternate search path for manual path. Manual pages are searched for the directory directory/operatorsPxxx and keywords are searched for the file directory/operatorPxx.html.

Inputs

operator_name: the name of a Pandore operator.

Result

No result value.

Examples

Display manual page about the operator "pman":
```
   pman pman
```
Display all operators that deal with word "segmentation":
```
   pman -k segmentation
```
Display manual page about the local operator "pfoo" located in the "/usr/local/myoperators/doc" directory:
```
   pman -M /usr/local/myoperators/doc pfoo
```