Research V3 development
[unix-history] / man / man1 / nroff.1
.pa 1
.he 'NROFF (I)'1/15/73'NROFF (I)'
.ti 0
NAME nroff -- format text
.sp
.ti 0
.nf
SYNOPSIS nroff\b\b\b\b\b_____ [+\b_N] [-s\b\b__] [-h\b\b__] [-q\b\b__] [-i\b\b__] files
.fi
.sp
.ti 0
DESCRIPTION nroff\b\b\b\b\b_____
formats text according to control lines embedded
in the text files.
The non-file option arguments are interpreted as follows:
.in +6
.ti -3
+N Output will commence at the first page whose page
number is N (independent of whether or not the
page number is being printed).
.ti -3
-s Stop between pages. Printing will halt prior to
each page (including the first) to permit paper
loading and changing. Printing is restarted by
typing either a "newline" or "delete" character.
.ti -3
-h High-speed output. During output, strings of
space characters are replaced where possible with
tab characters to speed up output. Futhermore, if
the output is directed into a file or a pipe,
this mode effectively reduces the total number of
characters in the file or pipe; this is especially
important in multi-column output where the
temporary file(s) or pipe(s) would otherwise contain
a large number of space characters.
.ti -3
-q The prompt names for insertions are not printed
and the bell character is sent instead; in
addition, the insertion is not echoed. This mode
permits insertions during the actual output printing
.ti -3
-i Index mode. NROFF creates a file called "index"
containing every word output together with the
line and page number. The format is word, tab,
page, tab, line, newline, etc. Invoking this mode
slows down the execution of NROFF considerably.
.sp
.in -6
Nroff is more completely described
in [1].
A condensed Request Summary is included here.
.sp
.ti 0
FILES /etc/suftab suffix hyphenation tables
.br
/tmp/rtm? temporary
.br
.sp
.ti 0
SEE ALSO [1] NROFF User's Manual (available as MM-73-1271-2).
.sp
.ti 0
DIAGNOSTICS none
.sp
.ti 0
BUGS -
.in 0
.bp
.cc %
%nf
%ce
REQUEST REFERENCE AND INDEX
Request Initial If no Cause
Form\b\b\b\b____ Value\b\b\b\b\b_____ Argument\b\b\b\b\b\b\b\b________ Break\b\b\b\b\b_____ Explanation\b\b\b\b\b\b\b\b\b\b\b___________
I. Page\b\b\b\b____ Control\b\b\b\b\b\b\b_______
.pl +\b_N N=66 N=66 no P\b_age L\b_ength.
.bp +\b_N N=1 - yes B\b_egin P\b_age.
.pn +\b_N N=1 ignored no P\b_age N\b_umber.
.po +\b_N N=0 N=prev no P\b_age O\b_ffset.
.ne N - N=1 no NE\b\b__ed N lines.
II. Text\b\b\b\b____ Filling\b\b\b\b\b\b\b_______, Adjusting\b\b\b\b\b\b\b\b\b_________, and\b\b\b___ Centering\b\b\b\b\b\b\b\b\b_________
.br - - yes BR\b\b__eak.
.fi fill - yes FI\b\b__ll output lines.
.nf fill - yes N\b_oF\b_ill.
.ad c adj,norm adjust no AD\b\b__just mode on.
.na adjust - no N\b_oA\b_djust.
.ce N off N=1 yes CE\b\b__nter N input text lines.
III. Line\b\b\b\b____ Spacing\b\b\b\b\b\b\b_______ and\b\b\b___ Blank\b\b\b\b\b_____ Lines\b\b\b\b\b_____
.ls +\b_N N=1 N=prev no L\b_ine S\b_pacing.
.sp N - N=1 yes SP\b\b__ace N lines
.lv N - N=1 no OR-
.sv N - N=1 no S\b_aV\b_e N lines.
.os - - no O\b_utput S\b_aved lines.
.ns space - no N\b_o-S\b_pace mode on.
.rs - - no R\b_estore S\b_pacing.
.xh off - no EX\b_tra-H\b_alf-line mode on.
IV. Line\b\b\b\b____ Length\b\b\b\b\b\b______ and\b\b\b___ Indenting\b\b\b\b\b\b\b\b\b_________
.ll +\b_N N=65 N=prev no L\b_ine L\b_ength.
.in +\b_N N=0 N=prev yes IN\b\b__dent.
.ti +\b_N - N=1 yes T\b_emporary I\b_ndent.
V. Macros\b\b\b\b\b\b______, Diversion\b\b\b\b\b\b\b\b\b_________, and\b\b\b___ Line\b\b\b\b____ Traps\b\b\b\b\b_____
.de xx - ignored no DE\b\b__fine or redefine a macro.
.rm xx - - no R\b_eM\b_ove macro name.
.di xx - end no DI\b\b__vert output to macro "xx".
.wh -\b_N xx - no WH\b\b__en; set a line trap.
.ch -\b_N -\b_M - no OR-
.ch xx -\b_M - no OR-
.ch -\b_N y - no OR-
.ch xx y - no CH\b\b__ange trap line.
VI. Number\b\b\b\b\b\b______ Registers\b\b\b\b\b\b\b\b\b_________
.nr a +\b_N -\b_M - no OR-
.nr ab +\b_N -\b_M - no N\b_umber R\b_egister.
.nc c \\n \\n no N\b_umber C\b_haracter.
.ar arabic - no Arabic numbers.
.ro arabic - no Roman numbers.
.RO arabic - no ROMAN numbers.
VII. Input\b\b\b\b\b_____ and\b\b\b___ Output\b\b\b\b\b\b______ Conventions\b\b\b\b\b\b\b\b\b\b\b___________ and\b\b\b___ Character\b\b\b\b\b\b\b\b\b_________ Translations\b\b\b\b\b\b\b\b\b\b\b\b____________
.ta N,M,... none no PseudoTA\b\b__bs setting.
.tc c space space no T\b_ab replacement C\b_haracter.
.lc c . . no L\b_eader replacement C\b_haracter.
.ul N - N=1 no UN\b\b__derline input text lines.
.cc c . . no Basic C\b_ontrol C\b_haracter.
.c2 c ' ' no Nobreak control character.
.li N - N=1 no Accept input lines LI\b\b__terally.
.tr abcd.... - no TR\b\b__anslate on output.
VIII. Hyphenation\b\b\b\b\b\b\b\b\b\b\b___________.
.nh on - no N\b_o H\b_yphen.
.hy on - no HY\b\b__phenate.
.hc c none none no H\b_yphenation indicator C\b_haracter.
IX. Three\b\b\b\b\b_____ Part\b\b\b\b____ Titles\b\b\b\b\b\b______.
.tl 'left'center'right' no T\b_itL\b_e.
.lt N N=65 N=prev no L\b_ength of T\b_itle.
X. Output\b\b\b\b\b\b______ Line\b\b\b\b____ Numbering\b\b\b\b\b\b\b\b\b_________.
.nm +\b_N M S I off no N\b_umber M\b_ode on or off, set parameters.
.np M S I reset no N\b_umber P\b_arameters set or reset.
XI. Conditional\b\b\b\b\b\b\b\b\b\b\b___________ Input\b\b\b\b\b_____ Line\b\b\b\b____ Acceptance\b\b\b\b\b\b\b\b\b\b__________
.if c anything - no OR-
.if !c anything - no OR-
.if N anything - no OR-
.if !N anything - no IF\b\b__ true accept line of "anything".
XII. Environment\b\b\b\b\b\b\b\b\b\b\b___________ Switching\b\b\b\b\b\b\b\b\b_________.
.ev N N=0 N=prev no E\b_nV\b_ironment switched.
XIII. Insertions\b\b\b\b\b\b\b\b\b\b__________ from\b\b\b\b____ the\b\b\b___ Standard\b\b\b\b\b\b\b\b________ Input\b\b\b\b\b_____ Stream\b\b\b\b\b\b______
.rd prompt bell no R\b_eaD\b_ insert.
.ex - - no EX\b\b__it.
XIV. Input\b\b\b\b\b_____ File\b\b\b\b____ Switching\b\b\b\b\b\b\b\b\b\b _________
.so filename - no Switch SO\b\b__urce file (push down).
.nx filename - no N\b_eX\b_t file.
.sp
XV. Miscellaneous\b\b\b\b\b\b\b\b\b\b\b\b\b_____________
.ig - - no IG\b\b__nore.
.fl - - no FL\b\b__ush output buffer.
.ab - - no AB\b\b__ort.
%cc .
.fi
.in 16