man/neatroff.1

   1 .\" first draft by Larry Kollar
   2 .TH neatroff 1
   3 .SH NAME
   4 neatroff \- the neatroff typesetting processor
   5 .SH SYNOPSIS
   6 .I neatroff
   7 .RB [ \-m\c
   8 .IR x ]
   9 .RB [ \-C ]
  10 .RB [ \-T\c
  11 .IR dev ]
  12 .RB [ \-F\c
  13 .IR dir ]
  14 .RB [ \-M\c
  15 .IR dir ]
  16 .RI [ files \&...]
  17 .SH DESCRIPTION
  18 .I Neatroff
  19 is an extended version of AT&T
  20 .IR ditroff ,
  21 supporting TrueType/OpenType fonts
  22 and whole-paragraph formatting.
  23 .I Neatroff
  24 requires the user to construct the pipeline
  25 to format a document.
  26 For example:
  27 .EX
  28 .sp
  29 cat mydoc.t | neateqn | neatroff -ms -Tutf | neatpost | ps2pdf - mydoc.pdf
  30 .EE
  31 .SS Extensions
  32 The following are the most important
  33 .I neatroff
  34 extensions:
  35 .IP \[bu] 3
  36 Like GNU
  37 .IR troff ,
  38 .I neatroff
  39 supports names of arbitrary length for
  40 requests, macro names, number registers, and string variables.
  41 .IP \[bu]
  42 .I Neatroff
  43 supports UTF-8 input
  44 without the need for a preprocessor.
  45 .IP \[bu]
  46 The ``dir'' branch of
  47 .I neatroff
  48 supports right-to-left typesetting
  49 for languages requiring it.
  50 .IP \[bu]
  51 To enable whole-paragraph formatting, add
  52 .B p
  53 in front of the adjustment specification; for example,
  54 .B "ad pb"
  55 fully justifies paragraphs with advanced filling.
  56 Finally, in the ``dir'' branch,
  57 .B "ad k"
  58 supports Kashideh justification.
  59 .SH OPTIONS
  60 The following options are available:
  61 .IP "\-m \fIx\fP" 8
  62 Loads the
  63 .I x
  64 macro package.
  65 .IP "\-C"
  66 Enables compatibility mode
  67 with AT&T
  68 .IR troff .
  69 .IP "\-T \fIdev\fP"
  70 Sets the output device.
  71 The default is
  72 .B utf
  73 for PostScript.
  74 .IP "\-F \fIdir\fP"
  75 Sets the font directory.
  76 The default is typically
  77 /usr/share/neatroff/font.
  78 .IP "\-M \fIdir\fP"
  79 Sets the macro directory.
  80 The default is typically
  81 /usr/share/neatroff/tmac.
  82 .SH FILES
  83 .IP "/usr/share/neatroff/tmac/tmac.x" 4
  84 The
  85 .I x
  86 macro package.
  87 .IP "/usr/share/neatroff/font/*"
  88 Output device directories.
  89 .SH "SEE ALSO"
  90 .IR neatpost (1),
  91 .IR neateqn (1),
  92 .IR neatrefer (1),
  93 .IR neatmkfn (1)
  94 .IP http://litcave.rudi.ir/neatstart.pdf 4
  95 Explains how to compile and install
  96 .IR neatroff ,
  97 and add new fonts.
  98 .IP http://litcave.rudi.ir/neatroff.pdf
  99 Describes the primary differences between
 100 .I neatroff
 101 and other troff-like typesetting systems.