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)

VGRIND(1)						    BSD General Commands Manual 						 VGRIND(1)

NAME

     vgrind -- grind nice listings of programs

SYNOPSIS

     vgrind [-] [-W] [-d file] [-f] [-h header] [-l language] [-n] [-sn] [-t] [-x] name ...

DESCRIPTION

     vgrind formats the program sources which are arguments in a nice style using troff(1).  Comments are placed in italics, keywords in bold
     face, and the name of the current function is listed down the margin of each page as it is encountered.

     vgrind runs in two basic modes, filter mode (see the -f option) or regular mode.  In filter mode vgrind acts as a filter in a manner similar
     to tbl(1).  The standard input is passed directly to the standard output except for lines bracketed by the troff-like macros:

     .vS     starts processing

     .vE     ends processing

     These lines are formatted as described above.  The output from this filter can be passed to troff for output.  There need be no particular
     ordering with eqn(1) or tbl(1).

     In regular mode vgrind accepts input files, processes them, and passes them to troff(1) for output.

     In both modes vgrind passes any lines beginning with a decimal point without conversion.

     The options are:

     -		   forces input to be taken from standard input (default if -f is specified )

     -d file	   specifies an alternative language definitions file (default is /usr/share/misc/vgrindefs)

     -f 	   forces filter mode

     -h header	   specifies a particular header to put on every output page (default is the file name)

     -l 	   specifies the language to use.  Currently known are PASCAL (-lp), MODEL (-lm), C (-lc or the default), CSH (-lcsh), SHELL
		   (-lsh), RATFOR (-lr), MODULA2 (-lmod2), YACC (-lyacc), LISP (-lisp), and ICON (-lI).

     -n 	   forces no keyword bolding

     -s 	   specifies a point size to use on output (exactly the same as the argument of a .ps)

     -t 	   similar to the same option in troff causing formatted text to go to the standard output

     -W 	   forces output to the (wide) Versatec printer rather than the (narrow) Varian

     -x 	   outputs the index file in a ``pretty'' format.  The index file itself is produced whenever vgrind is run with a file called
		   index in the current directory.  The index of function definitions can then be run off by giving vgrind the -x option and the
		   file index as argument.

FILES

     index			  file where source for index is created
     /usr/share/tmac/tmac.vgrind  macro package
     /usr/libexec/vfontedpr	  preprocessor
     /usr/share/misc/vgrindefs	  language descriptions

SEE ALSO

     lpr(1), troff(1), getcap(3), vgrindefs(5)

BUGS

     Vfontedpr assumes that a certain programming style is followed:

     For C - function names can be preceded on a line only by spaces, tabs, or an asterisk.  The parenthesized arguments must also be on the same
     line.

     For PASCAL - function names need to appear on the same line as the keywords function or procedure.

     For MODEL - function names need to appear on the same line as the keywords is beginproc.

     If these conventions are not followed, the indexing and marginal function name comment mechanisms will fail.

     More generally, arbitrary formatting styles for programs mostly look bad.	The use of spaces to align source code fails miserably; if you
     plan to vgrind your program you should use tabs.  This is somewhat inevitable since the font used by vgrind is variable width.

     The mechanism of ctags(1) in recognizing functions should be used here.

     Filter mode does not work in documents using the -me or -ms macros.  (So what use is it anyway?)

HISTORY

     The vgrind command appeared in 3.0BSD.

4th Berkeley Distribution					   June 6, 1993 					 4th Berkeley Distribution