Penguin
Recent Changes
Annotated edit history of manpath(5) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 manpath
2 !!!manpath
3 NAME
4 DESCRIPTION
5 FORMAT
6 BUGS
7 ----
8 !!NAME
9
10
11 manpath - format of the /etc/manpath.config file
12 !!DESCRIPTION
13
14
15 The manpath configuration file is used by the manual page
16 utilities to assess users' manpaths at run time, to indicate
17 which manual page hierarchies (manpaths) are to be treated
18 as system hierarchies and to assign them directories to be
19 used for storing cat files.
20
21
22 If the environment variable $__MANPATH__ is already set,
23 the information contained within /etc/manpath.config will
24 not override it.
25 !!FORMAT
26
27
28 The following field types are currently
29 recognised:
30
31
32 __#__ ''comment''
33
34
35 Blank lines or those beginning with a __#__ will be
36 treated as comments and ignored.
37
38
39 __MANDATORY_MANPATH__ ''manpath_element''
40
41
42 Lines of this form indicate manpaths that every
43 automatically generated $__MANPATH__ should contain. This
44 will typically include ''/usr/man''.
45
46
47 __MANPATH_MAP__ ''path_element
48 manpath_element''
49
50
51 Lines of this form set up $__PATH__ to $__MANPATH__
52 mappings. For each ''path_element'' found in the user's
53 $__PATH__, ''manpath_element'' will be added to the
54 $__MANPATH__.
55
56
57 __MANDB_MAP__ ''manpath_element'' [[
58 ''catpath_element'' ]
59
60
61 Lines of this form indicate which manpaths are to be treated
62 as system manpaths, and optionally where their cat files
63 should be stored. This field type is particularly important
64 if __man__ is a setuid program, as (when in the system
65 configuration file /etc/manpath.config rather than the
66 per-user configuration file .manpath) it indicates which
67 manual page hierarchies to access as the setuid user and
68 which as the invoking user.
69
70
71 The system manual page hierarchies are usually those stored
72 under ''/usr'' such as ''/usr/man'',
73 ''/usr/local/man'' and
74 ''/usr/X11R6/man''.
75
76
77 If cat pages from a particular ''manpath_element'' are
78 not to be stored or are to be stored in the traditional
79 location, ''catpath_element'' may be
80 omitted.
81
82
83 Traditional cat placement would be impossible for read only
84 mounted manual page hierarchies and because of this it is
85 possible to specify any valid directory hierarchy for their
86 storage. To observe the __Linux FSSTND__ the keyword
87 `__FSSTND__ can be used in place of an actual
88 directory.
89
90
91 Unfortunately, it is necessary to specify __all__ system
92 man tree paths, including alternate operating system paths
93 such as ''/usr/man/sun'' and any __NLS locale__ paths
94 such as ''/usr/man/de_DE.88591''.
95
96
97 As the information is parsed line by line in the order
98 written, it is necessary for any manpath that is a
99 sub-hierarchy of another hierarchy to be listed first,
100 otherwise an incorrect match will be made. An example is
101 that ''/usr/man/de_DE.88591'' must come before
102 ''/usr/man''.
103
104
105 __DEFINE__ ''key value''
106
107
108 Lines of this form define miscellaneous configuration
109 variables; see the default configuration file for those
110 variables used by the manual pager utilities. They include
111 default paths to various programs (such as ''grep'' and
112 ''tbl''), and default sets of arguments to those
113 programs.
114 !!BUGS
115
116
117 Unless the rules above are followed and observed precisely,
118 the manual pager utilities will not function as desired. The
119 rules are overly complicated.
120 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.