Penguin
Recent Changes
Annotated edit history of manpath(1) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 manpath
2 !!!manpath
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 ENVIRONMENT
8 FILES
9 SEE ALSO
10 AUTHOR
11 ----
12 !!NAME
13
14
15 manpath - determine search path for manual pages
16 !!SYNOPSIS
17
18
19 __manpath__ [[__-qgdc__] [[__-m__
20 ''system''[[,...]]
21 !!DESCRIPTION
22
23
24 If $__MANPATH__ is set, __manpath__ will simply
25 display its contents and issue a warning. If not,
26 __manpath__ will determine a suitable manual page
27 hierarchy search path and display the results.
28
29
30 The colon-delimited path is determined using information
31 gained from the man_db configuration file -
32 (''/etc/manpath.config'') and the user's
33 environment.
34 !!OPTIONS
35
36
37 __-q, --quiet__
38
39
40 Do not issue warnings.
41
42
43 __-d, --debug__
44
45
46 Produce debugging information.
47
48
49 __-c, --catpath__
50
51
52 Produce a catpath as opposed to a manpath. Once the manpath
53 is determined, each path element is converted to its
54 relative catpath.
55
56
57 __-g, --global__
58
59
60 Produce a manpath consisting of all paths named as `global'
61 within the man_db configuration file.
62
63
64 __-m__ ''system''[[,...]__,
65 --systems=__''system''[[,...]
66
67
68 If this system has access to other operating system's manual
69 hierarchies, this option can be used to include them in the
70 output of __manpath__. To include NewOS's manual page
71 hierarchies use the option __-m NewOS__.
72
73
74 The ''system'' specified can be a combination of comma
75 delimited operating system names. To include the native
76 operating system's manual page hierarchies, the system name
77 __man__ must be included in the argument string. This
78 option will override the $__SYSTEM__ environment
79 variable.
80
81
82 __-h, --help__
83
84
85 Print a help message and exit.
86
87
88 __-V, --version__
89
90
91 Display version and author information.
92 !!ENVIRONMENT
93
94
95 __MANPATH__
96
97
98 If $__MANPATH__ is set, __manpath__ displays its value
99 rather than determining it on the fly. If $__MANPATH__ is
100 prefixed by a colon, then the value of the variable is
101 appended to the list determined from the content of the
102 configuration files. If the colon comes at the end of the
103 value in the variable, then the determined list is appended
104 to the content of the variable. If the value of the variable
105 contains a double colon (__::__), then the determined
106 list is inserted in the middle of the value, between the two
107 colons.
108
109
110 __SYSTEM__
111
112
113 If $__SYSTEM__ is set, it will have the same effect as if
114 it had been specified as the argument to the __-m__
115 option.
116 !!FILES
117
118
119 ''/etc/manpath.config''
120
121
122 System configuration file.
123 !!SEE ALSO
124
125
126 apropos(1), whatis(1),
127 man(1).
128 !!AUTHOR
129
130
131 Wilf. (G.Wilford@ee.surrey.ac.uk).
132 Fabrizio Polacco (fpolacco@debian.org).
133 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.