If the -L option is specified,
the processes are run on the given language (LANG);
otherwise all language versions are processed.
If LANG is not English, the processes are also
run on the topicID directories in the en_US.ISO8859-1
hierarchy.
For example, the following command runs config_man on
all the topicID directories under the es
(Spanish language) and en_US.ISO8859-1 (English language)
directories:
config_man -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.
The installation script should always run the last call to config_man without the -n option so the new man pages get indexed.
Use -d mandir to specify the location of the man directory if the man pages are not installed in the default /usr/lib/scohelp/en_US.ISO8859-1/man directory (linked to /usr/man). For example, -d /usr/local/man.
Because config_man must be run to include manual pages in the index, whatis and search databases, run this script whenever new man pages or man page packages are installed.
Run config_views(1M) after config_man to process the view stanza files and update the REFhome.html manual page section list.
The config_man script performs the following actions for man sections:
For each mansection installed, config_man creates the following files:
In addition, config_man also merges the man/.SectionData/index files into the master man/index file, and combines the man/.SectionData/whatis files into the master man/whatis file.
When a man page or man page package is removed, the removal script should delete only the files that it installed. After the removal script removes the files it installed, the script should run config_man and config_views. The config_man script updates the files in the .SectionData directories to reflect which man pages and sections are left on the system and also moves the man.mansection.vbi file to the _SearchIndex/Delete directory. The config_man script also runs config_search automatically (if the -n option is not specified) to remove the index entries from the search databases. The config_views script removes the man pages or man page sections from the views.
If, after removing man pages or man page packages, there are no man pages left on the system, config_man removes the .SectionData and master index and whatis files.
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.
0 | on success |
1 | on failure |
Support tools not found in /usr/man/binMake sure the ODSSI tools (in the ``base'' package) are installed on your system.
No such directory: $DoptMake sure that the directory you specified (instead of /usr/lib/scohelp) exists.
Cannot find documentation directory: /usr/lib/scohelpMake sure that /usr/lib/scohelp exists on your system.
Cannot configure documentation: permission denied: /usr/lib/scohelpMake sure that /usr/lib/scohelp is writable by root.
No manual pages for language: LANGMake sure there are documentation files under /usr/lib/scohelp/LANG.
``Adding documents to the help system''