config_help(1M)


config_help -- perform documentation integration functions on topicIDs

Synopsis

/usr/man/bin/config_help [ -L LANG ] [ -n ] [topicID . . .]

Description

The config_help script examines the documentation distribution files in the given topicID directories or, if no topicID is specified, on the entire set of topicID directories, and then constructs the necessary files that connect the documentation into the SCOhelp system. See also config_man(1M).

If the -L option is specified, the processes are run on the given language (LANG); otherwise all language versions are processed. For example, the following command runs config_help on all the topicID directories under the es (Spanish language) directory:

config_help -L es

If the -n option is specified, all processing takes place except the final full-text indexing step. The bulk insert files are generated and placed in /usr/lib/scohelp/LANG/_SearchIndex/Insert, ready to be indexed, but the bulk insert process is not performed. This permits several documentation packages to be processed before running the (sometimes lengthy) indexing process on the whole set.


NOTE: If the -n option is not specified, config_help runs config_search(1M) automatically.

The installation script should always run the last call to config_help without the -n option so the new documentation files get indexed.

Run config_help whenever new documentation packages are installed, updated, or removed. Run config_views(1M) after config_help to process the view stanza files and update the appropriate view pages.

config_help performs the following actions:

For each topicID, config_help creates the following files:

When a documentation package is removed, the removal script should delete only the files that it installed. (The ODSSI-generated .titles and CONTENTS.html files prevent the removal script from removing the directory.) After the removal script removes the files it installed, the script should run config_help on the topicID; config_help detects that there are no other files and removes the .titles and CONTENTS.html files, as well as the topicID directory. config_help also moves the topicID.vbi file to the _SearchIndex/Delete directory and runs config_search (if the -n option is not specified) to remove the index entries from the search databases. The removal script should also run config_views to remove the topicID from the views.

The configuration works from whatever material is installed when the script is run. As such, it works for new installation, updates, and removals. The processes are repeatable, so processing material that has already been processed does not result in error. The scripts can be run again on the same installed material and produce the same results.

Files

/usr/man/bin/config_help
topic documentation integration script

Exit codes

0 on success
1 on failure

 
 0   on success 
 1   on failure 

Diagnostics

Support tools not found in /usr/man/bin 
Make sure the ODSSI tools (in the ``base'' package) are installed on your system.
Cannot find documentation directory: /usr/lib/scohelp 
Make sure that /usr/lib/scohelp exists on your system.
Cannot configure documentation: permission denied: /usr/lib/scohelp 
Make sure that /usr/lib/scohelp is writable by root.
No documentation for language: LANG 
Make sure there are documentation files under /usr/lib/scohelp/LANG.

References

config_man(1M), config_search(1M), config_views(1M)

``Adding documents to the help system''


30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.