Distributed applications
Home | Packages | Files | Procedures | Classes | Keywords | External packages
Two applications are distributed, autodoc and tkautodoc.
The difference between them is that autodoc starts scanning immediately,tkautodoc on the other hand pops up a graphical interface, allowing for
interactive redefinition of all options before start.
General invocation of both is as (tk)autodoc ?-option value?....
Recognized options are:
- -v
- Possible values are 0 and 1. If set to 1 the values of all
options are written to stdout. Defaults to 0.
- -srcdir
- The directory containing the distribution to be documented.
Defaults to the current working directory.
- -htmldir
- The directory to write the generated HTML pages into. Defaults
to subdirectory 'html' of the current working directory. Will
be made, if not in existence already.
- -tables
- Possible values are 0 and 1. Has effect only if the distribution
contains '.doc'-files generating additional pages. Influences the
layout of the homepage. If set to 1 distribution description and
links to the additional pages are placed side by side. Otherwise
the additional links are placed below the description. Defaults
to 0.
- -replyaddr
- The mail-address used at the bottom of every page. Defaults to [logname]@[info hostname]. 'logname' is defined
in the package Pool_Base.
- -psort
- Possible values are 0 and 1. Determines wether procedure/method
definitions of a file/class are written alphabetically sorted (1),
or in the order encountered during the scan (0). Defaults to 1.
- -ptable
- Possible values are 0 and 1. Determines wether procedure/method
definitions of a file/class are written as table (1) or definition
list (0). Defaults to 1.
Both applications read the file '.autodocrc' in the home directory of the
caller, if present, and incorporate any option-values defined in it.
These definitions take precedence over the hardwired defaults, but can be
overridden by the command line.
Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries