MAN page from Other texinfo-devel-4.8-1.i386.rpm

Texi2roff

Section: User Commands (1)
Updated: 1 Jan 90
Index

NAME

texi2roff, texi2index - convert Texinfo documents for formatting by troff.

SYNOPSIS

texi2roff[-me -mm -ms] [-iIt] [ file ... ]
texi2index[ file ... ]

DESCRIPTION

Texi2rofftranslates the namedfilesfrom the Texinfo macro language for TeX to the language accepted bytroff(1).Files are read and processed in order.If nofileis given or if thefileis-texi2roffreads the standard input.

Texi2indexgenerates indices for documents translated bytexi2roff.

OPTIONS

Texi2roff

-me -mm -ms: format the output for use with thetroffmacro package named.
-i: translate Texinfo index commands into troffindex commands.troffwill then emit index entries onto the standard error output.You may capture this output and usetexi2index(1)andtroffto prepare indices from it.
-I: include Texinfo ``Info file'' menu and node contents and@ifinfotext in the output.This material does not appearin a Texinfo document formatted by TeX, but may contain interestinginformation or be useful when searching a machine-readable document.
-t: (transparent) print text affected by otherwise discarded commands,for people who are afraid of missing something. For best results use-It.

EXAMPLES

Translatedoc.texinfousing the Bourne shellsh(1).Format withtroffand-ms,placing the formatted output indoc,index entries inindex,and the formatted index indoc.index.

$ texi2roff -i -ms doc.texinfo | troff -ms > doc 2> index$ texi2index index | troff -ms >doc.index

As above, but use the C shellcsh(1),nroffwith-me,and transparent mode:

% (texi2roff -iIt -me doc.texinfo | nroff -me > doc ) >& index% texi2index index | nroff -me >doc.index

DIAGNOSTICS

Errors are reported giving file name and line number.

AUTHOR

Beverly Erlebacher (erlebachAATTcs.toronto.edu).

BUGS

\f(CWis used to change to constant-width (typewriter-like) font.If this is not the standard at your site, run yourtexi2roffoutput throughsed(1)or edittexi2roff'stranslation tables.

There are a number of differences in formatting detailscompared to Texinfo.Indentation is occasionally imperfect.

@defcommands do not generate index entries.

Although Texinfo provides for a@contentsand@summarycontentsTable of Contents, if both are specifiedonly the first one will appear if-msis used.To prevent loss of detail,texi2roffgenerates the same Table of Contents for both commands.

The-mmmacro package regards keeps as a type ofdisplay. This can causetroffto abort in the case of a keep nestedin a display or vice versa. Either use a different macro package orremove a pair of Texinfo commands to eliminate nesting. Usually the@group...@end groupis the best to remove.

This document was created byman2html,using the manual pages.