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

313 lines
4.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of NROFF</TITLE>
</HEAD><BODY>
<H1>NROFF</H1>
Section: User Commands (1)<BR>Updated: 21 March 2020<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>
nroff - use groff to format documents for TTY devices
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
[<B>-CchipStUv</B>]
[<B>-d</B><I>cs</I>]
[<B>-M</B><I>dir</I>]
[<B>-m</B><I>name</I>]
[<B>-n</B><I>num</I>]
[<B>-o</B><I>list</I>]
[<B>-r</B><I>cn</I>]
[<B>-T</B><I>name</I>]
[<B>-W</B><I>warning</I>]
[<B>-w</B><I>warning</I>]
[<I>file</I>
...]
<B>--help</B>
<B>-v</B>
<B>--version</B>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<I>nroff</I>
formats documents written in the
<I><A HREF="/cgi-bin/man/man2html?7+roff">roff</A></I>(7)
language for typewriter-like devices such as terminal emulators.
<P>
GNU
<I>nroff</I>
emulates the traditional Unix
<I>nroff</I>
command using
<I><A HREF="/cgi-bin/man/man2html?1+groff">groff</A></I>(1).
<I>nroff</I>
generates output via
<I><A HREF="/cgi-bin/man/man2html?1+grotty">grotty</A></I>(1),
<I>groff</I>'s
TTY output device,
which needs to know the character encoding scheme used by the terminal.
Consequently,
acceptable arguments to the
<B>-T</B>
option are
<B>ascii</B>,
<B>latin1</B>,
<B>utf8</B>,
and
<B>cp1047</B>;
any others are ignored.
If neither the
<I>GROFF_TYPESETTER</I>
environment variable nor the
<B>-T</B>
command-line option (which overrides the environment variable)
specifies a (valid) device,
<I>nroff</I>
consults the locale to select an appropriate output device.
It first tries the
<I><A HREF="/cgi-bin/man/man2html?1+locale">locale</A></I>(1)
program,
then checks several locale-related environment variables;
see "ENVIRONMENT", below.
If all of the foregoing fail,
<B>-Tascii</B>
is implied.
<P>
Whitespace is not permitted between an option and its argument.
The
<B>-h</B>
and
<B>-c</B>
options
are equivalent to
<I>grotty</I>'s
options
<B>-h</B>
(using tabs in the output) and
<B>-c</B>
(using the old output scheme instead of SGR escape sequences).
The
<B>-d</B>,
<B>-C</B>,
<B>-i</B>,
<B>-M</B>,
<B>-m</B>,
<B>-n</B>,
<B>-o</B>,
<B>-r</B>,
<B>-w</B>,
and
<B>-W</B>
options have the effect described in
<I><A HREF="/cgi-bin/man/man2html?1+troff">troff</A></I>(1).
In addition,
<I>nroff</I>
ignores
<B>-e</B>,
<B>-q</B>,
and
<B>-s</B>
(which are not implemented in
<I>troff</I>).
The options
<B>-p</B>
(pic),
<B>-t</B>
(tbl),
<B>-S</B>
(safer), and
<B>-U</B>
(unsafe) are passed to
<I>groff</I>.
<B>-v</B>
and
<B>--version</B>
show version information,
while
<B>--help</B>
displays a usage message;
all exit afterward.
<A NAME="lbAE">&nbsp;</A>
<H2>ENVIRONMENT</H2>
<DL COMPACT>
<DT id="1"><I>GROFF_TYPESETTER</I>
<DD>
specifies the default output device for
<I>groff</I>.
<DT id="2"><I>GROFF_BIN_PATH</I>
<DD>
is a colon-separated list of directories in which to search for the
<I>groff</I>
executable before searching in
<I>PATH</I>.
If unset,
<I>/usr/:bin</I>
is used.
<DT id="3"><I>LC_ALL</I>
<DD>
<I>LC_CTYPE</I>
<I>LANG</I>
<I>LESSCHARSET</I>
are pattern-matched in this order for standard character encodings
supported by
<I>groff</I>
in the event no
<B>-T</B>
option is given and
<I>GROFF_TYPESETTER</I>
is unset.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>NOTES</H2>
Character definitions in the file
<I>/usr/:share/:groff/:1.22.4/:tmac/:tty-char.tmac</I>
are loaded to replace unrepresentable glyphs.
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<I><A HREF="/cgi-bin/man/man2html?1+groff">groff</A></I>(1),
<I><A HREF="/cgi-bin/man/man2html?1+troff">troff</A></I>(1),
<I><A HREF="/cgi-bin/man/man2html?1+grotty">grotty</A></I>(1),
<I><A HREF="/cgi-bin/man/man2html?1+locale">locale</A></I>(1),
<I><A HREF="/cgi-bin/man/man2html?7+roff">roff</A></I>(7)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="4"><A HREF="#lbAB">NAME</A><DD>
<DT id="5"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="6"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="7"><A HREF="#lbAE">ENVIRONMENT</A><DD>
<DT id="8"><A HREF="#lbAF">NOTES</A><DD>
<DT id="9"><A HREF="#lbAG">SEE ALSO</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:20 GMT, March 31, 2021
</BODY>
</HTML>