At 2017-11-08T11:52:37+0000, Ralph Corderoy wrote: > Hi Branden, > > Generally, try and use few words whilst preserving meaning and avoiding > ambiguity. Folks have to wade through this when they're looking for an > answer to their question. :-)
Brevity is the soul of...something or other. ;-) > > +In the > > +.I groff > > +source distribution, some of the macro packages (corresponding to > > +.BR groff_hdtbl (@MAN7EXT@), > > +.BR groff_mdoc (@MAN7EXT@), > > +.BR groff_me (@MAN7EXT@), > > +and > > +.BR groff_mom (@MAN7EXT@) > > +as of this writing) > > "currently foo, bar, and xyzzy,". Or don't add the dependency that > needs maintaining? Huh. I'd make the "doesn't need maintaining" argument to support what I already have, not your revision. "Currently" can become wrong. "As of this writing" acknowledges that the statement may become inaccurate in the future. > > +are maintained in \[lq]unstripped\[rq] forms that are then reduced for > > +installation. > > s/reduced/shrunk/? Since that's the aim, and reduce has many computer > meanings. No objection. > > +The stripping process primarily eliminates spaces between dots and > > +request or macro names (used for indentation and readability of the > > +macro sources) and most comments. > > s/process //? I would go you one better and get rid of the "The" in that case, too. > (So it doesn't handle spaces after «'» too.) Correct. '\" comments are rare and used to smuggle preprocessing advice into man pages, though "%beginhere%" still serves as a guard against that case. It seems good to have an escape hatch for a comment that for some reason really needs to survive shrinkage. > > +If you strip your macros, we strongly recommend that you follow GNU > > +.IR roff 's > > +example > > When did `GNU roff' get invented? Well before _my_ time! :) > I see groff(7) starts with > > The name groff stands for GNU roff > > but I've always understood it was a contraction of `GNU troff', and roff > was in no way a direct influence on its name or behaviour; troff and > nroff were copied. The existing groff documentation is largely consistent in referring to "roff" as the language, in contrast with nroff and troff as typesetting programs--though I'll grant that the Texinfo manual that FSF policy wants people reading in preference to all man pages exhibits a major exception with its subtitle. I'm attaching the output of "zgrep -C 1 -iw roff" of all the groff 1.22.3 man pages so that you can see where usge of the term stood before I came along. :) It's definitely not my innovation, but it makes sense to me. -- Regards, Branden
/usr/share/man/man1/groff.1.gz:program and macro suite is the implementation of a /usr/share/man/man1/groff.1.gz:.BR roff (7) /usr/share/man/man1/groff.1.gz:system within the free software collection /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:system has all features of the classical /usr/share/man/man1/groff.1.gz:.IR roff , /usr/share/man/man1/groff.1.gz:but adds many extensions. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:.I groff system /usr/share/man/man1/groff.1.gz:implements the infrastructure of classical roff; see /usr/share/man/man1/groff.1.gz:.BR roff (7) /usr/share/man/man1/groff.1.gz:for a survey on how a /usr/share/man/man1/groff.1.gz:.I roff /usr/share/man/man1/groff.1.gz:system works in general. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:is much easier than /usr/share/man/man1/groff.1.gz:.IR "classical roff" . /usr/share/man/man1/groff.1.gz:. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:It complements /usr/share/man/man1/groff.1.gz:.BR roff (7) /usr/share/man/man1/groff.1.gz:with /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:Doing so, the sometimes tedious piping mechanism of classical /usr/share/man/man1/groff.1.gz:.BR roff (7) /usr/share/man/man1/groff.1.gz:can be avoided. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:General concepts common to all /usr/share/man/man1/groff.1.gz:.I roff /usr/share/man/man1/groff.1.gz:programming languages are described in /usr/share/man/man1/groff.1.gz:.BR roff (7). /usr/share/man/man1/groff.1.gz:. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:The central /usr/share/man/man1/groff.1.gz:.I roff /usr/share/man/man1/groff.1.gz:formatter within the /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:which tries to emulate classical /usr/share/man/man1/groff.1.gz:.I roff /usr/share/man/man1/groff.1.gz:as much as possible. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:In /usr/share/man/man1/groff.1.gz:.IR roff , /usr/share/man/man1/groff.1.gz:the output targets are called /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:.BR \%xditview (1x) /usr/share/man/man1/groff.1.gz:.I roff /usr/share/man/man1/groff.1.gz:viewer distributed with X window. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:When there is a need to run different /usr/share/man/man1/groff.1.gz:.I roff /usr/share/man/man1/groff.1.gz:implementations at the same time /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:to different values, the different /usr/share/man/man1/groff.1.gz:.I roff /usr/share/man/man1/groff.1.gz:installations can be addressed. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:To process a /usr/share/man/man1/groff.1.gz:.I roff /usr/share/man/man1/groff.1.gz:file using the preprocessors /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:Introduction, history and further readings: /usr/share/man/man1/groff.1.gz:.BR roff (7). /usr/share/man/man1/groff.1.gz:. /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:.TP /usr/share/man/man1/groff.1.gz:Roff preprocessors: /usr/share/man/man1/groff.1.gz:.BR \%eqn (1), /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:.TP /usr/share/man/man1/groff.1.gz:Roff language with the groff extensions: /usr/share/man/man1/groff.1.gz:.BR \%groff (7), /usr/share/man/man1/groff.1.gz:-- /usr/share/man/man1/groff.1.gz:.TP /usr/share/man/man1/groff.1.gz:Roff formatter programs: /usr/share/man/man1/groff.1.gz:.BR \%nroff (1), /usr/share/man/man1/grog.1.gz:.\" grog.man -> grog.1 - man page for grog (section 1) /usr/share/man/man1/grog.1.gz:.\" Source file position: <groff_source_top>/src/roff/grog/grog.man /usr/share/man/man1/grog.1.gz:.\" Installed position: <prefix>/share/man/man1/grog.1 /usr/share/man/man1/grog.1.gz:-- /usr/share/man/man1/grog.1.gz:A /usr/share/man/man1/grog.1.gz:.I roff /usr/share/man/man1/grog.1.gz:file can also be written in the /usr/share/man/man1/grog.1.gz:-- /usr/share/man/man1/grog.1.gz:also works with pure text files without any /usr/share/man/man1/grog.1.gz:.I roff /usr/share/man/man1/grog.1.gz:requests, /usr/share/man/man1/grog.1.gz:-- /usr/share/man/man1/grog.1.gz:cannot be used to identify a file to be a /usr/share/man/man1/grog.1.gz:.I roff /usr/share/man/man1/grog.1.gz:file. /usr/share/man/man1/pic.1.gz:requests; /usr/share/man/man1/pic.1.gz:.B roff /usr/share/man/man1/pic.1.gz:configuration commands may be added at the beginning of the file, but no /usr/share/man/man1/pic.1.gz:.B roff /usr/share/man/man1/pic.1.gz:text. /usr/share/man/man1/troff.1.gz: /usr/share/man/man1/troff.1.gz:This file is part of groff, the GNU roff type-setting system, which /usr/share/man/man1/troff.1.gz:is a GNU free software project.. /usr/share/man/man1/troff.1.gz:-- /usr/share/man/man1/troff.1.gz:.TP /usr/share/man/man1/troff.1.gz:.BR roff (7) /usr/share/man/man1/troff.1.gz:An overview over /usr/share/man/man1/troff.1.gz:-- /usr/share/man/man1/troff.1.gz:and other /usr/share/man/man1/troff.1.gz:.I roff /usr/share/man/man1/troff.1.gz:systems, including pointers to further related documentation. /usr/share/man/man1/gpic.1.gz:requests; /usr/share/man/man1/gpic.1.gz:.B roff /usr/share/man/man1/gpic.1.gz:configuration commands may be added at the beginning of the file, but no /usr/share/man/man1/gpic.1.gz:.B roff /usr/share/man/man1/gpic.1.gz:text. /usr/share/man/man1/glilypond.1.gz:Each input must be written in the /usr/share/man/man1/glilypond.1.gz:.I roff /usr/share/man/man1/glilypond.1.gz:or /usr/share/man/man1/glilypond.1.gz:-- /usr/share/man/man1/glilypond.1.gz:.\" -------------------------------------------------------------------- /usr/share/man/man1/glilypond.1.gz:.SH "THE LILYPOND PARTS IN ROFF INPUT" /usr/share/man/man1/glilypond.1.gz:.\" -------------------------------------------------------------------- /usr/share/man/man1/glilypond.1.gz:-- /usr/share/man/man1/glilypond.1.gz:.\" -------------------------------------------------------------------- /usr/share/man/man1/glilypond.1.gz:.SH "THE GENERATED NEW ROFF STRUCTURE" /usr/share/man/man1/glilypond.1.gz:.\" -------------------------------------------------------------------- /usr/share/man/man1/gperl.1.gz:.SH NAME /usr/share/man/man1/gperl.1.gz:gperl \- groff preprocessor for Perl parts in roff files /usr/share/man/man1/gperl.1.gz:. /usr/share/man/man1/gperl.1.gz:-- /usr/share/man/man1/gperl.1.gz:in a /usr/share/man/man1/gperl.1.gz:.I roff file /usr/share/man/man1/gperl.1.gz:could look like that: /usr/share/man/man1/gperl.1.gz:-- /usr/share/man/man1/gperl.1.gz:into the /usr/share/man/man1/gperl.1.gz:.I roff string /usr/share/man/man1/gperl.1.gz:called /usr/share/man/man1/groffer.1.gz:or other /usr/share/man/man1/groffer.1.gz:.I \%roff /usr/share/man/man1/groffer.1.gz:languages, see /usr/share/man/man1/groffer.1.gz:.BR \%roff (7), /usr/share/man/man1/groffer.1.gz:that are compatible to the original /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:Transform /usr/share/man/man1/groffer.1.gz:.I roff input files /usr/share/man/man1/groffer.1.gz:into a /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:Display the formatted input in a native /usr/share/man/man1/groffer.1.gz:.I roff /usr/share/man/man1/groffer.1.gz:viewer. /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:.B source /usr/share/man/man1/groffer.1.gz:Output the roff source code of the input files without further /usr/share/man/man1/groffer.1.gz:processing. /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:\%\f[CR]X\~Window\f[] /usr/share/man/man1/groffer.1.gz:.I roff /usr/share/man/man1/groffer.1.gz:viewers such as /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:is a /usr/share/man/man1/groffer.1.gz:.I roff /usr/share/man/man1/groffer.1.gz:program; it wants to read /usr/share/man/man1/groffer.1.gz:.I roff /usr/share/man/man1/groffer.1.gz:source files and format them itself. /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:.EX /usr/share/man/man1/groffer.1.gz:\fIsh#\fR\~groffer\~groff\~\[cq]troff(1)\[cq]\~man:roff /usr/share/man/man1/groffer.1.gz:.EE /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:and /usr/share/man/man1/groffer.1.gz:.B \%roff /usr/share/man/man1/groffer.1.gz:(in the section with the lowest number, being\~7 in this case). /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:.EX /usr/share/man/man1/groffer.1.gz:\fIsh#\fR\~groffer\~\-\-source\~'man:roff(7)' /usr/share/man/man1/groffer.1.gz:.EE /usr/share/man/man1/groffer.1.gz:-- /usr/share/man/man1/groffer.1.gz:called /usr/share/man/man1/groffer.1.gz:.I \%roff /usr/share/man/man1/groffer.1.gz:in \fIman\fP\~section 7, decompress it, and print its unformatted /usr/share/man/man1/pdfroff.1.gz: /usr/share/man/man1/pdfroff.1.gz:This file is part of groff, the free GNU roff type-setting system. /usr/share/man/man1/pdfroff.1.gz: /usr/share/man/man1/roff2dvi.1.gz:.SH NAME /usr/share/man/man1/roff2dvi.1.gz:roff2dvi \- transform roff code into dvi mode /usr/share/man/man1/roff2dvi.1.gz:. /usr/share/man/man1/roff2dvi.1.gz:-- /usr/share/man/man1/roff2dvi.1.gz:transforms /usr/share/man/man1/roff2dvi.1.gz:.I roff /usr/share/man/man1/roff2dvi.1.gz:code into /usr/share/man/man1/roff2dvi.1.gz:-- /usr/share/man/man1/roff2dvi.1.gz:There are more of these programs for generating other formats of /usr/share/man/man1/roff2dvi.1.gz:.I \%roff /usr/share/man/man1/roff2dvi.1.gz:input. /usr/share/man/man1/roff2html.1.gz:.SH NAME /usr/share/man/man1/roff2html.1.gz:roff2html \- transform roff code into html mode /usr/share/man/man1/roff2html.1.gz:. /usr/share/man/man1/roff2html.1.gz:-- /usr/share/man/man1/roff2html.1.gz:transforms /usr/share/man/man1/roff2html.1.gz:.I roff /usr/share/man/man1/roff2html.1.gz:code into /usr/share/man/man1/roff2html.1.gz:-- /usr/share/man/man1/roff2html.1.gz:There are more of these programs for generating other formats of /usr/share/man/man1/roff2html.1.gz:.I \%roff /usr/share/man/man1/roff2html.1.gz:input. /usr/share/man/man1/roff2pdf.1.gz:.SH NAME /usr/share/man/man1/roff2pdf.1.gz:roff2pdf \- transform roff code into pdf mode /usr/share/man/man1/roff2pdf.1.gz:. /usr/share/man/man1/roff2pdf.1.gz:-- /usr/share/man/man1/roff2pdf.1.gz:transforms /usr/share/man/man1/roff2pdf.1.gz:.I roff /usr/share/man/man1/roff2pdf.1.gz:code into /usr/share/man/man1/roff2pdf.1.gz:-- /usr/share/man/man1/roff2pdf.1.gz:There are more of these programs for generating other formats of /usr/share/man/man1/roff2pdf.1.gz:.I \%roff /usr/share/man/man1/roff2pdf.1.gz:input. /usr/share/man/man1/roff2ps.1.gz:.SH NAME /usr/share/man/man1/roff2ps.1.gz:roff2ps \- transform roff code into ps mode /usr/share/man/man1/roff2ps.1.gz:. /usr/share/man/man1/roff2ps.1.gz:-- /usr/share/man/man1/roff2ps.1.gz:transforms /usr/share/man/man1/roff2ps.1.gz:.I roff /usr/share/man/man1/roff2ps.1.gz:code into /usr/share/man/man1/roff2ps.1.gz:-- /usr/share/man/man1/roff2ps.1.gz:There are more of these programs for generating other formats of /usr/share/man/man1/roff2ps.1.gz:.I \%roff /usr/share/man/man1/roff2ps.1.gz:input. /usr/share/man/man1/roff2text.1.gz:.SH NAME /usr/share/man/man1/roff2text.1.gz:roff2text \- transform roff code into text mode /usr/share/man/man1/roff2text.1.gz:. /usr/share/man/man1/roff2text.1.gz:-- /usr/share/man/man1/roff2text.1.gz:transforms /usr/share/man/man1/roff2text.1.gz:.I roff /usr/share/man/man1/roff2text.1.gz:code into /usr/share/man/man1/roff2text.1.gz:-- /usr/share/man/man1/roff2text.1.gz:There are more of these programs for generating other formats of /usr/share/man/man1/roff2text.1.gz:.I \%roff /usr/share/man/man1/roff2text.1.gz:input. /usr/share/man/man1/roff2x.1.gz:.SH NAME /usr/share/man/man1/roff2x.1.gz:roff2x \- transform roff code into x mode /usr/share/man/man1/roff2x.1.gz:. /usr/share/man/man1/roff2x.1.gz:-- /usr/share/man/man1/roff2x.1.gz:transforms /usr/share/man/man1/roff2x.1.gz:.I roff /usr/share/man/man1/roff2x.1.gz:code into /usr/share/man/man1/roff2x.1.gz:-- /usr/share/man/man1/roff2x.1.gz:There are more of these programs for generating other formats of /usr/share/man/man1/roff2x.1.gz:.I \%roff /usr/share/man/man1/roff2x.1.gz:input. /usr/share/man/man5/groff_font.5.gz: /usr/share/man/man5/groff_font.5.gz:This file is part of groff (GNU roff), which is a free software project. /usr/share/man/man5/groff_font.5.gz: /usr/share/man/man5/groff_out.5.gz: /usr/share/man/man5/groff_out.5.gz:This file is part of groff, the GNU roff type-setting system, which is /usr/share/man/man5/groff_out.5.gz:a free software project. /usr/share/man/man5/groff_out.5.gz:-- /usr/share/man/man5/groff_out.5.gz:format of the GNU /usr/share/man/man5/groff_out.5.gz:.BR roff (7) /usr/share/man/man5/groff_out.5.gz:text processing system /usr/share/man/man5/groff_out.5.gz:-- /usr/share/man/man5/groff_out.5.gz:As the GNU /usr/share/man/man5/groff_out.5.gz:.I roff /usr/share/man/man5/groff_out.5.gz:processor /usr/share/man/man5/groff_out.5.gz:-- /usr/share/man/man5/groff_out.5.gz:.RI pre- groff /usr/share/man/man5/groff_out.5.gz:.I roff /usr/share/man/man5/groff_out.5.gz:versions are denoted as /usr/share/man/man5/groff_out.5.gz:-- /usr/share/man/man5/groff_out.5.gz:the /usr/share/man/man5/groff_out.5.gz:.I roff /usr/share/man/man5/groff_out.5.gz:input is cracked down to the information on what has to be printed at /usr/share/man/man5/groff_out.5.gz:-- /usr/share/man/man5/groff_out.5.gz:language, never to the /usr/share/man/man5/groff_out.5.gz:.I roff /usr/share/man/man5/groff_out.5.gz:language used for document formatting. /usr/share/man/man5/groff_out.5.gz:-- /usr/share/man/man5/groff_out.5.gz:The /usr/share/man/man5/groff_out.5.gz:.I roff /usr/share/man/man5/groff_out.5.gz:postprocessors are programs that have the task to translate the /usr/share/man/man5/groff_out.5.gz:-- /usr/share/man/man5/groff_out.5.gz:.TP /usr/share/man/man5/groff_out.5.gz:.BR roff (7) /usr/share/man/man5/groff_out.5.gz:for historical aspects and the general structure of roff systems. /usr/share/man/man5/groff_out.5.gz:. /usr/share/man/man5/groff_tmac.5.gz:.SH NAME /usr/share/man/man5/groff_tmac.5.gz:groff_tmac \- macro files in the roff typesetting system /usr/share/man/man5/groff_tmac.5.gz:. /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz: /usr/share/man/man5/groff_tmac.5.gz:This file is part of groff, the GNU roff type-setting system. /usr/share/man/man5/groff_tmac.5.gz: /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:The /usr/share/man/man5/groff_tmac.5.gz:.BR roff (7) /usr/share/man/man5/groff_tmac.5.gz:type-setting system provides a set of macro packages suitable for /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:.RB \[oq] T\c /usr/share/man/man5/groff_tmac.5.gz:.IB roff MAC\c /usr/share/man/man5/groff_tmac.5.gz:.IR ros \[cq]. /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:.P /usr/share/man/man5/groff_tmac.5.gz:The tmac files are normal roff source documents, except that they /usr/share/man/man5/groff_tmac.5.gz:usually contain only definitions and setup commands, but no text. /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:. /usr/share/man/man5/groff_tmac.5.gz:.B roff /usr/share/man/man5/groff_tmac.5.gz:loads latin1 by default at start-up. /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:Due to different character ranges used in /usr/share/man/man5/groff_tmac.5.gz:.B roff /usr/share/man/man5/groff_tmac.5.gz:it doesn\[aq]t work on architectures which are based on ASCII. /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:. /usr/share/man/man5/groff_tmac.5.gz:Classical roff systems were designed before the conventions of the /usr/share/man/man5/groff_tmac.5.gz:modern C /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:.B .mso /usr/share/man/man5/groff_tmac.5.gz:requests, the roff preprocessor /usr/share/man/man5/groff_tmac.5.gz:.BR soelim (1) /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:and is used in some document called /usr/share/man/man5/groff_tmac.5.gz:.IR docu.roff . /usr/share/man/man5/groff_tmac.5.gz:. /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:.EX /usr/share/man/man5/groff_tmac.5.gz:\fIsh#\fP groff \-m macros docu.roff /usr/share/man/man5/groff_tmac.5.gz:.EE /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:.EX /usr/share/man/man5/groff_tmac.5.gz:\fIsh#\fP groff \-s docu.roff /usr/share/man/man5/groff_tmac.5.gz:.EE /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:. /usr/share/man/man5/groff_tmac.5.gz:There is a convention that is supported by many modern roff /usr/share/man/man5/groff_tmac.5.gz:type-setters and /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:(see /usr/share/man/man5/groff_tmac.5.gz:.BR roff (7)). /usr/share/man/man5/groff_tmac.5.gz:. /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:A /usr/share/man/man5/groff_tmac.5.gz:.BR roff (7) /usr/share/man/man5/groff_tmac.5.gz:document is a text file that is enriched by predefined formatting /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:These elements are described in /usr/share/man/man5/groff_tmac.5.gz:.BR roff (7). /usr/share/man/man5/groff_tmac.5.gz:. /usr/share/man/man5/groff_tmac.5.gz:-- /usr/share/man/man5/groff_tmac.5.gz:.I "copy mode" /usr/share/man/man5/groff_tmac.5.gz:in roff-talk. /usr/share/man/man5/groff_tmac.5.gz:. /usr/share/man/man7/ditroff.7.gz:.SH NAME /usr/share/man/man7/ditroff.7.gz:ditroff \- classical device independent roff /usr/share/man/man7/ditroff.7.gz:. /usr/share/man/man7/ditroff.7.gz:-- /usr/share/man/man7/ditroff.7.gz: /usr/share/man/man7/ditroff.7.gz:This file is part of groff, the GNU roff type-setting system. /usr/share/man/man7/ditroff.7.gz: /usr/share/man/man7/ditroff.7.gz:-- /usr/share/man/man7/ditroff.7.gz:In actual /usr/share/man/man7/ditroff.7.gz:.BR roff (7) /usr/share/man/man7/ditroff.7.gz:systems, the name /usr/share/man/man7/ditroff.7.gz:-- /usr/share/man/man7/ditroff.7.gz:.P /usr/share/man/man7/ditroff.7.gz:The first roff system was written by Joe Ossanna around 1973. /usr/share/man/man7/ditroff.7.gz:. /usr/share/man/man7/ditroff.7.gz:-- /usr/share/man/man7/ditroff.7.gz:.P /usr/share/man/man7/ditroff.7.gz:Today, any existing roff system is based on Kernighan\[aq]s /usr/share/man/man7/ditroff.7.gz:multi-device troff. /usr/share/man/man7/ditroff.7.gz:-- /usr/share/man/man7/ditroff.7.gz:.P /usr/share/man/man7/ditroff.7.gz:The easiest way to use ditroff is the GNU roff system, /usr/share/man/man7/ditroff.7.gz:.IR groff . /usr/share/man/man7/ditroff.7.gz:-- /usr/share/man/man7/ditroff.7.gz:.TP /usr/share/man/man7/ditroff.7.gz:.BR roff (7) /usr/share/man/man7/ditroff.7.gz:This document gives details on the history and concepts of roff. /usr/share/man/man7/ditroff.7.gz:. /usr/share/man/man7/ditroff.7.gz:-- /usr/share/man/man7/ditroff.7.gz:.BR groff (1) /usr/share/man/man7/ditroff.7.gz:The GNU roff program and pointers to all documentation around groff. /usr/share/man/man7/ditroff.7.gz:. /usr/share/man/man7/groff.7.gz:.SH NAME /usr/share/man/man7/groff.7.gz:groff \- a short reference for the GNU roff language /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.de co /usr/share/man/man7/groff.7.gz:This file is part of groff, the GNU roff type-setting system. /usr/share/man/man7/groff.7.gz: /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:stands for /usr/share/man/man7/groff.7.gz:.I GNU roff /usr/share/man/man7/groff.7.gz:and is the free implementation of the roff type-setting system. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:See /usr/share/man/man7/groff.7.gz:.BR roff (7) /usr/share/man/man7/groff.7.gz:for a survey and the background of the groff system. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.P /usr/share/man/man7/groff.7.gz:This document gives only short descriptions of the predefined roff /usr/share/man/man7/groff.7.gz:language elements as used in groff. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:Historically, the /usr/share/man/man7/groff.7.gz:.I roff language /usr/share/man/man7/groff.7.gz:was called /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:So in GNU, the terms /usr/share/man/man7/groff.7.gz:.IR roff , /usr/share/man/man7/groff.7.gz:.IR troff , /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:emphasizes the GNU extensions, and /usr/share/man/man7/groff.7.gz:.I roff /usr/share/man/man7/groff.7.gz:is the general term for the language. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:The general syntax for writing groff documents is relatively easy, but /usr/share/man/man7/groff.7.gz:writing extensions to the roff language can be a bit harder. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.P /usr/share/man/man7/groff.7.gz:The roff language is line-oriented. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.P /usr/share/man/man7/groff.7.gz:The roff language provides flexible instruments for writing language /usr/share/man/man7/groff.7.gz:extension, such as macros. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:When interpreting macro definitions, the roff system enters a special /usr/share/man/man7/groff.7.gz:operating mode, called the /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.P /usr/share/man/man7/groff.7.gz:Reading roff source files is easier, just reduce all double backslashes /usr/share/man/man7/groff.7.gz:to a single one in all macro definitions. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:The roff language elements add formatting information to a text file. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:The fundamental elements are predefined commands and variables that /usr/share/man/man7/groff.7.gz:make roff a full-blown programming language. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.P /usr/share/man/man7/groff.7.gz:There are two kinds of roff commands, possibly with arguments. /usr/share/man/man7/groff.7.gz:.B Requests /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.P /usr/share/man/man7/groff.7.gz:Moreover, there are some advanced roff elements. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:The /usr/share/man/man7/groff.7.gz:.I roff /usr/share/man/man7/groff.7.gz:language defines the following scaling indicators. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.REQ .ex /usr/share/man/man7/groff.7.gz:Exit from roff processing. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:They can originate from a macro package (see /usr/share/man/man7/groff.7.gz:.BR roff (7) /usr/share/man/man7/groff.7.gz:for an overview) or from a preprocessor. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.esc ( /usr/share/man/man7/groff.7.gz:construct are glyphs predefined by the roff system; these are called /usr/share/man/man7/groff.7.gz:\[oq]Special Characters\[cq] in the classical documentation. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.esc[] "" glyph , /usr/share/man/man7/groff.7.gz:but compatible to other roff versions. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:that allows to include all available Unicode characters into some /usr/share/man/man7/groff.7.gz:.I roff /usr/share/man/man7/groff.7.gz:file. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:But in /usr/share/man/man7/groff.7.gz:.I roff /usr/share/man/man7/groff.7.gz:this is much more difficult. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.BR groff_diff (7) /usr/share/man/man7/groff.7.gz:the differences of the groff language as compared to classical roff. /usr/share/man/man7/groff.7.gz:. /usr/share/man/man7/groff.7.gz:-- /usr/share/man/man7/groff.7.gz:.TP /usr/share/man/man7/groff.7.gz:.BR roff (7) /usr/share/man/man7/groff.7.gz:the history of roff, the common parts shared by all roff systems, and /usr/share/man/man7/groff.7.gz:pointers to further documentation. /usr/share/man/man7/groff_char.7.gz:. /usr/share/man/man7/groff_char.7.gz:.\" For best results, format this document with `groff' (GNU roff). /usr/share/man/man7/groff_char.7.gz:. /usr/share/man/man7/groff_char.7.gz:-- /usr/share/man/man7/groff_char.7.gz: /usr/share/man/man7/groff_char.7.gz:This file is part of groff (GNU roff), which is a free software project. /usr/share/man/man7/groff_char.7.gz: /usr/share/man/man7/groff_char.7.gz:-- /usr/share/man/man7/groff_char.7.gz:.BR man (1) /usr/share/man/man7/groff_char.7.gz:program or the roff formatter). /usr/share/man/man7/groff_char.7.gz:. /usr/share/man/man7/groff_char.7.gz:-- /usr/share/man/man7/groff_char.7.gz:.P /usr/share/man/man7/groff_char.7.gz:All roff systems provide the concept of named glyphs. /usr/share/man/man7/groff_char.7.gz:. /usr/share/man/man7/groff_char.7.gz:In traditional roff systems, only names of length\ 2 were used, while /usr/share/man/man7/groff_char.7.gz:groff also provides support for longer names. /usr/share/man/man7/groff_char.7.gz:-- /usr/share/man/man7/groff_char.7.gz:.BR groff (1) /usr/share/man/man7/groff_char.7.gz:the GNU roff formatter /usr/share/man/man7/groff_char.7.gz:. /usr/share/man/man7/groff_diff.7.gz:.P /usr/share/man/man7/groff_diff.7.gz:This file is part of groff, the GNU roff type-setting system. /usr/share/man/man7/groff_diff.7.gz:. /usr/share/man/man7/groff_diff.7.gz:-- /usr/share/man/man7/groff_diff.7.gz:the GNU /usr/share/man/man7/groff_diff.7.gz:.I roff /usr/share/man/man7/groff_diff.7.gz:text processing system, and the classical /usr/share/man/man7/groff_diff.7.gz:.I roff /usr/share/man/man7/groff_diff.7.gz:formatter of the freely available Unix\~7 of the 1970s, documented in /usr/share/man/man7/groff_diff.7.gz:-- /usr/share/man/man7/groff_diff.7.gz:. /usr/share/man/man7/groff_diff.7.gz:This includes the roff language as well as the intermediate output /usr/share/man/man7/groff_diff.7.gz:format (troff output). /usr/share/man/man7/groff_diff.7.gz:-- /usr/share/man/man7/groff_diff.7.gz:gives pointers to both the classical /usr/share/man/man7/groff_diff.7.gz:.I roff /usr/share/man/man7/groff_diff.7.gz:and the modern /usr/share/man/man7/groff_diff.7.gz:-- /usr/share/man/man7/groff_diff.7.gz:.B compatibility mode /usr/share/man/man7/groff_diff.7.gz:that allows to process roff code written for classical /usr/share/man/man7/groff_diff.7.gz:.B troff /usr/share/man/man7/groff_diff.7.gz:or for other implementations of roff in a consistent way. /usr/share/man/man7/groff_diff.7.gz:. /usr/share/man/man7/groff_diff.7.gz:-- /usr/share/man/man7/groff_diff.7.gz:.TP /usr/share/man/man7/groff_diff.7.gz:.BR roff (7) /usr/share/man/man7/groff_diff.7.gz:A survey of /usr/share/man/man7/groff_diff.7.gz:.I roff /usr/share/man/man7/groff_diff.7.gz:systems, including pointers to further historical documentation. /usr/share/man/man7/groff_filenames.7.gz:.SH NAME /usr/share/man/man7/groff_filenames.7.gz:groff_filenames \(em filename extensions for roff and groff /usr/share/man/man7/groff_filenames.7.gz:. /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:Since the evolution of /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:in the 1970s, a whole bunch of filename extensions for /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:files were used. /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:The /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:extensions refer to preprocessors or macro packages. /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/groff_filenames.7.gz:.SH COMPRESSION OF ROFF FILES /usr/share/man/man7/groff_filenames.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:Each /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:file can be optionally /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:style is the best known part of the /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:language. /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:There are 2 /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:languages for writing man\-pages: /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:Man-page format in /usr/share/man/man7/groff_filenames.7.gz:.IR "heirloom roff ". /usr/share/man/man7/groff_filenames.7.gz:. /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:The /usr/share/man/man7/groff_filenames.7.gz:.I "classical roff" /usr/share/man/man7/groff_filenames.7.gz:languages were interpreted by the traditional /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:There were several /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:languages, each represented by a /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:.IB <name> .me /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:file using the /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:.IB <name> .mm /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:file using the /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:.IB <name> .ms /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:file using the /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:All of these classical /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:languages and their extensions are still very active in /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:In traditional /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:the source code for the macro packages was stored in /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/groff_filenames.7.gz:.SS Classical Roff Files /usr/share/man/man7/groff_filenames.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:for files using the /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:language of any kind /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:. /usr/share/man/man7/groff_filenames.7.gz:.I "GNU roff" /usr/share/man/man7/groff_filenames.7.gz:.B groff /usr/share/man/man7/groff_filenames.7.gz:is the actual /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:standard, both for classical /usr/share/man/man7/groff_filenames.7.gz:.I roff /usr/share/man/man7/groff_filenames.7.gz:and new extensions. /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:.TQ /usr/share/man/man7/groff_filenames.7.gz:.IB <name> .roff /usr/share/man/man7/groff_filenames.7.gz:general ending for files using the /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:History and future /usr/share/man/man7/groff_filenames.7.gz:.BR roff (7), /usr/share/man/man7/groff_filenames.7.gz:.BR man\-pages (7), /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:.P /usr/share/man/man7/groff_filenames.7.gz:.UR https://\:github.com/\:n-t-roff/\:heirloom-doctools /usr/share/man/man7/groff_filenames.7.gz:.I Gunnar Ritter\[aq]s Heirloom roff project /usr/share/man/man7/groff_filenames.7.gz:.UE . /usr/share/man/man7/groff_filenames.7.gz:-- /usr/share/man/man7/groff_filenames.7.gz:.EX /usr/share/man/man7/groff_filenames.7.gz:\[Do] git clone https://github.com/n-t-roff/heirloom-doctools /usr/share/man/man7/groff_filenames.7.gz:.EE /usr/share/man/man7/groff_hdtbl.7.gz:to your /usr/share/man/man7/groff_hdtbl.7.gz:.I roff /usr/share/man/man7/groff_hdtbl.7.gz:file before using any macros of the /usr/share/man/man7/groff_hdtbl.7.gz:-- /usr/share/man/man7/groff_hdtbl.7.gz:As with /usr/share/man/man7/groff_hdtbl.7.gz:.BR roff 's /usr/share/man/man7/groff_hdtbl.7.gz:.CR .ft /usr/share/man/man7/groff_hdtbl.7.gz:-- /usr/share/man/man7/groff_hdtbl.7.gz:The file /usr/share/man/man7/groff_hdtbl.7.gz:.B examples/common.roff /usr/share/man/man7/groff_hdtbl.7.gz:provides another example setup /usr/share/man/man7/groff_mom.7.gz:.SH NAME /usr/share/man/man7/groff_mom.7.gz:groff_mom \- groff `mom' macros, `mom' is a `roff' language, part of `groff' /usr/share/man/man7/groff_mom.7.gz:. /usr/share/man/man7/groff_trace.7.gz: /usr/share/man/man7/groff_trace.7.gz:This file is part of groff, the GNU roff type-setting system. /usr/share/man/man7/groff_trace.7.gz: /usr/share/man/man7/groff_trace.7.gz:-- /usr/share/man/man7/groff_trace.7.gz:.BR groff (1) /usr/share/man/man7/groff_trace.7.gz:can be a valuable tool for debugging documents written in the roff /usr/share/man/man7/groff_trace.7.gz:formatting language. /usr/share/man/man7/groff_trace.7.gz:-- /usr/share/man/man7/groff_trace.7.gz:. /usr/share/man/man7/groff_trace.7.gz:In the following examples, a roff fragment is fed into groff via /usr/share/man/man7/groff_trace.7.gz:standard input. /usr/share/man/man7/groff_trace.7.gz:-- /usr/share/man/man7/groff_trace.7.gz:.BR groffer (1) /usr/share/man/man7/groff_trace.7.gz:A viewer program for all kinds of roff documents. /usr/share/man/man7/groff_trace.7.gz:. /usr/share/man/man7/roff.7.gz:'\" t /usr/share/man/man7/roff.7.gz:.TH ROFF 7 "13 December 2016" "Groff Version 1.22.3" /usr/share/man/man7/roff.7.gz:.SH NAME /usr/share/man/man7/roff.7.gz:roff \- concepts and history of roff typesetting /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:.\" this is man-page roff.7 /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:is the general name for a set of text formatting programs, known under /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:A /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system consists of an extensible text formatting language and a set of /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Unix-like operating systems distribute a /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system as a core package. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The most common /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system today is the free software implementation \f[CR]GNU\f[] /usr/share/man/man7/roff.7.gz:.IR roff , /usr/share/man/man7/roff.7.gz:.BR groff (1). /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The ancestry of /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:is described in section /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:In this document, the term /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:always refers to the general class of roff programs, not to the /usr/share/man/man7/roff.7.gz:.B roff /usr/share/man/man7/roff.7.gz:command provided in early UNIX systems. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:In spite of its age, /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:is in wide use today, for example, the manual pages on UNIX systems /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:many software books, system documentation, standards, and corporate /usr/share/man/man7/roff.7.gz:documents are written in roff. /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:The /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:output for text devices is still unmatched, and its graphical output /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.P /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:is used to format UNIX /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:This document describes the history of the development of the /usr/share/man/man7/roff.7.gz:.IR "roff system" ; /usr/share/man/man7/roff.7.gz:some usage aspects common to all /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:versions, details on the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:pipeline, which is usually hidden behind front-ends like /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:a general overview of the formatting language; some tips for editing /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:files; and many pointers to further readings. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system itself is intimately connected to the Unix operating system, but its /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:.BR roff \[aq]s /usr/share/man/man7/roff.7.gz:ancestor /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:was shortened to /usr/share/man/man7/roff.7.gz:.IR roff . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:included all elements of a full /usr/share/man/man7/roff.7.gz:.IR "roff system" . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:All modern /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:systems try to implement compatibility to this system. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:So Joe Ossanna can be called the father of all /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:systems. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:This first /usr/share/man/man7/roff.7.gz:.I roff system /usr/share/man/man7/roff.7.gz:had three formatter programs. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.B troff /usr/share/man/man7/roff.7.gz:.RI ( "typesetter roff\/" ) /usr/share/man/man7/roff.7.gz:generated a graphical output for the /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.TP /usr/share/man/man7/roff.7.gz:.B roff /usr/share/man/man7/roff.7.gz:was the reimplementation of the former /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Today, the name /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:is used to refer to a /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:joined the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:development by rewriting it in the C\~programming language. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:All later /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:systems tried to establish compatibility with this specification. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:This completed the structure of a /usr/share/man/man7/roff.7.gz:.I "roff system" /usr/share/man/man7/roff.7.gz:as it is still in use today; see section /usr/share/man/man7/roff.7.gz:.BR "USING ROFF" . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:.SS "groff \[em] free GNU roff" /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The most important free /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:project was the \f[CR]GNU\f[] implementation of /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:(\f[CR]GNU\f[] /usr/share/man/man7/roff.7.gz:.IR roff ). /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:It is the first /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system that is available on almost all operating systems \[em] and it /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:the de-facto /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:standard today. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:.SS "Free Heirloom roff" /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:An alternative is /usr/share/man/man7/roff.7.gz:.UR https://\:github.com/\:n-t-roff/\:heirloom-doctools /usr/share/man/man7/roff.7.gz:.I Gunnar Ritter\[aq]s Heirloom roff project /usr/share/man/man7/roff.7.gz:.UE /usr/share/man/man7/roff.7.gz:project, started in 2005, which provides enhanced versions of the various /usr/share/man/man7/roff.7.gz:roff tools found in the OpenSolaris and Plan\~9 operating systems, now /usr/share/man/man7/roff.7.gz:available under free licenses. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.EX /usr/share/man/man7/roff.7.gz:\[Do] git clone https://github.com/n-t-roff/heirloom-doctools /usr/share/man/man7/roff.7.gz:.EE /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Moreover, one finds there the /usr/share/man/man7/roff.7.gz:.UR https://github.com/n-t-roff/DWB3.3 /usr/share/man/man7/roff.7.gz:.I Original Documenter\[aq]s Workbench Release 3.3 /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:.SH "USING ROFF" /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Most people won\[aq]t even notice that they are actually using /usr/share/man/man7/roff.7.gz:.IR roff . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:When you read a system manual page (man page) /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:is working in the background. /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:documents can be viewed with a native viewer called /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:But using /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:explicitly isn\[aq]t difficult either. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Some /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:implementations provide wrapper programs that make it easy to use the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system on the shell command line. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:For example, the \f[CR]GNU\f[] /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:implementation /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:.SS "The roff Pipe" /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Each /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system consists of preprocessors, /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatter programs, and a set of device postprocessors. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The preprocessors generate /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:code that is fed into a /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatter (e.g.\& /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Moreover, /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:macro packages that were tailored for special purposes can be /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Most /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:documents use the macros of some package, intermixed with code for one /usr/share/man/man7/roff.7.gz:or more preprocessors, spiced with some elements from the plain /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:language. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The full power of the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatting language is seldom needed by users; only programmers of /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:A /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:preprocessor is any program that generates output that syntactically /usr/share/man/man7/roff.7.gz:obeys the rules of the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatting language. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:into /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:code when run through the preprocessor program. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Parts written in these languages may be included within a /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:document; they are identified by special /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:requests or macros. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:actual /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatter program, for the formatter just ignores all alien code. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:There are a lot of free and commercial /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:preprocessors. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:set of preprocessors that are considered as an integral part of each /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:A /usr/share/man/man7/roff.7.gz:.I roff formatter /usr/share/man/man7/roff.7.gz:is a program that parses documents written in the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatting language or uses some of the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:macro packages. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The output produced by a /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatter is represented in yet another language, the /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:compared to the high-level /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:language. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatter is the heart of the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The traditional /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:had two formatters, /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:A /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:postprocessor is a program that transforms /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:postprocessors are like device drivers for the output target. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:.SH "ROFF PROGRAMMING" /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Documents using /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:are normal text files decorated by /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatting elements. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatting language is quite powerful; it is almost a full programming /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Such macro packages are much handier than plain /usr/share/man/man7/roff.7.gz:.IR roff . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:internals of the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:language. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:This greatly eases the usage of /usr/share/man/man7/roff.7.gz:.IR roff . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:requests of the /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:language, see /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:.SS "The roff Formatting Language" /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The classical /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatting language is documented in the /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:language is a full programming language providing requests, definition /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The user can define request-like elements using predefined /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:elements. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:are /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:elements starting with a backslash /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:extension, e.g., the filename for this document is /usr/share/man/man7/roff.7.gz:.IR roff.7 , /usr/share/man/man7/roff.7.gz:i.e., it is kept in section\~7 /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:But there is no general naming scheme for /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:documents, though /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Maybe there should be a standardization for the filename extensions of /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:files. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:.SH "EDITING ROFF" /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The best program for editing a /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:document is Emacs (or Xemacs), see /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:mode that is suitable for all kinds of /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:dialects. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:All /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:formatters provide automated line breaks and horizontal and vertical /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Never include empty or blank lines in a /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:document. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Indented paragraphs can be constructed in a controlled way by /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:requests. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:an empty /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:request (a line consisting of a dot only) after each sentence. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The following example shows how optimal /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:editing could look. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.EX /usr/share/man/man7/roff.7.gz:This is an example for a \&.I roff document. \&. /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:There is a lot of documentation on /usr/share/man/man7/roff.7.gz:.IR roff . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:provides an overview and pointers to all historical aspects of /usr/share/man/man7/roff.7.gz:.IR roff . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.TP /usr/share/man/man7/roff.7.gz:\f[CR]GNU\f[] \f[I]roff\f[] /usr/share/man/man7/roff.7.gz:.UR http://\:www.gnu.org/\:software/\:groff /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:provides the free /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:implementation /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:the actual standard /usr/share/man/man7/roff.7.gz:.IR roff . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:.SS "Historical roff Documentation" /usr/share/man/man7/roff.7.gz:.\" -------------------------------------------------------------------- /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:The \[lq]little language\[rq] /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:papers are /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:You can get an archive with most /usr/share/man/man7/roff.7.gz:.I classical roff documentation /usr/share/man/man7/roff.7.gz:as reasonable /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:Due to its complex structure, a full /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:system has many man pages, each describing a single aspect of /usr/share/man/man7/roff.7.gz:.IR roff . /usr/share/man/man7/roff.7.gz:. /usr/share/man/man7/roff.7.gz:-- /usr/share/man/man7/roff.7.gz:among the different /usr/share/man/man7/roff.7.gz:.I roff /usr/share/man/man7/roff.7.gz:implementations.
signature.asc
Description: PGP signature
