| blob | a6e380f66cecd6a776df4c5aff5336587f9f3350 |
1 # man_db.conf
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 #
73 #---------------------------------------------------------
74 # Program definitions. These are commented out by default as the value
75 # of the definition is already the default. To change: uncomment a
76 # definition and modify it.
77 #
78 #DEFINE pager less
79 #DEFINE cat cat
80 #DEFINE tr tr '\255\267\264\327' '\055\157\047\170'
81 #DEFINE grep grep
82 #DEFINE troff groff -mandoc
83 #DEFINE nroff nroff -mandoc
84 #DEFINE eqn eqn
85 #DEFINE neqn neqn
86 #DEFINE tbl tbl
87 #DEFINE col col
88 #DEFINE vgrind
89 #DEFINE refer refer
90 #DEFINE grap
91 #DEFINE pic pic -S
92 #
93 #DEFINE compressor gzip -c7
94 #---------------------------------------------------------
95 # Misc definitions: same as program definitions above.
96 #
97 #DEFINE whatis_grep_flags -i
98 #DEFINE apropos_grep_flags -iEw
99 #DEFINE apropos_regex_grep_flags -iE
100 #---------------------------------------------------------
101 # Section names. Manual sections will be searched in the order listed here;
102 # the default is 1, n, l, 8, 3, 0, 2, 5, 4, 9, 6, 7. Multiple SECTION
103 # directives may be given for clarity, and will be concatenated together in
104 # the expected way.
105 # If a particular extension is not in this list (say, 1mh), it will be
106 # displayed with the rest of the section it belongs to. The effect of this
107 # is that you only need to explicitly list extensions if you want to force a
108 # particular order. Sections with extensions should usually be adjacent to
109 # their main section (e.g. "1 1mh 8 ...").
110 #
111 SECTION 1 1p 8 2 3 3p 4 5 6 7 9 0p tcl n l p o 1x 2x 3x 4x 5x 6x 7x 8x
112 #
113 #---------------------------------------------------------
114 # Range of terminal widths permitted when displaying cat pages. If the
115 # terminal falls outside this range, cat pages will not be created (if
116 # missing) or displayed.
117 #
118 #MINCATWIDTH 80
119 #MAXCATWIDTH 80
120 #
121 # If CATWIDTH is set to a non-zero number, cat pages will always be
122 # formatted for a terminal of the given width, regardless of the width of
123 # the terminal actually being used. This should generally be within the
124 # range set by MINCATWIDTH and MAXCATWIDTH.
125 #
126 #CATWIDTH 0
127 #
128 #---------------------------------------------------------
129 # Flags.
130 # NOCACHE keeps man from creating cat pages.
131 NOCACHE