texi2roff(1) [suse man page]

Texi2roff(1)						      General Commands Manual						      Texi2roff(1)

NAME

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

SYNOPSIS

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

DESCRIPTION

       Texi2roff translates the named files from the Texinfo macro language for TeX to the language accepted by troff(1).  Files are read and pro-
       cessed in order.  If no file is given or if the file is - texi2roff reads the standard input.

       Texi2index generates indices for documents translated by texi2roff.

OPTIONS

       Texi2roff

       -me -mm -ms
	      format the output for use with the troff macro package named.

       -i     translate Texinfo index commands into troff index commands.  troff will then emit index entries onto the standard error output.  You
	      may capture this output and use texi2index(1) and troff to prepare indices from it.

       -I     include  Texinfo	``Info	file''	menu and node contents and @ifinfo text in the output.	This material does not appear in a Texinfo
	      document formatted by TeX, but may contain interesting information 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

       Translate  doc.texinfo  using  the  Bourne  shell  sh(1).  Format with troff and -ms, placing the formatted output in doc, index entries in
       index, and the formatted index in doc.index.

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

       As above, but use the C shell csh(1), nroff with -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 (erlebach@cs.toronto.edu).

BUGS

       f(CW is used to change to constant-width (typewriter-like) font.  If this is not the standard at your  site,  run  your  texi2roff  output
       through sed(1) or edit texi2roff's translation tables.

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

       @def commands do not generate index entries.

       Although  Texinfo  provides for a @contents and @summarycontents Table of Contents, if both are specified only the first one will appear if
       -ms is used.  To prevent loss of detail, texi2roff generates the same Table of Contents for both commands.

       The -mm macro package regards keeps as a type of display.  This can cause troff to abort in the case of a keep nested in a display or  vice
       versa.  Either use a different macro package or remove a pair of Texinfo commands to eliminate nesting.	Usually the @group...@end group is
       the best to remove.

3rd Berkeley Distribution					     1 Jan 90							      Texi2roff(1)

Check Out this Related Man Page

checknr(1)							   User Commands							checknr(1)

NAME

       checknr - check nroff and troff input files; report possible errors

SYNOPSIS

       checknr [-fs] [-a . x1 . y1 . x2 . y2 ... .xn .yn]
	    [-c . x1 . x2 . x3 ... .xn] [filename]...

DESCRIPTION

       checknr	checks	a list of nroff(1) or troff(1) input files for certain kinds of errors involving mismatched opening and closing delimiters
       and unknown commands. If no files are specified, checknr checks the standard input. Delimiters checked are:

	   o	  Font changes using fx ... fP.

	   o	  Size changes using sx ... s0.

	   o	  Macros that come in open ... close forms, for example, the .TS and .TE macros which must always come in pairs.

       checknr knows about the ms(5) and me(5) macro packages.

       checknr is intended to be used on documents that are prepared with checknr in mind.  It expects a certain document writing style for f and
       s  commands, in that each fx must be terminated with fP and each sx must be terminated with s0. While it will work to directly go into
       the next font or explicitly specify the original font or point size, and many existing documents actually do this,  such  a  practice  will
       produce	complaints  from checknr. Since it is probably better to use the fP and s0 forms anyway, you should think of this as a contribu-
       tion to your document preparation style.

OPTIONS

       -f		       Ignore f font changes.

       -s		       Ignore s size changes.

       -a .x1 .y1...	       Add pairs of macros to the list. The pairs of macros are assumed to be those (such as .DS and .DE) that	should	be
			       checked	for  balance.	The  -a option must be followed by groups of six characters, each group defining a pair of
			       macros. The six characters are a period, the first macro name, another period, and the second macro name. For exam-
			       ple, to define a pair .BS and .ES, use `-a.BS.ES'

       -c .x1...	       Define commands which checknr would otherwise complain about as undefined.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWdoc			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       eqn(1), nroff(1), troff(1), attributes(5), me(5), ms(5)

BUGS

       There is no way to define a one-character macro name using the -a option.

SunOS 5.11							    14 Sep 1992 							checknr(1)

Linux and UNIX Man Pages

texi2roff(1) [suse man page]

Check Out this Related Man Page