
bldmanual(1)                 Khoros                  bldmanual(1)

PROGRAM
     bldmanual - formats the file in the doc directory for the
     Khoros manual

SYNTAX
     bldmanual

     -i             input file

     -o             output file

     [-U]           Gives the usage for bldmanual

     [-P]           Prompts for command line options

     [-A [file1]]   Creates the answer file called bldmanual.ans
                    or file1

     [-a [file1]]   Uses bldmanual.ans or file1 as the answer
                    file

DESCRIPTION
     bldmanual is used to format files in the KHOROS_HOME/doc
     directory of the printed Khoros manual.  This is necessary
     because the files in the KHOROS_HOME/doc directory are used
     for both the printed Khoros manual and the on-line help.
     The primary functions of bldmanual are to expand the paths
     of .so lines in the .man files of the Khoros manual, and to
     pull in relevant documentation from the KHOROS_HOME/doc
     directories for generation of the Khoros manual.

     The way the automatic manual generation is explained as fol-
     lows:
          A chapter in the Khoros manual might be on cantata. In
          this case all the information about cantata is in
          KHOROS_HOME/doc/cantata. So to access that information
          for the manual, one would put .so lines in the chapter
          file in the floowing form:
               .so KHOROS_HOME/doc/cantata/Overview.doc

          When this chapter file is processed by bldmanual, (1)
          each .so line will be changed to look look like the
          following:
               .so /usr/khoros/doc/cantata/manual/Overview

          (2) The Overview.doc file will be processed and a ver-
          sion formatted for the Khoros manual will be placed in
          KHOROS_HOME/doc/cantata/manual; (3) another .so line
          will be added as the first line of the chapter file.
          This extra .so line includes the roff macro written for
          the Khoros manual. This file is located in
          KHOROS_HOME/doc/utils/tmac.manual. The resulting file
          from bldmanual can then be processed by a roff program.

     In order for bldmanual to work correctly, there must exist a
     sub-directory called manual in the directories that contain
     the .doc files, as explained above.

     Bldmanual is called by prnmanual for printing of the Khoros
     manual.  Prnmanual is an interactive script for assembling
     and printing the Khoros manual.  To print a Chapter of the
     Khoros manual, execute the prnmanual script.  Please see the
     man page on prnmanual for more information.

     In order to further understand the structure of the chapter
     file described above, one might look at a Khoros manual file
     located in KHOROS_HOME/manual.

REQUIRED ARGUMENTS
     -i     type: infile
            desc: input file

     -o     type: outfile
            desc: output file

OPTIONAL ARGUMENTS
     none

EXAMPLES
     bldmanual -i chapter.man -o chapter.ms

     This will take the chapter.man file and format the file so
     that it may be formated using roff.

SEE ALSO
     intro(1)

RESTRICTIONS
     All .so lines must begin with KHOROS_HOME/....

COPYRIGHT
     Copyright 1990, University of New Mexico. All rights
     reserved.

Khoros                    Release: 1.0                          1

