5 kx # man_db.conf
5 kx #
5 kx # This file is used by the man-db package to configure the man and cat paths.
5 kx # It is also used to provide a manpath for those without one by examining
5 kx # their PATH environment variable. For details see the manpath(5) man page.
5 kx #
5 kx # Lines beginning with `#' are comments and are ignored. Any combination of
5 kx # tabs or spaces may be used as `whitespace' separators.
5 kx #
5 kx # There are three mappings allowed in this file:
5 kx # --------------------------------------------------------
5 kx # MANDATORY_MANPATH manpath_element
5 kx # MANPATH_MAP path_element manpath_element
5 kx # MANDB_MAP global_manpath [relative_catpath]
5 kx #---------------------------------------------------------
5 kx # every automatically generated MANPATH includes these fields
5 kx #
5 kx #MANDATORY_MANPATH /usr/src/pvm3/man
5 kx #
5 kx MANDATORY_MANPATH /usr/man
5 kx MANDATORY_MANPATH /usr/share/man
5 kx MANDATORY_MANPATH /usr/local/man
5 kx MANDATORY_MANPATH /usr/local/share/man
5 kx MANDATORY_MANPATH /opt/man
5 kx
5 kx #---------------------------------------------------------
5 kx # set up PATH to MANPATH mapping
5 kx # ie. what man tree holds man pages for what binary directory.
5 kx #
5 kx # *PATH* -> *MANPATH*
5 kx #
5 kx MANPATH_MAP /bin /usr/share/man
5 kx MANPATH_MAP /usr/bin /usr/share/man
5 kx MANPATH_MAP /sbin /usr/share/man
5 kx MANPATH_MAP /usr/sbin /usr/share/man
5 kx MANPATH_MAP /usr/local/bin /usr/local/man
5 kx MANPATH_MAP /usr/local/bin /usr/local/share/man
5 kx MANPATH_MAP /usr/local/sbin /usr/local/man
5 kx MANPATH_MAP /usr/local/sbin /usr/local/share/man
5 kx MANPATH_MAP /usr/X11R6/bin /usr/X11R6/man
5 kx MANPATH_MAP /usr/bin/X11 /usr/X11R6/man
5 kx MANPATH_MAP /usr/games /usr/share/man
5 kx MANPATH_MAP /opt/bin /opt/man
5 kx MANPATH_MAP /opt/sbin /opt/man
5 kx MANPATH_MAP /usr/lib/java/bin /usr/lib/java/man
5 kx
5 kx #---------------------------------------------------------
5 kx # For a manpath element to be treated as a system manpath (as most of those
5 kx # above should normally be), it must be mentioned below. Each line may have
5 kx # an optional extra string indicating the catpath associated with the
5 kx # manpath. If no catpath string is used, the catpath will default to the
5 kx # given manpath.
5 kx #
5 kx # You *must* provide all system manpaths, including manpaths for alternate
5 kx # operating systems, locale specific manpaths, and combinations of both, if
5 kx # they exist, otherwise the permissions of the user running man/mandb will
5 kx # be used to manipulate the manual pages. Also, mandb will not initialise
5 kx # the database cache for any manpaths not mentioned below unless explicitly
5 kx # requested to do so.
5 kx #
5 kx # In a per-user configuration file, this directive only controls the
5 kx # location of catpaths and the creation of database caches; it has no effect
5 kx # on privileges.
5 kx #
5 kx # Any manpaths that are subdirectories of other manpaths must be mentioned
5 kx # *before* the containing manpath. E.g. /usr/man/preformat must be listed
5 kx # before /usr/man.
5 kx #
5 kx # *MANPATH* -> *CATPATH*
5 kx #
5 kx MANDB_MAP /usr/man /var/cache/man/usr-man
5 kx MANDB_MAP /usr/share/man /var/cache/man/usr-share-man
5 kx MANDB_MAP /usr/local/man /var/cache/man/usr-local-man
5 kx MANDB_MAP /usr/local/share/man /var/cache/man/usr-local-share-man
5 kx MANDB_MAP /usr/X11R6/man /var/cache/man/usr-X11R6-man
5 kx MANDB_MAP /opt/man /var/cache/man/opt-man
5 kx MANDB_MAP /snap/man /var/cache/man/snap-man
5 kx MANDB_MAP /usr/lib/java/man /var/cache/man/usr-lib-java-man
5 kx
5 kx #---------------------------------------------------------
5 kx # Program definitions. These are commented out by default as the value
5 kx # of the definition is already the default. To change: uncomment a
5 kx # definition and modify it.
5 kx #
5 kx #DEFINE pager less
5 kx #DEFINE cat cat
5 kx #DEFINE tr tr '\255\267\264\327' '\055\157\047\170'
5 kx #DEFINE grep grep
5 kx #DEFINE troff groff -mandoc
5 kx #DEFINE nroff nroff -mandoc
5 kx #DEFINE eqn eqn
5 kx #DEFINE neqn neqn
5 kx #DEFINE tbl tbl
5 kx #DEFINE col col
5 kx #DEFINE vgrind
5 kx #DEFINE refer refer
5 kx #DEFINE grap
5 kx #DEFINE pic pic -S
5 kx #
5 kx #DEFINE compressor gzip -c7
5 kx #---------------------------------------------------------
5 kx # Misc definitions: same as program definitions above.
5 kx #
5 kx #DEFINE whatis_grep_flags -i
5 kx #DEFINE apropos_grep_flags -iEw
5 kx #DEFINE apropos_regex_grep_flags -iE
5 kx #---------------------------------------------------------
5 kx # Section names. Manual sections will be searched in the order listed here;
5 kx # the default is 1, n, l, 8, 3, 0, 2, 5, 4, 9, 6, 7. Multiple SECTION
5 kx # directives may be given for clarity, and will be concatenated together in
5 kx # the expected way.
5 kx # If a particular extension is not in this list (say, 1mh), it will be
5 kx # displayed with the rest of the section it belongs to. The effect of this
5 kx # is that you only need to explicitly list extensions if you want to force a
5 kx # particular order. Sections with extensions should usually be adjacent to
5 kx # their main section (e.g. "1 1mh 8 ...").
5 kx #
5 kx SECTION 1 n l 8 3 0 2 5 4 9 6 7
5 kx #
5 kx #---------------------------------------------------------
5 kx # Range of terminal widths permitted when displaying cat pages. If the
5 kx # terminal falls outside this range, cat pages will not be created (if
5 kx # missing) or displayed.
5 kx #
5 kx #MINCATWIDTH 80
5 kx #MAXCATWIDTH 80
5 kx #
5 kx # If CATWIDTH is set to a non-zero number, cat pages will always be
5 kx # formatted for a terminal of the given width, regardless of the width of
5 kx # the terminal actually being used. This should generally be within the
5 kx # range set by MINCATWIDTH and MAXCATWIDTH.
5 kx #
5 kx #CATWIDTH 0
5 kx #
5 kx #---------------------------------------------------------
5 kx # Flags.
5 kx # NOCACHE keeps man from creating cat pages.
5 kx NOCACHE