1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
|
'\" t
.TH ROFF 7 "7 November 2018" "Groff Version 1.22.3"
.SH NAME
roff \- concepts and history of roff typesetting
.
.\" this is man-page roff.7
.
.\" --------------------------------------------------------------------
.\" Legalese
.\" --------------------------------------------------------------------
.
.de co
Copyright \[co] 2000-2014 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the FDL (GNU Free Documentation License) Version
1.3 or any later version published by the Free Software Foundation.
with the Invariant Sections being the .au and .co macro definitions,
with no Front-Cover Texts, and with no Back-Cover Texts.
A copy of the Free Documentation License is included as a file called
FDL in the main directory of the groff source package.
The license text is also available on-line at the
.UR http://\:www.gnu.org/\:copyleft/\:fdl.html
GNU copyleft site
.UE .
..
.
.de au
This man-page was written by
.MT groff-bernd.warken-72@web.de
Bernd Warken
.ME
and is maintained by
.MT wl@gnu.org
Werner Lemberg
.ME .
..
.
.\" --------------------------------------------------------------------
.\" Local macros
.
.de Esc
. ds @1 \\$1
. shift
. nop \f[B]\[rs]\\*[@1]\f[]\\$*
. rm @1
..
.
.
.de QuotedChar
. ds @1 \\$1
. shift
. nop \[oq]\f[B]\\*[@1]\f[]\[cq]\\$*
. rm @1
..
.
.\" --------------------------------------------------------------------
.SH DESCRIPTION
.\" --------------------------------------------------------------------
.
.I roff
is the general name for a set of text formatting programs, known under
names like
.BR troff ,
.BR nroff ,
.BR ditroff ,
.BR groff ,
etc.
.
A
.I roff
system consists of an extensible text formatting language and a set of
programs for printing and converting to other text formats.
.
Unix-like operating systems distribute a
.I roff
system as a core package.
.
.
.P
The most common
.I roff
system today is the free software implementation \f[CR]GNU\f[]
.IR roff ,
.BR groff (1).
.
.I groff
implements the look-and-feel and functionality of its ancestors, with many
extensions.
.
.
.P
The ancestry of
.I roff
is described in section
.BR HISTORY .
.
In this document, the term
.I roff
always refers to the general class of roff programs, not to the
.B roff
command provided in early UNIX systems.
.
.
.P
In spite of its age,
.I roff
is in wide use today, for example, the manual pages on UNIX systems
.RI ( man\~pages ),
many software books, system documentation, standards, and corporate
documents are written in roff.
.
The
.I roff
output for text devices is still unmatched, and its graphical output
has the same quality as other free type-setting programs and is better
than some of the commercial systems.
.
.
.P
.I roff
is used to format UNIX
.IR "manual pages" ,
(or
.IR "man pages" ),
the standard documentation system on many UNIX-derived operating systems.
.
.
.P
This document describes the history of the development of the
.IR "roff system" ;
some usage aspects common to all
.I roff
versions, details on the
.I roff
pipeline, which is usually hidden behind front-ends like
.BR groff (1);
a general overview of the formatting language; some tips for editing
.I roff
files; and many pointers to further readings.
.
.
.\" --------------------------------------------------------------------
.SH "HISTORY"
.\" --------------------------------------------------------------------
.
Document formatting by computer dates back to the 1960s.
.
The
.I roff
system itself is intimately connected to the Unix operating system, but its
roots go back to the earlier operating systems CTSS and Multics.
.
.
.\" --------------------------------------------------------------------
.SS "The Predecessor RUNOFF"
.\" --------------------------------------------------------------------
.
.BR roff \[aq]s
ancestor
.B RUNOFF
was written in the MAD language by
.I Jerry Saltzer
for the
.IR "Compatible Time Sharing System (CTSS)" ,
a project of the Massachusetts Institute of Technology (MIT), in 1963 and
1964 \[en] note that CTSS commands were all uppercase.
.
.P
In 1965, MIT\[aq]s Project MAC teamed with Bell Telephone Laboratories
(BTL) and General Electric to begin the
.UR http://\:www.multicians.org
.I Multics
system
.UE .
.
A command called
.B runoff
was written for Multics in the late 60s in the BCPL language, by
.IR "Bob Morris" ,
.IR "Doug McIlroy" ,
and other members of the Multics team.
.
.
.P
Like its CTSS ancestor, Multics
.B runoff
formatted an input file consisting of text and command lines; commands began
with a period and were two letters.
.
Output from these commands was to terminal devices such as IBM Selectric
terminals.
.
Multics
.B runoff
had additional features added, such as the ability to do two-pass
formatting; it became the main format for Multics documentation and text
processing.
.
.
.P
BCPL and
.B runoff
were ported to the GCOS system at Bell Labs when BTL left the development of
Multics.
.
.
.P
There is a free archive about
.I historical RUNOFF
documents.
.
You can get it anonymously by the shell command
.RS
.EX
$git clone https://github.com/bwarken/RUNOFF_historical.git
.EE
.RE
.
.
.P
As well, there is a new project for writing a program that can read
.I "RUNOFF files" ,
but it does not yet work so far.
.
You can get an early version anonymously by the shell command
.RS
.EX
$git clone https://github.com/bwarken/runoff.git
.EE
.RE
.
.
.\" --------------------------------------------------------------------
.SS "The Classical nroff/troff System"
.\" --------------------------------------------------------------------
.
At BTL, there was a need to drive the
.I Graphic Systems CAT
typesetter, a graphical output device from a PDP-11 computer running Unix.
.
As
.B runoff
was too limited for this task it was further developed into a more
powerful text formatting system by
.IR "Joseph F.\& Ossanna" ,
who already programmed several runoff ports.
.
.
.P
The name
.I runoff
was shortened to
.IR roff .
.
The greatly enlarged language of Ossanna\[aq]s version already
included all elements of a full
.IR "roff system" .
.
All modern
.I roff
systems try to implement compatibility to this system.
.
So Joe Ossanna can be called the father of all
.I roff
systems.
.
.
.P
This first
.I roff system
had three formatter programs.
.
.TP
.B troff
.RI ( "typesetter roff\/" )
generated a graphical output for the
.I CAT
typesetter as its only device.
.
.TP
.B nroff
produced text output suitable for terminals and line printers.
.
.TP
.B roff
was the reimplementation of the former
.B runoff
program with its limited features; this program was abandoned in later
versions.
.
Today, the name
.I roff
is used to refer to a
.I troff/\:nroff
system as a whole.
.
.
.P
Ossanna\[aq]s first version was written in the PDP-11 assembly
language and released in 1973.
.
.I Brian Kernighan
joined the
.I roff
development by rewriting it in the C\~programming language.
.
The C\~version was released in 1975.
.
.
.P
The syntax of the formatting language of the
.BR nroff /\: troff
programs was documented in the famous
.IR "Troff User\[aq]s Manual [CSTR\~#54]" ,
first published in 1976, with further revisions up to 1992 by Brian
Kernighan.
.
This document is the specification of the
.IR "classical troff" .
.
All later
.I roff
systems tried to establish compatibility with this specification.
.
.
.P
After Ossanna\[aq]s death in 1977, Kernighan went on with developing
.IR troff .
.
In the late 1970s, Kernighan equipped
.I troff
with a general interface to support more devices, the intermediate
output format, and the postprocessor system.
.
This completed the structure of a
.I "roff system"
as it is still in use today; see section
.BR "USING ROFF" .
.
In 1979, these novelties were described in the paper
.IR "[CSTR\~#97]" .
.
This new
.I troff
version is the basis for all existing newer troff systems, including
.IR groff .
.
On some systems, this
.I device independent troff
got a binary of its own, called
.BR ditroff (7).
.
All modern
.B troff
programs already provide the full
.B ditroff
capabilities automatically.
.
.
.\" --------------------------------------------------------------------
.SS "Availability"
.\" --------------------------------------------------------------------
.
The source code of both the ancient Unix and classical
.I troff
weren\[aq]t available for two decades.
.
Meanwhile, it is accessible again (on-line) for non-commercial use,
cf.\& section
.BR "SEE ALSO" .
.
.
.\" --------------------------------------------------------------------
.SS "groff \[em] free GNU roff"
.\" --------------------------------------------------------------------
.
The most important free
.I roff
project was the \f[CR]GNU\f[] implementation of
.IR troff ,
written from scratch by
.I James Clark
and put under the
.UR http://\:www.gnu.org/\:copyleft
GNU Public License
.UE .
.
It was called
.I groff
(\f[CR]GNU\f[]
.IR roff ).
.
See
.BR groff (1)
for an overview.
.
.
.P
The
.I groff
system is still actively developed.
.
It is compatible to the classical
.IR troff ,
but many extensions were added.
.
It is the first
.I roff
system that is available on almost all operating systems \[em] and it
is free.
.
This makes
.I groff
the de-facto
.I roff
standard today.
.
.
.\" --------------------------------------------------------------------
.SS "Free Heirloom roff"
.\" --------------------------------------------------------------------
.
An alternative is
.UR https://\:github.com/\:n-t-roff/\:heirloom-doctools
.I Gunnar Ritter\[aq]s Heirloom roff project
.UE
project, started in 2005, which provides enhanced versions of the various
roff tools found in the OpenSolaris and Plan\~9 operating systems, now
available under free licenses.
.
You can get this package with the shell command:
.RS
.EX
\[Do] git clone https://github.com/n-t-roff/heirloom-doctools
.EE
.RE
.
.
.P
Moreover, one finds there the
.UR https://github.com/n-t-roff/DWB3.3
.I Original Documenter\[aq]s Workbench Release 3.3
.UE .
.
.
.\" --------------------------------------------------------------------
.SH "USING ROFF"
.\" --------------------------------------------------------------------
.
Most people won\[aq]t even notice that they are actually using
.IR roff .
.
When you read a system manual page (man page)
.I roff
is working in the background.
.
.I roff
documents can be viewed with a native viewer called
.BR \%xditview (1x),
a standard program of the X window distribution, see
.BR X (7x).
.
But using
.I roff
explicitly isn\[aq]t difficult either.
.
.
.P
Some
.I roff
implementations provide wrapper programs that make it easy to use the
.I roff
system on the shell command line.
.
For example, the \f[CR]GNU\f[]
.I roff
implementation
.BR groff (1)
provides command line options to avoid the long command pipes of
classical
.IR troff ;
a program
.BR grog (1)
tries to guess from the document which arguments should be used for a
run of
.BR groff ;
people who do not like specifying command line options should try the
.BR groffer (1)
program for graphically displaying
.I groff
files and man pages.
.
.
.\" --------------------------------------------------------------------
.SS "The roff Pipe"
.\" --------------------------------------------------------------------
.
Each
.I roff
system consists of preprocessors,
.I roff
formatter programs, and a set of device postprocessors.
.
This concept makes heavy use of the
.I piping
mechanism, that is, a series of programs is called one after the other,
where the output of each program in the queue is taken as the input
for the next program.
.
.RS
.P
cat \f[I]file\f[P] \
| .\|.\|. \
| \f[I]preproc\f[P] \
| .\|.\|. \
| troff \f[I]options\f[P] \
| \f[I]postproc\f[P]
.RE
.
.
.P
The preprocessors generate
.I roff
code that is fed into a
.I roff
formatter (e.g.\&
.BR troff ),
which in turn generates
.I intermediate output
that is fed into a device postprocessor program for printing or final
output.
.
.
.P
All of these parts use programming languages of their own; each
language is totally unrelated to the other parts.
.
Moreover,
.I roff
macro packages that were tailored for special purposes can be
included.
.
.
.P
Most
.I roff
documents use the macros of some package, intermixed with code for one
or more preprocessors, spiced with some elements from the plain
.I roff
language.
.
The full power of the
.I roff
formatting language is seldom needed by users; only programmers of
macro packages need to know about the gory details.
.
.
.
.\" --------------------------------------------------------------------
.SS "Preprocessors"
.\" --------------------------------------------------------------------
.
A
.I roff
preprocessor is any program that generates output that syntactically
obeys the rules of the
.I roff
formatting language.
.
Each preprocessor defines a language of its own that is translated
into
.I roff
code when run through the preprocessor program.
.
Parts written in these languages may be included within a
.I roff
document; they are identified by special
.I roff
requests or macros.
.
Each document that is enhanced by preprocessor code must be run
through all corresponding preprocessors before it is fed into the
actual
.I roff
formatter program, for the formatter just ignores all alien code.
.
The preprocessor programs extract and transform only the document
parts that are determined for them.
.
.
.P
There are a lot of free and commercial
.I roff
preprocessors.
.
Some of them aren\[aq]t available on each system, but there is a small
set of preprocessors that are considered as an integral part of each
.I roff
system.
.
The classical preprocessors are
.
.RS
.TS
tab (@);
lb l.
tbl@for tables.
eqn@for mathematical formulae.
pic@for drawing diagrams.
refer@for bibliographic references.
soelim@for including macro files from standard locations.
chem@for drawing chemical formul\[ae].
.TE
.RE
.
.
.P
Other known preprocessors that are not available on all systems
include
.
.RS
.TS
tab (@);
lb l.
grap@for constructing graphical elements.
grn@for including \fBgremlin\fR(1) pictures.
.TE
.RE
.
.
.\" --------------------------------------------------------------------
.SS "Formatter Programs"
.\" --------------------------------------------------------------------
.
A
.I roff formatter
is a program that parses documents written in the
.I roff
formatting language or uses some of the
.I roff
macro packages.
.
It generates
.IR "intermediate output" ,
which is intended to be fed into a single device postprocessor that
must be specified by a command-line option to the formatter program.
.
The documents must have been run through all necessary preprocessors
before.
.
.
.P
The output produced by a
.I roff
formatter is represented in yet another language, the
.IR "intermediate output format"
or
.IR "troff output" .
.
This language was first specified in
.IR "[CSTR\~#97]" ;
its \f[CR]GNU\f[] extension is documented in
.BR groff_out (5).
.
The intermediate output language is a kind of assembly language
compared to the high-level
.I roff
language.
.
The generated intermediate output is optimized for a special device,
but the language is the same for every device.
.
.
.P
The
.I roff
formatter is the heart of the
.I roff
system.
.
The traditional
.I roff
had two formatters,
.B nroff
for text devices and
.B troff
for graphical devices.
.
.
.P
Often, the name
.I troff
is used as a general term to refer to both formatters.
.
.
.\" --------------------------------------------------------------------
.SS "Devices and Postprocessors"
.\" --------------------------------------------------------------------
.
Devices are hardware interfaces like printers, text or graphical
terminals, etc., or software interfaces such as a conversion into a
different text or graphical format.
.
.
.P
A
.I roff
postprocessor is a program that transforms
.I troff
output into a form suitable for a special device.
.
The
.I roff
postprocessors are like device drivers for the output target.
.
.
.P
For each device there is a postprocessor program that fits the device
optimally.
.
The postprocessor parses the generated intermediate output and
generates device-specific code that is sent directly to the device.
.
.
.P
The names of the devices and the postprocessor programs are not fixed
because they greatly depend on the software and hardware abilities of
the actual computer.
.
For example, the classical devices mentioned in
.I [CSTR\~#54]
have greatly changed since the classical times.
.
The old hardware doesn\[aq]t exist any longer and the old graphical
conversions were quite imprecise when compared to their modern
counterparts.
.
.
.P
For example, the Postscript device
.I post
in classical
.I troff
had a resolution of 720 units per inch, while
.IR groff \[aq]s
.I ps
device has 72000, a refinement of factor 100.
.
.
.P
Today the operating systems provide device drivers for most
printer-like hardware, so it isn\[aq]t necessary to write a special
hardware postprocessor for each printer.
.
.
.\" --------------------------------------------------------------------
.SH "ROFF PROGRAMMING"
.\" --------------------------------------------------------------------
.
Documents using
.I roff
are normal text files decorated by
.I roff
formatting elements.
.
The
.I roff
formatting language is quite powerful; it is almost a full programming
language and provides elements to enlarge the language.
.
With these, it became possible to develop macro packages that are
tailored for special applications.
.
Such macro packages are much handier than plain
.IR roff .
.
So most people will choose a macro package without worrying about the
internals of the
.I roff
language.
.
.
.\" --------------------------------------------------------------------
.SS "Macro Packages"
.\" --------------------------------------------------------------------
.
Macro packages are collections of macros that are suitable to format a
special kind of documents in a convenient way.
.
This greatly eases the usage of
.IR roff .
.
The macro definitions of a package are kept in a file called
.IB name .tmac
(classically
.BI tmac. name\c
).
.
All tmac files are stored in one or more directories at standardized
positions.
.
Details on the naming of macro packages and their placement is found
in
.BR groff_tmac (5).
.
.
.P
A macro package that is to be used in a document can be announced to
the formatter by the command line option
.BR \-m ,
see
.BR troff (1),
or it can be specified within a document using the file inclusion
requests of the
.I roff
language, see
.BR groff (7).
.
.
.P
Famous classical macro packages are
.I man
for traditional man pages,
.I mdoc
for \f[CR]BSD\f[]-style manual pages;
the macro sets for books, articles, and letters are
.I me
(probably from the first name of its creator
.I Eric
Allman),
.I ms
(from
.IR "Manuscript Macros\/" ),
and
.I mm
(from
.IR "Memorandum Macros\/" ).
.
.
.\" --------------------------------------------------------------------
.SS "The roff Formatting Language"
.\" --------------------------------------------------------------------
.
The classical
.I roff
formatting language is documented in the
.I Troff User\[aq]s Manual
.IR "[CSTR\~#54]" .
.
The
.I roff
language is a full programming language providing requests, definition
of macros, escape sequences, string variables, number or size
registers, and flow controls.
.
.
.P
.I Requests
are the predefined basic formatting commands similar to the commands
at the shell prompt.
.
The user can define request-like elements using predefined
.I roff
elements.
.
These are then called
.IR macros .
.
A document writer will not note any difference in usage for requests
or macros; both are written on a line on their own starting with a dot.
.
.
.P
.I Escape sequences
are
.I roff
elements starting with a backslash
.QuotedChar \[rs] .
.
They can be inserted anywhere, also in the midst of text in a line.
.
They are used to implement various features, including the insertion of
non-\f[CR]ASCII\f[] characters with
.Esc ( ,
font changes with
.Esc f ,
in-line comments with
.Esc \[dq] ,
the escaping of special control characters like
.Esc \[rs] ,
and many other features.
.
.
.P
.I Strings
are variables that can store a string.
.
A string is stored by the
.B .ds
request.
.
The stored string can be retrieved later by the
.B \[rs]*
escape sequence.
.
.
.P
.I Registers
store numbers and sizes.
.
A register can be set with the request
.B .nr
and its value can be retrieved by the escape sequence
.BR "\[rs]n" .
.
.
.\" --------------------------------------------------------------------
.SH "FILE NAME EXTENSIONS"
.\" --------------------------------------------------------------------
.
Manual pages (man pages) take the section number as a file name
extension, e.g., the filename for this document is
.IR roff.7 ,
i.e., it is kept in section\~7
of the man pages.
.
.
.P
The classical macro packages take the package name as an extension, e.g.\&
.IB file. me
for a document using the
.I me
macro package,
.IB file. mm
for
.IR mm ,
.IB file. ms
for
.IR ms ,
.IB file. pic
for
.I pic
files,
etc.
.
.
.P
But there is no general naming scheme for
.I roff
documents, though
.IB file. tr
for
.I troff file
is seen now and then.
.
Maybe there should be a standardization for the filename extensions of
.I roff
files.
.
.
.P
File name extensions can be very handy in conjunction with the
.BR less (1)
pager.
.
It provides the possibility to feed all input into a command-line pipe
that is specified in the shell environment variable
.BR LESSOPEN .
.
This process is not well documented, so here an example:
.
.RS
.P
.EX
LESSOPEN='|lesspipe %s'
.EE
.RE
.
.
.P
where
.B lesspipe
is either a system supplied command or a shell script of your own.
.
.
.P
More details for
.I file name extensions
can be found at
.BR groff_filenames (7).
.
.
.\" --------------------------------------------------------------------
.SH "EDITING ROFF"
.\" --------------------------------------------------------------------
.
The best program for editing a
.I roff
document is Emacs (or Xemacs), see
.BR emacs (1).
.
It provides an
.I nroff
mode that is suitable for all kinds of
.I roff
dialects.
.
This mode can be activated by the following methods.
.
.
.P
When editing a file within Emacs the mode can be changed by typing
.RI \[oq] "M-x nroff-mode" \[cq],
where
.B M-x
means to hold down the
.B Meta
key (or
.BR Alt )
and hitting the
.BR x\~ key
at the same time.
.
.
.P
But it is also possible to have the mode automatically selected when
the file is loaded into the editor.
.
.IP \(bu
The most general method is to include the following 3 comment lines at
the end of the file.
.
.RS
.IP
.EX
\&.\[rs]" Local Variables:\""
\&.\[rs]" mode: nroff\""
\&.\[rs]" End:\""
.EE
.RE
.
.IP \(bu
There is a set of file name extensions, e.g.\& the man pages that
trigger the automatic activation of the
.I nroff
mode.
.
.IP \(bu
Theoretically, it is possible to write the sequence
.
.RS
.IP
.EX
\&.\[rs]" \%-*-\ nroff\ -*-\""
.EE
.RE
.
.IP
as the first line of a file to have it started in
.I nroff
mode when loaded.
.
Unfortunately, some applications such as the
.B man
program are confused by this; so this is deprecated.
.
.
.P
All
.I roff
formatters provide automated line breaks and horizontal and vertical
spacing.
.
In order to not disturb this, the following tips can be helpful.
.
.IP \(bu
Never include empty or blank lines in a
.I roff
document.
.
Instead, use the empty request (a line consisting of a dot only) or a
line comment
.B .\[rs]"\""
if a structuring element is needed.
.
.IP \(bu
Never start a line with whitespace because this can lead to unexpected
behavior.
.
Indented paragraphs can be constructed in a controlled way by
.I roff
requests.
.
.IP \(bu
Start each sentence on a line of its own, for the spacing after a dot
is handled differently depending on whether it terminates an
abbreviation or a sentence.
.
To distinguish both cases, do a line break after each sentence.
.
.IP \(bu
To additionally use the auto-fill mode in Emacs, it is best to insert
an empty
.I roff
request (a line consisting of a dot only) after each sentence.
.
.
.P
The following example shows how optimal
.I roff
editing could look.
.
.RS
.P
.EX
This is an example for a \&.I roff document. \&.
.
This is the next sentence in the same paragraph. \&.
.
This is a longer sentence stretching over several lines; abbreviations
like \[oq]cf.\[cq] are easily identified because the dot is not
followed by a line break. \&. In the output, this will still go to
the same paragraph.
.EE
.RE
.
.
.P
Besides Emacs, some other editors provide
.I nroff
style files too, e.g.\&
.BR vim (1),
an extension of the
.BR vi (1)
program.
.
.
.\" --------------------------------------------------------------------
.SH "SEE ALSO"
.\" --------------------------------------------------------------------
.
There is a lot of documentation on
.IR roff .
.
The original papers on classical
.I troff
are still available, and all aspects of
.I groff
are documented in great detail.
.
.
.\" --------------------------------------------------------------------
.SS "Internet sites"
.\" --------------------------------------------------------------------
.
.TP
troff.org
.UR http://\:www.troff.org
The historical troff site
.UE
provides an overview and pointers to all historical aspects of
.IR roff .
.
.TP
Multics
.UR http://\:www.multicians.org
The Multics site
.UE
contains a lot of information on the MIT projects, CTSS, Multics,
early Unix, including
.IR runoff ;
especially useful are a glossary and the many links to ancient
documents.
.
.TP
Unix Archive
.UR http://\:www.tuhs.org/\:Archive/
The Ancient Unixes Archive
.UE
.
provides the source code and some binaries of the ancient Unixes
(including the source code of
.I troff
and its documentation) that were made public by Caldera since 2001,
e.g.\& of the famous Unix version\~7 for PDP-11 at the
.UR http://\:www.tuhs.org/\:Archive/\:PDP-11/\:Trees/\:V7
Unix V7 site
.UE .
.
.TP
Developers at AT&T Bell Labs
.UR http://\:www.bell-labs.com/
Bell Labs Computing and Mathematical Sciences Research
.UE
.
provides a search facility for tracking information on the early
developers.
.
.TP
Plan 9
.UR http://\:plan9.bell-labs.com
The Plan\~9 operating system
.UE
.
by AT&T Bell Labs.
.
.TP
runoff
.UR http://\:web.mit.edu/\:Saltzer/\:www/\:publications/\:pubs.html
Jerry Saltzer\[aq]s home page
.UE
.
stores some documents using the ancient RUNOFF formatting language.
.
.TP
CSTR Papers
.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr.html
The Bell Labs CSTR site
.UE
.
stores the original
.I troff
manuals (CSTR #54, #97, #114, #116, #122) and famous historical
documents on programming.
.
.TP
\f[CR]GNU\f[] \f[I]roff\f[]
.UR http://\:www.gnu.org/\:software/\:groff
The groff web site
.UE
provides the free
.I roff
implementation
.IR groff ,
the actual standard
.IR roff .
.
.
.\" --------------------------------------------------------------------
.SS "Historical roff Documentation"
.\" --------------------------------------------------------------------
.
Many classical
.B troff
documents are still available on-line.
.
The two main manuals of the
.I troff
language are
.
.TP
[CSTR\~#54]
J.\& F.\& Ossanna,
.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:54.ps.gz
.I "Nroff/\:Troff User\[aq]s Manual"
.UE ;
.
Bell Labs, 1976; revised by Brian Kernighan, 1992.
.
.TP
[CSTR\~#97]
Brian Kernighan,
.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:97.ps.gz
.I "A Typesetter-independent TROFF"
.UE ,
.
Bell Labs, 1981, revised March 1982.
.
.P
The \[lq]little language\[rq]
.I roff
papers are
.
.TP
[CSTR\~#114]
Jon L.\& Bentley and Brian W.\& Kernighan,
.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:114.ps.gz
.I "GRAP \[en] A Language for Typesetting Graphs"
.UE ;
.
Bell Labs, August 1984.
.
.TP
[CSTR\~#116]
Brian W.\& Kernighan,
.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:116.ps.gz
.I "PIC \[en] A Graphics Language for Typesetting"
.UE ;
.
Bell Labs, December 1984.
.
.TP
[CSTR\~#122]
J.\& L.\& Bentley, L.\& W.\& Jelinski, and B.\& W.\& Kernighan,
.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:122.ps.gz
.I "CHEM \[en] A Program for Typesetting Chemical Structure Diagrams,"
.I "Computers and Chemistry"
.UE ;
.
Bell Labs, April 1986.
.
.
.P
You can get an archive with most
.I classical roff documentation
as reasonable
.I PDF files
at
.I github
using the
.I shell command
.RS
.EX
$ git clone https://github.com/bwarken/roff_classical.git
.EE
.RE
.
.
.\" --------------------------------------------------------------------
.SS "Manual Pages"
.\" --------------------------------------------------------------------
.
Due to its complex structure, a full
.I roff
system has many man pages, each describing a single aspect of
.IR roff .
.
Unfortunately, there is no general naming scheme for the documentation
among the different
.I roff
implementations.
.
.
.P
In
.IR groff ,
the man page
.BR groff (1)
contains a survey of all documentation available in
.IR groff .
.
.
.P
On other systems, you are on your own, but
.BR troff (1)
might be a good starting point.
.
.
.\" --------------------------------------------------------------------
.SH COPYING
.\" --------------------------------------------------------------------
.co
.\" --------------------------------------------------------------------
.SH AUTHORS
.\" --------------------------------------------------------------------
.au
.
.
.\" --------------------------------------------------------------------
.\" Emacs setup
.\" --------------------------------------------------------------------
.
.\" Local Variables:
.\" mode: nroff
.\" End:
|