1 .\" This file gives a small example how a web page could look like if created
5 .\" To make it work with other output devices also, we include www.tmac
10 .if '\*[.T]'html' .nr LL 10i
11 .if r ps4html .nr LL 10i
13 .HEAD "<link rel=""stylesheet"" type=""text/css"" href=""groff.css"" >"
14 .\" .HEAD "<link rel=""icon"" type=""image/png"" href=""http://www.gnu.org/graphics/gnu-mini.png"" >"
27 .defcolor mydarkred rgb 0.65f 0.1f 0.2f
28 .defcolor mydarkgreen rgb 0.1f 0.5f 0.2f
29 .defcolor mydarkblue rgb 0.1f 0.2f 0.6f
31 .ds GNU \m[mydarkred]G\m[]\m[mydarkgreen]N\m[]\m[mydarkblue]U\m[]
36 Home of Groff (GNU Troff).
40 .PSPIC -L gnu.eps 2i 2i
42 . nop \v'-0.66i'\h'2.0i'\s[100]\*[GNU] Troff\s0
44 . nop \v'-0.66i'\h'2.0i'\s[60]\*[GNU] Troff\s0
50 .URL http://\:groff.ffii.org/ Groff )
52 .URL http://\:www.gnu.org/ GNU
60 groff (GNU Troff) software
61 is a typesetting package which reads plain text mixed with
62 formatting commands and produces formatted output.
63 Groff now supports HTML.
69 The source code of the currently released versions of groff is
71 .URL "http://\:groff.ffii.org/\:groff/" "FFII host (Germany)" ,
72 .URL "ftp://\:ftp.gnu.org/\:gnu/\:groff/" "GNU host (USA)" ,
75 The USA site also contains older, obsolete versions.
77 The most actual pre-release, development version is available from a
78 CVS repository, see below.
80 Development snapshots (produced twice a day from the CVS repository)
81 can be downloaded from
82 .URL "http://\:groff.ffii.org/\:groff/\:devel" here .
84 For a special version of groff on the Microsoft operating systems, see
85 .URL "http://\:gnuwin32.sf.net/\:packages/\:groffl.htm" "Groff for Windows" .
87 GNU troff is released under the
88 .URL http://\:www.gnu.org/\:copyleft/\:gpl.html "GNU Copyright License" .
91 .MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding" .
93 Technical issues lead:
94 .MTO wl@\:gnu.org "Werner Lemberg" .
100 This is the GNU groff document formatting system.
101 The version number is given in the file VERSION.
103 Included in this release are implementations of troff, pic, eqn, tbl,
104 grn, refer, \-man, \-mdoc, and \-ms macros, and drivers for PostScript,
105 TeX dvi format, HP LaserJet\~4 printers, Canon CAPSL printers, HTML format
106 (beta status), and typewriter-like devices.
107 Also included is a modified version of the Berkeley \-me macros, an enhanced
108 version of the X11 xditview previewer, and an implementation of the \-mm
109 macros contributed by
110 .MTO jh@\:axis.se "J\[:o]rgen H\[:a]gg" .
112 See the file INSTALL for installation instructions.
113 You will require a C++ compiler.
115 The file NEWS describes recent user-visible changes to groff.
117 Groff is free software.
118 See the file COPYING for copying permission.
120 The file PROBLEMS describes various problems that have been encountered in
121 compiling, installing, and running groff.
123 The most recent released version of groff is always available by
124 .URL "ftp://\:ftp.gnu.org/\:gnu/\:groff" "anonymous ftp" .
126 The current development version of groff is available from a
127 .URL "http://\:savannah.gnu.org/\:cvs/\:?group=groff" "CVS repository" .
128 You can access it by first selecting a parent directory in
129 which to create a working copy (call it, say, ~/cvswork), and then
130 executing the commands
136 CVS_RSH=ssh; export CVS_RSH
137 cvs -d:ext:anoncvs@savannah.gnu.org/cvsroot/groff -z5 co groff
142 (Note that you need an SSH client for security reasons.)
144 This will create a subdirectory, ~/cvswork/groff, with a `checked out'
145 copy of the CVS repository.
146 An update of this working copy may be
147 achieved, at any later time by invoking the commands
153 CVS_RSH=ssh cvs -z5 update -dP
158 Please read the CVS info pages for further details.
160 Finally, it is possible to access the CVS with a
161 .URL http://\:savannah.gnu.org/\:cvs/\:?group=groff "web browser" .
163 Alternatively, you can download snapshots (which are updated twice a day).
164 The complete groff source as a single file is available
165 .URL http://\:groff.ffii.org/\:groff/\:devel/\:groff-current.tar.gz here .
167 A diff file relative to groff-\[la]version\[ra], the latest official groff
168 release is available at
172 http://groff.ffii.org/groff/devel/groff-\[la]version\[ra]-current.diff.gz
176 Assuming that groff-\[la]version\[ra].tar.gz and
177 groff-\[la]version\[ra]-current.diff.gz are in the same directory, do the
178 following to apply the diff file:
183 tar xzvf groff-\[la]version\[ra].tar.gz
184 cd groff-\[la]version\[ra]
185 gunzip -c ../groff-\[la]version\[ra]-current.diff.gz | patch -p1
190 Depending on your requirements, you may need at least some of the
191 following tools to build groff directly from its source:
199 bison \[>=] 1.875b or byacc
203 Note that texinfo and bison or byacc are required only for building from
204 CVS sources (either a checked out working copy, or a daily snapshot).
205 They are not required for building from a stable release tarball.
206 Also note that the version numbers stated are the minimum supported.
207 No version of texinfo < 4.8 will work, and the original release of bison
208 1.875 is known not to work; you \fImay\fP find that bison releases < 1.875
209 will work, but in case of difficulty, please update to a later version
210 \fIbefore\fP posting a bug report.
212 For \fIall\fP sources, you need ghostscript for creation of either PDF or
213 HTML output; the netpbm and psutils packages are required only for HTML
215 If you don't intend to produce output in either of these formats, then
216 these packages are unnecessary.
218 Please report bugs using the form in the file BUG-REPORT; the idea of this
219 is to make sure that FSF has all the information it needs to fix the bug.
220 At the very least, read the BUG-REPORT form and make sure that you supply
221 all the information that it asks for.
222 Even if you are not sure that something is a bug, report it using
223 BUG-REPORT: this will enable us to determine whether it really is a bug or
226 Three mailing lists are available:
230 .MTO bug-groff@gnu.org bug-groff@gnu.org
234 .MTO groff@gnu.org groff@gnu.org
235 for general discussion of groff
238 .MTO groff-commit@gnu.org groff-commit@gnu.org
239 a read-only list showing commitments to the CVS repository
242 You can post mails directly to the `bug-groff' list, without subscribing;
243 to post mails to the `groff' list you must subscribe to it.
245 To subscribe, send e-mail to \[la]list\[ra]-request@\[la]domain\[ra]
247 .MTO groff-request@\:gnu.org groff-request@\:gnu.org
248 for the `groff' list) with the word `subscribe' in either the
249 subject or body of the e-mail (don't include the quotes).
250 Alternatively, you may subscribe by visiting the web pages at
254 .URL http://lists.gnu.org/mailman/listinfo/bug-groff
255 .URL http://lists.gnu.org/mailman/listinfo/groff
256 .URL http://lists.gnu.org/mailman/listinfo/groff-commit
260 Each of these web pages also provides a link to a browseable archive of
261 postings to the corresponding mailing list.
263 GNU groff was written by
264 .MTO jjc@\:jclark.com "James Clark" .
265 It is now maintained by
266 .MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding"
268 .MTO wl@\:gnu.org "Werner Lemberg" .
278 Analogously to the .ft and \ef pair, two new requests `gcolor' and
279 `fcolor' (which pair with \em and \eM, respectively) have been added to
280 set the glyph and background colours.
283 A new read-only, string-valued register `.sty' returns the name of the
287 Two new conditional operators `F\~\[la]name\[ra]' and `S\~\[la]name\[ra]'
289 `F' is true if a font \[la]name\[ra] exists.
290 `S' is true if a style \[la]name\[ra] has been registered.
293 Cyrillic characters have been added to the `utf8' and `html' output
303 The `by' argument in a `for' loop can now be negative if it is additive.
304 For the multiplicative case, it must be greater than zero.
313 The following keywords aren't new but haven't been documented previously:
316 \fBundef NAME\fP (to undefine a macro)
318 \fBcopy "FILE"\fP (a synonym for `include')
320 \fBspace n\fP (to modify the vertical spacing before and after an equation)
324 The following macros aren't new but haven't been documented previously:
327 \fBAlpha, .\|.\|., Omega\fP (the same as `ALPHA', .\|.\|., `OMEGA')
329 \fBldots\fP (three dots on the base line)
331 \fBdollar\fP (a dollar glyph)
335 The following keywords have been extended. Again, this isn't new but
336 hasn't been documented previously:
356 (set vertical spacing between rows to\~N)
365 This device driver has been raised to beta stage; its set of tags should
369 New command line option `\-s' to set the base point size.
372 New command line option `\-S' to set the split level while generating
382 Experimental support for zero-width and double-width characters.
391 On platforms which have the X\~Window System this program is now built and
392 installed automatically.
401 This program to create font definition files for xditview isn't new but
402 hasn't been installed previously.
411 A security problem (reported as CAN-2004-0969) has been fixed.
420 A new script contributed by Mike Bianchi.
421 It compares two groff, nroff, or troff documents and creates an output with
422 added margin characters (using `.mc') to indicate the differences.
431 A new wrapper script contributed by Keith Marshall to easily create PDF
432 documents with groff.
445 Support for fractional point sizes: A value for the `PS', `VS', `FPS',
446 and `VPS' register larger than or equal to 1000 is always divided by 1000.
447 For example, `.nr\~PS\~10250' sets the document's font size to 10.25 points.
450 The `Ds' and `De' macros provided in ms since groff version 1.19 have
451 been removed; the equivalent `DS' and `DE' macros should be used instead.
452 X11 documents which actually use `Ds' and `De' always load a
453 specific macro file from the X11 distribution (`macros.t') which
454 provides proper definitions for the two macros.
457 The following registers have been added for improving layout control:
460 Defines number of lines following `LP', `PP', `QP', `IP' or `XP' which
461 must be kept together, before any automatic page break.
464 Sets number of lines of following paragraph which must be kept with a
465 heading, defined by `NH' or `SH', before any automatic page break.
468 Sets the first level of heading (set with `NH') which will keep the
469 same point size as body text.
472 Sets the point size increment for each level of heading (set with
473 `NH'), below the threshold level set by `GROWPS'; e.g., if
474 \en[PS]\~=\~10, \en[GROWPS]\~=\~3 and \en[PSINCR]\~=\~2.0p, then `.NH\~1'
475 will produce 14pt headings, `.NH\~2' will produce 12pt, and all other levels
476 will remain at 10pt (because \en[PS]\~=\~10).
479 The `SH' macro now accepts a numeric argument, to make heading size
480 match that of `NH' with same argument value when the `GROWPS'/`PSINCR'
484 Please refer to the documentation of the ms package for other, minor
490 The section type set with the `++' request is available in the `_M'
492 This isn't new but hasn't been documented before.
497 The `HR' macro no longer causes an empty line for non-HTML devices.
499 A new macro `HEAD' has been added to directly add data to the
500 <head>...</head> block.
502 New macros `OLS' and `OLE' to start and end an ordered list.
504 New macros `DLS' and `DLE' to start and end a definition list.
513 A new macro package contributed by Keith Marshall which implements PDF
515 This is in alpha stage currently.
524 Two new keywords to the DESC file have been added which are needed for
525 grohtml: `image_generator' and `unscaled_charwidths'.
526 The former gives the name of the program which creates PNG images,
527 and the latter makes troff always use unscaled character widths.
539 The argument of the command line option `\-I' is now also passed to troff
540 and grops, specifying a directory to search for files on the command line,
541 files named in `so' and `psbb' requests, and files named in \eX'ps:\~file'
542 and \eX'ps:\~import' escapes.
545 If option `\-V' is used more than once, the commands will be both printed
546 on standard error and run.
555 Two new read-only, string-valued registers `.m' and `.M' return the
556 name of the current drawing and background color, respectively.
559 New read-only register `.U' which is set to\~1 if in safer mode and set
560 to\~0 if in unsafe mode.
563 An input encoding file for \%latin-5 (a.k.a.\& ISO \%8859-9) has been
569 groff \-Tdvi \-mlatin5 my_file > my_file.dvi
573 Note that some output devices don't support all glyphs of this encoding.
576 If the `return' request is called with an argument, it exits twice,
577 namely the current macro and the macro one level higher.
578 This is used to define a wrapper macro for `return' in trace.tmac.
581 For completeness, two new requests have been added: `dei1' and `ami1'.
582 They are equivalent to `dei' and `ami', respectively, but the macros
583 are executed with compatibility mode off (similar to `de1' and `am1').
586 New command line option `\-I' to specify a directory for files (both
587 those on the command line and those named in `psbb' requests).
588 This is also handled by the groff wrapper program.
591 Since version 1.19 you can say `.vs\~0'.
592 Older versions emit a warning and convert this to `.vs\~\en[.V]'.
594 This hasn't been documented properly.
595 Note that `.vs\~0' isn't saved in a diversion since it doesn't result
605 Dashed and dotted ellipses have been implemented.
614 New key character `x' to make tbl call a user-defined macro on a table
617 .MTO hj.oertel@\:surfeu.de "Heinz-J\[:u]rgen Oertel" .
626 A new script contributed by
627 .MTO esr@\:thyrsus.com "Eric S. Raymond" .
628 It converts a grap diagram into a cropped image.
629 Since it uses gs and the PNM library, virtually all graphics formats
630 are available for output.
631 [Note that the grap program itself isn't part of the groff package;
632 see the file MORE.STUFF how to obtain grap.]
641 New option `\-j' to emit output splitted into multiple files.
650 New command line option `\-I' to specify a directory to search for files
651 on the command line and files named in \eX'ps:\~import' and \eX'ps:\~file'
653 This is also handled by the groff wrapper program.
656 The default value for the `broken' keyword in the DESC file is now\~0.
665 A new man page `lj4_font(5)' documents how fonts are accessed with
669 The built-in fonts for LJ4 and newer PCL\~5 devices have been completely
670 revised, mainly to access as much glyphs as possible.
671 The provided metric files should be compatible with recent PCL\~5 printers
673 Additionally, font description files have been added for the Arial and
674 Times New Roman family, the MS symbol, and Wingdings fonts.
683 New option `\-x' to prevent use of built-in Adobe Glyph List.
692 Completely revised to handle HP TrueType metric files also.
693 See the hpftodit manual page for more details.
702 This version is a rewrite of groffer in many parts, but it is kept in
703 the old single script style.
707 New options: \-\-text (\-\-mode\~text), \-\-tty-viewer, \-\-X (\-\-mode\~X),
708 \-\-X-viewer, \-\-html (\-\-mode\~html), \-\-html-view, \-\-apropos-data,
709 \-\-apropos-devel, \-\-apropos-progs.
712 New documentation file README_SH.
715 Enhancement of the configuration files and the `apropos' handling.
725 www.tmac: New macro `JOBNAME' to split output into multiple files.
728 In mdoc, multiple calls to `.Lb' are now supported in the LIBRARY
741 Input encoding files for \%latin-9 (a.k.a.\& \%latin-0 and ISO \%8859-15)
742 and \%latin-2 (ISO \%8859-2) have been added.
747 groff -Tdvi -mlatin9 my_file > my_file.dvi
751 You still need proper fonts with the necessary glyphs.
752 Out of the box, the groff package supports \%latin-9 only for \-Tps,
753 \-Tdvi, and \-Tutf8, and \%latin-2 only for \-Tdvi and \-Tutf8.
756 Composite glyphs are now supported.
757 To do this, a subset of the Adobe Glyph List (AGL) Algorithm as described in
758 .URL http://partners.adobe.com/asn/tech/type/unicodegn.jsp \
759 http://partners.adobe.com/asn/tech/type/unicodegn.jsp
760 is used to construct glyph names based on Unicode character codes.
761 The existing groff glyph names are frozen; no glyph names which can't be
762 constructed algorithmically will be added in the future.
764 The \e[...] escape sequence has been extended to specify multiple glyph
774 this accesses a glyph with the name `u0041_0328'.
776 Some groff glyphs which are useful as composites map to `wrong' Unicode
778 For example, `ho' maps to U+02DB which is a spacing ogonek, whereas a
779 non-spacing ogonek U+0328 is needed for composite glyphs.
788 will change the mapping while a composite glyph name is constructed.
789 To make \e[A\~ho] yield the expected result,
793 \&.composite ho u0328
798 [The new file `composite.tmac' loaded at start-up already
799 contains proper calls to `.composite'.]
801 Please refer to the info pages of groff and to the groff_char man page
805 A new request `fschar' has been added to define font-specific fallback
807 They are searched after the list of fonts declared with the
808 `fspecial' request but before the list of fonts declared with `special'.
811 Fallback characters defined with `fschar' can be removed with the
812 new `rfschar' request.
815 A new request `schar' has been added to define global fallback
817 They are searched after the list of fonts declared with the
818 `special' request but before the already mounted special fonts.
821 In groff versions 1.18 and 1.18.1, \eD'f\~...'\& didn't move the current
823 Despite of being silly, this change has been reverted for backwards
825 Consequently, the intermediate output command `Df' also moves the
826 position horizontally again.
828 \eD'f\~...'\& is deprecated since it depends on the horizontal resolution
829 of the output device (given with the `hor' parameter in the DESC file).
830 Use the new \eD'Fg\~...'\& escape instead.
833 For orthogonality, new \eD subcommands to change the fill color are
838 \eD'Fr ...' \f[R](rgb)\f[]
840 \eD'Fc ...' \f[R](cmy)\f[]
842 \eD'Fg ...' \f[R](gray)\f[]
844 \eD'Fk ...' \f[R](cmyk)\f[]
846 \eD'Fd' \f[R](default color)\f[]
850 The arguments are the same as with the `defcolor' request.
851 The current position is \f[I]not\f[] changed.
854 The values set with \eH and \eS are now available in number registers
855 \en[.height] and \en[.slant], respectively.
858 The `.pe' number register isn't new but hasn't been documented before.
859 It is set to\~1 during a page ejection caused by the `bp' request.
862 The new glyph symbol `tno' is a textual variant of `no'.
865 The new glyph symbol `+e' represents U+03F5, GREEK LUNATE EPSILON SYMBOL.
866 (Well, it is not really new since it has been previously supported by
868 The mapping for both the dvi and lj4 symbol font has been
869 changed accordingly so that Greek small letter epsilon, `*e', has the
870 same glyph shape as with other devices.
879 The font `freeeuro.pfa' has been added to provide various default glyph
880 shapes for `eu' and `Eu'.
883 It is now possible to access all glyphs in a Type\~1 font, not only 256
884 (provided the font file created by afmtodit has proper entries).
885 grops constructs additional encoding vectors on the fly if necessary.
888 The paper size is now emitted via the %%DocumentMedia and PageSize
889 mechanisms so that it is no longer required to tell `gv' or `ps2pdf'
890 about the paper size.
891 The `broken' flag value\~16 omits this feature
892 (the used PostScript command `setpagedevice' is a LanguageLevel\~2
895 .MTO egil@\:kvaleberg.no "Egil Kvaleberg" .
898 Non-slanted PostScript metrics have been changed again; they no longer
899 contain negative left italic correction values.
900 This assures correct spacing with eqn.
909 The font cmtex10 has been added as the special font `SC' to the DVI fonts.
910 It is used as a font-specific special font for CW and CWI.
913 New options \-l and \-p to set landscape orientation and the paper size.
914 grodvi now emits a `papersize' special which is understood by DVI drivers
917 Consequently, the DESC file should contain a `papersize' keyword.
920 The glyph shapes for \e[*f] and \e[*e] have been exchanged with \e[+f] and
921 \e[+e], respectively, to be in sync with all other devices.
924 Glyphs \e[HE] and \e[DI] have been replaced with \e[u2662] and \e[u2661],
925 respectively, since the former two glyphs have a black (filled) shape
926 which grodvi doesn't provide by default (it never has actually).
935 The glyphs \e[*e] and \e[+e] have been exchanged to be in sync with
939 The glyph \e[~=] is now called \e[|=]. Similar to other devices, \e[~=]
940 is now another name for glyph \e[~~].
950 It is similar to the \-i option except it tells grotty to
951 use the `reverse video' attribute to render italic fonts.
960 New command `figname' to set the name of a picture's output box in TeX
970 The environment variable `REFER' to override the name of the default
971 database isn't new but hasn't been documented before.
980 New option `\-r' to avoid emission of `.lf' lines.
983 New option `\-t' to emit TeX comment lines (giving current file and the
984 line number) instead of `.lf' lines.
993 Unencoded glyphs in an AFM file are output also (since grops can now emit
994 multiple encoding vectors for a single font).
997 New option `\-m' to prevent negative left italic correction values.
1000 The mapping and encoding file together with file `DESC' are now searched
1001 in the default font directory also.
1002 Please refer to the man page of afmtodit for more details.
1011 .MTO kollar@\:alltel.net "Larry Kollar"
1012 and others made the man macros more customizable.
1016 New command line options \-rFT, \-rIN, and \-rSN to set the vertical
1017 location of the footer line, the body text indentation, and the
1018 sub-subheading indentation.
1021 New command line option \-rHY (similar to the ms macros) to control
1025 New macros `.PT' and `.BT' to print the header and footer strings.
1026 They can be replaced with a customized version in `man.local'.
1029 The string `HF' now holds the typeface to print headings and
1033 Similar to the ms macros, the LT register now defaults to LL if not
1034 explicitly specified on the command line.
1038 troff's start-up file `troffrc' now includes `papersize.tmac' to set
1039 the paper size with the command line option `-dpaper=<size>'.
1041 Possible values for `<size>' are the same as the predefined `papersize'
1042 values in the DESC file (only lowercase; see the groff_font man page)
1044 An appended `l' (ell) character denotes landscape orientation.
1045 Examples: `a4', `c3l', `letterl'.
1047 Most output drivers need additional command line switches `\-p' and
1048 `\-l' to override the default paper length and orientation as set in
1049 the driver specific DESC file.
1051 For example, use the following for PS output on A4 paper in landscape
1056 groff -Tps -dpaper=a4l -P-pa4 -P-l -ms foo.ms > foo.ps
1070 The non-slanted PostScript font definition files have been regenerated to
1071 include left and right italic correction values.
1072 Applying those to a glyph (this is, prepending the glyph with `\e,' and
1073 appending `\e/' to the glyph) sets the glyph width to the real value given
1074 by the horizontal bounding box values.
1075 Without those escapes, the advance width for the particular glyph is used
1076 (which can differ considerably).
1078 Most users will neither need this feature nor notice a difference in
1079 existing documents (provided \e, and \e/ is used as advertised, namely for
1080 italic fonts only); its main goal is to improve image generation with
1083 This is an experimental change, and feedback is welcome.
1091 Added global option `nospaces' to ignore leading and trailing spaces in data
1100 The option \-w (\-\-linewidth) has been added (similar to other device
1101 drivers) to set the default line width.
1109 Support for b-spline and Bezier curves has been added.
1117 New option \-\-shell to select the shell under wich groffer shall run.
1125 The string `Am' (producing an ampersand) has been added to mdoc for
1126 compatibility with NetBSD.
1129 `.IX' is now deprecated for mom; you should use `.IQ' (Indent Quit)
1133 In mom, new inlines `FWD', `BCK', `UP', and `DOWN' deal with horizontal
1134 and vertical movements; please refer to contrib/mom/NEWS for more
1138 New macro ENDNOTES_HDRFTR_CENTER for mom to better control headers.
1146 The `papersize' keyword in the DESC file now accepts multiple arguments.
1147 It is scanned from left to the right, and the first valid argument is used.
1148 This makes it possible to provide a fallback paper size.
1154 papersize /etc/papersize a4
1159 A local font directory has been prepended to the default font path; it
1160 defaults to /usr/local/share/groff/site-font. Similar to the normal
1161 font searching process, files must be placed into a dev\f[I]XXX\f[]
1166 /usr/local/share/groff/site-font/devps/FOO
1170 for a PostScript font definition file FOO.
1177 This section describes recent user-visible changes in groff.
1178 Bug fixes are not described.
1179 There are more details in the man pages.
1183 Please read the changes below regarding
1185 . URL #grotty grotty ,
1188 groff's tty frontend.\
1198 Color support has been added to troff and pic (and to the device drivers
1199 grops, grodvi, grotty, and grohtml -- other preprocessors and drivers will
1201 A new function `defcolor' defines colors; the escape sequence `\em' sets the
1202 drawing color, the escape sequence `\eM' specifies the background color for
1203 closed objects created with \eD'.\|.\|.' commands.
1204 `\em[]' and `\eM[]' switch back to the previous color.
1205 `\em' and `\eM' correspond to the new troff output command sets starting
1207 The device-specific default color is called `default' and can't be
1210 Use the `color' request to toggle the usage of colors (default is on); the
1211 read-only register `.color' is\~0 if colors are not active, and non-zero
1214 The old `Df' output command is mapped onto `DFg'; all color output
1215 commands don't change the current font position (consequently, `Df'
1218 Outputting color can be disabled in troff and groff with the option\~\-c
1219 (it is always disabled in compatibility mode).
1220 See the section on grotty for the
1222 . URL #GROFF_NO_SGR GROFF_NO_SGR
1225 environment variable also.
1227 For defining color components as fractions between 0 and\~1, a new scaling
1228 indicator `f' has been defined: 1f\~=\~65536u.
1229 For testing whether a color is defined (with .if and .ie), a new
1230 conditional operator `m' is available.
1232 More details can be found in the groff_diff.7 manual page and in
1236 Similar to \em and \eM, \ef[] switches back to the previous font.
1237 \efP (and \ef[P]) is still valid for backwards compatibility.
1240 The new escape \eF is the same as `.fam'; \eF[] switches back to previous
1241 family -- \eF[P] selects family `P'.
1244 Two new glyph symbols are available: `eu' is the official Euro symbol;
1245 `Eu' is a font-specific glyph variant.
1248 The new glyph symbols `t+\-', `tdi', and `tmu' are textual variants of
1249 `+\-', `di', and `mu', respectively.
1252 Latin-1 character 181 (PS name `mu', Unicode name U+00B5 MICRO SIGN) has
1253 got the troff glyph name `mc'.
1256 \-Tutf8 is now available on EBCDIC hosts.
1259 Strings can take arguments, using this syntax: \e*[foo\~arg1\~arg2\~.\|.\|.].
1265 \&.ds xxx This is a \e\e$1 test.
1272 It is now possible to have whitespace between the first and second dot (or
1273 the name of the ending macro) to end a macro definition.
1283 \&. nop Hello, I'm `foo'.
1284 \&. nop I will now define `bar'.
1286 \&. nop Hello, I'm `bar'.
1294 `.fn' is a new string-valued register which returns the (internal) real
1295 font name; styles and families are properly concatenated.
1298 Three new read/write registers `seconds', `minutes', and `hours' contain
1299 the current time, set at start-up of troff.
1300 Use the `af' request to control their output format.
1303 The new request `fchar' can be used to provide fallback characters.
1304 It has the same syntax as the `char' request; the only difference is that
1305 a character defined with `.char' hides the glyph with the same name in the
1306 current font, whereas a character defined with `.fchar' is checked only if
1307 the particular glyph isn't found in the current font.
1308 This test happens before checking special fonts.
1311 In analogy to the `tmc' request, `.writec' is the same as `.write' but
1312 doesn't emit a final newline.
1315 The new request `itc' is a variant of `.it' for which a line interrupted
1316 with \ec counts as one input line.
1319 Two new requests `ds1' and `as1' which are similar to `ds' and `as' but
1320 with compatibility mode disabled during expansion of strings defined by
1324 The syntax of the `substring' request has been changed:
1325 The first character in a string now has index\~0, the last character
1327 Note that this is an incompatible change.
1330 To emit strings directly to the intermediate output, a new `output'
1331 request has been added; it is similar to `\e!' used at the top level.
1334 `.hpf' has been extended.
1335 It can now handle most TeX hyphenation pattern files without
1337 To do that, the commands \epatterns, \ehyphenation, and \eendinput are
1339 Please refer to groff_diff.7 for more information.
1342 `hpfcode' is a new request to provide an input encoding mapping for the
1346 The new request `hpfa' appends hyphenation patterns (`hpf' replaces
1347 already existing patterns).
1350 A new request `ami' (append macro indirect) has been added.
1351 The first and second parameter of `ami' are taken from string registers
1352 rather than directly; this very special request is needed to make
1353 `trace.tmac' independent from the escape character (which might even
1357 The new request `sizes' is similar to the `sizes' command in DESC files.
1358 It expects the same syntax; the data must be on a single line, and the
1359 final `0' can be omitted.
1362 `trin' (translate input) is a new request which is similar to `tr' with
1363 the exception that the `asciify' request will use the character code (if
1364 any) before the character translation.
1383 The result is `x\~a'. Using `tr', the result would be `x\~x'.
1386 The request `pvs' isn't new, but hasn't been documented before.
1387 It adds vertical space after a line has been output.
1388 This makes it an alternative to the `ls' request to produce
1389 double-spaced documents.
1390 The read-only register `.pvs' holds the current amount of the
1391 post-vertical line space.
1394 For compatibility with plan 9's troff, multiple `pi' requests are
1406 is now equivalent to
1415 A new escape sequence `\eO' is available to disable and enable glyph
1417 Please see groff_diff.man and groff.texinfo for more details.
1420 The escapes `\e%', `\e&', `\e)', and `\e:' no longer cause an error in \eX;
1421 they are ignored now.
1422 Additionally `\e\ ' and `\e~' are converted to single space characters.
1425 The default tab distance in nroff mode is now 0.8i to be compatible
1429 Using the latin-1 input character 0xAD (soft hyphen) for the `shc'
1430 request was a bad idea.
1431 Instead, it is now translated to `\e%', and the default hyphenation
1432 character is again \e[hy].
1433 Note that the glyph \e[shc] is not useful for typographic purposes;
1434 it only exists to have glyph names for all latin-1 characters.
1442 .MTO df191@\:ncf.ca "Peter Schaffter"
1443 has contributed a new major macro package called `mom', mainly for
1444 non-scientific writers, which takes care of many typographic issues.
1445 It comes with a complete reference (in HTML format) and some examples.
1446 `mom' has been designed to format documents for PostScript output only.
1449 Two macros `AT' (AT&T) and `UC' (Univ. of California) have been added to
1450 the man macros for compatibility with older BSD releases.
1453 Both the man and mdoc macro packages now use the LL and LT registers for
1454 setting the line and title length, respectively (similar to those
1455 registers in the ms macro package).
1456 If not set on the command line or in a macro file loaded before the macro
1457 package itself, they default to 78n in nroff mode and 6.5i in troff mode.
1460 The `\-xwidth' specifier in the mdoc macro package has been removed.
1461 Its functionality is now integrated directly into `\-width'.
1462 Similarly, `\-column' has been extended to has this functionality also.
1465 A new macro `Ex' has been added to the mdoc macro package to document an
1469 `troff.man' has been split. Differences to UNIX troff are now documented
1470 in the new man page `groff_diff.man'.
1473 The PSPIC macro has been extended to work with DVI output (`pspic.tmac' is
1474 now automatically loaded for \-Tdvi), using a dvips special to load the EPS
1478 The trace.tmac package now traces calls to `am' also.
1479 Additionally, it works in compatibility mode.
1482 `troff.1' has been split.
1483 Differences to UNIX troff are now documented in the new man page
1487 `groff_mwww.7' has been renamed to `groff_www.7'.
1488 The file mwww.tmac has been removed.
1491 `groff_ms.7' has been completely rewritten.
1492 It now contains a complete reference to the ms macros.
1495 `groff_trace.7' documents the trace macro package.
1500 Note that HTML support is still in alpha change, so it is rather likely
1501 that both macro names and macro syntax will change.
1502 Some of the macros mentioned below aren't really new but haven't been
1503 documented properly before.
1507 The following macros have been renamed:
1518 For consistency, the macros `URL', `FTL', and `MTO' now all have the
1519 address as the first parameter followed by the description.
1522 By default, grohtml generates links to all section headings at the top
1524 Use the new `LK' macro to specify a different place.
1527 For specifying the background color and a background image, use the
1528 new macros `BCL' and `BGIMG', respectively.
1531 The macro `NHR' has been added; it suppresses the generation of top and
1532 bottom rules which grohtml emits by default.
1535 The new macro `HX' determines the cut-off point for automatic link
1536 generation to headings.
1539 The image position parameter names in `IMG' have been changed to `\-L',
1543 New macro `PIMG' for inclusion of a PNG image (it will automatically
1544 convert it into an EPS file if not \-Thtml is used).
1547 New macro `MPIMG' for putting a PNG image into the left or right margin
1548 (it will automatically convert it into an EPS file if not \-Thtml is used).
1551 New macros `HnS', `HnE' to start and end a header line block.
1554 New macro `DC' to produce dropcap characters.
1557 New macro `HTL' to generate an HTML title line only but no H1 heading.
1560 New macros `ULS' and `ULE' to start and end an unordered list.
1561 The new macro `LI' inserts a list item.
1571 The new command line `\-c' disables color output (which is always disabled
1572 in compatibility mode).
1581 Two new command line options `\-c' and `\-C'; the former passes `\-c' to
1582 grotty (switching to the old output scheme); the latter passes `\-C' to
1583 groff (enabling compatibility mode).
1592 New keywords `color' (or `colour', `colored', `coloured'), `outline' (or
1593 `outlined'), and `shaded' are available.
1594 `outline' sets the color of the outline, `shaded' the fill color, and
1600 circle shaded "green" outline "black" ;
1604 Filled arrows always use the outline color for filling.
1606 Color support for TeX output is not implemented yet.
1615 A new script contributed by
1616 .MTO esr@\:thyrsus.com "Eric S.\~Raymond" .
1617 It converts a PIC diagram into a cropped image.
1618 Since it uses gs and the PNM library, virtually all graphics formats
1619 are available for output.
1628 A new script contributed by
1629 .MTO esr@\:thyrsus.com "Eric S.\~Raymond" .
1630 It converts an EQN diagram into a cropped image.
1631 Since it uses gs and the PNM library, virtually all graphics formats
1632 are available for output.
1641 A new script contributed by
1642 .MTO bwarken@mayn.de "Bernd Warken" .
1643 It displays groff files and man pages on X and tty, taking care of most
1644 parameters automatically.
1653 Documents using the mom macro package are recognized.
1662 Color support has been added.
1665 A new option `\-p' is available to select the output paper size.
1666 It has the same syntax as the new `papersize' keyword in the DESC file.
1675 By default, font sizes are now available in the range 5\-10000pt, similar
1677 If you want the old behaviour (i.e., font sizes at discrete values only),
1678 insert the following at the start of your document:
1683 \&.if '\e*[.T]'dvi' \e
1684 \&. sizes 500 600 700 800 900 1000 1095 1200 1400 1440 1600 \e
1685 \& 1728 1800 2000 2074 2200 2400 2488 2800 3600
1691 A new font file HBI (using cmssbxo10; this is slanted sans serif bold
1692 extended) has been added.
1695 Two font families are now available: `T' and `H'.
1698 EC and TC fonts have been integrated.
1699 Use `\-mec' (calling the file ec.tmac) to switch to them.
1700 Those fonts give a much better coverage of the symbols defined by groff
1703 Note that ec.tmac must be called before any language-specific files; it
1704 doesn't take care of hcode values.
1707 Color support has been added.
1708 For drawing commands, colors are translated to gray values currently.
1718 Color support has been added, using the SGR (ISO\~6429, sometimes called
1719 ANSI color) escape sequences.
1722 SGR escape sequences are now used by default for underlining and bold
1723 printing also, no longer using the backspace character trick.
1724 To revert to the old behaviour, use the `\-c' switch.
1726 Note that you have to use the `\-R' option of `less' to make SGR escapes
1728 On the other hand, terminal programs and consoles like `xterm' which
1729 support SGR sequences natively can directly display the output of grotty.
1730 Consequently, the options `\-b', `\-B', `\-u', and `\-U' work only in
1731 combination with `\-c' and are ignored silently otherwise.
1733 For the `man' program, it may be necessary to add the `\-R' option of
1734 `less' to the $PAGER environment variable; alternatively, you can use
1735 `man's `\-P' option (or adapt its configuration file accordingly).
1736 See man(1) for more details.
1740 If the environment variable GROFF_NO_SGR is set, SGR output is disabled,
1741 reverting to the old behaviour.
1744 A new special \eX'tty:\~sgr\~n' has been added; if n is non-zero or missing,
1745 enable SGR output (the default).
1748 If the new option `\-i' is used (only in SGR mode), grotty sends escape
1749 sequences to set the italic font attribute instead of the underline
1750 attribute for italic fonts.
1751 Note that many terminals don't have support for this (including xterm).
1760 Color support for glyphs has been added.
1763 New option `\-h' to select the style of headings in HTML output.
1766 New option `\-b' to set the background colour to white.
1769 New options `\-a' and `\-g' to control the number of bits for anti-aliasing
1770 used for text and graphics, respectively.
1771 Default value is\~4; 0\~means no anti-aliasing.
1774 groff character/glyph entities now map onto HTML\~4 character entities.
1783 Valid paper sizes are now specified as with the new `papersize' keyword
1785 Specifically, the old custom paper type format `custAAAxBBB' is no longer
1795 A new manual page `ditroff.7' is available.
1798 The groff texinfo manual will now be installed, together with a bunch
1802 A new keyword `papersize' has been added to the DESC file format.
1803 Its argument is either
1807 a predefined paper format (e.g. `A4' or `letter')
1810 a file name pointing to a file which must contain a paper size
1811 specification in its first line (e.g. `/etc/papersize')
1814 a custom paper size definition like `35c,4i'
1817 See groff_font(5) for more details.
1818 This keyword only affects the physical dimensions of the output medium;
1819 grops, grolj4, and grolbp use it currently.
1820 troff completely ignores it.
1825 \s[-2]\f[I]This document was produced using
1826 .URL http://groff.ffii.org/ groff-\n[.x].\n[.y].\n[.Y] .
1828 The image at the top has been contributed by Imogen Mulley (born 1991),
1829 based on a similar picture found on the
1830 .URL http://www.gnu.org "GNU server" .
projects / FreeBSD / releng / 10.0.git / blob