man-pages/man1/man-recode.1.html
2021-03-31 01:06:50 +01:00

144 lines
3.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of MAN-RECODE</TITLE>
</HEAD><BODY>
<H1>MAN-RECODE</H1>
Section: Manual pager utils (1)<BR>Updated: 2020-02-25<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
man-recode - convert manual pages to another encoding
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>man-recode</B>
<B>-t</B>
<I>to-code</I>
{<B>--suffix=</B><I>suffix/</I>|<B>--in-place</B>}
[<B>-dqhV</B>]
[<I>filename</I>]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>man-recode</B>
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</B>
or
<B>manconv</B>
on each page.
<P>
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.
<P>
Encoding declarations have the following form:
<P>
<DL COMPACT><DT id="1"><DD>
<PRE>
'\&quot; -*- coding: UTF-8 -*-
</PRE>
</DL>
<P>
or (if manual page preprocessors are also to be declared):
<P>
<DL COMPACT><DT id="2"><DD>
<PRE>
'\&quot; t -*- coding: ISO-8859-1 -*-
</PRE>
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="3"><B>-t</B> <I>encoding/</I>, <B>--to-code=</B><I>encoding</I><DD>
Convert manual pages to
<I>encoding</I>.
<DT id="4"><B>--suffix=</B><I>suffix</I><DD>
Form each output file name by appending
<I>suffix</I>
to the input file name, after removing any compression extension.
<DT id="5"><B>--in-place</B>
<DD>
Overwrite each input file with the output, after removing any compression
extension.
<DT id="6"><B>-q</B>, <B>--quiet</B>
<DD>
Do not issue error messages when the page cannot be converted.
<DT id="7"><B>-d</B>, <B>--debug</B>
<DD>
Print debugging information.
<DT id="8"><B>-h</B>, <B>--help</B>
<DD>
Print a help message and exit.
<DT id="9"><B>-V</B>, <B>--version</B>
<DD>
Display version information.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
<I><A HREF="/cgi-bin/man/man2html?1+iconv">iconv</A></I>(1),
<I><A HREF="/cgi-bin/man/man2html?1+man">man</A></I>(1),
<I><A HREF="/cgi-bin/man/man2html?1+manconv">manconv</A></I>(1)
<A NAME="lbAG">&nbsp;</A>
<H2>AUTHOR</H2>
<PRE>
Colin Watson (<A HREF="mailto:cjwatson@debian.org">cjwatson@debian.org</A>).
</PRE>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
<DT id="11"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="12"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="13"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="14"><A HREF="#lbAF">SEE ALSO</A><DD>
<DT id="15"><A HREF="#lbAG">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:19 GMT, March 31, 2021
</BODY>
</HTML>