Research V4 development

[unix-history] / man / man1 / roff.1

diff --git a/man/man1/roff.1 b/man/man1/roff.1
index 24d9e26..53302b9 100644 (file)
--- a/man/man1/roff.1
+++ b/man/man1/roff.1
@@ -1,197 +1,224 @@
-.pa 1
-.he 'ROFF (I)'6/12/72'ROFF (I)'
-.ti 0
-NAME           roff  --  format text
-.sp
-.ti 0
-.nf
-SYNOPSIS       roff\b\b\b\b____ [ +\b_number ] [ -s\b\b__ ] [ -h\b\b__ ] file\d1\u ...
-.fi
-.sp
-.ti 0
-DESCRIPTION    roff\b\b\b\b____
+.th ROFF I 6/12/72
+.sh NAME
+roff  \*-  format text
+.sh SYNOPSIS
+.bd roff
+[ \fB+\fIn\fR ] [ \fB\*-\fIn\fR ] [
+.bd \*-s
+] [
+.bd \*-h
+] file ...
+.sh DESCRIPTION
+.it Roff

 formats text according to control lines embedded
 formats text according to control lines embedded

-in the text in file\e91\e8, ... .
+in the text in the given files.

 Encountering a nonexistent file terminates printing.
 Encountering a nonexistent file terminates printing.

-The optional argument "+\b_number" causes printing
-to begin at the first page
-with that number.
-The optional argument
-"-s\b\b__" causes printing to stop before each page
-including the first
+Incoming interconsole messages are turned off during printing.
+The optional flag arguments mean:
+.s3
+.lp +5 5
+\fB+\fIn\fR    Start printing at the first page with number \fIn\fR.
+.s3
+.lp +5 5
+\fB\*-\fIn\fR  Stop printing at the first page numbered higher
+than \fIn\fR.
+.s3
+.lp +5 5
+\fB\*-s\fR     Stop before each page (including the first)

 to allow paper manipulation;
 to allow paper manipulation;

-printing is resumed upon
-receipt of an interrupt signal.
-The optional argument
-"-h" causes the output to contain
-horizontal tabs for two or more spaces
-that end on a tab stop.
-An interrupt signal received during printing terminates all
-printing.
-Incoming interconsole messages are turned off during printing,
-and the original message acceptance state is restored upon
-termination.
-.sp
-At the present time, there
-is no document describing ROFF in full.
+resume on receipt of an interrupt signal.
+.s3
+.lp +5 5
+\fB\*-h\fR     Insert tabs in the output stream to replace
+spaces whenever appropriate.
+.s3
+.i0

 A Request Summary is attached.
 A Request Summary is attached.

-.sp
-.ti 0
-FILES          /etc/suftab     suffix hyphenation tables
+.sh FILES
+/usr/lib/suftab        suffix hyphenation tables

 .br
 /tmp/rtm?      temporary
 .br
 .br
 /tmp/rtm?      temporary
 .br

-.sp
-.ti 0
-SEE ALSO       --
-.sp
-.ti 0
-DIAGNOSTICS    none
-.sp
-.ti 0
-BUGS           -
+.sh "SEE ALSO"
+nroff (I), troff (I)
+.sh BUGS
+.it Roff
+is the simplest of the runoff
+programs, but is virtually
+undocumented.

 .bp
 .bp

-.de xx
-.ti0
-.li
-..

 .tc |
 .tr |
 .in 0
 .ce
 REQUEST SUMMARY
 .tc |
 .tr |
 .in 0
 .ce
 REQUEST SUMMARY

-.sp2
+.s3

 .ul
 .ul

+.if t .ta .75i 1.5i 2.25i
+.if n .ta 8 16 24 32

 Request        Break   Initial Meaning
 Request        Break   Initial Meaning

-.in24
+.if t .in2.25i
+.if n .in24

 .na
 .na

-.sp
-.xx
+.ti 0
+.li

 .ad    yes     yes     Begin adjusting right margins.
 .ad    yes     yes     Begin adjusting right margins.

-.xx
+.ti 0
+.li

 .ar    no      arabic  Arabic page numbers.
 .ar    no      arabic  Arabic page numbers.

-.xx
-.br    yes     -       Causes a line break -­ thå filling of
+.ti 0
+.li
+.br    yes     -       Causes a line break \*- the filling of

 the current line is stopped.
 the current line is stopped.

