mandb

   1 # manpath.config
   2 #
   3 # This file is used by the man-db package to configure the man and cat paths.
   4 # It is also used to provide a manpath for those without one by examining
   5 # their PATH environment variable. For details see the manpath(5) man page.
   6 #
   7 # Lines beginning with `#' are comments and are ignored. Any combination of
   8 # tabs or spaces may be used as `whitespace' separators.
   9 #
  10 # There are three mappings allowed in this file:
  11 # --------------------------------------------------------
  12 # MANDATORY_MANPATH                     manpath_element
  13 # MANPATH_MAP           path_element    manpath_element
  14 # MANDB_MAP             global_manpath  [relative_catpath]
  15 #---------------------------------------------------------
  16 # every automatically generated MANPATH includes these fields
  17 #
  18 #MANDATORY_MANPATH                      /usr/src/pvm3/man
  19 #
  20 MANDATORY_MANPATH                       /usr/man
  21 MANDATORY_MANPATH                       /usr/share/man
  22 MANDATORY_MANPATH                       /usr/local/share/man
  23 #---------------------------------------------------------
  24 # set up PATH to MANPATH mapping
  25 # ie. what man tree holds man pages for what binary directory.
  26 #
  27 #               *PATH*        ->        *MANPATH*
  28 #
  29 MANPATH_MAP     /bin                    /usr/share/man
  30 MANPATH_MAP     /usr/bin                /usr/share/man
  31 MANPATH_MAP     /sbin                   /usr/share/man
  32 MANPATH_MAP     /usr/sbin               /usr/share/man
  33 MANPATH_MAP     /usr/local/bin          /usr/local/man
  34 MANPATH_MAP     /usr/local/bin          /usr/local/share/man
  35 MANPATH_MAP     /usr/local/sbin         /usr/local/man
  36 MANPATH_MAP     /usr/local/sbin         /usr/local/share/man
  37 MANPATH_MAP     /usr/X11R6/bin          /usr/X11R6/man
  38 MANPATH_MAP     /usr/bin/X11            /usr/X11R6/man
  39 MANPATH_MAP     /usr/games              /usr/share/man
  40 MANPATH_MAP     /opt/bin                /opt/man
  41 MANPATH_MAP     /opt/sbin               /opt/man
  42 #---------------------------------------------------------
  43 # For a manpath element to be treated as a system manpath (as most of those
  44 # above should normally be), it must be mentioned below. Each line may have
  45 # an optional extra string indicating the catpath associated with the
  46 # manpath. If no catpath string is used, the catpath will default to the
  47 # given manpath.
  48 #
  49 # You *must* provide all system manpaths, including manpaths for alternate
  50 # operating systems, locale specific manpaths, and combinations of both, if
  51 # they exist, otherwise the permissions of the user running man/mandb will
  52 # be used to manipulate the manual pages. Also, mandb will not initialise
  53 # the database cache for any manpaths not mentioned below unless explicitly
  54 # requested to do so.
  55 #
  56 # In a per-user configuration file, this directive only controls the
  57 # location of catpaths and the creation of database caches; it has no effect
  58 # on privileges.
  59 #
  60 # Any manpaths that are subdirectories of other manpaths must be mentioned
  61 # *before* the containing manpath. E.g. /usr/man/preformat must be listed
  62 # before /usr/man.
  63 #
  64 #               *MANPATH*     ->        *CATPATH*
  65 #
  66 MANDB_MAP       /usr/man                /var/cache/man/fsstnd
  67 MANDB_MAP       /usr/share/man          /var/cache/man
  68 MANDB_MAP       /usr/local/man          /var/cache/man/oldlocal
  69 MANDB_MAP       /usr/local/share/man    /var/cache/man/local
  70 MANDB_MAP       /usr/X11R6/man          /var/cache/man/X11R6
  71 MANDB_MAP       /opt/man                /var/cache/man/opt
  72 MANDB_MAP       /snap/man               /var/cache/man/snap
  73 #
  74 #---------------------------------------------------------
  75 # Program definitions.  These are commented out by default as the value
  76 # of the definition is already the default.  To change: uncomment a
  77 # definition and modify it.
  78 #
  79 #DEFINE         pager   pager
  80 #DEFINE         cat     cat
  81 #DEFINE         tr      tr '\255\267\264\327' '\055\157\047\170'
  82 #DEFINE         grep    grep
  83 #DEFINE         troff   groff -mandoc
  84 #DEFINE         nroff   nroff -mandoc
  85 #DEFINE         eqn     eqn
  86 #DEFINE         neqn    neqn
  87 #DEFINE         tbl     tbl
  88 #DEFINE         col     col
  89 #DEFINE         vgrind  vgrind
  90 #DEFINE         refer   refer
  91 #DEFINE         grap    grap
  92 #DEFINE         pic     pic -S
  93 #
  94 #DEFINE         compressor      gzip -c7
  95 #---------------------------------------------------------
  96 # Misc definitions: same as program definitions above.
  97 #
  98 #DEFINE         whatis_grep_flags               -i
  99 #DEFINE         apropos_grep_flags              -iEw
 100 #DEFINE         apropos_regex_grep_flags        -iE
 101 #---------------------------------------------------------
 102 # Section names. Manual sections will be searched in the order listed here;
 103 # the default is 1, n, l, 8, 3, 0, 2, 3type, 5, 4, 9, 6, 7. Multiple SECTION
 104 # directives may be given for clarity, and will be concatenated together in
 105 # the expected way.
 106 # If a particular extension is not in this list (say, 1mh), it will be
 107 # displayed with the rest of the section it belongs to. The effect of this
 108 # is that you only need to explicitly list extensions if you want to force a
 109 # particular order. Sections with extensions should usually be adjacent to
 110 # their main section (e.g. "1 1mh 8 ...").
 111 #
 112 SECTION         1 n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7
 113 #
 114 #---------------------------------------------------------
 115 # Range of terminal widths permitted when displaying cat pages. If the
 116 # terminal falls outside this range, cat pages will not be created (if
 117 # missing) or displayed.
 118 #
 119 #MINCATWIDTH    80
 120 #MAXCATWIDTH    80
 121 #
 122 # If CATWIDTH is set to a non-zero number, cat pages will always be
 123 # formatted for a terminal of the given width, regardless of the width of
 124 # the terminal actually being used. This should generally be within the
 125 # range set by MINCATWIDTH and MAXCATWIDTH.
 126 #
 127 #CATWIDTH       0
 128 #
 129 #---------------------------------------------------------
 130 # Flags.
 131 # NOCACHE keeps man from creating cat pages.
 132 #NOCACHE
 133