How man sections are processed

Depending on how much metadata is supplied for a topic or book, the ODSSI tools perform the following actions (from the area where the man pages being processed are installed):

1. Consider all man file formats. For each SECTION name and LANG (language code) to be processed, determine which of the following directories are present:

   • LANG/man/html.SECTION

   • LANG/man/man.SECTION

   • LANG/man/cat.SECTION

   The ODSSI tools perform this for each directory in /usr/lib/scohelp/LANG/man

2. Based on the files that exist in such directories, generate a list of all files with names of the form *.SECTION.*. These constitute the collection of man pages for that section in that language.

3. Locate, merge, and sort files with names of the form *.node and place them in the appropriate titles directory For example, man/.SectionData/titles/1M.

   ---

   NOTE: Some directories do not contain .node metadata files; in this case, the tools will extract default data from the filenames and content.

   ---

4. From the .titles file, create a man index file and a man whatis file for each section. The tools place these files in the appropriate directories; for example man/.SectionData/index/1M and man/.SectionData/whatis/1M.

   For languages other than English, if a man page name exists in English but not the native language, the English name is added to the index and whatis files for the native language. This ensures that a complete set of man pages are accessible for any LANG setting, even if some are not in the native languages.

5. Merge the section index files into a single man index file and place it in /usr/lib/scohelp/LANG/man/index.

6. Merge the section whatis files into a single man whatis file and place it in /usr/lib/scohelp/LANG/man/whatis.

7. Generate a CONTENTS.html file for the section. This file contains an entry for each Name and SubName metadata entry, sorted alphabetically. Each entry in the table of contents is in a <DL> list:

   <DT><A HREF=/cgi-bin/man/man?name+section TARGET="node">name</A><DD>
   

   For languages other than English, if a man page name exists in English but not the native language, the English name is added to the CONTENTS.html file for the native language. This ensures that a complete set of man pages are accessible for any LANG setting.

8. Generate a bulk insert file for the Verity search engine.

9. Run the bulk insert process to update the search indexes.