-.xx
-.bl|n  yes     -       Insert contiguous block of n blank lines.
-If necessary, a new page will be
-started to accomodate the entire block.
-.xx
-.bp|+n yes     n=1     Begin new page and number it n.
-If n is not given, normal sequencing occurs.
-.xx
+.ti 0
+.li
+.bl|n  yes     -       Insert of n blank lines, on new page if necessary.
+.ti 0
+.li
+.bp|+n yes     n=1     Begin new page and number it n; no n means `+1'.
+.ti 0
+.li

 .cc|c  no      c=.     Control character becomes `c'.
 .cc|c  no      c=.     Control character becomes `c'.

-.xx
+.ti 0
+.li

 .ce|n  yes     -       Center the next n input lines,
 without filling.
 .ce|n  yes     -       Center the next n input lines,
 without filling.

-.xx
-.de|xx no      -       Define macro named "xx"
-(definition ends with a line beginning with "..").
-.xx
-.ds    yes     no      Double space; same as ".ls 2".
-.xx
-.ef|t  no      t=''''  Even foot title becomes t.
-.xx
-.eh|t  no      t=''''  Even head title becomes t.
-.xx
+.ti 0
+.li
+.de|xx no      -       Define macro named `xx'
+(definition ends on line beginning `\fB..\fR').
+.ti 0
+.li
+.ds    yes     no      Double space; same as `.ls 2'.
+.ti 0
+.li
+.ef|t  no      t=\*a\*a\*a\*a  Even foot title becomes t.
+.ti 0
+.li
+.eh|t  no      t=\*a\*a\*a\*a  Even head title becomes t.
+.ti 0
+.li

 .fi    yes     yes     Begin filling output lines.
 .fi    yes     yes     Begin filling output lines.

-.xx
-.fo    no      t=''''  All foot titles are t.
-.xx
+.ti 0
+.li
+.fo    no      t=\*a\*a\*a\*a  All foot titles are t.
+.ti 0
+.li

 .hc|c  no      none    Hyphenation character set to `c'.
 .hc|c  no      none    Hyphenation character set to `c'.

-.xx
-.he|t  no      t=''''  All head titles are t.
-.xx
+.ti 0
+.li
+.he|t  no      t=\*a\*a\*a\*a  All head titles are t.
+.ti 0
+.li

 .hx    no      -       Title lines are suppressed.
 .hx    no      -       Title lines are suppressed.

-.xx
+.ti 0
+.li

 .hy|n  no      n=1     Hyphenation is done, if n=1;
 and is not done, if n=0.
 .hy|n  no      n=1     Hyphenation is done, if n=1;
 and is not done, if n=0.

-.xx
-.ig    no      -       Ignore input lines until and including
-a line beginning with "..".
-.xx
+.ti 0
+.li
+.ig    no      -       Ignore input lines through
+a line beginning with `\fB..\fR'.
+.ti 0
+.li

 .in|+n yes     -       Indent n spaces from left margin.
 .in|+n yes     -       Indent n spaces from left margin.

-.xx
-.ix +n no      -       Same as ".in" but without break.
-.xx
+.ti 0
+.li
+.ix +n no      -       Same as `.in' but without break.
+.ti 0
+.li

 .li|n  no      -       Literal, treat next n lines as text.
 .li|n  no      -       Literal, treat next n lines as text.

-.xx
+.ti 0
+.li

 .ll|+n no      n=65    Line length including indent is n characters.
 .ll|+n no      n=65    Line length including indent is n characters.

-.xx
+.ti 0
+.li

 .ls|+n yes     n=1     Line spacing set to n lines per output line.
 .ls|+n yes     n=1     Line spacing set to n lines per output line.

-.xx
-.m1|n  no      n=2     n blank lines are put between the top
-of a new page and the head title.
-.xx
-.m2|n  no      n=2     n blanks lines put between head title
+.ti 0
+.li
+.m1|n  no      n=2     Put n blank lines between the top
+of page and head title.
+.ti 0
+.li
+.m2|n  no      n=2     n blank lines put between head title

 and beginning of text on page.
 and beginning of text on page.

-.xx
-.m3|n  no      n=1     n blank lines put between the end of
-text and the foot title.
-.xx
+.ti 0
+.li
+.m3|n  no      n=1     n blank lines put between end of
+text and foot title.
+.ti 0
+.li

 .m4|n  no      n=3     n blank lines put between the foot title
 and the bottom of page.
 .m4|n  no      n=3     n blank lines put between the foot title
 and the bottom of page.

-.xx
+.ti 0
+.li

 .na    yes     no      Stop adjusting the right margin.
 .na    yes     no      Stop adjusting the right margin.

-.xx
+.ti 0
+.li

 .ne|n  no      -       Begin new page, if n output lines
 cannot fit on present page.
 .ne|n  no      -       Begin new page, if n output lines
 cannot fit on present page.

-.xx
+.ti 0
+.li

 .nn|+n no      -       The next n output lines are not numbered.
 .nn|+n no      -       The next n output lines are not numbered.

-.xx
-.n1    no      no      Output lines are numbered sequentially
-beginning with 1 on each new page.
-Head and foot titles are not numbered.
-.xx
-.n2    no      no      Output lines are numbered sequentially
-beginning with 1 on the next output line.
-.xx
+.ti 0
+.li
+.n1    no      no      Number output lines; start with 1 each page
+.ti 0
+.li
+.n2|n  no      no      Number output lines; stop numbering if n=0.
+.ti 0
+.li

 .ni|+n no      n=0     Line numbers are indented n.
 .ni|+n no      n=0     Line numbers are indented n.

-.xx
+.ti 0
+.li

 .nf    yes     no      Stop filling output lines.
 .nf    yes     no      Stop filling output lines.

-.xx
-.nx|filename   -       Change to input file "filename".
-.xx
-.of|t  no      t=''''  Odd foot title becomes t.
-.xx
-.oh|t  no      t=''''  Odd head title becomes t.
-.xx
-.pa|+n yes     n=1     Same as ".bp".
-.xx
+.ti 0
+.li
+.nx|filename   -       Change to input file `filename'.
+.ti 0
+.li
+.of|t  no      t=\*a\*a\*a\*a  Odd foot title becomes t.
+.ti 0
+.li
+.oh|t  no      t=\*a\*a\*a\*a  Odd head title becomes t.
+.ti 0
+.li
+.pa|+n yes     n=1     Same as `.bp'.
+.ti 0
+.li

 .pl|+n no      n=66    Total paper length taken to be n lines.
 .pl|+n no      n=66    Total paper length taken to be n lines.

-.xx
+.ti 0
+.li

 .po|+n no      n=0     Page offset.
 All lines are preceded by N spaces.
 .po|+n no      n=0     Page offset.
 All lines are preceded by N spaces.

-.xx
+.ti 0
+.li

 .ro    no      arabic  Roman page numbers.
 .ro    no      arabic  Roman page numbers.

-.xx
-.sk|n  no      -       n pages with head and foot titles but
-otherwise blank will be output beginning
-with the next page containing text.
-.xx
+.ti 0
+.li
+.sk|n  no      -       Produce n blank pages starting next page.
+.ti 0
+.li

 .sp|n  yes     -       Insert block of n blank lines.
 .sp|n  yes     -       Insert block of n blank lines.

-If the bottom of a page is reached,
-remaining lines are not\b\b\b___ put on next page.
-.xx
+.ti 0
+.li

 .ss    yes     yes     Single space output lines,
 .ss    yes     yes     Single space output lines,

-equivalent to ".ls 1".
-.xx
-.ta|N|M|...    -       Pseudotab settings.
+equivalent to `.ls 1'.
+.ti 0
+.li
+.ta|N|M|...            -       Pseudotab settings.

 Initial tab settings are columns 9,17,25,...
 Initial tab settings are columns 9,17,25,...

-.xx
-.tc|c  no      c="|"   Tab replacement character becomes "c".
-.xx
-.ti|+n yes     -       Temporarily indent next output line
-n spaces.
-.xx
-.tr|abcd.. no  -       Translate a into b, c into d, etc.
-.xx
-.ul|n  no      -       Underline the letters and numbers on the
-next n input lines.
-.sp
-.in0
-.fi
-.tc
-.in 16
-.tr ||
+.ti 0
+.li
+.tc|c  no      c=`|'   Tab replacement character becomes `c'.
+.ti 0
+.li
+.ti|+n yes     -       Temporarily indent next output
+line n space.
+.ti0
+.li
+.tr|abcd..     no      -       Translate a into b, c into d, etc.
+.ti0
+.li
+.ul|n  no      -       Underline the letters and numbers
+in the next n input lines.