summaryrefslogtreecommitdiffstats
path: root/man/man1/manconv.man1
blob: cfe36ad98efeea5a2b07373dbe079e022d4390a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
.\" Man page for manconv
.\"
.\" Copyright (c) 2007, 2008 Colin Watson <cjwatson@debian.org>
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the file docs/COPYING.GPLv2 that comes with the
.\" man-db distribution.
.pc
.TH %thmanconv% 1 "%date%" "%version%" "Manual pager utils"
.SH NAME
%manconv% \- convert manual page from one encoding to another
.SH SYNOPSIS
.B %manconv%
.B \-f
.RI [\| from-code \|[: from-code \|.\|.\|.]\|]
.B \-t
.I to-code
.RB [\| \-dqhV \|]
.RI [\| filename \|]
.SH DESCRIPTION
.B %manconv%
converts a manual page from one encoding to another, like
.BR iconv .
Unlike
.BR iconv ,
it can try multiple possible input encodings in sequence.
This is useful for manual pages installed in directories without an explicit
encoding declaration, since they may be in UTF\-8 or in a legacy character
set.
.PP
If an encoding declaration is found on the first line of the manual page,
that declaration overrides any input encodings specified on
.BR %manconv% 's
command line.
Encoding declarations have the following form:
.PP
.RS
.nf
.if !'po4a'hide' \&\(aq\e" \-*\- coding: UTF\-8 \-*\-
.fi
.RE
.PP
or (if manual page preprocessors are also to be declared):
.PP
.RS
.nf
.if !'po4a'hide' \&\(aq\e" t \-*\- coding: ISO\-8859\-1 \-*\-
.fi
.RE
.SH OPTIONS
.TP
\fB\-f\fP \fIencodings\fP, \fB\-\-from\-code\fP \fIencodings\fP
Try each of
.I encodings
(a colon-separated list) in sequence as the input encoding.
The default is to guess likely input encodings based on the file name.
.TP
\fB\-t\fP \fIencoding\fP, \fB\-\-to\-code\fP \fIencoding\fP
Convert the manual page to
.IR encoding .
.TP
.if !'po4a'hide' .BR \-q ", " \-\-quiet
Do not issue error messages when the page cannot be converted.
.TP
.if !'po4a'hide' .BR \-d ", " \-\-debug
Print debugging information.
.TP
.if !'po4a'hide' .BR \-h ", " \-\-help
Print a help message and exit.
.TP
.if !'po4a'hide' .BR \-V ", " \-\-version
Display version information.
.SH "SEE ALSO"
.if !'po4a'hide' .IR iconv (1),
.if !'po4a'hide' .IR %man% (1),
.if !'po4a'hide' .IR %man_recode% (1)
.SH AUTHOR
.nf
.if !'po4a'hide' Colin Watson (cjwatson@debian.org).
.fi
.SH BUGS
.if !'po4a'hide' https://gitlab.com/man-db/man-db/-/issues
.br
.if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db