Adding documents to the help system

Running ODSSI scripts

Documentation for UnixWare 7 is installed using the standard pkgadd(1M) utility. After the files are copied into place, the documentation package installation scripts for help material or man sections call the ODSSI (Online Documentation System Services Interface) scripts to integrate the documentation into the SCOhelp online documentation system.

These scripts are:

config_help(1M)
Performs documentation integration functions on topicIDs. The documentation package installation or removal script should run the config_help script when installing or removing help material.

config_man(1M)
Performs documentation integration functions on manual page sections. The documentation package installation or removal script should run the config_man script when installing or removing manual page sections.

NOTE: You must run config_man on your man pages, regardless of the format (HTML, man macro, or cat (preformatted ASCII)).

config_search(1M)
Manually runs the bulk insert indexing process on any remaining bulk insert files generated by config_man or config_help. This script is normally run automatically by those scripts unless the -n option is used to defer indexing.

config_views(1M)
Regenerates the set of view files. The documentation package installation or removal script should run the config_views script after running config_help(1M) or config_man(1M).

To call these scripts in your documentation package installation or removal script, use the following commands:

NOTE: Make sure that you run config_views after running config_help and config_man.

By default, the scripts process all documentation in all languages, even those not in the current installation package. See the respective manual pages for options to control which languages, topics, or man sections are processed. If some documentation was installed earlier and the ODSSI scripts were not run at that time, that documentation will be included in the processing the next time the scripts are run without options.

The actions are repeatable; that is, the scripts can be run again on the same installed material and produce the same results.

© 1999 The Santa Cruz Operation, Inc. All rights reserved.
UnixWare 7 Release 7.1.1 - 5 November 1999