troff

Source: Wikipedia, the free encyclopedia.
This article is about the Unix document processing system. For the command in BASIC, see
TROFF
.
Not to be confused with Trough (disambiguation).
troff
Cross-platform
TypeCommand
LicensePlan 9: MIT License
Websitetroff.org Edit this on Wikidata

troff (

document processing system developed by Bell Labs for the Unix operating system. troff and the related nroff were both developed from the original roff
.

While nroff was intended to produce output on terminals and line printers, troff was intended to produce output on typesetting systems, specifically the Graphic Systems CAT that had been introduced in 1972. Both used the same underlying markup language and a single source file could normally be used by nroff or troff without change.

troff features commands to designate fonts, spacing, paragraphs, margins, footnotes and more. Unlike many other text formatters, troff can position characters arbitrarily on a page, even overlapping them, and has a fully programmable input language. Separate preprocessors are used for more convenient production of tables, diagrams, and mathematics. Inputs to troff are plain text files that can be created by any text editor.

Extensive

man pages, mv macros for creating mountable transparencies
, and the ms and mm macros for letters, books, technical memoranda, and reports.

History

troff's origins can be traced to a

Jerome H. Saltzer for MIT's CTSS operating system
in the mid-1960s. (The name allegedly came from the phrase I'll run off a document.)

Doug McIlroy rewrote an extended and simplified version of roff in the BCPL programming language
.

The first version of Unix was developed on a PDP-7 which was sitting around Bell Labs. In 1971 the developers wanted to get a PDP-11 for further work on the operating system. In order to justify the cost for this system, they proposed that they would implement a document-formatting system for the Bell Labs patents department.[1] This first formatting program was a reimplementation of McIllroy's roff, written by Joe F. Ossanna.

When they needed a more flexible language, a new version of roff called nroff (newer "roff") was written, which provided the basis for all future versions. When they got a Graphic Systems CAT phototypesetter, Ossanna modified nroff to support multiple fonts and proportional spacing. Dubbed troff, for typesetter roff, its sophisticated output amazed the typesetter manufacturer and confused peer reviewers, who thought that manuscripts using troff had been published before.[2][3] As such, the name troff is pronounced /ˈtiːrɒf/ rather than */ˈtrɒf/.

With troff came nroff (they were actually almost the same program), which was for producing output for line printers and character terminals. It understood everything troff did, and ignored the commands which were not applicable, e.g., font changes.

Ossanna's troff was written in PDP-11 assembly language and produced output specifically for the CAT phototypesetter. He rewrote it in C, although it was now 7000 lines of uncommented code and still dependent on the CAT. As the CAT became less common, and was no longer supported by the manufacturer, the need to make it support other devices became a priority. Ossanna died before this task was completed, so Brian Kernighan took on the task of rewriting troff. The newly rewritten version produced a device-independent code which was very easy for post-processors to read and translate to the appropriate printer codes. Also, this new version of troff (often called ditroff for device independent troff) had several extensions, which included drawing functions.[4] The program's documentation defines the output format of ditroff, which is used by many modern troff clones like GNU groff.

In 1983, troff was one of several UNIX tools available for Charles River Data Systems'

Bell Laboratories license.[5]

The troff collection of tools (including

SoftQuad
took over the maintenance, although Brian Kernighan continued to improve troff on his own. Thus, there are at least the following variants of the original Bell Labs troff in use:

While troff has been supplanted by other programs such as

UNIX documentation
.

The software was reimplemented as

GNU system beginning in 1990. In addition, due to the open sourcing of Ancient UNIX systems, as well as modern successors such as the ditroff-based open-sourced versions found on OpenSolaris and Plan 9 from Bell Labs, there are several versions of AT&T troff (CAT and ditroff-based[6]
) available under various open-source licenses.

Macros

Troff includes macros that are run before starting to process the document. These macros include setting up page headers and footers, defining new commands, and influencing how the output will be formatted. The

command-line argument for including a macro set is -mname, which has led to many macro sets being known as the base filename with a leading m.[citation needed
]

The standard macro sets, with leading m are:

A more comprehensive list of macros available is usually listed in a tmac(5)

manual page.[11]

Preprocessors

As troff evolved, since there are several things which cannot be done easily in troff, several

pipes and filters
). Typically, each preprocessor translates only sections of the input file that are specially marked, passing the rest of the file through unchanged. The embedded preprocessing instructions are written in a simple application-specific programming language, which provides a high degree of power and flexibility.

  • eqn preprocessor allows mathematical formulae to be specified in simple and intuitive manner.[15]
  • tbl
    is a preprocessor for formatting tables.
  • bibliographic
    database.

Three preprocessors provide troff with drawing capabilities by defining a domain-specific language for describing the picture.

Yet more preprocessors allow the drawing of more complex pictures by generating output for pic.

See also

References

  1. ISBN 9781695978553
    .
  2. ^ J. F. Ossanna. Nroff/Troff User's Manual. CSTR #54, Bell Labs, 1976. Revised by B. W. Kernighan, 1992.
  3. McIlroy, M. D. (1987). A Research Unix reader: annotated excerpts from the Programmer's Manual, 1971–1986
    (PDF) (Technical report). CSTR. Bell Labs. 139.
  4. ^ B. W. Kernighan. A Typesetter-Independent TROFF. CSTR #97, Bell Labs, 1981, revised March 1982.
  5. ^ The Insider's Guide To The Universe (PDF). Charles River Data Systems, Inc. 1983. p. 13.
  6. ^ See the man page of the ditroff -> postscript converter on OpenSolaris: dpost(1) – illumos and OpenSolaris User Commands Reference Manual from latest Sun based OpenSolaris
  7. ^ "Writing and Formmating UNIX Manual Pages with -man macros". home.fnal.gov. Retrieved 7 May 2019.
  8. ^ man(7) – Linux Miscellanea Manual
  9. ^ mdoc(7) – FreeBSD Miscellaneous Information Manual
  10. ^ "Index - Mandoc extended documentation". Mandoc. Retrieved 7 May 2019.
  11. ^ a b groff_tmac(5) – Linux File Formats Manual
  12. ^ groff_me(7) – Linux Miscellanea Manual
  13. ^ groff_mm(7) – Linux Miscellanea Manual
  14. ^ groff_ms(7) – Linux Miscellanea Manual
  15. ^ B. W. Kernighan and Lorinda L. Cherry. A System for Typesetting Mathematics. CSTR #17, Bell Labs, May 1974.
  16. ^ B. W. Kernighan. PIC — A Graphics Language for Typesetting (Revised User Manual). CSTR #116, Bell Labs, December 1984.
  17. ^ C. J. Van Wyk. IDEAL User's Manual. CSTR #103, Bell Labs, December 1981.
  18. ^ grn — groff preprocessor for gremlin files [1].
  19. ^ J. L. Bentley and B. W. Kernighan. GRAP — A Language for Typesetting Graphs (Tutorial and User Manual). CSTR #114, Bell Labs, August 1984.
  20. ^ J. L. Bentley, L. W. Jelinski, and B. W. Kernighan. CHEM — A Program for Typesetting Chemical Structure Diagrams. CSTR #122, Computers and Chemistry, Bell Labs, April 1986.
  21. ^ J. L. Bentley. DFORMAT — A Program for Typesetting Data Formats. CSTR #142, Bell Labs, April 1988.

External links

Retrieved from "https://en.wikipedia.org/w/index.php?title=Troff&oldid=1205932961"
This page is based on the copyrighted Wikipedia article: Troff. Articles is available under the CC BY-SA 3.0 license; additional terms may apply.Privacy Policy