翻訳ドキュメント管理用
Révision | 0cd2929d197d1bc4c83afcaae6abc89b80110174 (tree) |
---|---|
l'heure | 2022-02-07 22:13:35 |
Auteur | matsuand <30614168+matsuand@user...> |
Commiter | matsuand |
man-db 2.10.0: Add original sources (*.man{1,5,8}).
Tweak translation_list.
@@ -0,0 +1,49 @@ | ||
1 | +#------------------------------ | |
2 | +# ソース tarball 入手と伸長 | |
3 | +#------------------------------ | |
4 | +$ cd ~/src | |
5 | +$ wget -N https://download.savannah.gnu.org/releases/man-db/man-db-2.10.0.tar.xz | |
6 | +$ tar xf man-db-2.10.0.tar.xz | |
7 | +$ ls | |
8 | +man-db-2.10.0 | |
9 | + | |
10 | +#------------------------------ | |
11 | +# configure 実行 | |
12 | +# configure 後に生成されるオリジナルパッケージの Makefile 等を | |
13 | +# 当プロジェクト内の Makefile において実行するために必要 | |
14 | +#------------------------------ | |
15 | +$ cd ~/src/man-db-2.10.0 | |
16 | +$ ./configure --prefix=/usr --sysconfdir=/etc | |
17 | + | |
18 | +#------------------------------ | |
19 | +# 当プロジェクトへの man ページのコピー | |
20 | +#------------------------------ | |
21 | + | |
22 | +$ cd $(JMTOP)/manual/man-db/man | |
23 | +$ cat > getfiles.sh <<"EOF" | |
24 | +#!/bin/sh | |
25 | + | |
26 | +SRCDIR=~/src/man-db-2.10.0 | |
27 | +if test ! -d $SRCDIR; then | |
28 | + echo Not found $SRCDIR. | |
29 | + echo You must spefify SRCDIR correctly. | |
30 | + exit 1 | |
31 | +fi | |
32 | + | |
33 | +rm -fr man{1,5,8} | |
34 | +mkdir man{1,5,8} | |
35 | + | |
36 | +for n in 1 5 8; do | |
37 | + cp -d $SRCDIR/man/man$n/*.man$n man$n | |
38 | +done | |
39 | + | |
40 | +if test ! -f $SRCDIR/man/ja/Makefile; then | |
41 | + echo You must configure the original package. | |
42 | + echo See getfiles.txt for details. | |
43 | + exit 1 | |
44 | +fi | |
45 | +cp -p $SRCDIR/man/replace.sin . | |
46 | +sed -f upsteam.mk.sed $SRCDIR/man/ja/Makefile >../upstream.mk | |
47 | +EOF | |
48 | + | |
49 | +$ sh getfiles.sh |
@@ -0,0 +1,268 @@ | ||
1 | +.\" Man page for %apropos% | |
2 | +.\" | |
3 | +.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.) | |
4 | +.\" | |
5 | +.\" You may distribute under the terms of the GNU General Public | |
6 | +.\" License as specified in the file COPYING that comes with the | |
7 | +.\" man-db distribution. | |
8 | +.\" | |
9 | +.\" Sat Oct 29 13:09:31 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) | |
10 | +.\" | |
11 | +.pc | |
12 | +.TH %thapropos% 1 "%date%" "%version%" "Manual pager utils" | |
13 | +.SH NAME | |
14 | +%apropos% \- search the manual page names and descriptions | |
15 | +.SH SYNOPSIS | |
16 | +.B %apropos% | |
17 | +.RB [\| \-dalv?V \|] | |
18 | +.RB [\| \-e \||\| \-w \||\| \-r\c | |
19 | +\|] | |
20 | +.RB [\| \-s | |
21 | +.IR list \|] | |
22 | +.RB [\| \-m | |
23 | +.IR system \|[\|,.\|.\|.\|]\|] | |
24 | +.RB [\| \-M | |
25 | +.IR path \|] | |
26 | +.RB [\| \-L | |
27 | +.IR locale \|] | |
28 | +.RB [\| \-C | |
29 | +.IR file \|] | |
30 | +.I keyword | |
31 | +\&.\|.\|. | |
32 | +.SH DESCRIPTION | |
33 | +Each manual page has a short description available within it. | |
34 | +.B %apropos% | |
35 | +searches the descriptions for instances of | |
36 | +.IR keyword . | |
37 | + | |
38 | +.I keyword | |
39 | +is usually a regular expression, as if | |
40 | +.RB ( \-r ) | |
41 | +was used, or | |
42 | +may contain wildcards | |
43 | +.RB ( \-w ), | |
44 | +or match the exact keyword | |
45 | +.RB ( \-e ). | |
46 | +Using these options, it may be necessary to quote the | |
47 | +.I keyword | |
48 | +or escape (\e) the special characters to stop the shell from interpreting | |
49 | +them. | |
50 | + | |
51 | +The standard matching rules allow matches to be made against the page name | |
52 | +and word boundaries in the description. | |
53 | + | |
54 | +The database searched by | |
55 | +.B %apropos% | |
56 | +is updated by the | |
57 | +.B %mandb% | |
58 | +program. | |
59 | +Depending on your installation, this may be run by a periodic cron job, or | |
60 | +may need to be run manually after new manual pages have been installed. | |
61 | +.SH OPTIONS | |
62 | +.TP | |
63 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
64 | +Print debugging information. | |
65 | +.TP | |
66 | +.if !'po4a'hide' .BR \-v ", " \-\-verbose | |
67 | +Print verbose warning messages. | |
68 | +.TP | |
69 | +.if !'po4a'hide' .BR \-r ", " \-\-regex | |
70 | +Interpret each keyword as a regular expression. | |
71 | +This is the default behaviour. | |
72 | +Each keyword will be matched against the page names and the descriptions | |
73 | +independently. | |
74 | +It can match any part of either. | |
75 | +The match is not limited to word boundaries. | |
76 | +.TP | |
77 | +.if !'po4a'hide' .BR \-w ", " \-\-wildcard | |
78 | +Interpret each keyword as a pattern containing shell style wildcards. | |
79 | +Each keyword will be matched against the page names and the descriptions | |
80 | +independently. | |
81 | +If | |
82 | +.B \-\-exact | |
83 | +is also used, | |
84 | +a match will only be found if an expanded keyword matches an entire | |
85 | +description or page name. | |
86 | +Otherwise the keyword is also allowed to match on word boundaries in the | |
87 | +description. | |
88 | +.TP | |
89 | +.if !'po4a'hide' .BR \-e ", " \-\-exact | |
90 | +Each keyword will be exactly matched against the page names and the | |
91 | +descriptions. | |
92 | +.TP | |
93 | +.if !'po4a'hide' .BR \-a ", " \-\-and | |
94 | +Only display items that match all the supplied keywords. | |
95 | +The default is to display items that match any keyword. | |
96 | +.TP | |
97 | +.if !'po4a'hide' .BR \-l ", " \-\-long | |
98 | +Do not trim output to the terminal width. | |
99 | +Normally, output will be truncated to the terminal width to avoid ugly | |
100 | +results from poorly-written | |
101 | +.B NAME | |
102 | +sections. | |
103 | +.TP | |
104 | +\fB\-s\fR \fIlist\/\fR, \ | |
105 | +\fB\-\-sections=\fIlist\/\fR, \ | |
106 | +\fB\-\-section=\fIlist\fR | |
107 | +Search only the given manual sections. | |
108 | +.I list | |
109 | +is a colon- or comma-separated list of sections. | |
110 | +If an entry in | |
111 | +.I list | |
112 | +is a simple section, for example "3", then the displayed list of | |
113 | +descriptions will include pages in sections "3", "3perl", "3x", and so on; | |
114 | +while if an entry in | |
115 | +.I list | |
116 | +has an extension, for example "3perl", then the list will only include | |
117 | +pages in that exact part of the manual section. | |
118 | +.TP | |
119 | +\fB\-m\fR \fIsystem\fR\|[\|,.\|.\|.\|]\|, \ | |
120 | +\fB\-\-systems=\fIsystem\fR\|[\|,.\|.\|.\|] | |
121 | +If this system has access to other operating systems' manual page | |
122 | +descriptions, they can be searched using this option. | |
123 | +To search NewOS's manual page descriptions, use the option | |
124 | +.B \-m | |
125 | +.BR NewOS . | |
126 | + | |
127 | +The | |
128 | +.I system | |
129 | +specified can be a combination of comma-delimited operating system names. | |
130 | +To include a search of the native operating system's | |
131 | +.B whatis | |
132 | +descriptions, include the system name | |
133 | +.B man | |
134 | +in the argument string. | |
135 | +This option will override the | |
136 | +.RB $ SYSTEM | |
137 | +environment variable. | |
138 | +.TP | |
139 | +.BI \-M\ path \fR,\ \fB\-\-manpath= path | |
140 | +Specify an alternate set of colon-delimited manual page hierarchies to | |
141 | +search. | |
142 | +By default, | |
143 | +.B %program% | |
144 | +uses the | |
145 | +.RB $ MANPATH | |
146 | +environment variable, unless it is empty or unset, in which case it will | |
147 | +determine an appropriate manpath based on your | |
148 | +.RB $ PATH | |
149 | +environment variable. | |
150 | +This option overrides the contents of | |
151 | +.RB $ MANPATH . | |
152 | +.TP | |
153 | +.BI \-L\ locale \fR,\ \fB\-\-locale= locale | |
154 | +.B %program% | |
155 | +will normally determine your current locale by a call to the C function | |
156 | +.BR setlocale (3) | |
157 | +which interrogates various environment variables, possibly including | |
158 | +.RB $ LC_MESSAGES | |
159 | +and | |
160 | +.RB $ LANG . | |
161 | +To temporarily override the determined value, use this option to supply a | |
162 | +.I locale | |
163 | +string directly to | |
164 | +.BR %program% . | |
165 | +Note that it will not take effect until the search for pages actually | |
166 | +begins. | |
167 | +Output such as the help message will always be displayed in the initially | |
168 | +determined locale. | |
169 | +.TP | |
170 | +.BI \-C\ file \fR,\ \fB\-\-config\-file= file | |
171 | +Use this user configuration file rather than the default of | |
172 | +.IR ~/.manpath . | |
173 | +.TP | |
174 | +.if !'po4a'hide' .BR \-? ", " \-\-help | |
175 | +Print a help message and exit. | |
176 | +.TP | |
177 | +.if !'po4a'hide' .B \-\-usage | |
178 | +Print a short usage message and exit. | |
179 | +.TP | |
180 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
181 | +Display version information. | |
182 | +.SH "EXIT STATUS" | |
183 | +.TP | |
184 | +.if !'po4a'hide' .B 0 | |
185 | +Successful program execution. | |
186 | +.TP | |
187 | +.if !'po4a'hide' .B 1 | |
188 | +Usage, syntax or configuration file error. | |
189 | +.TP | |
190 | +.if !'po4a'hide' .B 2 | |
191 | +Operational error. | |
192 | +.TP | |
193 | +.if !'po4a'hide' .B 16 | |
194 | +Nothing was found that matched the criteria specified. | |
195 | +.SH ENVIRONMENT | |
196 | +.TP | |
197 | +.if !'po4a'hide' .B SYSTEM | |
198 | +If | |
199 | +.RB $ SYSTEM | |
200 | +is set, it will have the same effect as if it had been specified as the | |
201 | +argument to the | |
202 | +.B \-m | |
203 | +option. | |
204 | +.TP | |
205 | +.if !'po4a'hide' .B MANPATH | |
206 | +If | |
207 | +.RB $ MANPATH | |
208 | +is set, its value is interpreted as the colon-delimited manual page | |
209 | +hierarchy search path to use. | |
210 | + | |
211 | +See the | |
212 | +.B SEARCH PATH | |
213 | +section of | |
214 | +.BR manpath (5) | |
215 | +for the default behaviour and details of how this environment variable is | |
216 | +handled. | |
217 | +.TP | |
218 | +.if !'po4a'hide' .B MANWIDTH | |
219 | +If | |
220 | +.RB $ MANWIDTH | |
221 | +is set, its value is used as the terminal width (see the | |
222 | +.B \-\-long | |
223 | +option). | |
224 | +If it is not set, the terminal width will be calculated using the value of | |
225 | +.RB $ COLUMNS , | |
226 | +and | |
227 | +.BR ioctl (2) | |
228 | +if available, or falling back to 80 characters if all else fails. | |
229 | +.TP | |
230 | +.if !'po4a'hide' .B POSIXLY_CORRECT | |
231 | +If | |
232 | +.RB $ POSIXLY_CORRECT | |
233 | +is set, even to a null value, the default | |
234 | +.B %apropos% | |
235 | +search will be as an extended regex | |
236 | +.RB ( \-r ). | |
237 | +Nowadays, this is the default behaviour anyway. | |
238 | +.SH FILES | |
239 | +.TP | |
240 | +.if !'po4a'hide' .I /usr/share/man/index.(bt\^|\^db\^|\^dir\^|\^pag) | |
241 | +A traditional global | |
242 | +.I index | |
243 | +database cache. | |
244 | +.TP | |
245 | +.if !'po4a'hide' .I /var/cache/man/index.(bt\^|\^db\^|\^dir\^|\^pag) | |
246 | +An FHS | |
247 | +compliant global | |
248 | +.I index | |
249 | +database cache. | |
250 | +.TP | |
251 | +.if !'po4a'hide' .I /usr/share/man/\|.\|.\|.\|/whatis | |
252 | +A traditional | |
253 | +.B whatis | |
254 | +text database. | |
255 | +.SH "SEE ALSO" | |
256 | +.if !'po4a'hide' .BR %man% (1), | |
257 | +.if !'po4a'hide' .BR %whatis% (1), | |
258 | +.if !'po4a'hide' .BR %mandb% (8) | |
259 | +.SH AUTHOR | |
260 | +.nf | |
261 | +.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk). | |
262 | +.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org). | |
263 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
264 | +.fi | |
265 | +.SH BUGS | |
266 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
267 | +.br | |
268 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,223 @@ | ||
1 | +.\" Man page for lexgrog | |
2 | +.\" | |
3 | +.\" Copyright (c) 2001 Colin Watson <cjwatson@debian.org> | |
4 | +.\" | |
5 | +.\" You may distribute under the terms of the GNU General Public | |
6 | +.\" License as specified in the file COPYING that comes with the | |
7 | +.\" man-db distribution. | |
8 | +.pc | |
9 | +.TH LEXGROG 1 "%date%" "%version%" "Manual pager utils" | |
10 | +.SH NAME | |
11 | +lexgrog \- parse header information in man pages | |
12 | +.SH SYNOPSIS | |
13 | +.B lexgrog | |
14 | +.RB [\| \-m \||\| -c \|] | |
15 | +.RB [\| \-dfw?V \|] | |
16 | +.RB [\| \-E | |
17 | +.IR encoding \|] | |
18 | +.I file | |
19 | +\&.\|.\|. | |
20 | +.SH DESCRIPTION | |
21 | +.B lexgrog | |
22 | +is an implementation of the traditional \(lqgroff guess\(rq utility in | |
23 | +.BR lex . | |
24 | +It reads the list of files on its command line as either man page source | |
25 | +files or preformatted \(lqcat\(rq pages, and displays their name and | |
26 | +description as used by | |
27 | +.B apropos | |
28 | +and | |
29 | +.BR whatis , | |
30 | +the list of preprocessing filters required by the man page before it is | |
31 | +passed to | |
32 | +.B nroff | |
33 | +or | |
34 | +.BR troff , | |
35 | +or both. | |
36 | +.PP | |
37 | +If its input is badly formatted, | |
38 | +.B lexgrog | |
39 | +will print \(lqparse failed\(rq; this may be useful for external | |
40 | +programs that need to check man pages for correctness. | |
41 | +If one of | |
42 | +.BR lexgrog 's | |
43 | +input files is \(lq\-\(rq, it will read from standard input; if any input | |
44 | +file is compressed, a decompressed version will be read automatically. | |
45 | +.SH OPTIONS | |
46 | +.TP | |
47 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
48 | +Print debugging information. | |
49 | +.TP | |
50 | +.if !'po4a'hide' .BR \-m ", " \-\-man | |
51 | +Parse input as man page source files. | |
52 | +This is the default if neither | |
53 | +.B \-\-man | |
54 | +nor | |
55 | +.B \-\-cat | |
56 | +is given. | |
57 | +.TP | |
58 | +.if !'po4a'hide' .BR \-c ", " \-\-cat | |
59 | +Parse input as preformatted man pages (\(lqcat pages\(rq). | |
60 | +.B \-\-man | |
61 | +and | |
62 | +.B \-\-cat | |
63 | +may not be given simultaneously. | |
64 | +.TP | |
65 | +.if !'po4a'hide' .BR \-w ", " \-\-whatis | |
66 | +Display the name and description from the man page's header, as used by | |
67 | +.B apropos | |
68 | +and | |
69 | +.BR whatis . | |
70 | +This is the default if neither | |
71 | +.B \-\-whatis | |
72 | +nor | |
73 | +.B \-\-filters | |
74 | +is given. | |
75 | +.TP | |
76 | +.if !'po4a'hide' .BR \-f ", " \-\-filters | |
77 | +Display the list of filters needed to preprocess the man page before | |
78 | +formatting with | |
79 | +.B nroff | |
80 | +or | |
81 | +.BR troff . | |
82 | +.TP | |
83 | +\fB\-E\fP \fIencoding\fP, \fB\-\-encoding\fP \fIencoding\fP | |
84 | +Override the guessed character set for the page to | |
85 | +.IR encoding . | |
86 | +.TP | |
87 | +.if !'po4a'hide' .BR \-? ", " \-\-help | |
88 | +Print a help message and exit. | |
89 | +.TP | |
90 | +.if !'po4a'hide' .B \-\-usage | |
91 | +Print a short usage message and exit. | |
92 | +.TP | |
93 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
94 | +Display version information. | |
95 | +.SH "EXIT STATUS" | |
96 | +.TP | |
97 | +.if !'po4a'hide' .B 0 | |
98 | +Successful program execution. | |
99 | +.TP | |
100 | +.if !'po4a'hide' .B 1 | |
101 | +Usage error. | |
102 | +.TP | |
103 | +.if !'po4a'hide' .B 2 | |
104 | +.B lexgrog | |
105 | +failed to parse one or more of its input files. | |
106 | +.SH EXAMPLES | |
107 | +.nf | |
108 | + $ lexgrog man.1 | |
109 | + man.1: "man \- an interface to the system reference manuals" | |
110 | + $ lexgrog \-fw man.1 | |
111 | + man.1 (t): "man \- an interface to the system reference manuals" | |
112 | + $ lexgrog \-c whatis.cat1 | |
113 | + whatis.cat1: "whatis \- display manual page descriptions" | |
114 | + $ lexgrog broken.1 | |
115 | + broken.1: parse failed | |
116 | +.fi | |
117 | +.SH WHATIS PARSING | |
118 | +.B %mandb% | |
119 | +(which uses the same code as | |
120 | +.BR lexgrog ) | |
121 | +parses the | |
122 | +.B NAME | |
123 | +section at the top of each manual page looking for names and descriptions | |
124 | +of the features documented in each. | |
125 | +While the parser is quite tolerant, as it has to cope with a number of | |
126 | +different forms that have historically been used, it may sometimes fail to | |
127 | +extract the required information. | |
128 | +.PP | |
129 | +When using the traditional | |
130 | +.I man | |
131 | +macro set, a correct | |
132 | +.B NAME | |
133 | +section looks something like this: | |
134 | +.PP | |
135 | +.RS | |
136 | +.ft CW | |
137 | +.nf | |
138 | +\&.SH NAME | |
139 | +foo \e\- program to do something | |
140 | +.fi | |
141 | +.ft P | |
142 | +.RE | |
143 | +.PP | |
144 | +Some manual pagers require the \(oq\e\-\(cq to be exactly as shown; | |
145 | +.B %mandb% | |
146 | +is more tolerant, but for compatibility with other systems it is | |
147 | +nevertheless a good idea to retain the backslash. | |
148 | +.PP | |
149 | +On the left-hand side, there may be several names, separated by commas. | |
150 | +Names containing whitespace will be ignored to avoid pathological behaviour | |
151 | +on certain ill-formed | |
152 | +.B NAME | |
153 | +sections. | |
154 | +The text on the right-hand side is free-form, and may be spread over | |
155 | +multiple lines. | |
156 | +If several features with different descriptions are being documented in the | |
157 | +same manual page, the following form is therefore used: | |
158 | +.PP | |
159 | +.RS | |
160 | +.ft CW | |
161 | +.nf | |
162 | +\&.SH NAME | |
163 | +foo, bar \e\- programs to do something | |
164 | +\&.br | |
165 | +baz \e\- program to do nothing | |
166 | +.fi | |
167 | +.ft P | |
168 | +.RE | |
169 | +.PP | |
170 | +(A macro which starts a new paragraph, like \f(CW.PP\fP, may be used instead | |
171 | +of the break macro \f(CW.br\fP.) | |
172 | +.PP | |
173 | +When using the BSD-derived | |
174 | +.I mdoc | |
175 | +macro set, a correct | |
176 | +.B NAME | |
177 | +section looks something like this: | |
178 | +.PP | |
179 | +.RS | |
180 | +.ft CW | |
181 | +.nf | |
182 | +\&.Sh NAME | |
183 | +\&.Nm foo | |
184 | +\&.Nd program to do something | |
185 | +.fi | |
186 | +.ft P | |
187 | +.RE | |
188 | + | |
189 | +There are several common reasons why whatis parsing fails. | |
190 | +Sometimes authors of manual pages replace \(oq.SH NAME\(cq with | |
191 | +\(oq.SH MYPROGRAM\(cq, and then | |
192 | +.B %mandb% | |
193 | +cannot find the section from which to extract the information it needs. | |
194 | +Sometimes authors include a NAME section, but place free-form text there | |
195 | +rather than \(oqname \e\- description\(cq. | |
196 | +However, any syntax resembling the above should be accepted. | |
197 | +.SH "SEE ALSO" | |
198 | +.if !'po4a'hide' .IR apropos (1), | |
199 | +.if !'po4a'hide' .IR man (1), | |
200 | +.if !'po4a'hide' .IR whatis (1), | |
201 | +.if !'po4a'hide' .IR mandb (8) | |
202 | +.SH NOTES | |
203 | +.B lexgrog | |
204 | +attempts to parse files containing .so requests, but will only be able | |
205 | +to do so correctly if the files are properly installed in a manual page | |
206 | +hierarchy. | |
207 | +.SH AUTHOR | |
208 | +The code used by | |
209 | +.B lexgrog | |
210 | +to scan man pages was written by: | |
211 | +.PP | |
212 | +.nf | |
213 | +.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk). | |
214 | +.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org). | |
215 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
216 | +.fi | |
217 | +.PP | |
218 | +Colin Watson wrote the current incarnation of the command-line | |
219 | +front-end, as well as this man page. | |
220 | +.SH BUGS | |
221 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
222 | +.br | |
223 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,89 @@ | ||
1 | +.\" Man page for man-recode | |
2 | +.\" | |
3 | +.\" Copyright (C) 2019 Colin Watson <cjwatson@debian.org> | |
4 | +.\" | |
5 | +.\" You may distribute under the terms of the GNU General Public | |
6 | +.\" License as specified in the file COPYING that comes with the | |
7 | +.\" man-db distribution. | |
8 | +.pc | |
9 | +.TH %thman_recode% 1 "%date%" "%version%" "Manual pager utils" | |
10 | +.SH NAME | |
11 | +%man_recode% \- convert manual pages to another encoding | |
12 | +.SH SYNOPSIS | |
13 | +.B %man_recode% | |
14 | +.B \-t | |
15 | +.I to-code | |
16 | +{\|\fB\-\-suffix=\fIsuffix\/\fR\||\|\c | |
17 | +.BR \-\-in\-place \|} | |
18 | +.RB [\| \-dqhV \|] | |
19 | +.RI [\| filename \|] | |
20 | +.SH DESCRIPTION | |
21 | +.B %man_recode% | |
22 | +converts multiple manual pages from one encoding to another, guessing the | |
23 | +appropriate input encoding for each one. | |
24 | +It is useful when permanently recoding pages written in legacy character | |
25 | +sets, or in build systems that need to recode a set of pages to a single | |
26 | +common encoding (usually UTF\-8) for installation. | |
27 | +When converting many manual pages, this program is much faster than running | |
28 | +.B %man% \-\-recode | |
29 | +or | |
30 | +.B %manconv% | |
31 | +on each page. | |
32 | +.PP | |
33 | +If an encoding declaration is found on the first line of a manual page, then | |
34 | +that declaration is used as the input encoding for that page. | |
35 | +Failing that, the input encoding is guessed based on the file name. | |
36 | +.PP | |
37 | +Encoding declarations have the following form: | |
38 | +.PP | |
39 | +.RS | |
40 | +.nf | |
41 | +.if !'po4a'hide' \&\(aq\e" \-*\- coding: UTF\-8 \-*\- | |
42 | +.fi | |
43 | +.RE | |
44 | +.PP | |
45 | +or (if manual page preprocessors are also to be declared): | |
46 | +.PP | |
47 | +.RS | |
48 | +.nf | |
49 | +.if !'po4a'hide' \&\(aq\e" t \-*\- coding: ISO\-8859\-1 \-*\- | |
50 | +.fi | |
51 | +.RE | |
52 | +.SH OPTIONS | |
53 | +.TP | |
54 | +\fB\-t\fR \fIencoding\/\fR, \fB\-\-to\-code=\fIencoding\fR | |
55 | +Convert manual pages to | |
56 | +.IR encoding . | |
57 | +.TP | |
58 | +\fB\-\-suffix=\fIsuffix\fR | |
59 | +Form each output file name by appending | |
60 | +.I suffix | |
61 | +to the input file name, after removing any compression extension. | |
62 | +.TP | |
63 | +.if !'po4a'hide' .B \-\-in\-place | |
64 | +Overwrite each input file with the output, after removing any compression | |
65 | +extension. | |
66 | +.TP | |
67 | +.if !'po4a'hide' .BR \-q ", " \-\-quiet | |
68 | +Do not issue error messages when the page cannot be converted. | |
69 | +.TP | |
70 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
71 | +Print debugging information. | |
72 | +.TP | |
73 | +.if !'po4a'hide' .BR \-h ", " \-\-help | |
74 | +Print a help message and exit. | |
75 | +.TP | |
76 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
77 | +Display version information. | |
78 | +.SH "SEE ALSO" | |
79 | +.if !'po4a'hide' .IR iconv (1), | |
80 | +.if !'po4a'hide' .IR %man% (1), | |
81 | +.if !'po4a'hide' .IR %manconv% (1) | |
82 | +.SH BUGS | |
83 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
84 | +.br | |
85 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db | |
86 | +.SH AUTHOR | |
87 | +.nf | |
88 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
89 | +.fi |
@@ -0,0 +1,1303 @@ | ||
1 | +'\" t | |
2 | +.\" ** The above line should force tbl to be a preprocessor ** | |
3 | +.\" Man page for man | |
4 | +.\" | |
5 | +.\" Copyright (C) 1994, 1995, Graeme W. Wilford. (Wilf.) | |
6 | +.\" Copyright (C) 2001-2019 Colin Watson. | |
7 | +.\" | |
8 | +.\" You may distribute under the terms of the GNU General Public | |
9 | +.\" License as specified in the file COPYING that comes with the | |
10 | +.\" man-db distribution. | |
11 | +.\" | |
12 | +.\" Sat Oct 29 13:09:31 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) | |
13 | +.\" | |
14 | +.pc | |
15 | +.TH %thman% 1 "%date%" "%version%" "Manual pager utils" | |
16 | +.SH NAME | |
17 | +%man% \- an interface to the system reference manuals | |
18 | +.SH SYNOPSIS | |
19 | +.\" The general command line | |
20 | +.B %man% | |
21 | +.RI [\| "man options" \|] | |
22 | +.RI [\|[\| section \|] | |
23 | +.IR page \ \|.\|.\|.\|]\ \.\|.\|.\& | |
24 | +.\" The apropos command line | |
25 | +.br | |
26 | +.B %man% | |
27 | +.B \-k | |
28 | +.RI [\| "apropos options" \|] | |
29 | +.I regexp | |
30 | +\&.\|.\|.\& | |
31 | +.\" The --global-apropos command line | |
32 | +.br | |
33 | +.B %man% | |
34 | +.B \-K | |
35 | +.RI [\| "man options" \|] | |
36 | +.RI [\| section \|] | |
37 | +.IR term \ .\|.\|.\& | |
38 | +.\" The whatis command line | |
39 | +.br | |
40 | +.B %man% | |
41 | +.B \-f | |
42 | +.RI [\| whatis | |
43 | +.IR options \|] | |
44 | +.I page | |
45 | +\&.\|.\|.\& | |
46 | +.\" The --local command line | |
47 | +.br | |
48 | +.B %man% | |
49 | +.B \-l | |
50 | +.RI [\| "man options" \|] | |
51 | +.I file | |
52 | +\&.\|.\|.\& | |
53 | +.\" The --where/--where-cat command line | |
54 | +.br | |
55 | +.B %man% | |
56 | +.BR \-w \||\| \-W | |
57 | +.RI [\| "man options" \|] | |
58 | +.I page | |
59 | +\&.\|.\|.\& | |
60 | +.SH DESCRIPTION | |
61 | +.B %man% | |
62 | +is the system's manual pager. | |
63 | +Each | |
64 | +.I page | |
65 | +argument given to | |
66 | +.B %man% | |
67 | +is normally the name of a program, utility or function. | |
68 | +The | |
69 | +.I manual page | |
70 | +associated with each of these arguments is then found and displayed. | |
71 | +A | |
72 | +.IR section , | |
73 | +if provided, will direct | |
74 | +.B %man% | |
75 | +to look only in that | |
76 | +.I section | |
77 | +of the manual. | |
78 | +The default action is to search in all of the available | |
79 | +.I sections | |
80 | +following a pre-defined order (see | |
81 | +.BR DEFAULTS ), | |
82 | +and to show only the first | |
83 | +.I page | |
84 | +found, even if | |
85 | +.I page | |
86 | +exists in several | |
87 | +.IR sections . | |
88 | + | |
89 | +The table below shows the | |
90 | +.I section | |
91 | +numbers of the manual followed by the types of pages they contain. | |
92 | + | |
93 | +.TS | |
94 | +tab (@); | |
95 | +l lx. | |
96 | +1@T{ | |
97 | +Executable programs or shell commands | |
98 | +T} | |
99 | +2@T{ | |
100 | +System calls (functions provided by the kernel) | |
101 | +T} | |
102 | +3@T{ | |
103 | +Library calls (functions within program libraries) | |
104 | +T} | |
105 | +4@T{ | |
106 | +Special files (usually found in \fI/dev\/\fR) | |
107 | +T} | |
108 | +5@T{ | |
109 | +File formats and conventions, e.g.\& \fI/etc/passwd\fR | |
110 | +T} | |
111 | +6@T{ | |
112 | +Games | |
113 | +T} | |
114 | +7@T{ | |
115 | +Miscellaneous (including macro packages and conventions), | |
116 | +e.g.\& \fBman\fR(7), \fBgroff\fR(7), \fBman\-pages\fR(7) | |
117 | +T} | |
118 | +8@T{ | |
119 | +System administration commands (usually only for root) | |
120 | +T} | |
121 | +9@T{ | |
122 | +Kernel routines [\|Non standard\|] | |
123 | +T} | |
124 | +.TE | |
125 | + | |
126 | +A manual | |
127 | +.I page | |
128 | +consists of several sections. | |
129 | + | |
130 | +Conventional section names include | |
131 | +.BR NAME , | |
132 | +.BR SYNOPSIS , | |
133 | +.BR CONFIGURATION , | |
134 | +.BR DESCRIPTION , | |
135 | +.BR OPTIONS , | |
136 | +.BR EXIT\ STATUS , | |
137 | +.BR RETURN\ VALUE , | |
138 | +.BR ERRORS , | |
139 | +.BR ENVIRONMENT , | |
140 | +.BR FILES , | |
141 | +.BR VERSIONS , | |
142 | +.BR CONFORMING\ TO , | |
143 | +.BR NOTES , | |
144 | +.BR BUGS , | |
145 | +.BR EXAMPLE , | |
146 | +.BR AUTHORS , | |
147 | +and | |
148 | +.BR SEE\ ALSO . | |
149 | + | |
150 | +The following conventions apply to the | |
151 | +.B SYNOPSIS | |
152 | +section and can be used as a guide in other sections. | |
153 | + | |
154 | +.TS | |
155 | +tab (@); | |
156 | +l lx. | |
157 | +\fBbold text\fR@T{ | |
158 | +type exactly as shown. | |
159 | +T} | |
160 | +\fIitalic text\fR@T{ | |
161 | +replace with appropriate argument. | |
162 | +T} | |
163 | +[\|\fB\-abc\fR\|]@T{ | |
164 | +any or all arguments within [ ] are optional. | |
165 | +T} | |
166 | +\fB\-a\|\fR|\|\fB\-b\fR@T{ | |
167 | +options delimited by | cannot be used together. | |
168 | +T} | |
169 | +\fIargument\fR .\|.\|.@T{ | |
170 | +\fIargument\fR is repeatable. | |
171 | +T} | |
172 | +[\|\fIexpression\fR\|]\fR .\|.\|.@T{ | |
173 | +\fRentire \fIexpression\fR\ within [ ] is repeatable. | |
174 | +T} | |
175 | +.TE | |
176 | + | |
177 | +Exact rendering may vary depending on the output device. | |
178 | +For instance, man will usually not be able to render italics when running in | |
179 | +a terminal, and will typically use underlined or coloured text instead. | |
180 | + | |
181 | +The command or function illustration is a pattern that should match all | |
182 | +possible invocations. | |
183 | +In some cases it is advisable to illustrate several exclusive invocations | |
184 | +as is shown in the | |
185 | +.B SYNOPSIS | |
186 | +section of this manual page. | |
187 | +.SH EXAMPLES | |
188 | +.TP \w'%man%\ 'u | |
189 | +.BI %man% \ ls | |
190 | +Display the manual page for the | |
191 | +.I item | |
192 | +(program) | |
193 | +.IR ls . | |
194 | +.TP | |
195 | +\fB%man%\fR \fIman\fR.\fI7\fR | |
196 | +Display the manual page for macro package | |
197 | +.I man | |
198 | +from section | |
199 | +.IR 7 . | |
200 | +(This is an alternative spelling of | |
201 | +"\fB%man%\fR \fI7 man\fR".) | |
202 | +.TP | |
203 | +\fB%man% '\fIman\fR(\fI7\fR)' | |
204 | +Display the manual page for macro package | |
205 | +.I man | |
206 | +from section | |
207 | +.IR 7 . | |
208 | +(This is another alternative spelling of | |
209 | +"\fB%man%\fR \fI7 man\fR". | |
210 | +It may be more convenient when copying and pasting cross-references to | |
211 | +manual pages. | |
212 | +Note that the parentheses must normally be quoted to protect them from the | |
213 | +shell.) | |
214 | +.TP | |
215 | +.BI %man%\ \-a \ intro | |
216 | +Display, in succession, all of the available | |
217 | +.I intro | |
218 | +manual pages contained within the manual. | |
219 | +It is possible to quit between successive displays or skip any of them. | |
220 | +.TP | |
221 | +\fB%man% \-t \fIbash \fR|\fI lpr \-Pps | |
222 | +Format the manual page for | |
223 | +.I bash | |
224 | +into the default | |
225 | +.B troff | |
226 | +or | |
227 | +.B groff | |
228 | +format and pipe it to the printer named | |
229 | +.IR ps . | |
230 | +The default output for | |
231 | +.B groff | |
232 | +is usually PostScript. | |
233 | +.B %man% \-\-help | |
234 | +should advise as to which processor is bound to the | |
235 | +.B \-t | |
236 | +option. | |
237 | +.TP | |
238 | +.BI "%man% \-l \-T" "dvi ./foo.1x.gz" " > " ./foo.1x.dvi | |
239 | +This command will decompress and format the nroff source manual page | |
240 | +.I ./foo.1x.gz | |
241 | +into a | |
242 | +.B device independent (dvi) | |
243 | +file. | |
244 | +The redirection is necessary as the | |
245 | +.B \-T | |
246 | +flag causes output to be directed to | |
247 | +.B stdout | |
248 | +with no pager. | |
249 | +The output could be viewed with a program such as | |
250 | +.B xdvi | |
251 | +or further processed into PostScript using a program such as | |
252 | +.BR dvips . | |
253 | +.TP | |
254 | +.BI %man%\ \-k \ printf | |
255 | +Search the short descriptions and manual page names for the keyword | |
256 | +.I printf | |
257 | +as regular expression. | |
258 | +Print out any matches. | |
259 | +Equivalent to | |
260 | +.BI %apropos% \ printf . | |
261 | +.TP | |
262 | +.BI %man%\ \-f \ smail | |
263 | +Lookup the manual pages referenced by | |
264 | +.I smail | |
265 | +and print out the short descriptions of any found. | |
266 | +Equivalent to | |
267 | +.BI %whatis% \ smail . | |
268 | +.SH OVERVIEW | |
269 | +Many options are available to | |
270 | +.B %man% | |
271 | +in order to give as much flexibility as possible to the user. | |
272 | +Changes can be made to the search path, section order, output processor, | |
273 | +and other behaviours and operations detailed below. | |
274 | + | |
275 | +If set, various environment variables are interrogated to determine | |
276 | +the operation of | |
277 | +.BR %man% . | |
278 | +It is possible to set the "catch-all" variable | |
279 | +.RB $ MANOPT | |
280 | +to any string in command line format, with the exception that any spaces | |
281 | +used as part of an option's argument must be escaped (preceded by a | |
282 | +backslash). | |
283 | +.B %man% | |
284 | +will parse | |
285 | +.RB $ MANOPT | |
286 | +prior to parsing its own command line. | |
287 | +Those options requiring an argument will be overridden by the same options | |
288 | +found on the command line. | |
289 | +To reset all of the options set in | |
290 | +.RB $ MANOPT , | |
291 | +.B \-D | |
292 | +can be specified as the initial command line option. | |
293 | +This will allow %man% to "forget" about the options specified in | |
294 | +.RB $ MANOPT , | |
295 | +although they must still have been valid. | |
296 | + | |
297 | +Manual pages are normally stored in | |
298 | +.BR nroff (1) | |
299 | +format under a directory such as | |
300 | +.IR /usr/share/man . | |
301 | +In some installations, there may also be preformatted | |
302 | +.I cat pages | |
303 | +to improve performance. | |
304 | +See | |
305 | +.BR manpath (5) | |
306 | +for details of where these files are stored. | |
307 | + | |
308 | +This package supports manual pages in multiple languages, controlled by your | |
309 | +.IR locale . | |
310 | +If your system did not set this up for you automatically, then you may need | |
311 | +to set | |
312 | +.RB $ LC_MESSAGES , | |
313 | +.RB $ LANG , | |
314 | +or another system-dependent environment variable to indicate your preferred | |
315 | +locale, usually specified in the | |
316 | +.B POSIX | |
317 | +format: | |
318 | + | |
319 | +<\fIlanguage\fR>\ | |
320 | +[\|\fB_\fR<\fIterritory\fR>\|\ | |
321 | +[\|\fB.\fR<\fIcharacter-set\fR>\|\ | |
322 | +[\|\fB,\fR<\fIversion\fR>\|]\|]\|] | |
323 | + | |
324 | +If the desired page is available in your | |
325 | +.IR locale , | |
326 | +it will be displayed in lieu of the standard | |
327 | +(usually American English) page. | |
328 | + | |
329 | +If you find that the translations supplied with this package are not | |
330 | +available in your native language and you would like to supply them, please | |
331 | +contact the maintainer who will be coordinating such activity. | |
332 | + | |
333 | +Individual manual pages are normally written and maintained by the | |
334 | +maintainers of the program, function, or other topic that they document, and | |
335 | +are not included with this package. | |
336 | +If you find that a manual page is missing or inadequate, please report that | |
337 | +to the maintainers of the package in question. | |
338 | + | |
339 | +For information regarding other features and extensions available with this | |
340 | +manual pager, please read the documents supplied with the package. | |
341 | +.SH DEFAULTS | |
342 | +The order of sections to search may be overridden by the environment | |
343 | +variable | |
344 | +.RB $ MANSECT | |
345 | +or by the | |
346 | +.B SECTION | |
347 | +directive in | |
348 | +.IR %manpath_config_file% . | |
349 | +By default it is as follows: | |
350 | + | |
351 | +.RS | |
352 | +.if !'po4a'hide' %sections% | |
353 | +.RE | |
354 | + | |
355 | +The formatted manual page is displayed using a | |
356 | +.IR pager . | |
357 | +This can be specified in a number of ways, or else will fall back to a | |
358 | +default (see option | |
359 | +.B \-P | |
360 | +for details). | |
361 | + | |
362 | +The filters are deciphered by a number of means. | |
363 | +Firstly, the command line option | |
364 | +.B \-p | |
365 | +or the environment variable | |
366 | +.RB $ MANROFFSEQ | |
367 | +is interrogated. | |
368 | +If | |
369 | +.B \-p | |
370 | +was not used and the environment variable was not set, the initial line of | |
371 | +the nroff file is parsed for a preprocessor string. | |
372 | +To contain a valid preprocessor string, the first line must resemble | |
373 | + | |
374 | +.B '\e" | |
375 | +.RB < string > | |
376 | + | |
377 | +where | |
378 | +.B string | |
379 | +can be any combination of letters described by option | |
380 | +.B \-p | |
381 | +below. | |
382 | + | |
383 | +If none of the above methods provide any filter information, a default set | |
384 | +is used. | |
385 | + | |
386 | +A formatting pipeline is formed from the filters and the primary | |
387 | +formatter | |
388 | +.RB ( nroff | |
389 | +or | |
390 | +.RB [ tg ] roff | |
391 | +with | |
392 | +.BR \-t ) | |
393 | +and executed. | |
394 | +Alternatively, if an executable program | |
395 | +.I mandb_nfmt | |
396 | +(or | |
397 | +.I mandb_tfmt | |
398 | +with | |
399 | +.BR \-t ) | |
400 | +exists in the man tree root, it is executed instead. | |
401 | +It gets passed the manual source file, the preprocessor string, and | |
402 | +optionally the device specified with | |
403 | +.BR \-T " or " \-E | |
404 | +as arguments. | |
405 | +.\" ******************************************************************** | |
406 | +.SH OPTIONS | |
407 | +Non-argument options that are duplicated either on the command line, in | |
408 | +.RB $ MANOPT , | |
409 | +or both, are not harmful. | |
410 | +For options that require an argument, each duplication will override the | |
411 | +previous argument value. | |
412 | +.SS "General options" | |
413 | +.TP | |
414 | +.BI \-C\ file \fR,\ \fB\-\-config\-file= file | |
415 | +Use this user configuration file rather than the default of | |
416 | +.IR ~/.manpath . | |
417 | +.TP | |
418 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
419 | +Print debugging information. | |
420 | +.TP | |
421 | +.if !'po4a'hide' .BR \-D ", " \-\-default | |
422 | +This option is normally issued as the very first option and resets | |
423 | +.B %man%'s | |
424 | +behaviour to its default. | |
425 | +Its use is to reset those options that may have been set in | |
426 | +.RB $ MANOPT . | |
427 | +Any options that follow | |
428 | +.B \-D | |
429 | +will have their usual effect. | |
430 | +.TP | |
431 | +\fB\-\-warnings\fP[=\fIwarnings\/\fP] | |
432 | +Enable warnings from | |
433 | +.IR groff . | |
434 | +This may be used to perform sanity checks on the source text of manual | |
435 | +pages. | |
436 | +.I warnings | |
437 | +is a comma-separated list of warning names; if it is not supplied, the | |
438 | +default is "mac". | |
439 | +See the \(lqWarnings\(rq node in | |
440 | +.B info groff | |
441 | +for a list of available warning names. | |
442 | +.SS "Main modes of operation" | |
443 | +.TP | |
444 | +.if !'po4a'hide' .BR \-f ", " \-\-whatis | |
445 | +Equivalent to | |
446 | +.BR %whatis% . | |
447 | +Display a short description from the manual page, if available. | |
448 | +See | |
449 | +.BR %whatis% (1) | |
450 | +for details. | |
451 | +.TP | |
452 | +.if !'po4a'hide' .BR \-k ", " \-\-apropos | |
453 | +Equivalent to | |
454 | +.BR %apropos% . | |
455 | +Search the short manual page descriptions for keywords and display any | |
456 | +matches. | |
457 | +See | |
458 | +.BR %apropos% (1) | |
459 | +for details. | |
460 | +.TP | |
461 | +.if !'po4a'hide' .BR \-K ", " \-\-global\-apropos | |
462 | +Search for text in all manual pages. | |
463 | +This is a brute-force search, and is likely to take some time; if you can, | |
464 | +you should specify a section to reduce the number of pages that need to be | |
465 | +searched. | |
466 | +Search terms may be simple strings (the default), or regular expressions if | |
467 | +the | |
468 | +.B \-\-regex | |
469 | +option is used. | |
470 | +.IP | |
471 | +Note that this searches the | |
472 | +.I sources | |
473 | +of the manual pages, not the rendered text, and so may include false | |
474 | +positives due to things like comments in source files. | |
475 | +Searching the rendered text would be much slower. | |
476 | +.TP | |
477 | +.if !'po4a'hide' .BR \-l ", " \-\-local\-file | |
478 | +Activate "local" mode. | |
479 | +Format and display local manual files instead of searching through the | |
480 | +system's manual collection. | |
481 | +Each manual page argument will be interpreted as an nroff source file in the | |
482 | +correct format. | |
483 | +.\" Compressed nroff source files with a supported compression | |
484 | +.\" extension will be decompressed by man prior to being displaying via the | |
485 | +.\" usual filters. | |
486 | +No cat file is produced. | |
487 | +If '\-' is listed as one of the arguments, input will be taken from stdin. | |
488 | +When this option is not used, and man fails to find the page required, | |
489 | +before displaying the error message, it attempts to act as if this | |
490 | +option was supplied, using the name as a filename and looking for an | |
491 | +exact match. | |
492 | +.TP | |
493 | +.if !'po4a'hide' .BR \-w ", " \-\-where ", " \-\-path ", " \-\-location | |
494 | +Don't actually display the manual page, but do print the location of the | |
495 | +source nroff file that would be formatted. | |
496 | +If the | |
497 | +.B \-a | |
498 | +option is also used, then print the locations of all source files that match | |
499 | +the search criteria. | |
500 | +.TP | |
501 | +.if !'po4a'hide' .BR \-W ", " \-\-where\-cat ", " \-\-location\-cat | |
502 | +Don't actually display the manual page, but do print the location of the | |
503 | +preformatted cat file that would be displayed. | |
504 | +If the | |
505 | +.B \-a | |
506 | +option is also used, then print the locations of all preformatted cat files | |
507 | +that match the search criteria. | |
508 | +.IP | |
509 | +If | |
510 | +.B \-w | |
511 | +and | |
512 | +.B \-W | |
513 | +are both used, then print both source file and cat file separated by a | |
514 | +space. | |
515 | +If | |
516 | +all of | |
517 | +.BR \-w , | |
518 | +.BR \-W , | |
519 | +and | |
520 | +.B \-a | |
521 | +are used, then do this for each possible match. | |
522 | +.TP | |
523 | +.if !'po4a'hide' .BR \-c ", " \-\-catman | |
524 | +This option is not for general use and should only be used by the | |
525 | +.B %catman% | |
526 | +program. | |
527 | +.TP | |
528 | +.BI \-R\ encoding\fR,\ \fI \-\-recode\fR=\fIencoding | |
529 | +Instead of formatting the manual page in the usual way, output its source | |
530 | +converted to the specified | |
531 | +.IR encoding . | |
532 | +If you already know the encoding of the source file, you can also use | |
533 | +.BR %manconv% (1) | |
534 | +directly. | |
535 | +However, this option allows you to convert several manual pages to a single | |
536 | +encoding without having to explicitly state the encoding of each, provided | |
537 | +that they were already installed in a structure similar to a manual page | |
538 | +hierarchy. | |
539 | +.IP | |
540 | +Consider using | |
541 | +.BR %man_recode% (1) | |
542 | +instead for converting multiple manual pages, since it has an interface | |
543 | +designed for bulk conversion and so can be much faster. | |
544 | +.SS "Finding manual pages" | |
545 | +.TP | |
546 | +.BI \-L\ locale \fR,\ \fB\-\-locale= locale | |
547 | +.B %program% | |
548 | +will normally determine your current locale by a call to the C function | |
549 | +.BR setlocale (3) | |
550 | +which interrogates various environment variables, possibly including | |
551 | +.RB $ LC_MESSAGES | |
552 | +and | |
553 | +.RB $ LANG . | |
554 | +To temporarily override the determined value, use this option to supply a | |
555 | +.I locale | |
556 | +string directly to | |
557 | +.BR %program% . | |
558 | +Note that it will not take effect until the search for pages actually | |
559 | +begins. | |
560 | +Output such as the help message will always be displayed in the initially | |
561 | +determined locale. | |
562 | +.TP | |
563 | +\fB\-m\fR \fIsystem\fR\|[\|,.\|.\|.\|]\|, \ | |
564 | +\fB\-\-systems=\fIsystem\fR\|[\|,.\|.\|.\|] | |
565 | +If this system has access to other operating systems' manual pages, they can | |
566 | +be accessed using this option. | |
567 | +To search for a manual page from NewOS's manual page collection, | |
568 | +use the option | |
569 | +.B \-m | |
570 | +.BR NewOS . | |
571 | + | |
572 | +The | |
573 | +.I system | |
574 | +specified can be a combination of comma delimited operating system names. | |
575 | +To include a search of the native operating system's manual pages, | |
576 | +include the system name | |
577 | +.B man | |
578 | +in the argument string. | |
579 | +This option will override the | |
580 | +.RB $ SYSTEM | |
581 | +environment variable. | |
582 | +.TP | |
583 | +.BI \-M\ path \fR,\ \fB\-\-manpath= path | |
584 | +Specify an alternate manpath to use. | |
585 | +By default, | |
586 | +.B %man% | |
587 | +uses | |
588 | +.B %manpath% | |
589 | +derived code to determine the path to search. | |
590 | +This option overrides the | |
591 | +.RB $ MANPATH | |
592 | +environment variable and causes option | |
593 | +.B \-m | |
594 | +to be ignored. | |
595 | + | |
596 | +A path specified as a manpath must be the root of a manual page hierarchy | |
597 | +structured into sections as described in the man-db manual (under "The | |
598 | +manual page system"). | |
599 | +To view manual pages outside such hierarchies, see the | |
600 | +.B \-l | |
601 | +option. | |
602 | +.TP | |
603 | +\fB\-S\fR \fIlist\/\fR, \ | |
604 | +\fB\-s\fR \fIlist\/\fR, \ | |
605 | +\fB\-\-sections=\fIlist\/\fR | |
606 | +The given | |
607 | +.I list | |
608 | +is a colon- or comma-separated list of sections, used to determine which | |
609 | +manual sections to search and in what order. | |
610 | +This option overrides the | |
611 | +.RB $ MANSECT | |
612 | +environment variable. | |
613 | +(The | |
614 | +.B \-s | |
615 | +spelling is for compatibility with System V.) | |
616 | +.TP | |
617 | +.BI \-e\ sub-extension \fR,\ \fB\-\-extension= sub-extension | |
618 | +Some systems incorporate large packages of manual pages, such as those that | |
619 | +accompany the | |
620 | +.B Tcl | |
621 | +package, into the main manual page hierarchy. | |
622 | +To get around the problem of having two manual pages with the same name | |
623 | +such as | |
624 | +.BR exit (3), | |
625 | +the | |
626 | +.B Tcl | |
627 | +pages were usually all assigned to section | |
628 | +.BR l . | |
629 | +As this is unfortunate, it is now possible to put the pages in the correct | |
630 | +section, and to assign a specific "extension" to them, in this case, | |
631 | +.BR exit (3tcl). | |
632 | +Under normal operation, | |
633 | +.B %man% | |
634 | +will display | |
635 | +.BR exit (3) | |
636 | +in preference to | |
637 | +.BR exit (3tcl). | |
638 | +To negotiate this situation and to avoid having to know which section the | |
639 | +page you require resides in, it is now possible to give | |
640 | +.B %man% | |
641 | +a | |
642 | +.I sub-extension | |
643 | +string indicating which package the page must belong to. | |
644 | +Using the above example, supplying the option | |
645 | +.B \-e\ tcl | |
646 | +to | |
647 | +.B %man% | |
648 | +will restrict the search to pages having an extension of | |
649 | +.BR *tcl . | |
650 | +.TP | |
651 | +.if !'po4a'hide' .BR \-i ", " \-\-ignore\-case | |
652 | +Ignore case when searching for manual pages. | |
653 | +This is the default. | |
654 | +.TP | |
655 | +.if !'po4a'hide' .BR \-I ", " \-\-match\-case | |
656 | +Search for manual pages case-sensitively. | |
657 | +.TP | |
658 | +.if !'po4a'hide' .B \-\-regex | |
659 | +Show all pages with any part of either their names or their descriptions | |
660 | +matching each | |
661 | +.I page | |
662 | +argument as a regular expression, as with | |
663 | +.BR apropos (1). | |
664 | +Since there is usually no reasonable way to pick a "best" page when | |
665 | +searching for a regular expression, this option implies | |
666 | +.BR \-a . | |
667 | +.TP | |
668 | +.if !'po4a'hide' .B \-\-wildcard | |
669 | +Show all pages with any part of either their names or their descriptions | |
670 | +matching each | |
671 | +.I page | |
672 | +argument using shell-style wildcards, as with | |
673 | +.BR apropos (1) | |
674 | +.BR \-\-wildcard . | |
675 | +The | |
676 | +.I page | |
677 | +argument must match the entire name or description, or match on word | |
678 | +boundaries in the description. | |
679 | +Since there is usually no reasonable way to pick a "best" page when | |
680 | +searching for a wildcard, this option implies | |
681 | +.BR \-a . | |
682 | +.TP | |
683 | +.if !'po4a'hide' .B \-\-names\-only | |
684 | +If the | |
685 | +.B \-\-regex | |
686 | +or | |
687 | +.B \-\-wildcard | |
688 | +option is used, match only page names, not page descriptions, as with | |
689 | +.BR whatis (1). | |
690 | +Otherwise, no effect. | |
691 | +.TP | |
692 | +.if !'po4a'hide' .BR \-a ", " \-\-all | |
693 | +By default, | |
694 | +.B %man% | |
695 | +will exit after displaying the most suitable manual page it finds. | |
696 | +Using this option forces | |
697 | +.B %man% | |
698 | +to display all the manual pages with names that match the search criteria. | |
699 | +.TP | |
700 | +.if !'po4a'hide' .BR \-u ", " \-\-update | |
701 | +This option causes | |
702 | +.B %man% | |
703 | +to update its database caches of installed manual pages. | |
704 | +This is only needed in rare situations, and it is normally better to run | |
705 | +.BR %mandb% (8) | |
706 | +instead. | |
707 | +.TP | |
708 | +.if !'po4a'hide' .B \-\-no\-subpages | |
709 | +By default, | |
710 | +.B %man% | |
711 | +will try to interpret pairs of manual page names given on the command line | |
712 | +as equivalent to a single manual page name containing a hyphen or an | |
713 | +underscore. | |
714 | +This supports the common pattern of programs that implement a number of | |
715 | +subcommands, allowing them to provide manual pages for each that can be | |
716 | +accessed using similar syntax as would be used to invoke the subcommands | |
717 | +themselves. | |
718 | +For example: | |
719 | + | |
720 | +.nf | |
721 | +.if !'po4a'hide' \& $ man \-aw git diff | |
722 | +.if !'po4a'hide' \& /usr/share/man/man1/git\-diff.1.gz | |
723 | +.fi | |
724 | + | |
725 | +To disable this behaviour, use the | |
726 | +.B \-\-no\-subpages | |
727 | +option. | |
728 | + | |
729 | +.nf | |
730 | +.if !'po4a'hide' \& $ man \-aw \-\-no\-subpages git diff | |
731 | +.if !'po4a'hide' \& /usr/share/man/man1/git.1.gz | |
732 | +.if !'po4a'hide' \& /usr/share/man/man3/Git.3pm.gz | |
733 | +.if !'po4a'hide' \& /usr/share/man/man1/diff.1.gz | |
734 | +.fi | |
735 | +.SS "Controlling formatted output" | |
736 | +.TP | |
737 | +.BI \-P\ pager \fR,\ \fB\-\-pager= pager | |
738 | +Specify which output pager to use. | |
739 | +By default, | |
740 | +.B %man% | |
741 | +uses | |
742 | +.BR "%pager%" , | |
743 | +falling back to | |
744 | +.B %cat% | |
745 | +if | |
746 | +.B %pager% | |
747 | +is not found or is not executable. | |
748 | +This option overrides the | |
749 | +.RB $ MANPAGER | |
750 | +environment variable, which in turn overrides the | |
751 | +.RB $ PAGER | |
752 | +environment variable. | |
753 | +It is not used in conjunction with | |
754 | +.B \-f | |
755 | +or | |
756 | +.BR \-k . | |
757 | + | |
758 | +The value may be a simple command name or a command with arguments, and may | |
759 | +use shell quoting (backslashes, single quotes, or double quotes). | |
760 | +It may not use pipes to connect multiple commands; if you need that, use a | |
761 | +wrapper script, which may take the file to display either as an argument or | |
762 | +on standard input. | |
763 | +.TP | |
764 | +.BI \-r\ prompt \fR,\ \fB\-\-prompt= prompt | |
765 | +If a recent version of | |
766 | +.B less | |
767 | +is used as the pager, | |
768 | +.B %man% | |
769 | +will attempt to set its prompt and some sensible options. | |
770 | +The default prompt looks like | |
771 | + | |
772 | +.BI " Manual page" " name" ( sec ") line" " x" | |
773 | + | |
774 | +where | |
775 | +.I name | |
776 | +denotes the manual page name, | |
777 | +.I sec | |
778 | +denotes the section it was found under and | |
779 | +.I x | |
780 | +the current line number. | |
781 | +.\"The default options are | |
782 | +.\".BR \-six8 . | |
783 | +This is achieved by using the | |
784 | +.RB $ LESS | |
785 | +environment variable. | |
786 | +.\"The actual default will depend on your chosen | |
787 | +.\".BR locale . | |
788 | + | |
789 | +Supplying | |
790 | +.B \-r | |
791 | +with a string will override this default. | |
792 | +.\"You may need to do this if your | |
793 | +.\"version of | |
794 | +.\".B less | |
795 | +.\"rejects the default options or if you prefer a different prompt. | |
796 | +The string may contain the text | |
797 | +.B $MAN_PN | |
798 | +which will be expanded to the name of the current manual page and its | |
799 | +section name surrounded by "(" and ")". | |
800 | +The string used to produce the default could be expressed as | |
801 | + | |
802 | +.B \e\ Manual\e\ page\e\ \e$MAN_PN\e\ ?ltline\e\ %lt?L/%L.: | |
803 | +.br | |
804 | +.B byte\e\ %bB?s/%s..?\e\ (END):?pB\e\ %pB\e\e%.. | |
805 | +.br | |
806 | +.B (press h for help or q to quit) | |
807 | + | |
808 | +It is broken into three lines here for the sake of readability only. | |
809 | +For its meaning see the | |
810 | +.BR less (1) | |
811 | +manual page. | |
812 | +The prompt string is first evaluated by the shell. | |
813 | +All double quotes, back-quotes and backslashes in the prompt must be escaped | |
814 | +by a preceding backslash. | |
815 | +The prompt string may end in an escaped $ which may be followed by further | |
816 | +options for less. | |
817 | +By default | |
818 | +.B %man% | |
819 | +sets the | |
820 | +.B \-ix8 | |
821 | +options. | |
822 | + | |
823 | +The | |
824 | +.RB $ MANLESS | |
825 | +environment variable described below may be used to set a default prompt | |
826 | +string if none is supplied on the command line. | |
827 | +.TP | |
828 | +.if !'po4a'hide' .BR \-7 ", " \-\-ascii | |
829 | +When viewing a pure | |
830 | +.IR ascii (7) | |
831 | +manual page on a 7 bit terminal or terminal emulator, some characters may | |
832 | +not display correctly when using the | |
833 | +.IR latin1 (7) | |
834 | +device description with | |
835 | +.B GNU | |
836 | +.BR nroff . | |
837 | +This option allows pure | |
838 | +.I ascii | |
839 | +manual pages to be displayed in | |
840 | +.I ascii | |
841 | +with the | |
842 | +.I latin1 | |
843 | +device. | |
844 | +It will not translate any | |
845 | +.I latin1 | |
846 | +text. | |
847 | +The following table shows the translations performed: some parts of it may | |
848 | +only be displayed properly when using | |
849 | +.B GNU | |
850 | +.BR nroff 's | |
851 | +.IR latin1 (7) | |
852 | +device. | |
853 | + | |
854 | +.ie c \[shc] \ | |
855 | +. ds softhyphen \[shc] | |
856 | +.el \ | |
857 | +. ds softhyphen \(hy | |
858 | +.na | |
859 | +.TS | |
860 | +tab (@); | |
861 | +l c c c. | |
862 | +Description@Octal@latin1@ascii | |
863 | +_ | |
864 | +T{ | |
865 | +continuation hyphen | |
866 | +T}@255@\*[softhyphen]@- | |
867 | +T{ | |
868 | +bullet (middle dot) | |
869 | +T}@267@\(bu@o | |
870 | +T{ | |
871 | +acute accent | |
872 | +T}@264@\(aa@' | |
873 | +T{ | |
874 | +multiplication sign | |
875 | +T}@327@\(mu@x | |
876 | +.TE | |
877 | +.ad | |
878 | + | |
879 | +If the | |
880 | +.I latin1 | |
881 | +column displays correctly, your terminal may be set up for | |
882 | +.I latin1 | |
883 | +characters and this option is not necessary. | |
884 | +If the | |
885 | +.I latin1 | |
886 | +and | |
887 | +.I ascii | |
888 | +columns are identical, you are reading this page using this option or | |
889 | +.B %man% | |
890 | +did not format this page using the | |
891 | +.I latin1 | |
892 | +device description. | |
893 | +If the | |
894 | +.I latin1 | |
895 | +column is missing or corrupt, you may need to view manual pages with this | |
896 | +option. | |
897 | + | |
898 | +This option is ignored when using options | |
899 | +.BR \-t , | |
900 | +.BR \-H , | |
901 | +.BR \-T , | |
902 | +or | |
903 | +.B \-Z | |
904 | +and may be useless for | |
905 | +.B nroff | |
906 | +other than | |
907 | +.BR GNU's . | |
908 | +.TP | |
909 | +.BI \-E\ encoding\fR,\ \fI \-\-encoding\fR=\fIencoding | |
910 | +Generate output for a character encoding other than the default. | |
911 | +For backward compatibility, | |
912 | +.I encoding | |
913 | +may be an | |
914 | +.B nroff | |
915 | +device such as | |
916 | +.BR ascii ", " latin1 ", or " utf8 | |
917 | +as well as a true character encoding such as | |
918 | +.BR UTF\-8 . | |
919 | +.TP | |
920 | +.if !'po4a'hide' .BR \-\-no\-hyphenation ", " \-\-nh | |
921 | +Normally, | |
922 | +.B nroff | |
923 | +will automatically hyphenate text at line breaks even in words that do not | |
924 | +contain hyphens, if it is necessary to do so to lay out words on a line | |
925 | +without excessive spacing. | |
926 | +This option disables automatic hyphenation, so words will only be hyphenated | |
927 | +if they already contain hyphens. | |
928 | + | |
929 | +If you are writing a manual page and simply want to prevent | |
930 | +.B nroff | |
931 | +from hyphenating a word at an inappropriate point, do not use this option, | |
932 | +but consult the | |
933 | +.B nroff | |
934 | +documentation instead; for instance, you can put "\e%" inside a word to | |
935 | +indicate that it may be hyphenated at that point, or put "\e%" at the start | |
936 | +of a word to prevent it from being hyphenated. | |
937 | +.TP | |
938 | +.if !'po4a'hide' .BR \-\-no\-justification ", " \-\-nj | |
939 | +Normally, | |
940 | +.B nroff | |
941 | +will automatically justify text to both margins. | |
942 | +This option disables full justification, leaving justified only to the left | |
943 | +margin, sometimes called "ragged-right" text. | |
944 | + | |
945 | +If you are writing a manual page and simply want to prevent | |
946 | +.B nroff | |
947 | +from justifying certain paragraphs, do not use this option, but consult the | |
948 | +.B nroff | |
949 | +documentation instead; for instance, you can use the ".na", ".nf", ".fi", | |
950 | +and ".ad" requests to temporarily disable adjusting and filling. | |
951 | +.TP | |
952 | +.BI \-p\ string \fR,\ \fB\-\-preprocessor= string | |
953 | +Specify the sequence of preprocessors to run before | |
954 | +.B nroff | |
955 | +or | |
956 | +.BR troff / groff . | |
957 | +Not all installations will have a full set of preprocessors. | |
958 | +Some of the preprocessors and the letters used to designate them are: | |
959 | +.BR eqn " (" e ), | |
960 | +.BR grap " (" g ), | |
961 | +.BR pic " (" p ), | |
962 | +.BR tbl " (" t ), | |
963 | +.BR vgrind " (" v ), | |
964 | +.BR refer " (" r ). | |
965 | +This option overrides the | |
966 | +.RB $ MANROFFSEQ | |
967 | +environment variable. | |
968 | +.B %zsoelim% | |
969 | +is always run as the very first preprocessor. | |
970 | +.TP | |
971 | +.if !'po4a'hide' .BR \-t ", " \-\-troff | |
972 | +Use | |
973 | +.I %troff% | |
974 | +to format the manual page to stdout. | |
975 | +This option is not required in conjunction with | |
976 | +.BR \-H , | |
977 | +.BR \-T , | |
978 | +or | |
979 | +.BR \-Z . | |
980 | +.TP | |
981 | +\fB\-T\fP[\fIdevice\/\fP], \fB\-\-troff\-device\fP[=\fIdevice\/\fP] | |
982 | +This option is used to change | |
983 | +.B groff | |
984 | +(or possibly | |
985 | +.BR troff's ) | |
986 | +output to be suitable for a device other than the default. | |
987 | +It implies | |
988 | +.BR \-t . | |
989 | +Examples (provided with Groff-1.17) include | |
990 | +.BR dvi ", " latin1 ", " ps ", " utf8 , | |
991 | +.BR X75 " and " X100 . | |
992 | +.TP | |
993 | +\fB\-H\fP[\fIbrowser\/\fP], \fB\-\-html\fP[=\fIbrowser\/\fP] | |
994 | +This option will cause | |
995 | +.B groff | |
996 | +to produce HTML output, and will display that output in a web browser. | |
997 | +The choice of browser is determined by the optional | |
998 | +.I browser | |
999 | +argument if one is provided, by the | |
1000 | +.RB $ BROWSER | |
1001 | +environment variable, or by a compile-time default if that is unset (usually | |
1002 | +.BR lynx ). | |
1003 | +This option implies | |
1004 | +.BR \-t , | |
1005 | +and will only work with | |
1006 | +.B GNU | |
1007 | +.BR troff . | |
1008 | +.TP | |
1009 | +\fB\-X\fP[\fIdpi\/\fP], \fB\-\-gxditview\fP[=\fIdpi\/\fP] | |
1010 | +This option displays the output of | |
1011 | +.B groff | |
1012 | +in a graphical window using the | |
1013 | +.B gxditview | |
1014 | +program. | |
1015 | +The | |
1016 | +.I dpi | |
1017 | +(dots per inch) may be 75, 75-12, 100, or 100-12, defaulting to 75; | |
1018 | +the -12 variants use a 12-point base font. | |
1019 | +This option implies | |
1020 | +.B \-T | |
1021 | +with the X75, X75-12, X100, or X100-12 device respectively. | |
1022 | +.TP | |
1023 | +.if !'po4a'hide' .BR \-Z ", " \-\-ditroff | |
1024 | +.B groff | |
1025 | +will run | |
1026 | +.B troff | |
1027 | +and then use an appropriate post-processor to produce output suitable for | |
1028 | +the chosen device. | |
1029 | +If | |
1030 | +.I %troff% | |
1031 | +is | |
1032 | +.BR groff , | |
1033 | +this option is passed to | |
1034 | +.B groff | |
1035 | +and will suppress the use of a post-processor. | |
1036 | +It implies | |
1037 | +.BR \-t . | |
1038 | +.SS "Getting help" | |
1039 | +.TP | |
1040 | +.if !'po4a'hide' .BR \-? ", " \-\-help | |
1041 | +Print a help message and exit. | |
1042 | +.TP | |
1043 | +.if !'po4a'hide' .B \-\-usage | |
1044 | +Print a short usage message and exit. | |
1045 | +.TP | |
1046 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
1047 | +Display version information. | |
1048 | +.SH "EXIT STATUS" | |
1049 | +.TP | |
1050 | +.if !'po4a'hide' .B 0 | |
1051 | +Successful program execution. | |
1052 | +.TP | |
1053 | +.if !'po4a'hide' .B 1 | |
1054 | +Usage, syntax or configuration file error. | |
1055 | +.TP | |
1056 | +.if !'po4a'hide' .B 2 | |
1057 | +Operational error. | |
1058 | +.TP | |
1059 | +.if !'po4a'hide' .B 3 | |
1060 | +A child process returned a non-zero exit status. | |
1061 | +.TP | |
1062 | +.if !'po4a'hide' .B 16 | |
1063 | +At least one of the pages/files/keywords didn't exist or wasn't matched. | |
1064 | +.SH ENVIRONMENT | |
1065 | +.\".TP \w'MANROFFSEQ\ \ 'u | |
1066 | +.TP | |
1067 | +.if !'po4a'hide' .B MANPATH | |
1068 | +If | |
1069 | +.RB $ MANPATH | |
1070 | +is set, its value is used as the path to search for manual pages. | |
1071 | + | |
1072 | +See the | |
1073 | +.B SEARCH PATH | |
1074 | +section of | |
1075 | +.BR manpath (5) | |
1076 | +for the default behaviour and details of how this environment variable is | |
1077 | +handled. | |
1078 | +.TP | |
1079 | +.if !'po4a'hide' .B MANROFFOPT | |
1080 | +Every time | |
1081 | +.B man | |
1082 | +invokes the formatter | |
1083 | +.RB ( nroff , | |
1084 | +.BR troff , | |
1085 | +or | |
1086 | +.BR groff ), | |
1087 | +it adds the contents of | |
1088 | +.RB $ MANROFFOPT | |
1089 | +to the formatter's command line. | |
1090 | +.TP | |
1091 | +.if !'po4a'hide' .B MANROFFSEQ | |
1092 | +If | |
1093 | +.RB $ MANROFFSEQ | |
1094 | +is set, its value is used to determine the set of preprocessors to pass | |
1095 | +each manual page through. | |
1096 | +The default preprocessor list is system dependent. | |
1097 | +.TP | |
1098 | +.if !'po4a'hide' .B MANSECT | |
1099 | +If | |
1100 | +.RB $ MANSECT | |
1101 | +is set, its value is a colon-delimited list of sections and it is used to | |
1102 | +determine which manual sections to search and in what order. | |
1103 | +The default is | |
1104 | +"%sections%", | |
1105 | +unless overridden by the | |
1106 | +.B SECTION | |
1107 | +directive in | |
1108 | +.IR %manpath_config_file% . | |
1109 | +.TP | |
1110 | +.if !'po4a'hide' .BR MANPAGER , " PAGER" | |
1111 | +If | |
1112 | +.RB $ MANPAGER | |
1113 | +or | |
1114 | +.RB $ PAGER | |
1115 | +is set | |
1116 | +.RB ($ MANPAGER | |
1117 | +is used in preference), its value is used as the name of the program used to | |
1118 | +display the manual page. | |
1119 | +By default, | |
1120 | +.B %pager% | |
1121 | +is used, falling back to | |
1122 | +.B %cat% | |
1123 | +if | |
1124 | +.B %pager% | |
1125 | +is not found or is not executable. | |
1126 | + | |
1127 | +The value may be a simple command name or a command with arguments, and may | |
1128 | +use shell quoting (backslashes, single quotes, or double quotes). | |
1129 | +It may not use pipes to connect multiple commands; if you need that, use a | |
1130 | +wrapper script, which may take the file to display either as an argument or | |
1131 | +on standard input. | |
1132 | +.TP | |
1133 | +.if !'po4a'hide' .B MANLESS | |
1134 | +If | |
1135 | +.RB $ MANLESS | |
1136 | +is set, its value will be used as the default prompt string for the | |
1137 | +.B less | |
1138 | +pager, as if it had been passed using the | |
1139 | +.B \-r | |
1140 | +option (so any occurrences of the text | |
1141 | +.B $MAN_PN | |
1142 | +will be expanded in the same way). | |
1143 | +For example, if you want to set the prompt string unconditionally to | |
1144 | +\(lqmy prompt string\(rq, set | |
1145 | +.RB $ MANLESS | |
1146 | +to | |
1147 | +.RB \(oq \-Psmy\ prompt\ string \(cq. | |
1148 | +Using the | |
1149 | +.B \-r | |
1150 | +option overrides this environment variable. | |
1151 | +.TP | |
1152 | +.if !'po4a'hide' .B BROWSER | |
1153 | +If | |
1154 | +.RB $ BROWSER | |
1155 | +is set, its value is a colon-delimited list of commands, each of which in | |
1156 | +turn is used to try to start a web browser for | |
1157 | +.B man | |
1158 | +.BR \-\-html . | |
1159 | +In each command, | |
1160 | +.I %s | |
1161 | +is replaced by a filename containing the HTML output from | |
1162 | +.BR groff , | |
1163 | +.I %% | |
1164 | +is replaced by a single percent sign (%), and | |
1165 | +.I %c | |
1166 | +is replaced by a colon (:). | |
1167 | +.TP | |
1168 | +.if !'po4a'hide' .B SYSTEM | |
1169 | +If | |
1170 | +.RB $ SYSTEM | |
1171 | +is set, it will have the same effect as if it had been specified as the | |
1172 | +argument to the | |
1173 | +.B \-m | |
1174 | +option. | |
1175 | +.TP | |
1176 | +.if !'po4a'hide' .B MANOPT | |
1177 | +If | |
1178 | +.RB $ MANOPT | |
1179 | +is set, it will be parsed prior to | |
1180 | +.B %man%'s | |
1181 | +command line and is expected to be in a similar format. | |
1182 | +As all of the other | |
1183 | +.B %man% | |
1184 | +specific environment variables can be expressed as command line options, and | |
1185 | +are thus candidates for being included in | |
1186 | +.RB $ MANOPT | |
1187 | +it is expected that they will become obsolete. | |
1188 | +N.B. All spaces that should be interpreted as part of an option's argument | |
1189 | +must be escaped. | |
1190 | +.TP | |
1191 | +.if !'po4a'hide' .B MANWIDTH | |
1192 | +If | |
1193 | +.RB $ MANWIDTH | |
1194 | +is set, its value is used as the line length for which manual pages should | |
1195 | +be formatted. | |
1196 | +If it is not set, manual pages will be formatted with a line length | |
1197 | +appropriate to the current terminal (using the value of | |
1198 | +.RB $ COLUMNS , | |
1199 | +and | |
1200 | +.BR ioctl (2) | |
1201 | +if available, or falling back to 80 characters if neither is available). | |
1202 | +Cat pages will only be saved when the default formatting can be used, that | |
1203 | +is when the terminal line length is between 66 and 80 characters. | |
1204 | +.TP | |
1205 | +.if !'po4a'hide' .B MAN_KEEP_FORMATTING | |
1206 | +Normally, when output is not being directed to a terminal (such as to a file | |
1207 | +or a pipe), formatting characters are discarded to make it easier to read | |
1208 | +the result without special tools. | |
1209 | +However, if | |
1210 | +.RB $ MAN_KEEP_FORMATTING | |
1211 | +is set to any non-empty value, these formatting characters are retained. | |
1212 | +This may be useful for wrappers around | |
1213 | +.B %man% | |
1214 | +that can interpret formatting characters. | |
1215 | +.TP | |
1216 | +.if !'po4a'hide' .B MAN_KEEP_STDERR | |
1217 | +Normally, when output is being directed to a terminal (usually to a pager), | |
1218 | +any error output from the command used to produce formatted versions of | |
1219 | +manual pages is discarded to avoid interfering with the pager's display. | |
1220 | +Programs such as | |
1221 | +.B groff | |
1222 | +often produce relatively minor error messages about typographical problems | |
1223 | +such as poor alignment, which are unsightly and generally confusing when | |
1224 | +displayed along with the manual page. | |
1225 | +However, some users want to see them anyway, so, if | |
1226 | +.RB $ MAN_KEEP_STDERR | |
1227 | +is set to any non-empty value, error output will be displayed as usual. | |
1228 | +.TP | |
1229 | +.if !'po4a'hide' .B MAN_DISABLE_SECCOMP | |
1230 | +On Linux, | |
1231 | +.B %man% | |
1232 | +normally confines subprocesses that handle untrusted data using a | |
1233 | +.BR seccomp (2) | |
1234 | +sandbox. | |
1235 | +This makes it safer to run complex parsing code over arbitrary manual pages. | |
1236 | +If this goes wrong for some reason unrelated to the content of the page | |
1237 | +being displayed, you can set | |
1238 | +.RB $ MAN_DISABLE_SECCOMP | |
1239 | +to any non-empty value to disable the sandbox. | |
1240 | +.TP | |
1241 | +.if !'po4a'hide' .B PIPELINE_DEBUG | |
1242 | +If the | |
1243 | +.RB $ PIPELINE_DEBUG | |
1244 | +environment variable is set to "1", then | |
1245 | +.B %man% | |
1246 | +will print debugging messages to standard error describing each subprocess | |
1247 | +it runs. | |
1248 | +.TP | |
1249 | +.if !'po4a'hide' .BR LANG , " LC_MESSAGES" | |
1250 | +Depending on system and implementation, either or both of | |
1251 | +.RB $ LANG | |
1252 | +and | |
1253 | +.RB $ LC_MESSAGES | |
1254 | +will be interrogated for the current message locale. | |
1255 | +.B %man% | |
1256 | +will display its messages in that locale (if available). | |
1257 | +See | |
1258 | +.BR setlocale (3) | |
1259 | +for precise details. | |
1260 | +.SH FILES | |
1261 | +.TP | |
1262 | +.if !'po4a'hide' .I %manpath_config_file% | |
1263 | +man-db configuration file. | |
1264 | +.TP | |
1265 | +.if !'po4a'hide' .I /usr/share/man | |
1266 | +A global manual page hierarchy. | |
1267 | +.SH "SEE ALSO" | |
1268 | +.if !'po4a'hide' .BR %apropos% (1), | |
1269 | +.if !'po4a'hide' .BR groff (1), | |
1270 | +.if !'po4a'hide' .BR less (1), | |
1271 | +.if !'po4a'hide' .BR %manpath% (1), | |
1272 | +.if !'po4a'hide' .BR nroff (1), | |
1273 | +.if !'po4a'hide' .BR troff (1), | |
1274 | +.if !'po4a'hide' .BR %whatis% (1), | |
1275 | +.if !'po4a'hide' .BR %zsoelim% (1), | |
1276 | +.if !'po4a'hide' .BR manpath (5), | |
1277 | +.if !'po4a'hide' .BR man (7), | |
1278 | +.if !'po4a'hide' .BR %catman% (8), | |
1279 | +.if !'po4a'hide' .BR %mandb% (8) | |
1280 | +.PP | |
1281 | +Documentation for some packages may be available in other formats, such as | |
1282 | +.BR info (1) | |
1283 | +or HTML. | |
1284 | +.SH HISTORY | |
1285 | +1990, 1991 \(en Originally written by John W.\& Eaton (jwe@che.utexas.edu). | |
1286 | + | |
1287 | +Dec 23 1992: Rik Faith (faith@cs.unc.edu) applied bug fixes | |
1288 | +supplied by Willem Kasdorp (wkasdo@nikhefk.nikef.nl). | |
1289 | + | |
1290 | +30th April 1994 \(en 23rd February 2000: Wilf.\& (G.Wilford@ee.surrey.ac.uk) | |
1291 | +has been developing and maintaining this package | |
1292 | +with the help of a few dedicated people. | |
1293 | + | |
1294 | +30th October 1996 \(en 30th March 2001: Fabrizio Polacco <fpolacco@debian.org> | |
1295 | +maintained and enhanced this package for the Debian project, with the | |
1296 | +help of all the community. | |
1297 | + | |
1298 | +31st March 2001 \(en present day: Colin Watson <cjwatson@debian.org> is now | |
1299 | +developing and maintaining man-db. | |
1300 | +.SH BUGS | |
1301 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
1302 | +.br | |
1303 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,84 @@ | ||
1 | +.\" Man page for manconv | |
2 | +.\" | |
3 | +.\" Copyright (c) 2007, 2008 Colin Watson <cjwatson@debian.org> | |
4 | +.\" | |
5 | +.\" You may distribute under the terms of the GNU General Public | |
6 | +.\" License as specified in the file COPYING that comes with the | |
7 | +.\" man-db distribution. | |
8 | +.pc | |
9 | +.TH %thmanconv% 1 "%date%" "%version%" "Manual pager utils" | |
10 | +.SH NAME | |
11 | +%manconv% \- convert manual page from one encoding to another | |
12 | +.SH SYNOPSIS | |
13 | +.B %manconv% | |
14 | +.B \-f | |
15 | +.RI [\| from-code \|[: from-code \|.\|.\|.]\|] | |
16 | +.B \-t | |
17 | +.I to-code | |
18 | +.RB [\| \-dqhV \|] | |
19 | +.RI [\| filename \|] | |
20 | +.SH DESCRIPTION | |
21 | +.B %manconv% | |
22 | +converts a manual page from one encoding to another, like | |
23 | +.BR iconv . | |
24 | +Unlike | |
25 | +.BR iconv , | |
26 | +it can try multiple possible input encodings in sequence. | |
27 | +This is useful for manual pages installed in directories without an explicit | |
28 | +encoding declaration, since they may be in UTF\-8 or in a legacy character | |
29 | +set. | |
30 | +.PP | |
31 | +If an encoding declaration is found on the first line of the manual page, | |
32 | +that declaration overrides any input encodings specified on | |
33 | +.BR %manconv% 's | |
34 | +command line. | |
35 | +Encoding declarations have the following form: | |
36 | +.PP | |
37 | +.RS | |
38 | +.nf | |
39 | +.if !'po4a'hide' \&\(aq\e" \-*\- coding: UTF\-8 \-*\- | |
40 | +.fi | |
41 | +.RE | |
42 | +.PP | |
43 | +or (if manual page preprocessors are also to be declared): | |
44 | +.PP | |
45 | +.RS | |
46 | +.nf | |
47 | +.if !'po4a'hide' \&\(aq\e" t \-*\- coding: ISO\-8859\-1 \-*\- | |
48 | +.fi | |
49 | +.RE | |
50 | +.SH OPTIONS | |
51 | +.TP | |
52 | +\fB\-f\fP \fIencodings\fP, \fB\-\-from\-code\fP \fIencodings\fP | |
53 | +Try each of | |
54 | +.I encodings | |
55 | +(a colon-separated list) in sequence as the input encoding. | |
56 | +The default is to guess likely input encodings based on the file name. | |
57 | +.TP | |
58 | +\fB\-t\fP \fIencoding\fP, \fB\-\-to\-code\fP \fIencoding\fP | |
59 | +Convert the manual page to | |
60 | +.IR encoding . | |
61 | +.TP | |
62 | +.if !'po4a'hide' .BR \-q ", " \-\-quiet | |
63 | +Do not issue error messages when the page cannot be converted. | |
64 | +.TP | |
65 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
66 | +Print debugging information. | |
67 | +.TP | |
68 | +.if !'po4a'hide' .BR \-h ", " \-\-help | |
69 | +Print a help message and exit. | |
70 | +.TP | |
71 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
72 | +Display version information. | |
73 | +.SH "SEE ALSO" | |
74 | +.if !'po4a'hide' .IR iconv (1), | |
75 | +.if !'po4a'hide' .IR %man% (1), | |
76 | +.if !'po4a'hide' .IR %man_recode% (1) | |
77 | +.SH AUTHOR | |
78 | +.nf | |
79 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
80 | +.fi | |
81 | +.SH BUGS | |
82 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
83 | +.br | |
84 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,127 @@ | ||
1 | +.\" Man page for manpath | |
2 | +.\" | |
3 | +.\" Copyright (C) 1995, Graeme W. Wilford. (Wilf.) | |
4 | +.\" Copyright (C) 2001-2019 Colin Watson. | |
5 | +.\" | |
6 | +.\" You may distribute under the terms of the GNU General Public | |
7 | +.\" License as specified in the COPYING file that comes with the | |
8 | +.\" man-db distribution. | |
9 | +.\" | |
10 | +.\" Sun Jan 22 22:15:17 GMT 1995 Wilf. (G.Wilford@ee.surrey.ac.uk) | |
11 | +.\" | |
12 | +.pc | |
13 | +.TH %thmanpath% 1 "%date%" "%version%" "Manual pager utils" | |
14 | +.SH NAME | |
15 | +%manpath% \- determine search path for manual pages | |
16 | +.SH SYNOPSIS | |
17 | +.B %manpath% | |
18 | +.RB [\| \-qgdc?V \|] | |
19 | +.RB [\| \-m | |
20 | +.IR system \|[\|,.\|.\|.\|]\|] | |
21 | +.RB [\| \-C | |
22 | +.IR file \|] | |
23 | +.SH DESCRIPTION | |
24 | +If | |
25 | +.RB $ MANPATH | |
26 | +is set, | |
27 | +.B %manpath% | |
28 | +will simply display its contents and issue a warning. | |
29 | +If not, | |
30 | +.B %manpath% | |
31 | +will determine a suitable manual page hierarchy search path and display the | |
32 | +results. | |
33 | + | |
34 | +The colon-delimited path is determined using information gained from the | |
35 | +man-db configuration file \(en | |
36 | +.RI ( "%manpath_config_file%" ) | |
37 | +and the user's environment. | |
38 | +.SH OPTIONS | |
39 | +.TP | |
40 | +.if !'po4a'hide' .BR \-q ", " \-\-quiet | |
41 | +Do not issue warnings. | |
42 | +.TP | |
43 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
44 | +Print debugging information. | |
45 | +.TP | |
46 | +.if !'po4a'hide' .BR \-c ", " \-\-catpath | |
47 | +Produce a catpath as opposed to a manpath. | |
48 | +Once the manpath is determined, | |
49 | +each path element is converted to its relative catpath. | |
50 | +.TP | |
51 | +.if !'po4a'hide' .BR \-g ", " \-\-global | |
52 | +Produce a manpath consisting of all paths named as "global" within the | |
53 | +man-db configuration file. | |
54 | +.TP | |
55 | +\fB\-m\fR \fIsystem\fR\|[\|,.\|.\|.\|]\|, \ | |
56 | +\fB\-\-systems=\fIsystem\fR\|[\|,.\|.\|.\|] | |
57 | +If this system has access to other operating systems' manual hierarchies, | |
58 | +this option can be used to include them in the output of | |
59 | +.BR %manpath% . | |
60 | +To include NewOS's manual page hierarchies use the option | |
61 | +.B \-m | |
62 | +.BR NewOS . | |
63 | + | |
64 | +The | |
65 | +.I system | |
66 | +specified can be a combination of comma delimited operating system names. | |
67 | +To include the native operating system's manual page hierarchies, | |
68 | +the system name | |
69 | +.B man | |
70 | +must be included in the argument string. | |
71 | +This option will override the | |
72 | +.RB $ SYSTEM | |
73 | +environment variable. | |
74 | +.TP | |
75 | +.BI \-C\ file \fR,\ \fB\-\-config\-file= file | |
76 | +Use this user configuration file rather than the default of | |
77 | +.IR ~/.manpath . | |
78 | +.TP | |
79 | +.if !'po4a'hide' .BR \-? ", " \-\-help | |
80 | +Print a help message and exit. | |
81 | +.TP | |
82 | +.if !'po4a'hide' .B \-\-usage | |
83 | +Print a short usage message and exit. | |
84 | +.TP | |
85 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
86 | +Display version information. | |
87 | +.SH ENVIRONMENT | |
88 | +.TP | |
89 | +.if !'po4a'hide' .B MANPATH | |
90 | +If | |
91 | +.RB $ MANPATH | |
92 | +is set, | |
93 | +.B %manpath% | |
94 | +displays its value rather than determining it on the fly. | |
95 | + | |
96 | +See the | |
97 | +.B SEARCH PATH | |
98 | +section of | |
99 | +.BR manpath (5) | |
100 | +for the default behaviour and details of how this environment variable is | |
101 | +handled. | |
102 | +.TP | |
103 | +.if !'po4a'hide' .B SYSTEM | |
104 | +If | |
105 | +.RB $ SYSTEM | |
106 | +is set, it will have the same effect as if it had been specified as the | |
107 | +argument to the | |
108 | +.B \-m | |
109 | +option. | |
110 | +.SH FILES | |
111 | +.TP \w'%manpath_config_file%'u+2n | |
112 | +.if !'po4a'hide' .I %manpath_config_file% | |
113 | +man-db configuration file. | |
114 | +.SH "SEE ALSO" | |
115 | +.if !'po4a'hide' .BR %apropos% (1), | |
116 | +.if !'po4a'hide' .BR %man% (1), | |
117 | +.if !'po4a'hide' .BR %whatis% (1) | |
118 | +.SH AUTHOR | |
119 | +.nf | |
120 | +.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk). | |
121 | +.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org). | |
122 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
123 | +.fi | |
124 | +.SH BUGS | |
125 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
126 | +.br | |
127 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,263 @@ | ||
1 | +.\" Man page for whatis | |
2 | +.\" | |
3 | +.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.) | |
4 | +.\" | |
5 | +.\" You may distribute under the terms of the GNU General Public | |
6 | +.\" License as specified in the file COPYING that comes with the | |
7 | +.\" man-db distribution. | |
8 | +.\" | |
9 | +.\" Sat Oct 29 13:09:31 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) | |
10 | +.\" | |
11 | +.pc | |
12 | +.TH %thwhatis% 1 "%date%" "%version%" "Manual pager utils" | |
13 | +.SH NAME | |
14 | +%whatis% \- display one-line manual page descriptions | |
15 | +.SH SYNOPSIS | |
16 | +.B %whatis% | |
17 | +.RB [\| \-dlv?V \|] | |
18 | +.RB [\| \-r \||\| \-w\c | |
19 | +\|] | |
20 | +.RB [\| \-s | |
21 | +.IR list \|] | |
22 | +.RB [\| \-m | |
23 | +.IR system \|[\|,.\|.\|.\|]\|] | |
24 | +.RB [\| \-M | |
25 | +.IR path \|] | |
26 | +.RB [\| \-L | |
27 | +.IR locale \|] | |
28 | +.RB [\| \-C | |
29 | +.IR file \|] | |
30 | +.I name | |
31 | +\&.\|.\|. | |
32 | +.SH DESCRIPTION | |
33 | +Each manual page has a short description available within it. | |
34 | +.B %whatis% | |
35 | +searches the manual page names and displays the manual page descriptions | |
36 | +of any | |
37 | +.I name | |
38 | +matched. | |
39 | + | |
40 | +.I name | |
41 | +may contain wildcards | |
42 | +.RB ( \-w ) | |
43 | +or be a regular expression | |
44 | +.RB ( \-r ). | |
45 | +Using these options, it may be necessary to quote the | |
46 | +.I name | |
47 | +or escape (\\) the special characters to stop the shell from interpreting | |
48 | +them. | |
49 | + | |
50 | +.B index | |
51 | +databases are used during the search, and are updated by the | |
52 | +.B %mandb% | |
53 | +program. | |
54 | +Depending on your installation, this may be run by a periodic cron job, or | |
55 | +may need to be run manually after new manual pages have been installed. | |
56 | +To produce an old style text | |
57 | +.B whatis | |
58 | +database from the relative | |
59 | +.B index | |
60 | +database, issue the command: | |
61 | + | |
62 | +.B %whatis% \-M | |
63 | +.I manpath | |
64 | +.B \-w '*' | sort > | |
65 | +.I manpath/whatis | |
66 | + | |
67 | +where | |
68 | +.I manpath | |
69 | +is a manual page hierarchy such as | |
70 | +.IR /usr/man . | |
71 | +.SH OPTIONS | |
72 | +.TP | |
73 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
74 | +Print debugging information. | |
75 | +.TP | |
76 | +.if !'po4a'hide' .BR \-v ", " \-\-verbose | |
77 | +Print verbose warning messages. | |
78 | +.TP | |
79 | +.if !'po4a'hide' .BR \-r ", " \-\-regex | |
80 | +Interpret each | |
81 | +.I name | |
82 | +as a regular expression. | |
83 | +If a | |
84 | +.I name | |
85 | +matches any part of a page name, a match will be made. | |
86 | +This option causes | |
87 | +.B %whatis% | |
88 | +to be somewhat slower due to the nature of database searches. | |
89 | +.TP | |
90 | +.if !'po4a'hide' .BR \-w ", " \-\-wildcard | |
91 | +Interpret each | |
92 | +.I name | |
93 | +as a pattern containing shell style wildcards. | |
94 | +For a match to be made, an expanded | |
95 | +.I name | |
96 | +must match the entire page name. | |
97 | +This option causes | |
98 | +.B %whatis% | |
99 | +to be somewhat slower due to the nature of database searches. | |
100 | +.TP | |
101 | +.if !'po4a'hide' .BR \-l ", " \-\-long | |
102 | +Do not trim output to the terminal width. | |
103 | +Normally, output will be truncated to the terminal width to avoid ugly | |
104 | +results from poorly-written | |
105 | +.B NAME | |
106 | +sections. | |
107 | +.TP | |
108 | +\fB\-s\fR \fIlist\/\fR, \ | |
109 | +\fB\-\-sections=\fIlist\/\fR, \ | |
110 | +\fB\-\-section=\fIlist\fR | |
111 | +Search only the given manual sections. | |
112 | +.I list | |
113 | +is a colon- or comma-separated list of sections. | |
114 | +If an entry in | |
115 | +.I list | |
116 | +is a simple section, for example "3", then the displayed list of | |
117 | +descriptions will include pages in sections "3", "3perl", "3x", and so on; | |
118 | +while if an entry in | |
119 | +.I list | |
120 | +has an extension, for example "3perl", then the list will only include | |
121 | +pages in that exact part of the manual section. | |
122 | +.TP | |
123 | +\fB\-m\fR \fIsystem\fR\|[\|,.\|.\|.\|]\|, \ | |
124 | +\fB\-\-systems=\fIsystem\fR\|[\|,.\|.\|.\|] | |
125 | +If this system has access to other operating systems' manual page names, | |
126 | +they can be accessed using this option. | |
127 | +To search NewOS's manual page names, | |
128 | +use the option | |
129 | +.B \-m | |
130 | +.BR NewOS . | |
131 | + | |
132 | +The | |
133 | +.I system | |
134 | +specified can be a combination of comma delimited operating system names. | |
135 | +To include a search of the native operating system's | |
136 | +manual page names, include the system name | |
137 | +.B man | |
138 | +in the argument string. | |
139 | +This option will override the | |
140 | +.RB $ SYSTEM | |
141 | +environment variable. | |
142 | +.TP | |
143 | +.BI \-M\ path \fR,\ \fB\-\-manpath= path | |
144 | +Specify an alternate set of colon-delimited manual page hierarchies to | |
145 | +search. | |
146 | +By default, | |
147 | +.B %program% | |
148 | +uses the | |
149 | +.RB $ MANPATH | |
150 | +environment variable, unless it is empty or unset, in which case it will | |
151 | +determine an appropriate manpath based on your | |
152 | +.RB $ PATH | |
153 | +environment variable. | |
154 | +This option overrides the contents of | |
155 | +.RB $ MANPATH . | |
156 | +.TP | |
157 | +.BI \-L\ locale \fR,\ \fB\-\-locale= locale | |
158 | +.B %program% | |
159 | +will normally determine your current locale by a call to the C function | |
160 | +.BR setlocale (3) | |
161 | +which interrogates various environment variables, possibly including | |
162 | +.RB $ LC_MESSAGES | |
163 | +and | |
164 | +.RB $ LANG . | |
165 | +To temporarily override the determined value, use this option to supply a | |
166 | +.I locale | |
167 | +string directly to | |
168 | +.BR %program% . | |
169 | +Note that it will not take effect until the search for pages actually | |
170 | +begins. | |
171 | +Output such as the help message will always be displayed in the initially | |
172 | +determined locale. | |
173 | +.TP | |
174 | +.BI \-C\ file \fR,\ \fB\-\-config\-file= file | |
175 | +Use this user configuration file rather than the default of | |
176 | +.IR ~/.manpath . | |
177 | +.TP | |
178 | +.if !'po4a'hide' .BR \-? ", " \-\-help | |
179 | +Print a help message and exit. | |
180 | +.TP | |
181 | +.if !'po4a'hide' .B \-\-usage | |
182 | +Print a short usage message and exit. | |
183 | +.TP | |
184 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
185 | +Display version information. | |
186 | +.SH "EXIT STATUS" | |
187 | +.TP | |
188 | +.if !'po4a'hide' .B 0 | |
189 | +Successful program execution. | |
190 | +.TP | |
191 | +.if !'po4a'hide' .B 1 | |
192 | +Usage, syntax or configuration file error. | |
193 | +.TP | |
194 | +.if !'po4a'hide' .B 2 | |
195 | +Operational error. | |
196 | +.TP | |
197 | +.if !'po4a'hide' .B 16 | |
198 | +Nothing was found that matched the criteria specified. | |
199 | +.SH ENVIRONMENT | |
200 | +.TP | |
201 | +.if !'po4a'hide' .B SYSTEM | |
202 | +If | |
203 | +.RB $ SYSTEM | |
204 | +is set, it will have the same effect as if it had been specified as the | |
205 | +argument to the | |
206 | +.B \-m | |
207 | +option. | |
208 | +.TP | |
209 | +.if !'po4a'hide' .B MANPATH | |
210 | +If | |
211 | +.RB $ MANPATH | |
212 | +is set, its value is interpreted as the colon-delimited manual page | |
213 | +hierarchy search path to use. | |
214 | + | |
215 | +See the | |
216 | +.B SEARCH PATH | |
217 | +section of | |
218 | +.BR manpath (5) | |
219 | +for the default behaviour and details of how this environment variable is | |
220 | +handled. | |
221 | +.TP | |
222 | +.if !'po4a'hide' .B MANWIDTH | |
223 | +If | |
224 | +.RB $ MANWIDTH | |
225 | +is set, its value is used as the terminal width (see the | |
226 | +.B \-\-long | |
227 | +option). | |
228 | +If it is not set, the terminal width will be calculated using the value of | |
229 | +.RB $ COLUMNS , | |
230 | +and | |
231 | +.BR ioctl (2) | |
232 | +if available, or falling back to 80 characters if all else fails. | |
233 | +.SH FILES | |
234 | +.TP | |
235 | +.if !'po4a'hide' .I /usr/share/man/index.(bt|db|dir|pag) | |
236 | +A traditional global | |
237 | +.I index | |
238 | +database cache. | |
239 | +.TP | |
240 | +.if !'po4a'hide' .I /var/cache/man/index.(bt|db|dir|pag) | |
241 | +An FHS | |
242 | +compliant global | |
243 | +.I index | |
244 | +database cache. | |
245 | +.TP | |
246 | +.if !'po4a'hide' .I /usr/share/man/\|.\|.\|.\|/whatis | |
247 | +A traditional | |
248 | +.B whatis | |
249 | +text database. | |
250 | +.SH "SEE ALSO" | |
251 | +.if !'po4a'hide' .BR %apropos% (1), | |
252 | +.if !'po4a'hide' .BR %man% (1), | |
253 | +.if !'po4a'hide' .BR %mandb% (8) | |
254 | +.SH AUTHOR | |
255 | +.nf | |
256 | +.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk). | |
257 | +.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org). | |
258 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
259 | +.fi | |
260 | +.SH BUGS | |
261 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
262 | +.br | |
263 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,84 @@ | ||
1 | +.\" Man page for %zsoelim% | |
2 | +.\" | |
3 | +.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.) | |
4 | +.\" | |
5 | +.\" You may distribute under the terms of the GNU General Public | |
6 | +.\" License as specified in the file COPYING that comes with the | |
7 | +.\" man-db distribution. | |
8 | +.\" | |
9 | +.\" Sat Dec 10 19:33:32 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) | |
10 | +.\" | |
11 | +.pc | |
12 | +.TH %thzsoelim% 1 "%date%" "%version%" "Manual pager utils" | |
13 | +.SH NAME | |
14 | +%zsoelim% \- satisfy .so requests in roff input | |
15 | +.SH SYNOPSIS | |
16 | +.B %zsoelim% | |
17 | +.RB [\| \-CVh \|] | |
18 | +.RI [\| file | |
19 | +\&.\|.\|.\|] | |
20 | +.SH DESCRIPTION | |
21 | +.B %zsoelim% | |
22 | +parses | |
23 | +.I file | |
24 | +arguments, or if none are specified, its standard input for lines of the | |
25 | +form: | |
26 | + | |
27 | +.B .so | |
28 | +.RI <\| filename \|> | |
29 | + | |
30 | +These requests are replaced by the contents of the | |
31 | +.I filename | |
32 | +specified. | |
33 | +If the request cannot be met, | |
34 | +.B %zsoelim% | |
35 | +looks for | |
36 | +.I filename.ext | |
37 | +where | |
38 | +.I .ext | |
39 | +can be one of | |
40 | +.BR .gz , | |
41 | +.B .Z | |
42 | +or | |
43 | +.BR .z . | |
44 | +Other extension types may be supported depending upon compile time options. | |
45 | +If the request can be met by a compressed file, this file is decompressed | |
46 | +using an appropriate decompressor and its output is used to satisfy | |
47 | +the request. | |
48 | + | |
49 | +Traditionally, | |
50 | +.B soelim | |
51 | +programs were used to allow roff preprocessors to be able to preprocess the | |
52 | +files referred to by the requests. | |
53 | +This particular version was written to circumvent problems created by | |
54 | +support for compressed manual pages. | |
55 | +.SH OPTIONS | |
56 | +.TP | |
57 | +.if !'po4a'hide' .BR \-C ", " \-\-compatible | |
58 | +This flag is available for compatibility with other | |
59 | +.B soelim | |
60 | +programs. | |
61 | +Its use is to enable .so requests followed by something other than | |
62 | +whitespace. | |
63 | +As this is already the default behaviour, it is ignored. | |
64 | +.TP | |
65 | +.if !'po4a'hide' .BR \-h ", " \-\-help | |
66 | +Print a help message and exit. | |
67 | +.TP | |
68 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
69 | +Display version information. | |
70 | +.SH "SEE ALSO" | |
71 | +.if !'po4a'hide' .BR groff (1), | |
72 | +.if !'po4a'hide' .BR %man% (1), | |
73 | +.if !'po4a'hide' .BR nroff (1), | |
74 | +.if !'po4a'hide' .BR troff (1) | |
75 | +.SH AUTHOR | |
76 | +.nf | |
77 | +.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk). | |
78 | +.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org). | |
79 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
80 | +.fi | |
81 | +.SH BUGS | |
82 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
83 | +.br | |
84 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,247 @@ | ||
1 | +.\" Man page for format of the manpath.config data file | |
2 | +.\" | |
3 | +.\" Copyright (C) 1994, 1995 Graeme W. Wilford. (Wilf.) | |
4 | +.\" Copyright (C) 2001-2019 Colin Watson. | |
5 | +.\" | |
6 | +.\" You may distribute under the terms of the GNU General Public | |
7 | +.\" License as specified in the file COPYING that comes with the | |
8 | +.\" man-db distribution. | |
9 | +.\" | |
10 | +.\" Sat Oct 29 13:09:31 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) | |
11 | +.\" | |
12 | +.pc | |
13 | +.TH MANPATH 5 "%date%" "%version%" "%manpath_config_file%" | |
14 | +.SH NAME | |
15 | +manpath \- format of the %manpath_config_file% file | |
16 | +.SH DESCRIPTION | |
17 | +The manpath configuration file is used by the manual page utilities | |
18 | +to assess users' manpaths at run time, to indicate which manual page | |
19 | +hierarchies (manpaths) are to be treated as system hierarchies and to | |
20 | +assign them directories to be used for storing cat files. | |
21 | + | |
22 | +If the environment variable | |
23 | +.RB $ MANPATH | |
24 | +is already set, the information contained within %manpath_config_file% will | |
25 | +not override it. | |
26 | +.SH SEARCH PATH | |
27 | +By default, man-db examines the user's | |
28 | +.RB $ PATH . | |
29 | +For each | |
30 | +.I path_element | |
31 | +found there, | |
32 | +it adds | |
33 | +.I manpath_element | |
34 | +to the search path. | |
35 | + | |
36 | +If there is no | |
37 | +.B MANPATH_MAP | |
38 | +line in the configuration file for a given | |
39 | +.IR path_element , | |
40 | +then it adds all of | |
41 | +.IR path_element/../man , | |
42 | +.IR path_element/man , | |
43 | +.IR path_element/../share/man , | |
44 | +and | |
45 | +.IR path_element/share/man | |
46 | +that exist as directories to the search path. | |
47 | + | |
48 | +It then adds any | |
49 | +.B MANDATORY_MANPATH | |
50 | +entries from the configuration file to the search path. | |
51 | + | |
52 | +Finally, if the | |
53 | +.B \-\-systems | |
54 | +option is used or the | |
55 | +.RB $ SYSTEM | |
56 | +environment variable is set, then that should consist of a sequence of | |
57 | +operating system names separated by commas or colons. | |
58 | +This acts as a template, expanding the search path once more to allow access | |
59 | +to other operating systems' manual pages: for each system name, man-db looks | |
60 | +for that name as a subdirectory of each entry in the search path, and adds | |
61 | +it to the final search path if it exists. | |
62 | +A system name of | |
63 | +.B man | |
64 | +inserts the normal search path without subdirectories. | |
65 | +For example, if the search path would otherwise have been | |
66 | +.IR /usr/share/man:/usr/local/man , | |
67 | +and | |
68 | +.RB $ SYSTEM | |
69 | +is set to | |
70 | +.IR newOS:man , | |
71 | +then the final search path will be | |
72 | +.IR /usr/share/man/newOS:/usr/share/man:/usr/local/man/newOS:/usr/local/man . | |
73 | + | |
74 | +The | |
75 | +.RB $ MANPATH | |
76 | +environment variable overrides man-db's default manual page search paths. | |
77 | +Most users should not need to set it. | |
78 | +Its syntax is similar to the | |
79 | +.RB $ PATH | |
80 | +environment variable: it consists of a sequence of directory names separated | |
81 | +by colons. | |
82 | +It overrides the default search path described above. | |
83 | + | |
84 | +If the value of | |
85 | +.RB $ MANPATH | |
86 | +starts with a colon, then the default search path is added at its start. | |
87 | +If the value of | |
88 | +.RB $ MANPATH | |
89 | +ends with a colon, then the default search path is added at its end. | |
90 | +If the value of | |
91 | +.RB $ MANPATH | |
92 | +contains a double colon | |
93 | +.RB ( :: ), | |
94 | +then the default search path is inserted in the middle of the value, between | |
95 | +the two colons. | |
96 | +.SH FORMAT | |
97 | +The following field types are currently recognised: | |
98 | +.TP | |
99 | +.BI # \ comment | |
100 | +Blank lines or those beginning with a | |
101 | +.B # | |
102 | +will be treated as comments and ignored. | |
103 | +.TP | |
104 | +.BI MANDATORY_MANPATH \ manpath_element | |
105 | +Lines of this form indicate manpaths that every automatically generated | |
106 | +.RB $ MANPATH | |
107 | +should contain. | |
108 | +This will typically include | |
109 | +.IR /usr/man . | |
110 | +.TP | |
111 | +.BI MANPATH_MAP \ path_element\ manpath_element | |
112 | +Lines of this form set up | |
113 | +.RB $ PATH | |
114 | +to | |
115 | +.RB $ MANPATH | |
116 | +mappings. | |
117 | +For each | |
118 | +.I path_element | |
119 | +found in the user's | |
120 | +.RB $ PATH , | |
121 | +.I manpath_element | |
122 | +will be added to the | |
123 | +.RB $ MANPATH . | |
124 | +.TP | |
125 | +\fBMANDB_MAP \fImanpath_element \fR\|[\| \fIcatpath_element\fR \|] | |
126 | +Lines of this form indicate which manpaths are to be treated as system | |
127 | +manpaths, and optionally where their cat files should be stored. | |
128 | +This field type is particularly important if | |
129 | +.B man | |
130 | +is a setuid program, as (when in the system configuration file | |
131 | +%manpath_config_file% rather than the per-user configuration file .manpath) | |
132 | +it indicates which manual page hierarchies to access as the setuid user and | |
133 | +which as the invoking user. | |
134 | + | |
135 | +The system manual page hierarchies are usually those stored under | |
136 | +.I /usr | |
137 | +such as | |
138 | +.IR /usr/man , | |
139 | +.I /usr/local/man | |
140 | +and | |
141 | +.IR /usr/X11R6/man . | |
142 | + | |
143 | +If cat pages from a particular | |
144 | +.I manpath_element | |
145 | +are not to be stored or are to be stored in the traditional location, | |
146 | +.I catpath_element | |
147 | +may be omitted. | |
148 | + | |
149 | +Traditional cat placement would be impossible for read only mounted manual | |
150 | +page hierarchies and because of this it is possible to specify any valid | |
151 | +directory hierarchy for their storage. | |
152 | +To observe the | |
153 | +.B Linux FSSTND | |
154 | +the keyword | |
155 | +.B FSSTND | |
156 | +can be used in place of an actual directory. | |
157 | + | |
158 | +Unfortunately, it is necessary to specify | |
159 | +.B all | |
160 | +system man tree paths, including alternate operating system paths such as | |
161 | +.I /usr/man/sun | |
162 | +and any | |
163 | +.B NLS locale | |
164 | +paths such as | |
165 | +.IR /usr/man/de_DE.88591 . | |
166 | + | |
167 | +As the information is parsed line by line in the order written, it is | |
168 | +necessary for any manpath that is a sub-hierarchy of another hierarchy to be | |
169 | +listed first, otherwise an incorrect match will be made. | |
170 | +An example is that | |
171 | +.I /usr/man/de_DE.88591 | |
172 | +must come before | |
173 | +.IR /usr/man . | |
174 | +.TP | |
175 | +.BI DEFINE \ key\ value | |
176 | +Lines of this form define miscellaneous configuration variables; see the | |
177 | +default configuration file for those variables used by the manual pager | |
178 | +utilities. | |
179 | +They include default paths to various programs (such as | |
180 | +.I grep | |
181 | +and | |
182 | +.IR tbl ), | |
183 | +and default sets of arguments to those programs. | |
184 | +.TP | |
185 | +\fBSECTION\fR \fIsection\fR .\|.\|. | |
186 | +.RS | |
187 | +Lines of this form define the order in which manual sections should be | |
188 | +searched. | |
189 | +If there are no | |
190 | +.B SECTION | |
191 | +directives in the configuration file, the default is: | |
192 | +.PP | |
193 | +.RS | |
194 | +.nf | |
195 | +.if !'po4a'hide' SECTION 1 n l 8 3 0 2 5 4 9 6 7 | |
196 | +.fi | |
197 | +.RE | |
198 | +.PP | |
199 | +If multiple | |
200 | +.B SECTION | |
201 | +directives are given, their section lists will be concatenated. | |
202 | +.PP | |
203 | +If a particular extension is not in this list (say, 1mh) it will be | |
204 | +displayed with the rest of the section it belongs to. | |
205 | +The effect of this is that you only need to explicitly list extensions if | |
206 | +you want to force a particular order. | |
207 | +Sections with extensions should usually be adjacent to their main section | |
208 | +(e.g. "1 1mh 8 ..."). | |
209 | +.PP | |
210 | +.B SECTIONS | |
211 | +is accepted as an alternative name for this directive. | |
212 | +.RE | |
213 | +.TP | |
214 | +.BI MINCATWIDTH \ width | |
215 | +If the terminal width is less than | |
216 | +.IR width , | |
217 | +cat pages will not be created (if missing) or displayed. | |
218 | +The default is 80. | |
219 | +.TP | |
220 | +.BI MAXCATWIDTH \ width | |
221 | +If the terminal width is greater than | |
222 | +.IR width , | |
223 | +cat pages will not be created (if missing) or displayed. | |
224 | +The default is 80. | |
225 | +.TP | |
226 | +.BI CATWIDTH \ width | |
227 | +If | |
228 | +.I width | |
229 | +is non-zero, cat pages will always be formatted for a terminal of the given | |
230 | +width, regardless of the width of the terminal actually being used. | |
231 | +This should generally be within the range set by | |
232 | +.B MINCATWIDTH | |
233 | +and | |
234 | +.BR MAXCATWIDTH . | |
235 | +.TP | |
236 | +.if !'po4a'hide' .B NOCACHE | |
237 | +This flag prevents | |
238 | +.BR %man% (1) | |
239 | +from creating cat pages automatically. | |
240 | +.SH BUGS | |
241 | +Unless the rules above are followed and observed precisely, the manual pager | |
242 | +utilities will not function as desired. | |
243 | +The rules are overly complicated. | |
244 | +.PP | |
245 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
246 | +.br | |
247 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,51 @@ | ||
1 | +.\" Man page for accessdb | |
2 | +.\" | |
3 | +.\" Copyright (c) 1998 Fabrizio Polacco <fpolacco@debian.org | |
4 | +.\" | |
5 | +.\" You may distribute under the terms of the GNU General Public | |
6 | +.\" License as specified in the file COPYING that comes with the | |
7 | +.\" man-db distribution. | |
8 | +.\" | |
9 | +.\" Tue, 24 Feb 1998 18:18:36 +0200 | |
10 | +.\" | |
11 | +.pc | |
12 | +.TH ACCESSDB 8 "%date%" "%version%" "Manual pager utils" | |
13 | +.SH NAME | |
14 | +accessdb \- dumps the content of a man-db database in a human readable | |
15 | +format | |
16 | +.SH SYNOPSIS | |
17 | +.B /usr/sbin/accessdb | |
18 | +.RB [\| \-d?V \|] | |
19 | +.RI [ <index-file> ] | |
20 | +.SH DESCRIPTION | |
21 | +.B accessdb | |
22 | +will output the data contained within a man-db database in a | |
23 | +human readable form. | |
24 | +By default, it will dump the data from | |
25 | +.B /var/cache/man/index.<db-type>, | |
26 | +where <db-type> is dependent on the database library in use. | |
27 | + | |
28 | +Supplying an argument to accessdb will override this default. | |
29 | +.SH OPTIONS | |
30 | +.TP | |
31 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
32 | +Print debugging information. | |
33 | +.TP | |
34 | +.if !'po4a'hide' .BR \-? ", " \-\-help | |
35 | +Print a help message and exit. | |
36 | +.TP | |
37 | +.if !'po4a'hide' .B \-\-usage | |
38 | +Print a short usage message and exit. | |
39 | +.TP | |
40 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
41 | +Display version information. | |
42 | +.SH AUTHOR | |
43 | +.nf | |
44 | +.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk). | |
45 | +.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org). | |
46 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
47 | +.fi | |
48 | +.SH BUGS | |
49 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
50 | +.br | |
51 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,129 @@ | ||
1 | +.\" Man page for catman | |
2 | +.\" | |
3 | +.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.) | |
4 | +.\" | |
5 | +.\" You may distribute under the terms of the GNU General Public | |
6 | +.\" License as specified in the file COPYING that comes with the | |
7 | +.\" man-db distribution. | |
8 | +.\" | |
9 | +.\" Sat Dec 10 14:17:29 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) | |
10 | +.\" | |
11 | +.pc | |
12 | +.TH %thcatman% 8 "%date%" "%version%" "Manual pager utils" | |
13 | +.SH NAME | |
14 | +%catman% \- create or update the pre-formatted manual pages | |
15 | +.SH SYNOPSIS | |
16 | +.B %catman% | |
17 | +.RB [\| \-d?V \|] | |
18 | +.RB [\| \-M | |
19 | +.IR path \|] | |
20 | +.RB [\| \-C | |
21 | +.IR file \|] | |
22 | +.RI [\| section \|] | |
23 | +\&.\|.\|. | |
24 | +.SH DESCRIPTION | |
25 | +.B %catman% | |
26 | +is used to create an up to date set of pre-formatted manual pages known as | |
27 | +cat pages. | |
28 | +Cat pages are generally much faster to display than the original | |
29 | +manual pages, but require extra storage space. | |
30 | +The decision to support cat pages is that of the local administrator, who | |
31 | +must provide suitable directories to contain them. | |
32 | + | |
33 | +The options available to | |
34 | +.B %catman% | |
35 | +are the manual page hierarchies and sections to pre-format. | |
36 | +The default hierarchies are those specified as system hierarchies in the | |
37 | +man-db configuration file, and the default sections are either the | |
38 | +colon-delimited contents of the environment variable | |
39 | +.RB $ MANSECT | |
40 | +or the standard set compiled into | |
41 | +.B %man% | |
42 | +if | |
43 | +.RB $ MANSECT | |
44 | +is undefined. | |
45 | +Supplying | |
46 | +.B %catman% | |
47 | +with a set of whitespace-delimited section names will override both of | |
48 | +the above. | |
49 | + | |
50 | +.B %catman% | |
51 | +makes use of the | |
52 | +.B index | |
53 | +database cache associated with each hierarchy to determine which files | |
54 | +need to be formatted. | |
55 | +.SH OPTIONS | |
56 | +.TP | |
57 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
58 | +Print debugging information. | |
59 | +.TP | |
60 | +.BI \-M\ path \fR,\ \fB\-\-manpath= path | |
61 | +Specify an alternate colon-delimited manual page hierarchy search path. | |
62 | +By default, this is all paths indicated as system hierarchies | |
63 | +in the man-db configuration file. | |
64 | +.TP | |
65 | +.BI \-C\ file \fR,\ \fB\-\-config\-file= file | |
66 | +Use this user configuration file rather than the default of | |
67 | +.IR ~/.manpath . | |
68 | +.TP | |
69 | +.if !'po4a'hide' .BR \-? ", " \-\-help | |
70 | +Print a help message and exit. | |
71 | +.TP | |
72 | +.if !'po4a'hide' .B \-\-usage | |
73 | +Print a short usage message and exit. | |
74 | +.TP | |
75 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
76 | +Display version information. | |
77 | +.SH ENVIRONMENT | |
78 | +.TP | |
79 | +.if !'po4a'hide' .B MANSECT | |
80 | +If | |
81 | +.RB $ MANSECT | |
82 | +is set, its value is a colon-delimited list of sections and it is used to | |
83 | +determine which manual sections to search and in what order. | |
84 | +The default is "%sections%", unless overridden by the | |
85 | +.B SECTION | |
86 | +directive in | |
87 | +.IR %manpath_config_file% . | |
88 | +.TP | |
89 | +.if !'po4a'hide' .B MANPATH | |
90 | +If | |
91 | +.RB $ MANPATH | |
92 | +is set, its value is interpreted as the colon-delimited manual page | |
93 | +hierarchy search path to use. | |
94 | + | |
95 | +See the | |
96 | +.B SEARCH PATH | |
97 | +section of | |
98 | +.BR manpath (5) | |
99 | +for the default behaviour and details of how this environment variable is | |
100 | +handled. | |
101 | +.SH FILES | |
102 | +.TP | |
103 | +.if !'po4a'hide' .I %manpath_config_file% | |
104 | +man-db configuration file. | |
105 | +.TP | |
106 | +.if !'po4a'hide' .I /usr/man/index.(bt|db|dir|pag) | |
107 | +A traditional global | |
108 | +.I index | |
109 | +database cache. | |
110 | +.TP | |
111 | +.if !'po4a'hide' .I /var/catman/index.(bt|db|dir|pag) | |
112 | +An alternate or FSSTND | |
113 | +compliant global | |
114 | +.I index | |
115 | +database cache. | |
116 | +.SH "SEE ALSO" | |
117 | +.if !'po4a'hide' .BR %man% (1), | |
118 | +.if !'po4a'hide' .BR manpath (5), | |
119 | +.if !'po4a'hide' .BR %mandb% (8) | |
120 | +.SH AUTHOR | |
121 | +.nf | |
122 | +.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk). | |
123 | +.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org). | |
124 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
125 | +.fi | |
126 | +.SH BUGS | |
127 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
128 | +.br | |
129 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,226 @@ | ||
1 | +'\" t | |
2 | +.\" Man page for mandb | |
3 | +.\" | |
4 | +.\" Copyright (C) 1994, 1995, Graeme W. Wilford. (Wilf.) | |
5 | +.\" Copyright (C) 2001-2019 Colin Watson. | |
6 | +.\" | |
7 | +.\" You may distribute under the terms of the GNU General Public | |
8 | +.\" License as specified in the file COPYING that comes with the | |
9 | +.\" man-db distribution. | |
10 | +.\" | |
11 | +.\" Tue Apr 26 12:56:44 BST 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) | |
12 | +.\" | |
13 | +.pc | |
14 | +.TH %thmandb% 8 "%date%" "%version%" "Manual pager utils" | |
15 | +.SH NAME | |
16 | +%mandb% \- create or update the manual page index caches | |
17 | +.SH SYNOPSIS | |
18 | +.B %mandb% | |
19 | +.RB [\| \-dqsucpt?V \|] | |
20 | +.RB [\| \-C | |
21 | +.IR file \|] | |
22 | +.RI [\| manpath \|] | |
23 | +.br | |
24 | +.B %mandb% | |
25 | +.RB [\| \-dqsut \|] | |
26 | +.RB [\| \-C | |
27 | +.IR file \|] | |
28 | +.B \-f | |
29 | +.IR filename \ .\|.\|. | |
30 | +.SH DESCRIPTION | |
31 | +.B %mandb% | |
32 | +is used to initialise or manually update | |
33 | +.B index | |
34 | +database caches. | |
35 | +The caches contain information relevant to the current state of the manual | |
36 | +page system and the information stored within them is used by the man-db | |
37 | +utilities to enhance their speed and functionality. | |
38 | + | |
39 | +When creating or updating an | |
40 | +.BR index , | |
41 | +.B %mandb% | |
42 | +will warn of bad ROFF .so requests, bogus manual page filenames and | |
43 | +manual pages from which the | |
44 | +.B whatis | |
45 | +cannot be parsed. | |
46 | + | |
47 | +Supplying | |
48 | +.B %mandb% | |
49 | +with an optional colon-delimited path will override the internal system | |
50 | +manual page hierarchy search path, determined from information found within | |
51 | +the man-db configuration file. | |
52 | +.SH "DATABASE CACHES" | |
53 | +.B %mandb% | |
54 | +can be compiled with support for any one of the following database types. | |
55 | + | |
56 | +.TS | |
57 | +tab (@); | |
58 | +l l l. | |
59 | +Name@Async@Filename | |
60 | +_ | |
61 | +Berkeley db@Yes@\fIindex.bt\fR | |
62 | +GNU gdbm@Yes@\fIindex.db\fR | |
63 | +UNIX ndbm@No@\fIindex.(dir|pag)\fR | |
64 | +.TE | |
65 | + | |
66 | +Those database types that support asynchronous updates provide enhanced | |
67 | +speed at the cost of possible corruption in the event of unusual | |
68 | +termination. | |
69 | +In an unusual case where this has occurred, it may be necessary to rerun | |
70 | +.B %mandb% | |
71 | +with the | |
72 | +.B \-c | |
73 | +option to re-create the databases from scratch. | |
74 | +.SH OPTIONS | |
75 | +.TP | |
76 | +.if !'po4a'hide' .BR \-d ", " \-\-debug | |
77 | +Print debugging information. | |
78 | +.TP | |
79 | +.if !'po4a'hide' .BR \-q ", " \-\-quiet | |
80 | +Produce no warnings. | |
81 | +.TP | |
82 | +.if !'po4a'hide' .BR \-s ", " \-\-no-straycats | |
83 | +Do not spend time looking for or adding information to the databases | |
84 | +regarding stray cats. | |
85 | +.TP | |
86 | +.if !'po4a'hide' .BR \-p ", " \-\-no-purge | |
87 | +Do not spend time checking for deleted manual pages and purging them from | |
88 | +the databases. | |
89 | +.TP | |
90 | +.if !'po4a'hide' .BR \-c ", " \-\-create | |
91 | +By default, | |
92 | +.B %mandb% | |
93 | +will try to update any previously created databases. | |
94 | +If a database does not exist, it will create it. | |
95 | +This option forces | |
96 | +.B %mandb% | |
97 | +to delete previous databases and re-create them from scratch, and implies | |
98 | +.B \-\-no-purge. | |
99 | +This may be necessary if a database becomes corrupt or if a new database | |
100 | +storage scheme is introduced in the future. | |
101 | +.TP | |
102 | +.if !'po4a'hide' .BR \-u ", " \-\-user-db | |
103 | +Create user databases only, even with write permissions necessary to create | |
104 | +system databases. | |
105 | +.TP | |
106 | +.if !'po4a'hide' .BR \-t ", " \-\-test | |
107 | +Perform correctness checks on manual pages in the hierarchy search path. | |
108 | +With this option, | |
109 | +.B %mandb% | |
110 | +will not alter existing databases. | |
111 | +.TP | |
112 | +.if !'po4a'hide' .BR \-f ", " \-\-filename | |
113 | +Update only the entries for the given filename. | |
114 | +This option is not for general use; it is used internally by | |
115 | +.B %man% | |
116 | +when it has been compiled with the | |
117 | +.B MAN_DB_UPDATES | |
118 | +option and finds that a page is out of date. | |
119 | +It implies | |
120 | +.B \-p | |
121 | +and disables | |
122 | +.B \-c | |
123 | +and | |
124 | +.BR \-s . | |
125 | +.TP | |
126 | +.BI \-C\ file \fR,\ \fB\-\-config\-file= file | |
127 | +Use this user configuration file rather than the default of | |
128 | +.IR ~/.manpath . | |
129 | +.TP | |
130 | +.if !'po4a'hide' .BR \-? ", " \-\-help | |
131 | +Show the usage message, then exit. | |
132 | +.TP | |
133 | +.if !'po4a'hide' .B \-\-usage | |
134 | +Print a short usage message and exit. | |
135 | +.TP | |
136 | +.if !'po4a'hide' .BR \-V ", " \-\-version | |
137 | +Show the version, then exit. | |
138 | +.SH "EXIT STATUS" | |
139 | +.TP | |
140 | +.if !'po4a'hide' .B 0 | |
141 | +Successful program execution. | |
142 | +.TP | |
143 | +.if !'po4a'hide' .B 1 | |
144 | +Usage, syntax, or configuration file error. | |
145 | +.TP | |
146 | +.if !'po4a'hide' .B 2 | |
147 | +Operational error. | |
148 | +.TP | |
149 | +.if !'po4a'hide' .B 3 | |
150 | +A child process failed. | |
151 | +.SH DIAGNOSTICS | |
152 | +The following warning messages can be emitted during database building. | |
153 | +.TP | |
154 | +.B <filename>: whatis parse for page(sec) failed | |
155 | +An attempt to extract whatis line(s) from the given <filename> failed. | |
156 | +This is usually due to a poorly written manual page, but if many such | |
157 | +messages are emitted it is likely that the system contains non-standard | |
158 | +manual pages which are incompatible with the man-db whatis parser. | |
159 | +See the | |
160 | +.B WHATIS PARSING | |
161 | +section in | |
162 | +.BR lexgrog (1) | |
163 | +for more information. | |
164 | +.TP | |
165 | +.B <filename>: is a dangling symlink | |
166 | +<filename> does not exist but is referenced by a symbolic link. | |
167 | +Further diagnostics are usually emitted to identify the <filename> of the | |
168 | +offending link. | |
169 | +.TP | |
170 | +.B <filename>: bad symlink or ROFF `.so' request | |
171 | +<filename> is either a symbolic link to, or contains a ROFF include | |
172 | +request to, a non existent file. | |
173 | +.TP | |
174 | +.B <filename>: ignoring bogus filename | |
175 | +The <filename> may or may not be a valid manual page but its name is | |
176 | +invalid. | |
177 | +This is usually due to a manual page with sectional extension <x> being put | |
178 | +in manual page section <y>. | |
179 | +.TP | |
180 | +.B <filename_mask>: competing extensions | |
181 | +The wildcard <filename_mask> is not unique. | |
182 | +This is usually caused by the existence of both a compressed and | |
183 | +uncompressed version of the same manual page. | |
184 | +All but the most recent are ignored. | |
185 | +.SH FILES | |
186 | +.TP | |
187 | +.if !'po4a'hide' .I %manpath_config_file% | |
188 | +man-db configuration file. | |
189 | +.TP | |
190 | +.if !'po4a'hide' .I /var/cache/man/index.(bt|db|dir|pag) | |
191 | +An FHS compliant global | |
192 | +.I index | |
193 | +database cache. | |
194 | +.PP | |
195 | +Older locations for the database cache included: | |
196 | +.TP | |
197 | +.if !'po4a'hide' .I /usr/man/index.(bt|db|dir|pag) | |
198 | +A traditional global | |
199 | +.I index | |
200 | +database cache. | |
201 | +.TP | |
202 | +.if !'po4a'hide' .I /var/catman/index.(bt|db|dir|pag) | |
203 | +An alternate or FSSTND | |
204 | +compliant global | |
205 | +.I index | |
206 | +database cache. | |
207 | +.SH "SEE ALSO" | |
208 | +.if !'po4a'hide' .BR lexgrog (1), | |
209 | +.if !'po4a'hide' .BR %man% (1), | |
210 | +.if !'po4a'hide' .BR manpath (5), | |
211 | +.if !'po4a'hide' .BR %catman% (8) | |
212 | +.PP | |
213 | +The | |
214 | +.B "WHATIS PARSING" | |
215 | +section formerly in this manual page is now part of | |
216 | +.BR lexgrog (1). | |
217 | +.SH AUTHOR | |
218 | +.nf | |
219 | +.if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk). | |
220 | +.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org). | |
221 | +.if !'po4a'hide' Colin Watson (cjwatson@debian.org). | |
222 | +.fi | |
223 | +.SH BUGS | |
224 | +.if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues | |
225 | +.br | |
226 | +.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db |
@@ -0,0 +1,27 @@ | ||
1 | +# この sed ファイルは man-db オリジナルソースを configure した後に | |
2 | +# 生成される <original_soruce_dir>/man/ja/Makefile に対して、 | |
3 | +# 以下の置換を施して本 man ページビルドを行うためのもの。 | |
4 | +# (original/gettext.txt にてこれを利用するコマンド実行を行っている。) | |
5 | +# | |
6 | +# ビルドディレクトリをカレントにする (不要だったか?) | |
7 | +s|$(top_builddir)|.|g | |
8 | +# -------------------------------------------------- | |
9 | +# | |
10 | +# *.man{1,5,8} の生成出力先を tmp 配下とする。 | |
11 | +s|^\tman|\ttmp/man|g | |
12 | +# -------------------------------------------------- | |
13 | +# | |
14 | +# DESTDIR 手法をとるため mandir 定義を unset する。 | |
15 | +s|^mandir =.*$|mandir =| | |
16 | +# -------------------------------------------------- | |
17 | +# | |
18 | +# sed ファイル replace.sin の配置場所を変更する。 | |
19 | +# (これは original/gettext.sh であらかじめその場所にコピーしている。) | |
20 | +s|man/replace.sin|original/replace.sin| | |
21 | +# -------------------------------------------------- | |
22 | +# | |
23 | +# 以下はおそらくオリジナルのバグであり、 | |
24 | +# これがあると無関係な場所にman{1,5,8}ディレクトリが生成されてしまう | |
25 | +# ため、ディレクトリ先を修正する。 | |
26 | +s|$(AM_V_at)$(MKDIR_P) man|$(AM_V_at)$(MKDIR_P) release/man|g | |
27 | +# -------------------------------------------------- |
@@ -1,8 +1,8 @@ | ||
1 | 1 | ■:man-db:2.3.10=>2.10.0:2022/02/04:apropos:man1:2022/02/07::michio_matsuyama@yahoo.co.jp:Michio MATSUYAMA: |
2 | -▲:man-db:2.10.0:2022/02/04:lexgrog:man1:2022/02/07:::: | |
2 | +▲:man-db:2.10.0:2022/02/04:lexgrog:man1:2022/02/07::michio_matsuyama@yahoo.co.jp:Michio MATSUYAMA: | |
3 | 3 | ■:man-db:2.3.10=>2.10.0:2022/02/04:man:man1:2022/02/07::michio_matsuyama@yahoo.co.jp:Michio MATSUYAMA: |
4 | -▲:man-db:2.10.0:2022/02/04:man-recode:man1:2022/02/07:::: | |
5 | -▲:man-db:2.10.0:2022/02/04:manconv:man1:2022/02/07:::: | |
4 | +▲:man-db:2.10.0:2022/02/04:man-recode:man1:2022/02/07::michio_matsuyama@yahoo.co.jp:Michio MATSUYAMA: | |
5 | +▲:man-db:2.10.0:2022/02/04:manconv:man1:2022/02/07::michio_matsuyama@yahoo.co.jp:Michio MATSUYAMA: | |
6 | 6 | ■:man-db:2.3.10=>2.10.0:2022/02/04:manpath:man1:2022/02/07::michio_matsuyama@yahoo.co.jp:Michio MATSUYAMA: |
7 | 7 | ■:man-db:2.3.10=>2.10.0:2022/02/04:whatis:man1:2022/02/07::michio_matsuyama@yahoo.co.jp:Michio MATSUYAMA: |
8 | 8 | ■:man-db:2.3.10=>2.10.0:2022/02/04:zsoelim:man1:2022/02/07::michio_matsuyama@yahoo.co.jp:Michio MATSUYAMA: |