man/man4/mangen.4

   1 .TH mangen 4 "" "ALICE Reference Manual"
   2 .ad b
   3 .SH NAME
   4 mangen - generate manual entries for library
   5 .SH SYNOPSIS
   6 mangen [-d] [-n] [-l] chapter file
   7
   8 .SH DESCRIPTION
   9 generates:    <name>.<chapter#>  (manual entry for module)
  10 and if "-l":  <name>.<chapter#+1> (manual entries for each routine)
  11
  12 where <name> is the "root" of the "tail" of the specified file
  13 (i.e. if file="/usr/dave/gronk.c", then name="gronk");
  14 and <chapter#> is the single digit chapter number
  15 (i.e. just the specified chapter number if one was given,
  16 or the number from the table below if a chapter name was given).
  17
  18 <chapter> can be any digit or any of the following chapter abbreviations:
  19
  20  #  abbr   name        what
  21  =  ====   =========== ====================================
  22  0  con*
  23     over*  conventions - conventions and overview material
  24  1  lib*   libraries   - subroutine library summaries
  25  2         routines    - individual library routines
  26  3  task*
  27     tsk*
  28     dr*    drivers     - tasks and drivers
  29  4  tool*  tools       - Unix development/maintenence tools
  30
  31 .SH NOTE
  32 Specifying the chapter as "lib" automatically selects the -l option.
  33
  34 "-l" flag causes a special library module style manual entry to be created.
  35 The manual entry for a library has a specially constructed synopsis section
  36 that contains the titles and calling sequence of each routine in the library.
  37 Also a seperate manual entry is generated for each of the routines in the
  38 library.  These routine manual entries will be put in a file named libxxx.2.
  39
  40 "-d" flag causes the intermediate nroff source files to NOT be deleted.
  41 These are called "mg.out" and "mgr.out" for the module manual entry
  42 and individual routine entries (only if -l option specified), respectively.
  43 This option is useful for debugging manual entries that don't look the
  44 way you expected.
  45
  46 "-n" flag causes nroff sources not to be deleted, and not to be nroffed
  47 either.  In this case, "mg.out" (and "mgr.out") will be the ONLY output
  48 from mangen.
  49
  50 .SH EXAMPLE
  51       % mangen lib /usr/vw/lib/lstlib.c
  52 will create "lstlib.1" and "liblst.2" in the current directory.