.\" Man page for man-recode
.\"
.\" Copyright (C) 2019 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 %thman_recode% 1 "%date%" "%version%" "Manual pager utils"
.SH NAME
%man_recode% \- convert manual pages to another encoding
.SH SYNOPSIS
.B %man_recode%
.B \-t
.I to-code
{\|\fB\-\-suffix=\fIsuffix\/\fR\||\|\c
.BR \-\-in\-place \|}
.RB [\| \-dqhV \|]
.RI [\| filename \|]
.SH DESCRIPTION
.B %man_recode%
converts multiple manual pages from one encoding to another, guessing the
appropriate input encoding for each one.
It is useful when permanently recoding pages written in legacy character
sets, or in build systems that need to recode a set of pages to a single
common encoding (usually UTF\-8) for installation.
When converting many manual pages, this program is much faster than running
.B %man% \-\-recode
or
.B %manconv%
on each page.
.PP
If an encoding declaration is found on the first line of a manual page, then
that declaration is used as the input encoding for that page.
Failing that, the input encoding is guessed based on the file name.
.PP
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\-t\fR \fIencoding\/\fR, \fB\-\-to\-code=\fIencoding\fR
Convert manual pages to
.IR encoding .
.TP
\fB\-\-suffix=\fIsuffix\fR
Form each output file name by appending
.I suffix
to the input file name, after removing any compression extension.
.TP
.if !'po4a'hide' .B \-\-in\-place
Overwrite each input file with the output, after removing any compression
extension.
.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 %manconv% (1)
.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
.SH AUTHOR
.nf
.if !'po4a'hide' Colin Watson (cjwatson@debian.org).
.fi
