cgal/Manual_tools/scripts

README for the Specification and Manual Writing Tools
       for C++ Reference Manuals
=====================================================
21.11.1996   Zurich   Lutz Kettner
06.05.1997   Zurich   Lutz Kettner

This is the directory containing small scripts around manual writing.
The directory structure is:

    README              this file.

    RCS/                revision controlled files.

    index_fix           a Perl script for postprocessing a .ind file generated
                        by makeindex.

    cc_ref_wizard       creates templates for reference pages.
    cc_ref_wizard_rc    example for a $HOME/.cc_ref_wizard_rc file.

    cc_make_ref_pages   creates a main.tex file for a reference
                        page directory.

The script cc_ref_wizard understands several environment variables and
it reads the config file '${HOME}/.cc_ref_wizard_rc' (in csh syntax).
See the script itself for more details.

Usage Message of cc_ref_wizard -h:
-----------------------------------------------------

Hi, I am the reference manual page wizard. I create a reference
manual page skeleton for you. I'll need to know the <category>
of page you want me to create and the <item-name>, e.g. the name
of the class, function, etc. you want to document. A third and
optional argument specifies the subdirectory where the header
file for the item  is located, e.g. IO for io related files.
The <category> can be one of:

    Class Concept Enum Function Macro Variable

cc_ref_wizard $Revision$ (c) Lutz Kettner
Usage: cc_ref_wizard [<options>] <category> <item-name> [<sub-dir>]
       -s <scope>       scope the item is in (suppresses prefix).
       -p <package>     name of the package the item belongs to.
       -o <outfile>     the output filename. Default: <item-name>.tex.
       -V               version number.
       -h               help message.


Usage Message of cc_make_ref_pages:
-----------------------------------------------------

Usage: cc_make_ref_pages <Package-dir>
       creates a file '<Package-dir>/main.tex' that will be the driver
       file for the reference manual chapter for <Package-dir>, i.e. it
       inputs '<Package-dir>/intro.tex' for the chapter intro and all
       tex files from <Package-dir> in alphabetical order thereafter.
       Creates also a file '<Package-dir>/html_main.tex' for the
       HTML online manual generation.

EOF