diff options
Diffstat (limited to 'contrib/groff/doc')
| -rw-r--r-- | contrib/groff/doc/Makefile.in | 136 | ||||
| -rw-r--r-- | contrib/groff/doc/Makefile.sub | 202 | ||||
| -rw-r--r-- | contrib/groff/doc/fdl.texi | 403 | ||||
| -rw-r--r-- | contrib/groff/doc/gnu.eps | 1018 | ||||
| -rw-r--r-- | contrib/groff/doc/gnu.png | bin | 0 -> 7260 bytes | |||
| -rw-r--r-- | contrib/groff/doc/gnu.xpm | 198 | ||||
| -rw-r--r-- | contrib/groff/doc/grnexmpl.me | 2 | ||||
| -rw-r--r-- | contrib/groff/doc/groff | 297 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-1 | 1386 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-10 | 208 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-11 | 1536 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-2 | 1683 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-3 | 1374 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-4 | 1316 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-5 | 1185 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-6 | 1415 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-7 | 1608 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-8 | 1268 | ||||
| -rw-r--r-- | contrib/groff/doc/groff-9 | 931 | ||||
| -rw-r--r-- | contrib/groff/doc/groff.texinfo | 9931 | ||||
| -rw-r--r-- | contrib/groff/doc/pic.ms | 1529 | ||||
| -rw-r--r-- | contrib/groff/doc/texinfo.tex | 1134 | ||||
| -rw-r--r-- | contrib/groff/doc/webpage.ms | 969 |
23 files changed, 25966 insertions, 3763 deletions
diff --git a/contrib/groff/doc/Makefile.in b/contrib/groff/doc/Makefile.in new file mode 100644 index 0000000..97f75f9 --- /dev/null +++ b/contrib/groff/doc/Makefile.in @@ -0,0 +1,136 @@ +# Copyright (C) 2002 Free Software Foundation, Inc. +# Written by Werner Lemberg <wl@gnu.org> +# +# This file is part of groff. +# +# groff is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation; either version 2, or (at your option) any later +# version. +# +# groff is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +# for more details. +# +# You should have received a copy of the GNU General Public License along +# with groff; see the file COPYING. If not, write to the Free Software +# Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + +# Use this file to produce documentation in various formats; e.g. you can +# say +# +# make groff.pdf +# +# to get the groff texinfo manual as a PDF file. +# +# Note that you have to compile the groff package first. + + +srcdir=@srcdir@ +top_srcdir=@top_srcdir@ +VPATH=@srcdir@ +top_builddir=@groff_top_builddir@ + + +# Since info files are distributed within the groff package, no +# autoconf test for the makeinfo binary is done. +MAKEINFO=makeinfo + +# Users who want to print out the groff manual are expected to have +# a working TeX installation. +TEXI2DVI=texi2dvi + +groff_bin_dirs=\ + $(top_builddir)/src/roff/groff \ + $(top_builddir)/src/roff/troff \ + $(top_builddir)/src/preproc/pic \ + $(top_builddir)/src/preproc/eqn \ + $(top_builddir)/src/preproc/tbl \ + $(top_builddir)/src/preproc/grn \ + $(top_builddir)/src/preproc/refer \ + $(top_builddir)/src/preproc/soelim \ + $(top_builddir)/src/preproc/html \ + $(top_builddir)/src/devices/grops \ + $(top_builddir)/src/devices/grodvi \ + $(top_builddir)/src/devices/grotty \ + $(top_builddir)/src/devices/grolj4 \ + $(top_builddir)/src/devices/grolbp \ + $(top_builddir)/src/devices/grohtml +groff_bin_path=`echo $(groff_bin_dirs) | sed -e 's| *|:|g'` + +version=`cat $(top_srcdir)/VERSION` +# No additional number if revision is zero. +revision=`sed -e 's/^0$$//' -e 's/^[1-9].*$$/.&/' $(top_srcdir)/REVISION` + +FFLAG=-F$(top_builddir)/font -F$(top_srcdir)/font +TFLAG=-M$(top_builddir)/tmac -M$(top_srcdir)/tmac + +TROFF=$(top_builddir)/src/roff/troff/troff $(TFLAG) $(FFLAG) -ww +GROFF=GROFF_COMMAND_PREFIX=''; \ + export GROFF_COMMAND_PREFIX; \ + GROFF_BIN_PATH=$(groff_bin_path); \ + export GROFF_BIN_PATH; \ + sed -e "s;@VERSION@;$(version)$(revision);" $< \ + | $(top_builddir)/src/roff/groff/groff $(TFLAG) $(FFLAG) -Upet -ww + +imagedir=img + +.SUFFIXES: .me .ms .ps .html .txt .texinfo .dvi .pdf + +# For simplicity, we always call grn and eqn. +.me.txt: + $(GROFF) -Tascii -ge -me >$@ +.me.ps: + $(GROFF) -Tps -ge -me >$@ + +.ms.html: + $(GROFF) -P-p -P-b -P-I`basename $< | sed -e 's|.ms$$||'` \ + -P-D$(imagedir) -Thtml -ms >$@ +.ms.txt: + $(GROFF) -Tascii -ms -mwww >$@ +.ms.ps: + $(GROFF) -Tps -ms -mwww >$@ + +.texinfo.dvi: + $(TEXI2DVI) -e $< +.texinfo.pdf: + $(TEXI2DVI) -e --pdf $< +.texinfo.html: + $(MAKEINFO) -I$(srcdir) --html --no-split $< + + +all: prepare_examples + +prepare_examples: grnexmpl.g + test -f grnexmpl.g || cp $(srcdir)/grnexmpl.g . + +groff: groff.texinfo + $(MAKEINFO) -I$(srcdir) $(srcdir)/groff.texinfo + +gnu.eps: gnu.xpm + xpmtoppm $(srcdir)/gnu.xpm | pnmdepth 15 | pnmtops -noturn >$@ +gnu.png: gnu.xpm + xpmtoppm $(srcdir)/gnu.xpm | pnmdepth 15 | pnmtopng >$@ + +webpage.html: webpage.ms gnu.png gnu.eps +webpage.ps: gnu.eps + +grnexmpl.ps: grnexmpl.me grnexmpl.g + + +clean: + -rm -f *.ps *.html *.txt *.png *.eps *.gif *.dit core + -rm -f *.aux *.dvi *.pdf *.log *.toc texput.log + -rm -f *.cp *.cps *.cv *.cn *.es *.ess *.fn *.fns *.ky *.kys \ + *.ma *.mas *.op *.ops *.pg *.pgs *.rq *.rqs *.st *.sts \ + *.tp *.tps *.tr *.vr *.vrs + -rm -rf img + +distclean: clean + +realclean: distclean + +extraclean: clean + -rm -f core *~ \#* junk temp grot diff --git a/contrib/groff/doc/Makefile.sub b/contrib/groff/doc/Makefile.sub new file mode 100644 index 0000000..c72293f --- /dev/null +++ b/contrib/groff/doc/Makefile.sub @@ -0,0 +1,202 @@ +# Copyright (C) 2002 Free Software Foundation, Inc. +# Written by Werner Lemberg <wl@gnu.org> +# +# This file is part of groff. +# +# groff is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation; either version 2, or (at your option) any later +# version. +# +# groff is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +# for more details. +# +# You should have received a copy of the GNU General Public License along +# with groff; see the file COPYING. If not, write to the Free Software +# Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + +# Since info files are distributed within the groff package, no +# autoconf test for the makeinfo binary is done. +MAKEINFO=makeinfo + +groff_bin_dirs=\ + $(top_builddir)/src/roff/groff \ + $(top_builddir)/src/roff/troff \ + $(top_builddir)/src/preproc/pic \ + $(top_builddir)/src/preproc/eqn \ + $(top_builddir)/src/preproc/tbl \ + $(top_builddir)/src/preproc/grn \ + $(top_builddir)/src/preproc/refer \ + $(top_builddir)/src/preproc/soelim \ + $(top_builddir)/src/preproc/html \ + $(top_builddir)/src/devices/grops \ + $(top_builddir)/src/devices/grohtml +groff_bin_path=`echo $(groff_bin_dirs) | sed -e 's| *|:|g'` + +FFLAG=-F$(top_builddir)/font -F$(top_srcdir)/font +TFLAG=-M$(top_builddir)/tmac -M$(top_srcdir)/tmac + +GROFF=\ + GROFF_COMMAND_PREFIX=''; \ + export GROFF_COMMAND_PREFIX; \ + GROFF_BIN_PATH=$(groff_bin_path); \ + export GROFF_BIN_PATH; \ + sed -e "s;@VERSION@;$(version)$(revision);" $< \ + | $(top_builddir)/src/roff/groff/groff $(TFLAG) $(FFLAG) -Upet -ww + +DOCFILES=\ + meref.me \ + meintro.me \ + pic.ms + +PROCESSEDDOCFILES=\ + meref.ps \ + meintro.ps \ + pic.ps + +HTMLDOCFILES=\ + pic.html + +HTMLDOCIMAGEFILES=\ + pic* + +EXAMPLEFILES=\ + webpage.ms \ + grnexmpl.g \ + grnexmpl.me + +PROCESSEDEXAMPLEFILES=\ + webpage.ps \ + grnexmpl.ps + +HTMLEXAMPLEFILES=\ + webpage.html + +HTMLEXAMPLEIMAGEFILES=\ + webpage* + +imagedir=img +htmldocimagedir=$(htmldocdir)/$(imagedir) +exampleimagedir=$(exampledir)/$(imagedir) + +CLEANADD=\ + $(PROCESSEDDOCFILES) \ + $(PROCESSEDEXAMPLEFILES) \ + $(HTMLEXAMPLEFILES) \ + $(HTMLDOCFILES) + +CLEANDIRADD=\ + $(imagedir) + +CLEANNOTSRCDIRADD=\ + grnexmpl.g \ + groff \ + groff-* \ + gnu.eps \ + gnu.png + +.SUFFIXES: .me .ms .ps .html + +# For simplicity, we always call grn and eqn. +.me.ps: + $(GROFF) -Tps -ge -me >$@ + +.ms.html: + $(GROFF) -P-p -P-b -P-I`basename $< | sed -e 's|.ms$$||'` \ + -P-D$(imagedir) -Thtml -ms >$@ +.ms.ps: + $(GROFF) -Tps -ms -mwww >$@ + + +all: groff $(PROCESSEDDOCFILES) prepare_examples \ + $(PROCESSEDEXAMPLEFILES) $(make_html) + +html: $(HTMLDOCFILES) $(HTMLEXAMPLEFILES) + +prepare_examples: grnexmpl.g + test -f grnexmpl.g || cp $(srcdir)/grnexmpl.g . + +groff: groff.texinfo + $(MAKEINFO) -I$(srcdir) $(srcdir)/groff.texinfo + +gnu.eps: gnu.xpm + xpmtoppm $(srcdir)/gnu.xpm | pnmdepth 15 | pnmtops -noturn -rle >$@ +gnu.png: gnu.xpm + xpmtoppm $(srcdir)/gnu.xpm | pnmdepth 15 | pnmtopng >$@ + +webpage.html: webpage.ms gnu.png +webpage.ps: gnu.eps + +grnexmpl.ps: grnexmpl.me grnexmpl.g + +distfiles: groff gnu.eps gnu.png + +install_data: groff $(DOCFILES) $(PROCESSEDDOCFILES) $(make_install_html) \ + $(EXAMPLEFILES) $(PROCESSEDEXAMPLEFILES) + -test -d $(infodir) || $(mkinstalldirs) $(infodir) +# Prefer info files in builddir over srcdir; we test for +# the existence of `groff'. + d=.; \ + test -f "groff" || d=$(srcdir); \ + for f in $$d/groff $$d/groff-*; do \ + rm -f $(infodir)/`basename $$f`; \ + $(INSTALL_DATA) $$f $(infodir)/`basename $$f`; \ + done + $(INSTALL_INFO) --info-dir=$(infodir) $(infodir)/groff + -test -d $(docdir) || $(mkinstalldirs) $(docdir) + for f in $(DOCFILES); do \ + rm -f $(docdir)/$$f; \ + $(INSTALL_DATA) $(srcdir)/$$f $(docdir)/$$f; \ + done + for f in $(PROCESSEDDOCFILES); do \ + rm -f $(docdir)/$$f; \ + $(INSTALL_DATA) $$f $(docdir)/$$f; \ + done + -test -d $(exampledir) || $(mkinstalldirs) $(exampledir) + for f in $(EXAMPLEFILES); do \ + rm -f $(exampledir)/$$f; \ + $(INSTALL_DATA) $(srcdir)/$$f $(exampledir)/$$f; \ + done + for f in $(PROCESSEDEXAMPLEFILES); do \ + rm -f $(exampledir)/$$f; \ + $(INSTALL_DATA) $$f $(exampledir)/$$f; \ + done + +install_html: $(HTMLDOCFILES) $(HTMLEXAMPLEFILES) + -test -d $(htmldocdir) || $(mkinstalldirs) $(htmldocdir) + for f in $(HTMLDOCFILES); do \ + rm -f $(htmldocdir)/$$f; \ + $(INSTALL_DATA) $$f $(htmldocdir)/$$f; \ + done + -test -d $(htmldocimagedir) || $(mkinstalldirs) $(htmldocimagedir) + rm -f $(htmldocimagedir)/$(HTMLDOCIMAGEFILES) + $(INSTALL_DATA) $(imagedir)/$(HTMLDOCIMAGEFILES) $(htmldocimagedir) + -test -d $(exampledir) || $(mkinstalldirs) $(exampledir) + for f in $(HTMLEXAMPLEFILES); do \ + rm -f $(exampledir)/$$f; \ + $(INSTALL_DATA) $$f $(exampledir)/$$f; \ + done + -test -d $(exampleimagedir) || $(mkinstalldirs) $(exampleimagedir) + rm -f $(exampleimagedir)/$(HTMLEXAMPLEIMAGEFILES) + $(INSTALL_DATA) $(imagedir)/$(HTMLEXAMPLEIMAGEFILES) $(exampleimagedir) + +uninstall_sub: + -for f in groff groff-*; do \ + rm -f $(infodir)/$$f; \ + done + $(INSTALL_INFO) --delete --info-dir=$(infodir) $(infodir)/groff + -for f in $(DOCFILES) $(PROCESSEDDOCFILES); do \ + rm -f $(docdir)/$$f; \ + done + -for f in $(HTMLDOCFILES); do \ + rm -f $(htmldocdir)/$$f; \ + done + -rm -f $(htmldocimagedir)/$(HTMLDOCIMAGEFILES) + -rmdir $(htmldocimagedir) + -for f in $(EXAMPLEFILES) $(PROCESSEDEXAMPLEFILES); do \ + rm -f $(exampledir)/$$f; \ + done + -rm -f $(exampleimagedir)/$(HTMLEXAMPLEIMAGEFILES) + -rmdir $(exampleimagedir) diff --git a/contrib/groff/doc/fdl.texi b/contrib/groff/doc/fdl.texi new file mode 100644 index 0000000..361f90f --- /dev/null +++ b/contrib/groff/doc/fdl.texi @@ -0,0 +1,403 @@ + +@node GNU Free Documentation License +@appendixsec GNU Free Documentation License + +@cindex FDL, GNU Free Documentation License +@center Version 1.1, March 2000 + +@display +Copyright @copyright{} 2000 Free Software Foundation, Inc. +59 Temple Place, Suite 330, Boston, MA 02111-1307, USA + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +@end display + +@enumerate 0 +@item +PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +written document @dfn{free} in the sense of freedom: to assure everyone +the effective freedom to copy and redistribute it, with or without +modifying it, either commercially or noncommercially. Secondarily, +this License preserves for the author and publisher a way to get +credit for their work, while not being considered responsible for +modifications made by others. + +This License is a kind of ``copyleft'', which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + +@item +APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work that contains a +notice placed by the copyright holder saying it can be distributed +under the terms of this License. The ``Document'', below, refers to any +such manual or work. Any member of the public is a licensee, and is +addressed as ``you''. + +A ``Modified Version'' of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A ``Secondary Section'' is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall subject +(or to related matters) and contains nothing that could fall directly +within that overall subject. (For example, if the Document is in part a +textbook of mathematics, a Secondary Section may not explain any +mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The ``Invariant Sections'' are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. + +The ``Cover Texts'' are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. + +A ``Transparent'' copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, whose contents can be viewed and edited directly and +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup has been designed to thwart or discourage +subsequent modification by readers is not Transparent. A copy that is +not ``Transparent'' is called ``Opaque''. + +Examples of suitable formats for Transparent copies include plain +@sc{ascii} without markup, Texinfo input format, La@TeX{} input format, +@acronym{SGML} or @acronym{XML} using a publicly available +@acronym{DTD}, and standard-conforming simple @acronym{HTML} designed +for human modification. Opaque formats include PostScript, +@acronym{PDF}, proprietary formats that can be read and edited only by +proprietary word processors, @acronym{SGML} or @acronym{XML} for which +the @acronym{DTD} and/or processing tools are not generally available, +and the machine-generated @acronym{HTML} produced by some word +processors for output purposes only. + +The ``Title Page'' means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, ``Title Page'' means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +@item +VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + +@item +COPYING IN QUANTITY + +If you publish printed copies of the Document numbering more than 100, +and the Document's license notice requires Cover Texts, you must enclose +the copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a publicly-accessible computer-network location containing a complete +Transparent copy of the Document, free of added material, which the +general network-using public has access to download anonymously at no +charge using public-standard network protocols. If you use the latter +option, you must take reasonably prudent steps, when you begin +distribution of Opaque copies in quantity, to ensure that this +Transparent copy will remain thus accessible at the stated location +until at least one year after the last time you distribute an Opaque +copy (directly or through your agents or retailers) of that edition to +the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + +@item +MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +@enumerate A +@item +Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +@item +List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has less than five). + +@item +State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +@item +Preserve all the copyright notices of the Document. + +@item +Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +@item +Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +@item +Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document's license notice. + +@item +Include an unaltered copy of this License. + +@item +Preserve the section entitled ``History'', and its title, and add to +it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section entitled ``History'' in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +@item +Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the ``History'' section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +@item +In any section entitled ``Acknowledgments'' or ``Dedications'', +preserve the section's title, and preserve in the section all the +substance and tone of each of the contributor acknowledgments +and/or dedications given therein. + +@item +Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +@item +Delete any section entitled ``Endorsements''. Such a section +may not be included in the Modified Version. + +@item +Do not retitle any existing section as ``Endorsements'' +or to conflict in title with any Invariant Section. +@end enumerate + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section entitled ``Endorsements'', provided it contains +nothing but endorsements of your Modified Version by various +parties---for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + +@item +COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections entitled ``History'' +in the various original documents, forming one section entitled +``History''; likewise combine any sections entitled ``Acknowledgments'', +and any sections entitled ``Dedications''. You must delete all sections +entitled ``Endorsements.'' + +@item +COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + +@item +AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, does not as a whole count as a Modified Version +of the Document, provided no compilation copyright is claimed for the +compilation. Such a compilation is called an ``aggregate'', and this +License does not apply to the other self-contained works thus compiled +with the Document, on account of their being thus compiled, if they +are not themselves derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one quarter +of the entire aggregate, the Document's Cover Texts may be placed on +covers that surround only the Document within the aggregate. +Otherwise they must appear on covers around the whole aggregate. + +@item +TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License provided that you also include the +original English version of this License. In case of a disagreement +between the translation and the original English version of this +License, the original English version will prevail. + +@item +TERMINATION + +You may not copy, modify, sublicense, or distribute the Document except +as expressly provided for under this License. Any other attempt to +copy, modify, sublicense or distribute the Document is void, and will +automatically terminate your rights under this License. However, +parties who have received copies, or rights, from you under this +License will not have their licenses terminated so long as such +parties remain in full compliance. + +@item +FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +@uref{http://www.gnu.org/copyleft/}. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. +@end enumerate + +@page +@appendixsubsec ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + +@smallexample +@group + Copyright (C) @var{year} @var{your name}. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.1 + or any later version published by the Free Software Foundation; + with the Invariant Sections being @var{list their titles}, with the + Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}. + A copy of the license is included in the section entitled ``GNU + Free Documentation License''. +@end group +@end smallexample + +If you have no Invariant Sections, write ``with no Invariant Sections'' +instead of saying which ones are invariant. If you have no +Front-Cover Texts, write ``no Front-Cover Texts'' instead of +``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + +@c Local Variables: +@c ispell-local-pdict: "ispell-dict" +@c End: + diff --git a/contrib/groff/doc/gnu.eps b/contrib/groff/doc/gnu.eps new file mode 100644 index 0000000..f09ba02 --- /dev/null +++ b/contrib/groff/doc/gnu.eps @@ -0,0 +1,1018 @@ +%!PS-Adobe-2.0 EPSF-2.0 +%%Creator: pnmtops +%%Title: noname.ps +%%Pages: 1 +%%BoundingBox: 203 311 408 481 +%%EndComments +/rlestr1 1 string def +/readrlestring { + /rlestr exch def + currentfile rlestr1 readhexstring pop + 0 get + dup 127 le { + currentfile rlestr 0 + 4 3 roll + 1 add getinterval + readhexstring pop + length + } { + 256 exch sub dup + currentfile rlestr1 readhexstring pop + 0 get + exch 0 exch 1 exch 1 sub { + rlestr exch 2 index put + } for + pop + } ifelse +} bind def +/readstring { + dup length 0 { + 3 copy exch + 1 index sub + getinterval + readrlestring + add + 2 copy le { exit } if + } loop + pop pop +} bind def +/rpicstr 107 string def +/gpicstr 107 string def +/bpicstr 107 string def +%%EndProlog +%%Page: 1 1 +gsave +203.76 311.04 translate +204.48 169.92 scale +213 177 4 +[ 213 0 0 -177 0 177 ] +{ rpicstr readstring } +{ gpicstr readstring } +{ bpicstr readstring } +true 3 +colorimage +96fffff096fffff096fffff096fffff096fffff096fffff0ebff04eddcaa +bddeb0fffff0ebff04eddcaabddeb0fffff0ebff04eddcaabddeb0fffff0 +edff0ad988777478864555678adfb4fffff0edff0ad98877747886455567 +8adfb4fffff0edff0ad988777478864555678adfb4fffff0efff0dfdbba9 +4afcb867b544777675447cb5fffff0efff0dfdbba94afcb867b544777675 +447cb5fffff0efff0dfdbba94afcb867b544777675447cb5fffff0f0ff10 +faab6985449d5d649543484465675558bdd2ff01ecdfe7fffff0f0ff10fa +ab6985449d5d649543484465675558bdd2ff01ecdfe7fffff0f0ff10faab +6985449d5d649543484465675558bdd2ff01ecdfe7fffff0f1ff12fb9de8 +9476454897d54a44397443575554339fd6ff06d978778998889ce9fffff0 +f1ff12fb9de89476454897d54a44397443575554339fd6ff06d978778998 +889ce9fffff0f1ff12fb9de89476454897d54a44397443575554339fd6ff +06d978778998889ce9fffff0f2ff14fc9cfff834455554669b487434a544 +4755555346cfd9ff0afc869cfdcfa9fedaa988dfebfffff0f2ff14fc9cff +f834455554669b487434a5444755555346cfd9ff0afc869cfdcfa9fedaa9 +88dfebfffff0f2ff14fc9cfff834455554669b487434a5444755555346cf +d9ff0afc869cfdcfa9fedaa988dfebfffff0f2ff159bffd5ae8453455445 +4c74b4444744449445665549effcff00fee1ff0ce8977adb887476456444 +4aee99ebfffff0f2ff159bffd5ae84534554454c74b44447444494456655 +49effcff00fee1ff0ce8977adb8874764564444aee99ebfffff0f2ff159b +ffd5ae84534554454c74b4444744449445665549effcff00fee1ff0ce897 +7adb8874764564444aee99ebfffff0f4ff1dfee8defd9975ca4535454445 +c47844455444554456444558bfffffff76afe3ff0ee8448baa5665444444 +4535797efc8becfffff0f4ff1dfee8defd9975ca4535454445c478444554 +44554456444558bfffffff76afe3ff0ee8448baa56654444444535797efc +8becfffff0f4ff1dfee8defd9975ca4535454445c4784445544455445644 +4558bfffffff76afe3ff0ee8448baa56654444444535797efc8becfffff0 +f4ff1de7cef97cd76758a454545456754b4454545446455463855caaacdd +a7bdafecff01fdbefaff10fd77a86754454445444444896446effc9eedff +fff0f4ff1de7cef97cd76758a454545456754b4454545446455463855caa +acdda7bdafecff01fdbefaff10fd77a86754454445444444896446effc9e +edfffff0f4ff1de7cef97cd76758a454545456754b445454544645546385 +5caaacdda7bdafecff01fdbefaff10fd77a86754454445444444896446ef +fc9eedfffff0f5ff1efe8e758a849ec65488444467c86467945646444444 +54555757efca78bffaefecff19d675affffffffeed976666844443444343 +444455677898affbaeeefffff0f5ff1efe8e758a849ec65488444467c864 +6794564644444454555757efca78bffaefecff19d675affffffffeed9766 +66844443444343444455677898affbaeeefffff0f5ff1efe8e758a849ec6 +5488444467c8646794564644444454555757efca78bffaefecff19d675af +fffffffeed976666844443444343444455677898affbaeeefffff0f5ff1d +c79889555655afc64664457efd75b594485445455445494674eefddeefda +ebff039efb6466fc4412466558444334563454434555434459cfffe9efef +fffff0f5ff1dc79889555655afc64664457efd75b5944854454554454946 +74eefddeefdaebff039efb6466fc44124665584443345634544345554344 +59cfffe9efeffffff0f5ff1dc79889555655afc64664457efd75b5944854 +45455445494674eefddeefdaebff039efb6466fc44124665584443345634 +54434555434459cfffe9efeffffff0f6ff1ef9ac796686455447eea64589 +dffffffddc669557656856684494cecba66c8eebff1aa8fefecb985677b6 +5554844434345346433456457899998effffadeffffff0f6ff1ef9ac7966 +86455447eea64589dffffffddc669557656856684494cecba66c8eebff1a +a8fefecb985677b65554844434345346433456457899998effffadefffff +f0f6ff1ef9ac796686455447eea64589dffffffddc669557656856684494 +cecba66c8eebff1aa8fefecb985677b65554844434345346433456457899 +998effffadeffffff0f6ff1dc7ffeffb557555465bfe77ccfffecccbba56 +8c9dfe8aefbed8dbfeeffd99eaff1bf57deef85544545555565343334534 +53345434644454444579fffbdff0fffff0f6ff1dc7ffeffb557555465bfe +77ccfffecccbba568c9dfe8aefbed8dbfeeffd99eaff1bf57deef8554454 +555556534333453453345434644454444579fffbdff0fffff0f6ff1dc7ff +effb557555465bfe77ccfffecccbba568c9dfe8aefbed8dbfeeffd99eaff +1bf57deef8554454555556534333453453345434644454444579fffbdff0 +fffff0f7ff1efe9ffdedffe7445465959ffbefe967abbbcdcb97778999aa +acceefffeb89dfe9ff1094679d9964454555569a65664345334443fa4403 +4568ffbef0fffff0f7ff1efe9ffdedffe7445465959ffbefe967abbbcdcb +97778999aaacceefffeb89dfe9ff1094679d9964454555569a6566434533 +4443fa44034568ffbef0fffff0f7ff1efe9ffdedffe7445465959ffbefe9 +67abbbcdcb97778999aaacceefffeb89dfe9ff1094679d9964454555569a +65664345334443fa44034568ffbef0fffff0f7ff0ef9ffc5457bff944545 +bd78ffe97aeffaff07edddccbccccccedee7ff1bfe96434689d556686887 +75874765675444443333344455789cfffaeff1fffff0f7ff0ef9ffc5457b +ff944545bd78ffe97aeffaff07edddccbccccccedee7ff1bfe96434689d5 +5668688775874765675444443333344455789cfffaeff1fffff0f7ff0ef9 +ffc5457bff944545bd78ffe97aeffaff07edddccbccccccedee7ff1bfe96 +434689d55668688775874765675444443333344455789cfffaeff1fffff0 +f7ff0c9ddea6544469e856567efceb9dd5ff05fda754445bdefcff04c65d +fe5444fa33043446effebff1fffff0f7ff0c9ddea6544469e856567efceb +9dd5ff05fda754445bdefcff04c65dfe5444fa33043446effebff1fffff0 +f7ff0c9ddea6544469e856567efceb9dd5ff05fda754445bdefcff04c65d +fe5444fa33043446effebff1fffff0f8ff0cf8bc7559bb853459679aa9fe +9dcaff03fea68ed6fc3307344456765467dfaff1fffff0f8ff0cf8bc7559 +bb853459679aa9fe9dcaff03fea68ed6fc3307344456765467dfaff1ffff +f0f8ff0cf8bc7559bb853459679aa9fe9dcaff03fea68ed6fc3307344456 +765467dfaff1fffff0f9ff0dfd74469cb646bdb63459eeffd8efc8ff0dc7 +cd33334444588754334457dfccf1fffff0f9ff0dfd74469cb646bdb63459 +eeffd8efc8ff0dc7cd33334444588754334457dfccf1fffff0f9ff0dfd74 +469cb646bdb63459eeffd8efc8ff0dc7cd33334444588754334457dfccf1 +fffff0f9ff0cf89644445885457dc436cefb8ec6ff028ab445fc33053456 +76654debf1fffff0f9ff0cf89644445885457dc436cefb8ec6ff028ab445 +fc3305345676654debf1fffff0f9ff0cf89644445885457dc436cefb8ec6 +ff028ab445fc3305345676654debf1fffff0f9ff0bc8ffeb744445544489 +5befb9c5ff0cfb8c95433334444444577769faf1fffff0f9ff0bc8ffeb74 +44455444895befb9c5ff0cfb8c95433334444444577769faf1fffff0f9ff +0bc8ffeb7444455444895befb9c5ff0cfb8c95433334444444577769faf1 +fffff0faff0cfe7cbbcacdb6444455666ffb9fc4ff02b8fc43fc33044445 +5568caf1fffff0faff0cfe7cbbcacdb6444455666ffb9fc4ff02b8fc43fc +330444455568caf1fffff0faff0cfe7cbbcacdb6444455666ffb9fc4ff02 +b8fc43fc330444455568caf1fffff0faff0be7e555444569a7444558dfd8 +c3ff0cfa7fb53334433333457abbebeff2fffff0faff0be7e555444569a7 +444558dfd8c3ff0cfa7fb53334433333457abbebeff2fffff0faff0be7e5 +55444569a7444558dfd8c3ff0cfa7fb53334433333457abbebeff2fffff0 +faff0b9bfc9cea7544568855da8b8eecff05edbbaaaabcefdcff0b97e633 +333334578865569dcff2fffff0faff0b9bfc9cea7544568855da8b8eecff +05edbbaaaabcefdcff0b97e633333334578865569dcff2fffff0faff0b9b +fc9cea7544568855da8b8eecff05edbbaaaabcefdcff0b97e63333333457 +8865569dcff2fffff0fbff0cfe7ffffeefffd9445776eff7dfeeff09eb86 +7789998778778adff6ff02cbcdefebff0bfaa5333433433469dfffffbff2 +fffff0fbff0cfe7ffffeefffd9445776eff7dfeeff09eb86778999877877 +8adff6ff02cbcdefebff0bfaa5333433433469dfffffbff2fffff0fbff0c +fe7ffffeefffd9445776eff7dfeeff09eb867789998778778adff6ff02cb +cdefebff0bfaa5333433433469dfffffbff2fffff0fbff0bf9dfffcbaaab +ceeb556cffabeeff0be769cedbb9988aa9abba88cff9ff05fea8998889ad +ebff0a77344555455444467cffaff2fffff0fbff0bf9dfffcbaaabceeb55 +6cffabeeff0be769cedbb9988aa9abba88cff9ff05fea8998889adebff0a +77344555455444467cffaff2fffff0fbff0bf9dfffcbaaabceeb556cffab +eeff0be769cedbb9988aa9abba88cff9ff05fea8998889adebff0a773445 +55455444467cffaff2fffff0fbff0be8ff94443344446afb9efc8fefff0d +fc69a899abdefeecba8668aa78cffbff07fb9aba988abdfcbdecff0ac874 +55544433344458ffbff2fffff0fbff0be8ff94443344446afb9efc8fefff +0dfc69a899abdefeecba8668aa78cffbff07fb9aba988abdfcbdecff0ac8 +7455544433344458ffbff2fffff0fbff0be8ff94443344446afb9efc8fef +ff0dfc69a899abdefeecba8668aa78cffbff07fb9aba988abdfcbdecff0a +c87455544433344458ffbff2fffff0fbff0a9dc856789a987544dfffe7ef +ff03fd747adff9ff11ec877667dfffffffe978879bcedba98aecbfedff0a +f7da53333333344456efbff2fffff0fbff0a9dc856789a987544dfffe7ef +ff03fd747adff9ff11ec877667dfffffffe978879bcedba98aecbfedff0a +f7da53333333344456efbff2fffff0fbff0a9dc856789a987544dfffe7ef +ff03fd747adff9ff11ec877667dfffffffe978879bcedba98aecbfedff0a +f7da53333333344456efbff2fffff0fbff0a8f998887765567977bffadef +ff1ca58efffffffdcfefffceffffffeb8549ffffd9968ceffb5becfffc89 +efedff0af9c85333333443344679cef2fffff0fbff0a8f99888776556797 +7bffadefff1ca58efffffffdcfefffceffffffeb8549ffffd9968ceffb5b +ecfffc89efedff0af9c85333333443344679cef2fffff0fbff0a8f998887 +765567977bffadefff1ca58efffffffdcfefffceffffffeb8549ffffd996 +8ceffb5becfffc89efedff0af9c85333333443344679cef2fffff0fcff0b +faad444444568aa86576df9ff0ff1dfa8efffffeffff9c885de67cffec9b +fd848ddab98effffe754547ffffe89edff0afd9f645aa6434696445ecef2 +fffff0fcff0bfaad444444568aa86576df9ff0ff1dfa8efffffeffff9c88 +5de67cffec9bfd848ddab98effffe754547ffffe89edff0afd9f645aa643 +4696445ecef2fffff0fcff0bfaad444444568aa86576df9ff0ff1dfa8eff +fffeffff9c885de67cffec9bfd848ddab98effffe754547ffffe89edff0a +fd9f645aa6434696445ecef2fffff0fcff0bf666544565654458dec9bf9f +f0ff1e9bfffffff9c8d99aa9485967ee6766cf9c65be88befdca8d444734 +9aeffd8cedff097d443347984348684eddf2fffff0fcff0bf66654456565 +4458dec9bf9ff0ff1e9bfffffff9c8d99aa9485967ee6766cf9c65be88be +fdca8d4447349aeffd8cedff097d443347984348684eddf2fffff0fcff0b +f666544565654458dec9bf9ff0ff1e9bfffffff9c8d99aa9485967ee6766 +cf9c65be88befdca8d4447349aeffd8cedff097d443347984348684eddf2 +fffff0fcff0bb888aaa8877655554ceffdbff1ff20e8cfffffc9b9aaab69 +b74b69586865565ba6d786b7559c5d644945a3465da9ea8eeeff09786443 +3434685345bfbcf2fffff0fcff0bb888aaa8877655554ceffdbff1ff20e8 +cfffffc9b9aaab69b74b69586865565ba6d786b7559c5d644945a3465da9 +ea8eeeff097864433434685345bfbcf2fffff0fcff0bb888aaa887765555 +4ceffdbff1ff20e8cfffffc9b9aaab69b74b69586865565ba6d786b7559c +5d644945a3465da9ea8eeeff097864433434685345bfbcf2fffff0fcff0b +6efddb9865554445569ffaeff1ff218effffff887b8a8c57c66887475875 +4764655a869e644566d548a3943333335bd7dfefff099a44333344447944 +bfbaf2fffff0fcff0b6efddb9865554445569ffaeff1ff218effffff887b +8a8c57c668874758754764655a869e644566d548a3943333335bd7dfefff +099a44333344447944bfbaf2fffff0fcff0b6efddb9865554445569ffaef +f1ff218effffff887b8a8c57c668874758754764655a869e644566d548a3 +943333335bd7dfefff099a44333344447944bfbaf2fffff0fdff0bfe7ffc +544444555556666df8f1ff22f8cfbea86ea55d697e56d575a54645854655 +4355a64ba454439b34c454334333345a7befff099d544555433445b65dba +f2fffff0fdff0bfe7ffc544444555556666df8f1ff22f8cfbea86ea55d69 +7e56d575a546458546554355a64ba454439b34c454334333345a7befff09 +9d544555433445b65dbaf2fffff0fdff0bfe7ffc544444555556666df8f1 +ff22f8cfbea86ea55d697e56d575a546458546554355a64ba454439b34c4 +54334333345a7befff099d544555433445b65dbaf2fffff0fdff02fbae95 +fb44034547eee9f1ff239cdd9bc65bd55d677f56e574c454459645544345 +6855d555654d7386453344533334b99ff0ff09ab4444345543454885a9f2 +fffff0fdff02fbae95fb44034547eee9f1ff239cdd9bc65bd55d677f56e5 +74c4544596455443456855d555654d7386453344533334b99ff0ff09ab44 +44345543454885a9f2fffff0fdff02fbae95fb44034547eee9f1ff239cdd +9bc65bd55d677f56e574c4544596455443456855d555654d738645334453 +3334b99ff0ff09ab4444345543454885a9f2fffff0fdff0bf8d9444578b9 +bcba75356e9cf2ff24f9aff768f549e55a857f55d463b444459547645445 +5655ab584844a3784643637443335bb8f0ff09baa443444345544448e9f2 +fffff0fdff0bf8d9444578b9bcba75356e9cf2ff24f9aff768f549e55a85 +7f55d463b4444595476454455655ab584844a3784643637443335bb8f0ff +09baa443444345544448e9f2fffff0fdff0bf8d9444578b9bcba75356e9c +f2ff24f9aff768f549e55a857f55d463b4444595476454455655ab584844 +a3784643637443335bb8f0ff09baa443444345544448e9f2fffff0fdff0b +f7fb59bba8754444458def8ff2ff25bce9fa56f648f659956f55d4749444 +44a65784563455945b6594b4546c354363854333349b9ff1ff09aba43334 +5533344346e9f2fffff0fdff0bf7fb59bba8754444458def8ff2ff25bce9 +fa56f648f659956f55d474944444a65784563455945b6594b4546c354363 +854333349b9ff1ff09aba433345533344346e9f2fffff0fdff0bf7fb59bb +a8754444458def8ff2ff25bce9fa56f648f659956f55d474944444a65784 +563455945b6594b4546c354363854333349b9ff1ff09aba4333455333443 +46e9f2fffff0fdff0bf7ffb854346788787569ce9ff3ff26fe8ff77655f6 +45f756a46e55a474744544b566a4754554a446846479864a454353754343 +43499cf1ff098d7643333568634446daf2fffff0fdff0bf7ffb854346788 +787569ce9ff3ff26fe8ff77655f645f756a46e55a474744544b566a47545 +54a446846479864a45435375434343499cf1ff098d7643333568634446da +f2fffff0fdff0bf7ffb854346788787569ce9ff3ff26fe8ff77655f645f7 +56a46e55a474744544b566a4754554a446846479864a4543537543434349 +9cf1ff098d7643333568634446daf2fffff0fdff0bf8ff84589876555676 +6acd9ff3ff27e7ee99b445e754e945945f54c584654544b577c464545485 +66458a5d5c38644465454343434486eff2ff0a7f8ac7333334774446faef +f3fffff0fdff0bf8ff845898765556766acd9ff3ff27e7ee99b445e754e9 +45945f54c584654544b577c46454548566458a5d5c386444654543434344 +86eff2ff0a7f8ac7333334774446faeff3fffff0fdff0bf8ff8458987655 +56766acd9ff3ff27e7ee99b445e754e945945f54c584654544b577c46454 +548566458a5d5c38644465454343434486eff2ff0a7f8ac7333334774446 +faeff3fffff0fdff0bf8fe576544455666567ace9ff3ff278dbb6a9544d8 +54da45a46f64d584554644c576c4858554655788fe8b8447844546444453 +4344467df3ff0bfe8e5544333334557554cbdff3fffff0fdff0bf8fe5765 +44455666567ace9ff3ff278dbb6a9544d854da45a46f64d584554644c576 +c4858554655788fe8b84478445464444534344467df3ff0bfe8e55443333 +34557554cbdff3fffff0fdff0bf8fe576544455666567ace9ff3ff278dbb +6a9544d854da45a46f64d584554644c576c4858554655788fe8b84478445 +464444534344467df3ff0bfe8e5544333334557554cbdff3fffff0fdff0b +fafc57555666655654448d8ff4ff29f8cff6489735c854bc55c56e54d584 +454844c578d485a6755433a47cf96445b4454735446444344456dff4ff02 +faae57fc3304355854ebdff3fffff0fdff0bfafc57555666655654448d8f +f4ff29f8cff6489735c854bc55c56e54d584454844c578d485a6755433a4 +7cf96445b4454735446444344456dff4ff02faae57fc3304355854ebdff3 +fffff0fdff0bfafc57555666655654448d8ff4ff29f8cff6489735c854bc +55c56e54d584454844c578d485a6755433a47cf96445b445473544644434 +4456dff4ff02faae57fc3304355854ebdff3fffff0fdff0bfdf9a44578ad +b985445bff8ff4ff299afff6488a34c954ad54d66e44d494444655b679d4 +a5c59666c9c445bfb343b54555364465443444456ef4ff03f8efd543fc33 +0355a4cbeff3fffff0fdff0bfdf9a44578adb985445bff8ff4ff299afff6 +488a34c954ad54d66e44d494444655b679d4a5c59666c9c445bfb343b545 +55364465443444456ef4ff03f8efd543fc330355a4cbeff3fffff0fdff0b +fdf9a44578adb985445bff8ff4ff299afff6488a34c954ad54d66e44d494 +444655b679d4a5c59666c9c445bfb343b54555364465443444456ef4ff03 +f8efd543fc330355a4cbeff3fffff0fcff0af67bdfea6546988655cf8ff5 +ff2afaadff55487c34c9549d44c76c44b4a5445546975bc4a5d4a55dfdc3 +334543437735553444564434443446f4ff0bf7ffa43453333333347cebef +f3fffff0fcff0af67bdfea6546988655cf8ff5ff2afaadff55487c34c954 +9d44c76c44b4a5445546975bc4a5d4a55dfdc33345434377355534445644 +34443446f4ff0bf7ffa43453333333347cebeff3fffff0fcff0af67bdfea +6546988655cf8ff5ff2afaadff55487c34c9549d44c76c44b4a544554697 +5bc4a5d4a55dfdc3334543437735553444564434443446f4ff0bf7ffa434 +53333333347cebeff3fffff0fdff0bfcf9fb85456875543345cf8ff5ff2b +a8fb9d44486e34a7549c45d66a4594a4444446685ca47694844ae5e53465 +554368345434445545454433446ef5ff0bf7fd533346334333345dfbeff3 +fffff0fdff0bfcf9fb85456875543345cf8ff5ff2ba8fb9d44486e34a754 +9c45d66a4594a4444446685ca47694844ae5e53465554368345434445545 +454433446ef5ff0bf7fd533346334333345dfbeff3fffff0fdff0bfcf9fb +85456875543345cf8ff5ff2ba8fb9d44486e34a7549c45d66a4594a44444 +46685ca47694844ae5e53465554368345434445545454433446ef5ff0bf7 +fd533346334333345dfbeff3fffff0fdff0bfbfea558754444697657ff8f +f6ff2dfa9ffe5e44466f45a7558b45e5763694b44544574d6c9576556347 +e4db747ca544683444344554454454353446eff6ff0ad654343334643443 +3489fbf2fffff0fdff0bfbfea558754444697657ff8ff6ff2dfa9ffe5e44 +466f45a7558b45e5763694b44544574d6c9576556347e4db747ca5446834 +44344554454454353446eff6ff0ad6543433346434433489fbf2fffff0fd +ff0bfbfea558754444697657ff8ff6ff2dfa9ffe5e44466f45a7558b45e5 +763694b44544574d6c9576556347e4db747ca54468344434455445445435 +3446eff6ff0ad6543433346434433489fbf2fffff0fdff0bfaee88754445 +9b85448cfd9cf6ff2d9affff5b54565e5486547847d4644866844535457a +4959fe9a6544d5affb4486866834443444644544643744468ef6ff0a958b +433333364334347ffaf2fffff0fdff0bfaee887544459b85448cfd9cf6ff +2d9affff5b54565e5486547847d4644866844535457a4959fe9a6544d5af +fb4486866834443444644544643744468ef6ff0a958b433333364334347f +faf2fffff0fdff0bfaee887544459b85448cfd9cf6ff2d9affff5b54565e +5486547847d4644866844535457a4959fe9a6544d5affb44868668344434 +44644544643744468ef6ff0a958b433333364334347ffaf2fffff0fdff0b +fadc985459da534784578ad8f7ff2ff8bffbbf7844566f54855455488444 +464853543646696fedcdc84a46555effa543545b44444344744644554764 +5ad7acf7ff0a74d543333333543343affbf2fffff0fdff0bfadc985459da +534784578ad8f7ff2ff8bffbbf7844566f54855455488444464853543646 +696fedcdc84a46555effa543545b444443447446445547645ad7acf7ff0a +74d543333333543343affbf2fffff0fdff0bfadc985459da534784578ad8 +f7ff2ff8bffbbf7844566f54855455488444464853543646696fedcdc84a +46555effa543545b444443447446445547645ad7acf7ff0a74d543333333 +543343affbf2fffff0fdff0bfb9ba56ce9534775444598f7f8ff30fe7cff +fc5f9654556f655455445846a7577a556577bf777855547a7b683836acee +63455c5445444464574365448457ed9af8ff02fb8663fc33043433436ffa +f2fffff0fdff0bfb9ba56ce9534775444598f7f8ff30fe7cfffc5f965455 +6f655455445846a7577a556577bf777855547a7b683836acee63455c5445 +444464574365448457ed9af8ff02fb8663fc33043433436ffaf2fffff0fd +ff0bfb9ba56ce9534775444598f7f8ff30fe7cfffc5f9654556f65545544 +5846a7577a556577bf777855547a7b683836acee63455c54454444645743 +65448457ed9af8ff02fb8663fc33043433436ffaf2fffff0fdff0cfe8eda +e9444454465445bdeabff9ff31e7dffece5eb555466f555474afd99d84aa +a954578887445aedc4bf8a7a76633455335b7b8487446447a94464445444 +8ff99ff9ff0be7e834334334333343343afbf2fffff0fdff0cfe8edae944 +4454465445bdeabff9ff31e7dffece5eb555466f555474afd99d84aaa954 +578887445aedc4bf8a7a76633455335b7b8487446447a944644454448ff9 +9ff9ff0be7e834334334333343343afbf2fffff0fdff0cfe8edae9444454 +465445bdeabff9ff31e7dffece5eb555466f555474afd99d84aaa9545788 +87445aedc4bf8a7a76633455335b7b8487446447a944644454448ff99ff9 +ff0be7e834334334333343343afbf2fffff0fcff0b7eec56b64346544455 +66ce9ffaff32fe7dffff7c7ba5565566487884963466556778887666789b +effff65d9358c585455954ad8c73445534556644444334544cfe69f9ff0b +7bd44334333343333334dfbef2fffff0fcff0b7eec56b6434654445566ce +9ffaff32fe7dffff7c7ba5565566487884963466556778887666789befff +f65d9358c585455954ad8c73445534556644444334544cfe69f9ff0b7bd4 +4334333343333334dfbef2fffff0fcff0b7eec56b6434654445566ce9ffa +ff32fe7dffff7c7ba5565566487884963466556778887666789beffff65d +9358c585455954ad8c73445534556644444334544cfe69f9ff0b7bd44334 +333343333334dfbef2fffff0fcff0b7c94774445544454445bef8cfaff0e +e8dfffffa887b46644886ec7458aeff9ff1deefffffffe48ec5359484379 +58f9566ab87dbefecaa967675574578de69ffbff02f87b63f9330234ef9f +f2fffff0fcff0b7c94774445544454445bef8cfaff0ee8dfffffa887b466 +44886ec7458aeff9ff1deefffffffe48ec535948437958f9566ab87dbefe +caa967675574578de69ffbff02f87b63f9330234ef9ff2fffff0fcff0b7c +94774445544454445bef8cfaff0ee8dfffffa887b46644886ec7458aeff9 +ff1deefffffffe48ec535948437958f9566ab87dbefecaa967675574578d +e69ffbff02f87b63f9330234ef9ff2fffff0fcff0ca97bb6444444585446 +449ff8bffcff0dfe7effffaec7b6c46545bd7579cff2ff2ac57dc6335364 +543a58efffffb79ffffffffdcb86557455cf97cffddeffea556494333433 +333334334afdaff2fffff0fcff0ca97bb6444444585446449ff8bffcff0d +fe7effffaec7b6c46545bd7579cff2ff2ac57dc6335364543a58efffffb7 +9ffffffffdcb86557455cf97cffddeffea556494333433333334334afdaf +f2fffff0fcff0ca97bb6444444585446449ff8bffcff0dfe7effffaec7b6 +c46545bd7579cff2ff2ac57dc6335364543a58efffffb79ffffffffdcb86 +557455cf97cffddeffea556494333433333334334afdaff2fffff0fcff0c +c9ec64444448754475345fff89fcff0bc8efffea6bc6b484959866aef0ff +08fe745885443334549ffcff01b6effcff17fdb685554bfc654456b847e7 +e633433343333333436ff9eff2fffff0fcff0cc9ec64444448754475345f +ff89fcff0bc8efffea6bc6b484959866aef0ff08fe745885443334549ffc +ff01b6effcff17fdb685554bfc654456b847e7e633433343333333436ff9 +eff2fffff0fcff0cc9ec64444448754475345fff89fcff0bc8efffea6bc6 +b484959866aef0ff08fe745885443334549ffcff01b6effcff17fdb68555 +4bfc654456b847e7e633433343333333436ff9eff2fffff0fcff1be7a644 +654595644853464cfff88dffffd99fffffc969e59595746aeff7ff00eff8 +ff0dea454589333684dffffdeffffc6ffaff0ea555635cfec8668aeff764 +54233334fc33014bf9f1fffff0fcff1be7a644654595644853464cfff88d +ffffd99fffffc969e59595746aeff7ff00eff8ff0dea454589333684dfff +fdeffffc6ffaff0ea555635cfec8668aeff76454233334fc33014bf9f1ff +fff0fcff1be7a644654595644853464cfff88dffffd99fffffc969e59595 +746aeff7ff00eff8ff0dea454589333684dffffdeffffc6ffaff0ea55563 +5cfec8668aeff76454233334fc33014bf9f1fffff0fcff19f7d658546857 +4476447445efffb988889dffffff8957e564459ef8ff03fea9568ff8ff0d +feedb845339d75bfffc57fffffb7faff0cfee644338ebdfb99eac5333553 +fb33023467ccf1fffff0fcff19f7d6585468574476447445efffb988889d +ffffff8957e564459ef8ff03fea9568ff8ff0dfeedb845339d75bfffc57f +ffffb7faff0cfee644338ebdfb99eac5333553fb33023467ccf1fffff0fc +ff19f7d6585468574476447445efffb988889dffffff8957e564459ef8ff +03fea9568ff8ff0dfeedb845339d75bfffc57fffffb7faff0cfee644338e +bdfb99eac5333553fb33023467ccf1fffff0fcff0cfab7a5467465576447 +7544b9cffcff07fdecda5d56e437dff9ff05fecaaada35effaff10eeefff +eedeb436e7487ff9a87efffff9affaff13cd554334448543443333334333 +43333334447a9ff1fffff0fcff0cfab7a54674655764477544b9cffcff07 +fdecda5d56e437dff9ff05fecaaada35effaff10eeefffeedeb436e7487f +f9a87efffff9affaff13cd55433444854344333333433343333334447a9f +f1fffff0fcff0cfab7a54674655764477544b9cffcff07fdecda5d56e437 +dff9ff05fecaaada35effaff10eeefffeedeb436e7487ff9a87efffff9af +faff13cd55433444854344333333433343333334447a9ff1fffff0fcff0c +fc9e94664655764458473455cefcff06f99b875d75838ff8ff04c4466553 +39faff11fe7445effffef955b3346ec8646effffef6dfaff02db9443fc33 +0034f7330248fe9ff1fffff0fcff0cfc9e94664655764458473455cefcff +06f99b875d75838ff8ff04c446655339faff11fe7445effffef955b3346e +c8646effffef6dfaff02db9443fc330034f7330248fe9ff1fffff0fcff0c +fc9e94664655764458473455cefcff06f99b875d75838ff8ff04c4466553 +39faff11fe7445effffef955b3346ec8646effffef6dfaff02db9443fc33 +0034f7330248fe9ff1fffff0fbff157f9764556664457464345577fddfff +ffea4a475d8434f8ff05fa444343336ff9ff10d844aeffefffd553338f94 +33afffffcfb7faff03fbd54334fc330b4334433333343333443dfadff1ff +fff0fbff157f9764556664457464345577fddfffffea4a475d8434f8ff05 +fa444343336ff9ff10d844aeffefffd553338f9433afffffcfb7faff03fb +d54334fc330b4334433333343333443dfadff1fffff0fbff157f97645566 +64457464345577fddfffffea4a475d8434f8ff05fa444343336ff9ff10d8 +44aeffefffd553338f9433afffffcfb7faff03fbd54334fc330b43344333 +33343333443dfadff1fffff0fbff158deb457866437655733543459b67ff +ffa947584b8357f8ff05e433344336eff9ff10fea46cffeffc644358de64 +34dffffebff6faff02fe9944f533044233343ceaf0fffff0fbff158deb45 +7866437655733543459b67ffffa947584b8357f8ff05e433344336eff9ff +10fea46cffeffc644358de6434dffffebff6faff02fe9944f53304423334 +3ceaf0fffff0fbff158deb457866437655733543459b67ffffa947584b83 +57f8ff05e433344336eff9ff10fea46cffeffc644358de6434dffffebff6 +faff02fe9944f533044233343ceaf0fffff0fbff15bbfb66969445554843 +4634554865faedb645594a639ef8ff04934334338ffbff14d7558dfffaaa +cffffb4368adfe6338dfffffcff7effaff01c844fc33013434fc33054333 +33335e9ef0fffff0fbff15bbfb669694455548434634554865faedb64559 +4a639ef8ff04934334338ffbff14d7558dfffaaacffffb4368adfe6338df +ffffcff7effaff01c844fc33013434fc3305433333335e9ef0fffff0fbff +15bbfb669694455548434634554865faedb645594a639ef8ff0493433433 +8ffbff14d7558dfffaaacffffb4368adfe6338dfffffcff7effaff01c844 +fc33013434fc3305433333335e9ef0fffff0fbff14e9fb5d6b5446545544 +4534544685f77e7645674545f8ff04fd4335337cfbff15b5335646fffffc +8bbffea8aeffed733aabaadedff8effaff01f854fa330043fb330334447b +bff0fffff0fbff14e9fb5d6b54465455444534544685f77e7645674545f8 +ff04fd4335337cfbff15b5335646fffffc8bbffea8aeffed733aabaadedf +f8effaff01f854fa330043fb330334447bbff0fffff0fbff14e9fb5d6b54 +465455444534544685f77e7645674545f8ff04fd4335337cfbff15b53356 +46fffffc8bbffea8aeffed733aabaadedff8effaff01f854fa330043fb33 +0334447bbff0fffff0fbff14f8c5d896547544644444344555a5f75c6654 +664489f8ff04f6335438bffcff15f946aeff74efffffd58ffffefffffa94 +368dfc8ccff7f9ff01fb44f433024475a9effffff0fbff14f8c5d8965475 +44644444344555a5f75c6654664489f8ff04f6335438bffcff15f946aeff +74efffffd58ffffefffffa94368dfc8ccff7f9ff01fb44f433024475a9ef +fffff0fbff14f8c5d896547544644444344555a5f75c6654664489f8ff04 +f6335438bffcff15f946aeff74efffffd58ffffefffffa94368dfc8ccff7 +f9ff01fb44f433024475a9effffff0fbff14fa6de8756574564454544436 +54b6f56a6754543bdff8ff12b4367469bffffffffc65cfffff849fffffb6 +9ffcff07f883357cfeebffe6f9ff09fd654333333334443334fc330253ad +cceffffff0fbff14fa6de875657456445454443654b6f56a6754543bdff8 +ff12b4367469bffffffffc65cfffff849fffffb69ffcff07f883357cfeeb +ffe6f9ff09fd654333333334443334fc330253adcceffffff0fbff14fa6d +e875657456445454443654b6f56a6754543bdff8ff12b4367469bfffffff +fc65cfffff849fffffb69ffcff07f883357cfeebffe6f9ff09fd65433333 +3334443334fc330253adcceffffff0fbff13fe8ffa756856554464634445 +55a5e56a7845535ff8ff04fc537fdaf5fcff0aa38fffffffd44efffffaae +fcff07f98334bfffffffb7f9ff10fb64334333333344333433333343566e +9feffffff0fbff13fe8ffa75685655446463444555a5e56a7845535ff8ff +04fc537fdaf5fcff0aa38fffffffd44efffffaaefcff07f98334bfffffff +b7f9ff10fb64334333333344333433333343566e9feffffff0fbff13fe8f +fa75685655446463444555a5e56a7845535ff8ff04fc537fdaf5fcff0aa3 +8fffffffd44efffffaaefcff07f98334bfffffffb7f9ff10fb6433433333 +3344333433333343566e9feffffff0faff129ef759685457455443544555 +75b45a765443bff8ff04c57affffc6fcff0057fcff11f93dfffffc58efff +fffffa53339efeffff8bf8ff0f84334333333344333334333433bf78cfef +fffff0faff129ef75968545745544354455575b45a765443bff8ff04c57a +ffffc6fcff0057fcff11f93dfffffc58effffffffa53339efeffff8bf8ff +0f84334333333344333334333433bf78cfeffffff0faff129ef759685457 +45544354455575b45a765443bff8ff04c57affffc6fcff0057fcff11f93d +fffffc58effffffffa53339efeffff8bf8ff0f8433433333334433333433 +3433bf78cfeffffff0faff11cbfb57954568484444444555548559675434 +f8ff20fd9bafffff6afffffffc5dfffcb9876639fffffe54bffffffffc53 +3356779bff8df8ff0efc443533333344443333443646fe8aeefffff0faff +11cbfb57954568484444444555548559675434f8ff20fd9bafffff6affff +fffc5dfffcb9876639fffffe54bffffffffc533356779bff8df8ff0efc44 +3533333344443333443646fe8aeefffff0faff11cbfb5795456848444444 +4555548559675434f8ff20fd9bafffff6afffffffc5dfffcb9876639ffff +fe54bffffffffc533356779bff8df8ff0efc443533333344443333443646 +fe8aeefffff0faff11f8fea9945895584534444956457459664437f7ff19 +e8effffe4dfffffffa38fb5333433335cfffffc4bffffffffe93fc330159 +7bf7ff0d743534333334443343535559fe8feefffff0faff11f8fea99458 +95584534444956457459664437f7ff19e8effffe4dfffffffa38fb533343 +3335cfffffc4bffffffffe93fc3301597bf7ff0d74353433333444334353 +5559fe8feefffff0faff11f8fea9945895584534444956457459664437f7 +ff19e8effffe4dfffffffa38fb5333433335cfffffc4bffffffffe93fc33 +01597bf7ff0d743534333334443343535559fe8feefffff0faff11fbafff +8678c4644434445c5645544b66644bf7ff14eefffffa6ffffffffd345333 +34333894bffffff6bffcff06d4354456875449f7ff0dc434333333344445 +43537cbfd8efeefffff0faff11fbafff8678c4644434445c5645544b6664 +4bf7ff14eefffffa6ffffffffd34533334333894bffffff6bffcff06d435 +4456875449f7ff0dc43433333334444543537cbfd8efeefffff0faff11fb +afff8678c4644434445c5645544b66644bf7ff14eefffffa6ffffffffd34 +533334333894bffffff6bffcff06d4354456875449f7ff0dc43433333334 +444543537cbfd8efeefffff0f9ff108efff6c894744444446b5645555b67 +544ef4ff11f7affffffffe533334333338b97ffffffeadfcff07f6464545 +557744eff8ff0cf5333433334333453356fffb6eedfffff0f9ff108efff6 +c894744444446b5645555b67544ef4ff11f7affffffffe533334333338b9 +7ffffffeadfcff07f6464545557744eff8ff0cf5333433334333453356ff +fb6eedfffff0f9ff108efff6c894744444446b5645555b67544ef4ff11f7 +affffffffe533334333338b97ffffffeadfcff07f6464545557744eff8ff +0cf5333433334333453356fffb6eedfffff0f9ff10e8eff8ea7544734454 +886544555b56648ff4ff01f4effcff0b5335843345338a7dffffff79fcff +07fe469333435777cff8ff0cf644453333334466659efa77dfedfffff0f9 +ff10e8eff8ea7544734454886544555b56648ff4ff01f4effcff0b533584 +3345338a7dffffff79fcff07fe469333435777cff8ff0cf6444533333344 +66659efa77dfedfffff0f9ff10e8eff8ea7544734454886544555b56648f +f4ff01f4effcff0b5335843345338a7dffffff79fcff07fe469333435777 +cff8ff0cf644453333334466659efa77dfedfffff0f9ff10fd9dfceb6559 +533844a59554565a5554eff4ff00e6fcff0cfe45bdc43344436edeffffff +67fcff07fe747334334789eff8ff0bfb4446333344458e66b758efecffff +f0f9ff10fd9dfceb6559533844a59554565a5554eff4ff00e6fcff0cfe45 +bdc43344436edeffffff67fcff07fe747334334789eff8ff0bfb44463333 +44458e66b758efecfffff0f9ff10fd9dfceb6559533844a59554565a5554 +eff4ff00e6fcff0cfe45bdc43344436edeffffff67fcff07fe7473343347 +89eff8ff0bfb4446333344458e66b758efecfffff0f8ff0ef8efee669a43 +484585b4657649453cf3ff009afbff0b4cffd33333435daefffffe5dfcff +06eec533333336bff7ff09fd69b643345874bd636beafffff0f8ff0ef8ef +ee669a43484585b4657649453cf3ff009afbff0b4cffd33333435daeffff +fe5dfcff06eec533333336bff7ff09fd69b643345874bd636beafffff0f8 +ff0ef8efee669a43484585b4657649453cf3ff009afbff0b4cffd3333343 +5daefffffe5dfcff06eec533333336bff7ff09fd69b643345874bd636bea +fffff0f8ff0efe9fffa9b634a54768a5b55559549ff3ff007efbff0b88fe +f5333334775ffffff8affcff07feeb43333356768ff7ff07c9fb87dcfed8 +76ade9fffff0f8ff0efe9fffa9b634a54768a5b55559549ff3ff007efbff +0b88fef5333334775ffffff8affcff07feeb43333356768ff7ff07c9fb87 +dcfed876ade9fffff0f8ff0efe9fffa9b634a54768a5b55559549ff3ff00 +7efbff0b88fef5333334775ffffff8affcff07feeb43333356768ff7ff07 +c9fb87dcfed876ade9fffff0f7ff0ccbffbae86594775d6684547655f2ff +006ffbff07e77cdc433346a56ff6ff0583333377845ff7ff06f566887777 +8bdffbff07feffdfdffffffffef5fffff0f7ff0ccbffbae86594775d6684 +547655f2ff006ffbff07e77cdc433346a56ff6ff0583333377845ff7ff06 +f5668877778bdffbff07feffdfdffffffffef5fffff0f7ff0ccbffbae865 +94775d6684547655f2ff006ffbff07e77cdc433346a56ff6ff0583333377 +845ff7ff06f5668877778bdffbff07feffdfdffffffffef5fffff0f7ff0c +fdaeefffda55b4ab586554954bf3ff01fc4efcff08feeda49fd88989b59f +f6ff05d445569c94cff7ff03fbdedeeffbff0ddeffe58bff6e6ffffebde5 +97bdbef8fffff0f7ff0cfdaeefffda55b4ab586554954bf3ff01fc4efcff +08feeda49fd88989b59ff6ff05d445569c94cff7ff03fbdedeeffbff0dde +ffe58bff6e6ffffebde597bdbef8fffff0f7ff0cfdaeefffda55b4ab5865 +54954bf3ff01fc4efcff08feeda49fd88989b59ff6ff05d445569c94cff7 +ff03fbdedeeffbff0ddeffe58bff6e6ffffebde597bdbef8fffff0f6ff0b +fabdfffcbb49e6bf7654854ff3ff01f95efaff05fd67aab75558f5ff05f9 +45669859dff6ff008ff9ff0fa4cff738fe579fcbfe76db549b6577affaff +fff0f6ff0bfabdfffcbb49e6bf7654854ff3ff01f95efaff05fd67aab755 +58f5ff05f945669859dff6ff008ff9ff0fa4cff738fe579fcbfe76db549b +6577affafffff0f6ff0bfabdfffcbb49e6bf7654854ff3ff01f95efaff05 +fd67aab75558f5ff05f945669859dff6ff008ff9ff0fa4cff738fe579fcb +fe76db549b6577affafffff0f5ff0afcacfc94aa79fd6855578ff3ff01f5 +9efaff05eefd989abdeff4ff03947757daf5ff009df9ff0ffb5dff56fd45 +eb48dfa55d849b46b6effafffff0f5ff0afcacfc94aa79fd6855578ff3ff +01f59efaff05eefd989abdeff4ff03947757daf5ff009df9ff0ffb5dff56 +fd45eb48dfa55d849b46b6effafffff0f5ff0afcacfc94aa79fd6855578f +f3ff01f59efaff05eefd989abdeff4ff03947757daf5ff009df9ff0ffb5d +ff56fd45eb48dfa55d849b46b6effafffff0f4ff09febabefecffcde8cd5 +dff3ff01e6aef9ff03feefffeef3ff03f64dfffcf5ff00e8f8ff0dd6efd8 +ee5dd436bff846d48c4c6ef9fffff0f4ff09febabefecffcde8cd5dff3ff +01e6aef9ff03feefffeef3ff03f64dfffcf5ff00e8f8ff0dd6efd8ee5dd4 +36bff846d48c4c6ef9fffff0f4ff09febabefecffcde8cd5dff3ff01e6ae +f9ff03feefffeef3ff03f64dfffcf5ff00e8f8ff0dd6efd8ee5dd436bff8 +46d48c4c6ef9fffff0f2ff06bbbbceffffffe5f2ff0198ccf7ff01efdff3 +ff04fd58fff97ff6ff00f8f8ff0efa6fffffec59358876446467558aeffa +fffff0f2ff06bbbbceffffffe5f2ff0198ccf7ff01efdff3ff04fd58fff9 +7ff6ff00f8f8ff0efa6fffffec59358876446467558aeffafffff0f2ff06 +bbbbceffffffe5f2ff0198ccf7ff01efdff3ff04fd58fff97ff6ff00f8f8 +ff0efa6fffffec59358876446467558aeffafffff0f0ff04ecbcceff69f2 +ff025cfacee8ff03a4cffb58f6ff01fbcffaff0fcaa957766664678889bd +eff9fffffebffafffff0f0ff04ecbcceff69f2ff025cfacee8ff03a4cffb +58f6ff01fbcffaff0fcaa957766664678889bdeff9fffffebffafffff0f0 +ff04ecbcceff69f2ff025cfacee8ff03a4cffb58f6ff01fbcffaff0fcaa9 +57766664678889bdeff9fffffebffafffff0eeff02fdc94ef3ff03fd3efb +cde8ff04f77ffe46dff6ff009ffaff047bcc89bceffaff04faffffffbffa +fffff0eeff02fdc94ef3ff03fd3efbcde8ff04f77ffe46dff6ff009ffaff +047bcc89bceffaff04faffffffbffafffff0eeff02fdc94ef3ff03fd3efb +cde8ff04f77ffe46dff6ff009ffaff047bcc89bceffaff04faffffffbffa +fffff0edff01f96ff3ff03f73cfedde8ff04fb4dffa78ef6ff00dafaff02 +8fffcff8ff04fafffffebffafffff0edff01f96ff3ff03f73cfedde8ff04 +fb4dffa78ef6ff00dafaff028fffcff8ff04fafffffebffafffff0edff01 +f96ff3ff03f73cfedde8ff04fb4dffa78ef6ff00dafaff028fffcff8ff04 +fafffffebffafffff0edff01f4cff3ff03d54efffee7ff0498fff5d7eef7 +ff01f9effbff029ffeaffcff08eddbba9997ab79adbffafffff0edff01f4 +cff3ff03d54efffee7ff0498fff5d7eef7ff01f9effbff029ffeaffcff08 +eddbba9997ab79adbffafffff0edff01f4cff3ff03d54efffee7ff0498ff +f5d7eef7ff01f9effbff029ffeaffcff08eddbba9997ab79adbffafffff0 +edff00c6f2ff027956dfe6ff04e5eff78e7df7ff01fe9ffcff10fd787658 +a987765445785796a8dd55a9cffafffff0edff00c6f2ff027956dfe6ff04 +e5eff78e7df7ff01fe9ffcff10fd787658a987765445785796a8dd55a9cf +fafffff0edff00c6f2ff027956dfe6ff04e5eff78e7df7ff01fe9ffcff10 +fd787658a987765445785796a8dd55a9cffafffff0edff007af3ff02fc5f +b7e5ff05f56ff95fe9cff7ff00dbfcff0ffe9a7684bbb968d74bff78f9fe +df97dff9fffff0edff007af3ff02fc5fb7e5ff05f56ff95fe9cff7ff00db +fcff0ffe9a7684bbb968d74bff78f9fedf97dff9fffff0edff007af3ff02 +fc5fb7e5ff05f56ff95fe9cff7ff00dbfcff0ffe9a7684bbb968d74bff78 +f9fedf97dff9fffff0eeff01fe4ef3ff02f78f95f0ff00edf6ff06fd5dfa +4effaaeff8ff01fbdffbff0d9bd5fffe6af94aff77f9ffefe7dff9fffff0 +eeff01fe4ef3ff02f78f95f0ff00edf6ff06fd5dfa4effaaeff8ff01fbdf +fbff0d9bd5fffe6af94aff77f9ffefe7dff9fffff0eeff01fe4ef3ff02f7 +8f95f0ff00edf6ff06fd5dfa4effaaeff8ff01fbdffbff0d9bd5fffe6af9 +4aff77f9ffefe7dff9fffff0eeff01fb6ff3ff03c4efb68ef3ff05feeeb4 +aeffecf8ff0688fc4afffe89eff8ff00aefbff0d8bb5ffff6afa49ff77f9 +fffff7dff9fffff0eeff01fb6ff3ff03c4efb68ef3ff05feeeb4aeffecf8 +ff0688fc4afffe89eff8ff00aefbff0d8bb5ffff6afa49ff77f9fffff7df +f9fffff0eeff01fb6ff3ff03c4efb68ef3ff05feeeb4aeffecf8ff0688fc +4afffe89eff8ff00aefbff0d8bb5ffff6afa49ff77f9fffff7dff9fffff0 +eeff01f7aff4ff05fe59ffd85eeff4ff0596678959ddddf8ff07e6bd59ff +fffd99aef9ff01f98efcff0d6bc5ffff5afa48ff86f8ffeff7dff9fffff0 +eeff01f7aff4ff05fe59ffd85eeff4ff0596678959ddddf8ff07e6bd59ff +fffd99aef9ff01f98efcff0d6bc5ffff5afa48ff86f8ffeff7dff9fffff0 +eeff01f7aff4ff05fe59ffd85eeff4ff0596678959ddddf8ff07e6bd59ff +fffd99aef9ff01f98efcff0d6bc5ffff5afa48ff86f8ffeff7dff9fffff0 +eeff01f4eff4ff05f77ffffc668ff1ff05c8667878888bfbff02fb6c59fc +ff02d98beffaff12e8efffffff7ad6fffe5afb49ff75f8fffff7dff9ffff +f0eeff01f4eff4ff05f77ffffc668ff1ff05c8667878888bfbff02fb6c59 +fcff02d98beffaff12e8efffffff7ad6fffe5afb49ff75f8fffff7dff9ff +fff0eeff01f4eff4ff05f77ffffc668ff1ff05c8667878888bfbff02fb6c +59fcff02d98beffaff12e8efffffff7ad6fffe5afb49ff75f8fffff7dff9 +fffff0eeff00c5f3ff05a6efffff754df2ff05ecbcccddeeeff9ff01685a +fbff1afb78adefffffffebaaefffffff7bd6ffff4bfb4aff75f8fffff7df +f9fffff0eeff00c5f3ff05a6efffff754df2ff05ecbcccddeeeff9ff0168 +5afbff1afb78adefffffffebaaefffffff7bd6ffff4bfb4aff75f8fffff7 +dff9fffff0eeff00c5f3ff05a6efffff754df2ff05ecbcccddeeeff9ff01 +685afbff1afb78adefffffffebaaefffffff7bd6ffff4bfb4aff75f8ffff +f7dff9fffff0eeff0089f4ff06e76ffffffffb6bf4ff06fd66787765458d +f8ff01a46cf9ff05c988999989befbff0d7bc7ffff5afc59ff76f8fffff6 +dff9fffff0eeff0089f4ff06e76ffffffffb6bf4ff06fd66787765458df8 +ff01a46cf9ff05c988999989befbff0d7bc7ffff5afc59ff76f8fffff6df +f9fffff0eeff0089f4ff06e76ffffffffb6bf4ff06fd66787765458df8ff +01a46cf9ff05c988999989befbff0d7bc7ffff5afc59ff76f8fffff6dff9 +fffff0eeff005ef5ff02fe55dffcff00abf4ff08f5affffffffeb858effa +ff01d54eeeff0d8bc7fffe4afc5aff77f8fffff6eff9fffff0eeff005ef5 +ff02fe55dffcff00abf4ff08f5affffffffeb858effaff01d54eeeff0d8b +c7fffe4afc5aff77f8fffff6eff9fffff0eeff005ef5ff02fe55dffcff00 +abf4ff08f5affffffffeb858effaff01d54eeeff0d8bc7fffe4afc5aff77 +f8fffff6eff9fffff0efff01fb5ff5ff01c44dfbff00eff4ff0098faff01 +d74bfaff02fc4befefff0d7bb7fffe4afd4aff87f8fffff6eff9fffff0ef +ff01fb5ff5ff01c44dfbff00eff4ff0098faff01d74bfaff02fc4befefff +0d7bb7fffe4afd4aff87f8fffff6eff9fffff0efff01fb5ff5ff01c44dfb +ff00eff4ff0098faff01d74bfaff02fc4befefff0d7bb7fffe4afd4aff87 +f8fffff6eff9fffff0efff01f6bff6ff02fd44cfefff01fc4df9ff01b58e +faff0474dfedc88af2ff0d7bb7fffe49fe4bff78f7fffff6eff9fffff0ef +ff01f6bff6ff02fd44cfefff01fc4df9ff01b58efaff0474dfedc88af2ff +0d7bb7fffe49fe4bff78f7fffff6eff9fffff0efff01f6bff6ff02fd44cf +efff01fc4df9ff01b58efaff0474dfedc88af2ff0d7bb7fffe49fe4bff78 +f7fffff6eff9fffff0efff00b5f5ff01b55ceeff04f6cfb6448efbff01a5 +affbff0596544557776df3ff0d7bb7fffe49fe4cff78f8fffff6eff9ffff +f0efff00b5f5ff01b55ceeff04f6cfb6448efbff01a5affbff0596544557 +776df3ff0d7bb7fffe49fe4cff78f8fffff6eff9fffff0efff00b5f5ff01 +b55ceeff04f6cfb6448efbff01a5affbff0596544557776df3ff0d7bb7ff +fe49fe4cff78f8fffff6eff9fffff0f0ff01fe5cf7ff03fea658efeeff05 +e6f8357755dffcff02fd66bffbff05feffffffd5eff4ff0d7ba8fffe49fe +4cff88f7fffff6eff9fffff0f0ff01fe5cf7ff03fea658efeeff05e6f835 +7755dffcff02fd66bffbff05feffffffd5eff4ff0d7ba8fffe49fe4cff88 +f7fffff6eff9fffff0f0ff01fe5cf7ff03fea658efeeff05e6f8357755df +fcff02fd66bffbff05feffffffd5eff4ff0d7ba8fffe49fe4cff88f7ffff +f6eff9fffff0f0ff01f59ff8ff03eb7457afedff05a8a37ffffceffbff02 +fa57dff8ff01fa8ff4ff0d7bb8fffd4afe4dff89f7fffff6eff9fffff0f0 +ff01f59ff8ff03eb7457afedff05a8a37ffffceffbff02fa57dff8ff01fa +8ff4ff0d7bb8fffd4afe4dff89f7fffff6eff9fffff0f0ff01f59ff8ff03 +eb7457afedff05a8a37ffffceffbff02fa57dff8ff01fa8ff4ff0d7bb8ff +fd4afe4dff89f7fffff6eff9fffff0f0ff0086faff05eca876678ccdecff +027d53bff7ff01e75bf7ff005ff4ff0c7cb8fffd4afe4cffacf8fffff6f8 +fffff0f0ff0086faff05eca876678ccdecff027d53bff7ff01e75bf7ff00 +5ff4ff0c7cb8fffd4afe4cffacf8fffff6f8fffff0f0ff0086faff05eca8 +76678ccdecff027d53bff7ff01e75bf7ff005ff4ff0c7cb8fffd4afe4cff +acf8fffff6f8fffff0f1ff01fa4efcff08fb75468beffe9db9efedff026d +84eff6ff0185aff8ff006df4ff0c6cb8fffc4bfb4dff8cf7fffff5f8ffff +f0f1ff01fa4efcff08fb75468beffe9db9efedff026d84eff6ff0185aff8 +ff006df4ff0c6cb8fffc4bfb4dff8cf7fffff5f8fffff0f1ff01fa4efcff +08fb75468beffe9db9efedff026d84eff6ff0185aff8ff006df4ff0c6cb8 +fffc4bfb4dff8cf7fffff5f8fffff0f1ff0ea4dffffffff95799bfffffff +fa8abfedff076dc5ffffc74579effbff00faf7ff008bf4ff0c6ca9fffc4b +fb4cff8cf7fffff5f8fffff0f1ff0ea4dffffffff95799bffffffffa8abf +edff076dc5ffffc74579effbff00faf7ff008bf4ff0c6ca9fffc4bfb4cff +8cf7fffff5f8fffff0f1ff0ea4dffffffff95799bffffffffa8abfedff07 +6dc5ffffc74579effbff00faf7ff008bf4ff0c6ca9fffc4bfb4cff8cf7ff +fff5f8fffff0f2ff01fa4cfcff0284efe9fcff02fe87bfedff07befdffff +75dca65ef1ff00a9f4ff0c6da9fffc4bfb4cff8bf7fffff5f8fffff0f2ff +01fa4cfcff0284efe9fcff02fe87bfedff07befdffff75dca65ef1ff00a9 +f4ff0c6da9fffc4bfb4cff8bf7fffff5f8fffff0f2ff01fa4cfcff0284ef +e9fcff02fe87bfedff07befdffff75dca65ef1ff00a9f4ff0c6da9fffc4b +fb4cff8bf7fffff5f8fffff0f2ff0873bffffffffd4bff9dfbff01c4efed +ff07dcfffffe43643567f1ff00a9f4ff0c6c99fffb4bfb4cff8cf7fffff5 +f8fffff0f2ff0873bffffffffd4bff9dfbff01c4efedff07dcfffffe4364 +3567f1ff00a9f4ff0c6c99fffb4bfb4cff8cf7fffff5f8fffff0f2ff0873 +bffffffffd4bff9dfbff01c4efedff07dcfffffe43643567f1ff00a9f4ff +0c6c99fffb4bfb4cff8cf7fffff5f8fffff0f3ff01f939fcff03f66fff7f +fbff00f6f1ff00cef9ff06fe433333569adff4ff01db7cf4ff0c5d99fffb +4aa539ff7cf7fffff5f8fffff0f3ff01f939fcff03f66fff7ffbff00f6f1 +ff00cef9ff06fe433333569adff4ff01db7cf4ff0c5d99fffb4aa539ff7c +f7fffff5f8fffff0f3ff01f939fcff03f66fff7ffbff00f6f1ff00cef9ff +06fe433333569adff4ff01db7cf4ff0c5d99fffb4aa539ff7cf7fffff5f8 +fffff0f3ff01f57ffcff03b4bfff7ffbff01f7bff3ff01edeff9ff06fe63 +33333b546ef5ff02fe875ff4ff0c6da9fffb479dc6bf6cf7fffff5f8ffff +f0f3ff01f57ffcff03b4bfff7ffbff01f7bff3ff01edeff9ff06fe633333 +3b546ef5ff02fe875ff4ff0c6da9fffb479dc6bf6cf7fffff5f8fffff0f3 +ff01f57ffcff03b4bfff7ffbff01f7bff3ff01edeff9ff06fe6333333b54 +6ef5ff02fe875ff4ff0c6da9fffb479dc6bf6cf7fffff5f8fffff0f3ff09 +f4effea69ec849fffe8ffbff01f85ff5ff02fe866df7ff05e633334d553a +f5ff02f7577ff4ff0c5db8fffb46ffec5e6cf7fffff5f8fffff0f3ff09f4 +effea69ec849fffe8ffbff01f85ff5ff02fe866df7ff05e633334d553af5 +ff02f7577ff4ff0c5db8fffb46ffec5e6cf7fffff5f8fffff0f3ff09f4ef +fea69ec849fffe8ffbff01f85ff5ff02fe866df7ff05e633334d553af5ff +02f7577ff4ff0c5db8fffb46ffec5e6cf7fffff5f8fffff0f3ff09f77863 +577347dffffb9ffbff01f95bf5ff01d6aef5ff04b8aeff5b46f5ff028344 +7ff4ff0c6ec8fffb4afff9344497ffffe5f8fffff0f3ff09f77863577347 +dffffb9ffbff01f95bf5ff01d6aef5ff04b8aeff5b46f5ff0283447ff4ff +0c6ec8fffb4afff9344497ffffe5f8fffff0f3ff09f77863577347dffffb +9ffbff01f95bf5ff01d6aef5ff04b8aeff5b46f5ff0283447ff4ff0c6ec8 +fffb4afff9344497ffffe5f8fffff0f3ff09fe99abfffedffffffabffbff +01f8c9f5ff005df1ff026cb3eff7ff03f84334cff4ff0c5eb9fffb38ffe4 +6745a7fffeb6f8fffff0f3ff09fe99abfffedffffffabffbff01f8c9f5ff +005df1ff026cb3eff7ff03f84334cff4ff0c5eb9fffb38ffe46745a7fffe +b6f8fffff0f3ff09fe99abfffedffffffabffbff01f8c9f5ff005df1ff02 +6cb3eff7ff03f84334cff4ff0c5eb9fffb38ffe46745a7fffeb6f8fffff0 +ebff01f9dffbff01f8f8f1ff01baeff6ff025ce4aff8ff03fe743337f3ff +0c5eb8fffa45ffe5ff6cf7eadda6f8fffff0ebff01f9dffbff01f8f8f1ff +01baeff6ff025ce4aff8ff03fe743337f3ff0c5eb8fffa45ffe5ff6cf7ea +dda6f8fffff0ebff01f9dffbff01f8f8f1ff01baeff6ff025ce4aff8ff03 +fe743337f3ff0c5eb8fffa45ffe5ff6cf7eadda6f8fffff0ebff01f8dffb +ff01f8f8f2ff05c5464afffffefaff03fe6ff57ff9ff04feb643345ef3ff +0c4eb8fff944cf88ff5bf7a37ba6f8fffff0ebff01f8dffbff01f8f8f2ff +05c5464afffffefaff03fe6ff57ff9ff04feb643345ef3ff0c4eb8fff944 +cf88ff5bf7a37ba6f8fffff0ebff01f8dffbff01f8f8f2ff05c5464affff +fefaff03fe6ff57ff9ff04feb643345ef3ff0c4eb8fff944cf88ff5bf7a3 +7ba6f8fffff0ebff01f9cffbff01f9e7f2ff05aedfe5bffdeff8ff01f99f +faff05eed7433346bff3ff0c4db9fff846df59ff6bf7a35ca7f8fffff0eb +ff01f9cffbff01f9e7f2ff05aedfe5bffdeff8ff01f99ffaff05eed74333 +46bff3ff0c4db9fff846df59ff6bf7a35ca7f8fffff0ebff01f9cffbff01 +f9e7f2ff05aedfe5bffdeff8ff01f99ffaff05eed7433346bff3ff0c4db9 +fff846df59ff6bf7a35ca7f8fffff0ebff01f9cffbff02fac8dff1ff02fc +4df8efff04fc64333378f2ff0c4ca9fff639ee84af5bf7834b97f8fffff0 +ebff01f9cffbff02fac8dff1ff02fc4df8efff04fc64333378f2ff0c4ca9 +fff639ee84af5bf7834b97f8fffff0ebff01f9cffbff02fac8dff1ff02fc +4df8efff04fc64333378f2ff0c4ca9fff639ee84af5bf7834b97f8fffff0 +ebff01fabffaff01a85ef0ff0179e8f0ff05fe853333356ef2ff0c4da558 +5445759a5a5bf7c69b97f8fffff0ebff01fabffaff01a85ef0ff0179e8f0 +ff05fe853333356ef2ff0c4da5585445759a5a5bf7c69b97f8fffff0ebff +01fabffaff01a85ef0ff0179e8f0ff05fe853333356ef2ff0c4da5585445 +759a5a5bf7c69b97f8fffff0ebff01fb9ff9ff0097f0ff01d6aaf0ff05e7 +43433346dff2ff0c4da85eedba8654444bf7edfb97f8fffff0ebff01fb9f +f9ff0097f0ff01d6aaf0ff05e743433346dff2ff0c4da85eedba8654444b +f7edfb97f8fffff0ebff01fb9ff9ff0097f0ff01d6aaf0ff05e743433346 +dff2ff0c4da85eedba8654444bf7edfb97f8fffff0ebff01fd8ff9ff01e6 +cff1ff01f96af1ff05fe743433346ef1ff0c5d8668aceffffffe5bf7effc +97f8fffff0ebff01fd8ff9ff01e6cff1ff01f96af1ff05fe743433346ef1 +ff0c5d8668aceffffffe5bf7effc97f8fffff0ebff01fd8ff9ff01e6cff1 +ff01f96af1ff05fe743433346ef1ff0c5d8668aceffffffe5bf7effc97f8 +fffff0ebff01fe7ff9ff01f89ff1ff01fe58f3ff07feede744443346dff1 +ff0c7d746456555666685bf7fffd98f8fffff0ebff01fe7ff9ff01f89ff1 +ff01fe58f3ff07feede744443346dff1ff0c7d746456555666685bf7fffd +98f8fffff0ebff01fe7ff9ff01f89ff1ff01fe58f3ff07feede744443346 +dff1ff0c7d746456555666685bf7fffd98f8fffff0eaff007ff9ff01eb8f +f0ff00b5f1ff05c889755459eff1ff0c6c8555bfffffec585bf7fffda8f8 +fffff0eaff007ff9ff01eb8ff0ff00b5f1ff05c889755459eff1ff0c6c85 +55bfffffec585bf7fffda8f8fffff0eaff007ff9ff01eb8ff0ff00b5f1ff +05c889755459eff1ff0c6c8555bfffffec585bf7fffda8f8fffff0eaff00 +7ff9ff01bd8ff0ff01f6cff2ff09eeffedbafd8efffeeedff6ff0dfe6965 +97feffffffd55bf6fffea9f8fffff0eaff007ff9ff01bd8ff0ff01f6cff2 +ff09eeffedbafd8efffeeedff6ff0dfe696597feffffffd55bf6fffea9f8 +fffff0eaff007ff9ff01bd8ff0ff01f6cff2ff09eeffedbafd8efffeeedf +f6ff0dfe696597feffffffd55bf6fffea9f8fffff0eaff007ef9ff01db9c +f0ff01fb8fedff06fb67656764666df9ff0efd84434658abceeeecb64af6 +fffea8f8fffff0eaff007ef9ff01db9cf0ff01fb8fedff06fb6765676466 +6df9ff0efd84434658abceeeecb64af6fffea8f8fffff0eaff007ef9ff01 +db9cf0ff01fb8fedff06fb67656764666df9ff0efd84434658abceeeecb6 +4af6fffea8f8fffff0eaff009bf9ff01f9c8efff007eecff05ccfffebefe +7af9ff0ef86aa98999a8764444364af6fffea9f8fffff0eaff009bf9ff01 +f9c8efff007eecff05ccfffebefe7af9ff0ef86aa98999a8764444364af6 +fffea9f8fffff0eaff009bf9ff01f9c8efff007eecff05ccfffebefe7af9 +ff0ef86aa98999a8764444364af6fffea9f8fffff0eaff00baf9ff02fe95 +acf0ff00d8ecff06fbdf97cceee6effaff0eb86544665567594666444ae6 +fffd9af8fffff0eaff00baf9ff02fe95acf0ff00d8ecff06fbdf97cceee6 +effaff0eb86544665567594666444ae6fffd9af8fffff0eaff00baf9ff02 +fe95acf0ff00d8ecff06fbdf97cceee6effaff0eb8654466556759466644 +4ae6fffd9af8fffff0eaff00d8f8ff03fbcb88eff2ff01fd8fedff06fe9e +b4386efc7ffaff0efeb764957acb5756544649d5fffd8af8fffff0eaff00 +d8f8ff03fbcb88eff2ff01fd8fedff06fe9eb4386efc7ffaff0efeb76495 +7acb5756544649d5fffd8af8fffff0eaff00d8f8ff03fbcb88eff2ff01fd +8fedff06fe9eb4386efc7ffaff0efeb764957acb5756544649d5fffd8af8 +fffff0eaff00f7f8ff04fcbffd88eff2ff00c9edff06fd7ed5439eff8af8 +ff0ce5f7aefe6ecdbddc58d6fffc8af8fffff0eaff00f7f8ff04fcbffd88 +eff2ff00c9edff06fd7ed5439eff8af8ff0ce5f7aefe6ecdbddc58d6fffc +8af8fffff0eaff00f7f8ff04fcbffd88eff2ff00c9edff06fd7ed5439eff +8af8ff0ce5f7aefe6ecdbddc58d6fffc8af8fffff0eaff00f7f7ff03baac +fd7cf2ff01fc9ff1ff0aeffebaa638e8547fffd5dff9ff0ce5f6adec58de +ebba57e6fffb8af8fffff0eaff00f7f7ff03baacfd7cf2ff01fc9ff1ff0a +effebaa638e8547fffd5dff9ff0ce5f6adec58deebba57e6fffb8af8ffff +f0eaff00f7f7ff03baacfd7cf2ff01fc9ff1ff0aeffebaa638e8547fffd5 +dff9ff0ce5f6adec58deebba57e6fffb8af8fffff0eaff01facff7ff03eb +9cf7dff2ff0186cff6ff0ec96655556798674a54ba555cfffc6dfaff10fe +b5b76554445569a738f6fffa88ccccdffbfffff0eaff01facff7ff03eb9c +f7dff2ff0186cff6ff0ec96655556798674a54ba555cfffc6dfaff10feb5 +b76554445569a738f6fffa88ccccdffbfffff0eaff01facff7ff03eb9cf7 +dff2ff0186cff6ff0ec96655556798674a54ba555cfffc6dfaff10feb5b7 +6554445569a738f6fffa88ccccdffbfffff0eaff01fd9ff6ff02fab86af2 +ff1be749effecbceefffeed996543344444333334bdeb36a454779bec68e +fbff00b6fb440b5444564ae6fffd855554456dfcfffff0eaff01fd9ff6ff +02fab86af2ff1be749effecbceefffeed996543344444333334bdeb36a45 +4779bec68efbff00b6fb440b5444564ae6fffd855554456dfcfffff0eaff +01fd9ff6ff02fab86af2ff1be749effecbceefffeed99654334444433333 +4bdeb36a454779bec68efbff00b6fb440b5444564ae6fffd855554456dfc +fffff0e9ff006ff6ff02fe99e7f1ff08a455533469cdcdb643f93326349f +fff73435469766774688898899996444455555455555454af6ffff864544 +44489afffffff0e9ff006ff6ff02fe99e7f1ff08a455533469cdcdb643f9 +3326349ffff73435469766774688898899996444455555455555454af6ff +ff86454444489afffffff0e9ff006ff6ff02fe99e7f1ff08a455533469cd +cdb643f93326349ffff73435469766774688898899996444455555455555 +454af6ffff86454444489afffffff0e9ff008df6ff02f9e8f8f1ff06fc44 +5bdcdb9754fb33143444334438fffffd455844678bdfdacebaabababa8fa +990f98775cf5efff78bbcbaaaab77ffffff0e9ff008df6ff02f9e8f8f1ff +06fc445bdcdb9754fb33143444334438fffffd455844678bdfdacebaabab +aba8fa990f98775cf5efff78bbcbaaaab77ffffff0e9ff008df6ff02f9e8 +f8f1ff06fc445bdcdb9754fb33143444334438fffffd455844678bdfdace +baabababa8fa990f98775cf5efff78bbcbaaaab77ffffff0e9ff00d8f6ff +02f8d9acf0ff04e534444343fc332c4433456655437ffffffe466857eca3 +7be8788767888888778799998aaabbba5bc5efff7899866658869ffffff0 +e9ff00d8f6ff02f8d9acf0ff04e534444343fc332c4433456655437fffff +fe466857eca37be8788767888888778799998aaabbba5bc5efff78998666 +58869ffffff0e9ff00d8f6ff02f8d9acf0ff04e534444343fc332c443345 +6655437ffffffe466857eca37be8788767888888778799998aaabbba5bc5 +efff7899866658869ffffff0e9ff00f7f6ff02f98e8ef0ff35fc74333334 +688887abcbaaefefded9afffffff488666fed347c49ddcbbaabbba75a469 +c85cccdccb7db5cffe7cfff8bd6ff9cffffff0e9ff00f7f6ff02f98e8ef0 +ff35fc74333334688887abcbaaefefded9afffffff488666fed347c49ddc +bbaabbba75a469c85cccdccb7db5cffe7cfff8bd6ff9cffffff0e9ff00f7 +f6ff02f98e8ef0ff35fc74333334688887abcbaaefefded9afffffff4886 +66fed347c49ddcbbaabbba75a469c85cccdccb7db5cffe7cfff8bd6ff9cf +fffff0e9ff00f7f6ff02f78f8feeff03edcdddeff8ff0cfd8fffffff57b5 +85dfe447c4bffbff1586e49efa7fffffff8ee5cffd7dfff8ce6ff9dfffff +f0e9ff00f7f6ff02f78f8feeff03edcdddeff8ff0cfd8fffffff57b585df +e447c4bffbff1586e49efa7fffffff8ee5cffd7dfff8ce6ff9dffffff0e9 +ff00f7f6ff02f78f8feeff03edcdddeff8ff0cfd8fffffff57b585dfe447 +c4bffbff1586e49efa7fffffff8ee5cffd7dfff8ce6ff9dffffff0e9ff01 +f8dff7ff02f78cafecff00fcf7ff0cfe7ffffffe58c6949fe559b4dffbff +15a7f48fe99fffffff8ff5dffe6dfff9ce6ff9dffffff0e9ff01f8dff7ff +02f78cafecff00fcf7ff0cfe7ffffffe58c6949fe559b4dffbff15a7f48f +e99fffffff8ff5dffe6dfff9ce6ff9dffffff0e9ff01f8dff7ff02f78caf +ecff00fcf7ff0cfe7ffffffe58c6949fe559b4dffbff15a7f48fe99fffff +ff8ff5dffe6dfff9ce6ff9dffffff0e9ff01fbaff7ff02f96cafe2ff0bfb +8ffffffe58d8955ff65cb6faff1596e58ff88ffffffd7ee5dfff6dfff8cd +7ff9effffff0e9ff01fbaff7ff02f96cafe2ff0bfb8ffffffe58d8955ff6 +5cb6faff1596e58ff88ffffffd7ee5dfff6dfff8cd7ff9effffff0e9ff01 +fbaff7ff02f96cafe2ff0bfb8ffffffe58d8955ff65cb6faff1596e58ff8 +8ffffffd7ee5dfff6dfff8cd7ff9effffff0e8ff007ff6ff01798fe2ff0b +f6dffffffd58e7765ef66e97faff1596f57ff98ffffffd7ff5efff6dfff8 +dd8ff8effffff0e8ff007ff6ff01798fe2ff0bf6dffffffd58e7765ef66e +97faff1596f57ff98ffffffd7ff5efff6dfff8dd8ff8effffff0e8ff007f +f6ff01798fe2ff0bf6dffffffd58e7765ef66e97faff1596f57ff98fffff +fd7ff5efff6dfff8dd8ff8effffff0e8ff00baf6ff01f66ce2ff0bc6ffff +fffd69e6685be66f88faff1596f59ff99ffffffe8fe6ffff5efff8ec9ff7 +fffffff0e8ff00baf6ff01f66ce2ff0bc6fffffffd69e6685be66f88faff +1596f59ff99ffffffe8fe6ffff5efff8ec9ff7fffffff0e8ff00baf6ff01 +f66ce2ff0bc6fffffffd69e6685be66f88faff1596f59ff99ffffffe8fe6 +ffff5efff8ec9ff7fffffff0e8ff00f7f6ff03fe87fffde5ff0cfe7dffff +fffc5af67938d67f6afaff15a5d59ff89fffffff9fe7ffff5efff8fbaff7 +fffffff0e8ff00f7f6ff03fe87fffde5ff0cfe7dfffffffc5af67938d67f +6afaff15a5d59ff89fffffff9fe7ffff5efff8fbaff7fffffff0e8ff00f7 +f6ff03fe87fffde5ff0cfe7dfffffffc5af67938d67f6afaff15a5d59ff8 +9fffffff9fe7ffff5efff8fbaff7fffffff0e8ff01f9cff6ff02fbbff7e6 +ff0dfd88effffffffb5ce67935d78e5efaff1595c49ff89fffffff9fe7ff +ff5efff8fabff6fffffff0e8ff01f9cff6ff02fbbff7e6ff0dfd88efffff +fffb5ce67935d78e5efaff1595c49ff89fffffff9fe7ffff5efff8fabff6 +fffffff0e8ff01f9cff6ff02fbbff7e6ff0dfd88effffffffb5ce67935d7 +8e5efaff1595c49ff89fffffff9fe7ffff5efff8fabff6fffffff0e8ff01 +fd8ff5ff01aee8e9ff04fefeb88aeffcff07fb4ec8a944b7ad5ffaff1596 +c49ff7afffffff9fe7ffff5ffff8f9dff7fffffff0e8ff01fd8ff5ff01ae +e8e9ff04fefeb88aeffcff07fb4ec8a944b7ad5ffaff1596c49ff7afffff +ff9fe7ffff5ffff8f9dff7fffffff0e8ff01fd8ff5ff01aee8e9ff04fefe +b88aeffcff07fb4ec8a944b7ad5ffaff1596c49ff7afffffff9fe7ffff5f +fff8f9dff7fffffff0e7ff007ef5ff03fac9ffdff0ff07db967665555788 +cffaff07fb4eb8d67587c97ffaff1586d49fe7afffffff9fe7ffff6ffff8 +f8efe6fffffff0e7ff007ef5ff03fac9ffdff0ff07db967665555788cffa +ff07fb4eb8d67587c97ffaff1586d49fe7afffffff9fe7ffff6ffff8f8ef +e6fffffff0e7ff007ef5ff03fac9ffdff0ff07db967665555788cffaff07 +fb4eb8d67587c97ffaff1586d49fe7afffffff9fe7ffff6ffff8f8efe6ff +fffff0e7ff00b8f5ff03fac9ffdff1ff06b643333343334ef8ff07f95faa +e6a566d79ffaff1586d49fe6affffffe8fe8ffff6ffff8f8ffd5fffffff0 +e7ff00b8f5ff03fac9ffdff1ff06b643333343334ef8ff07f95faae6a566 +d79ffaff1586d49fe6affffffe8fe8ffff6ffff8f8ffd5fffffff0e7ff00 +b8f5ff03fac9ffdff1ff06b643333343334ef8ff07f95faae6a566d79ffa +ff1586d49fe6affffffe8fe8ffff6ffff8f8ffd5fffffff0e7ff01f9bff6 +ff03cbb9fe8ff3ff01fe94fa33007ff8ff07f86f8af7d655d5dffaff1586 +d4aff5affffffe7fe8ffff7ffff7f7ffb5fffffff0e7ff01f9bff6ff03cb +b9fe8ff3ff01fe94fa33007ff8ff07f86f8af7d655d5dffaff1586d4aff5 +affffffe7fe8ffff7ffff7f7ffb5fffffff0e7ff01f9bff6ff03cbb9fe8f +f3ff01fe94fa33007ff8ff07f86f8af7d655d5dffaff1586d4aff5afffff +fe7fe8ffff7ffff7f7ffb5fffffff0e6ff007ef6ff03adc9fadff3ff08b5 +44333334333434dff8ff06f76f7bf97656e5f9ff1596e3bff4cfffffff9f +e8ffff7fffe8f7ffc8fffffff0e6ff007ef6ff03adc9fadff3ff08b54433 +3334333434dff8ff06f76f7bf97656e5f9ff1596e3bff4cfffffff9fe8ff +ff7fffe8f7ffc8fffffff0e6ff007ef6ff03adc9fadff3ff08b544333334 +333434dff8ff06f76f7bf97656e5f9ff1596e3bff4cfffffff9fe8ffff7f +ffe8f7ffc8fffffff0e6ff00d9f6ff03cae7f8fef3ff0083fb33014339f7 +ff06f68f6dfc5947c5f9ff15a5e3cff4aaa978998fd8fffc49ffe8f7ffcb +fffffff0e6ff00d9f6ff03cae7f8fef3ff0083fb33014339f7ff06f68f6d +fc5947c5f9ff15a5e3cff4aaa978998fd8fffc49ffe8f7ffcbfffffff0e6 +ff00d9f6ff03cae7f8fef3ff0083fb33014339f7ff06f68f6dfc5947c5f9 +ff15a5e3cff4aaa978998fd8fffc49ffe8f7ffcbfffffff0e6ff01facff7 +ff02f7e8c7f2ff079c665655469de63af7ff23f59f6ffe4b48c466677766 +78776656d4cff49bbba9978fc7fffe546db8f7ffcafffffff0e6ff01facf +f7ff02f7e8c7f2ff079c665655469de63af7ff23f59f6ffe4b48c4666777 +6678776656d4cff49bbba9978fc7fffe546db8f7ffcafffffff0e6ff01fa +cff7ff02f7e8c7f2ff079c665655469de63af7ff23f59f6ffe4b48c46667 +776678776656d4cff49bbba9978fc7fffe546db8f7ffcafffffff0e5ff00 +8ef7ff04fe8977fffcf3ff07c58e7ad9cfe864cff8ff23e59f6ffe7769c6 +eeeedddeddeeffc5e4cfd4dffffffb9fd7ffffac6478e8ffcafffffff0e5 +ff008ef7ff04fe8977fffcf3ff07c58e7ad9cfe864cff8ff23e59f6ffe77 +69c6eeeedddeddeeffc5e4cfd4dffffffb9fd7ffffac6478e8ffcaffffff +f0e5ff008ef7ff04fe8977fffcf3ff07c58e7ad9cfe864cff8ff23e59f6f +fe7769c6eeeedddeddeeffc5e4cfd4dffffffb9fd7ffffac6478e8ffcaff +fffff0e5ff01e7eff7ff0afa45dffcfffdbefdfffaeffaff07f7cd6ffcbf +fbf86ff8ff07b69e6fffd46bd49efaff15c6f3cfe4effffffccfe9fffe9f +fc67d9ffbbfffffff0e5ff01e7eff7ff0afa45dffcfffdbefdfffaeffaff +07f7cd6ffcbffbf86ff8ff07b69e6fffd46bd49efaff15c6f3cfe4efffff +fccfe9fffe9ffc67d9ffbbfffffff0e5ff01e7eff7ff0afa45dffcfffdbe +fdfffaeffaff07f7cd6ffcbffbf86ff8ff07b69e6fffd46bd49efaff15c6 +f3cfe4effffffccfe9fffe9ffc67d9ffbbfffffff0e5ff01fe7cf7ff09fe +74affcfcfe8cefffb6f9ff07fa9a8efe9ffffd4df8ff08b6cd7ffff55da8 +77dffbff15b6d4dfd4effffffddff9fffe9fffa9caffadfffffff0e5ff01 +fe7cf7ff09fe74affcfcfe8cefffb6f9ff07fa9a8efe9ffffd4df8ff08b6 +cd7ffff55da877dffbff15b6d4dfd4effffffddff9fffe9fffa9caffadff +fffff0e5ff01fe7cf7ff09fe74affcfcfe8cefffb6f9ff07fa9a8efe9fff +fd4df8ff08b6cd7ffff55da877dffbff15b6d4dfd4effffffddff9fffe9f +ffa9caffadfffffff0e4ff01f9bff8ff09fe946ffbfbfbcebfff5cf9ff07 +fe8e8afe9fcdff76f8ff0985e99ffff85e5adc69effcff15d6435554ffff +fffebff8fffe8fff8aabefaffffffff0e4ff01f9bff8ff09fe946ffbfbfb +cebfff5cf9ff07fe8e8afe9fcdff76f8ff0985e99ffff85e5adc69effcff +15d6435554fffffffebff8fffe8fff8aabefaffffffff0e4ff01f9bff8ff +09fe946ffbfbfbcebfff5cf9ff07fe8e8afe9fcdff76f8ff0985e99ffff8 +5e5adc69effcff15d6435554fffffffebff8fffe8fff8aabefaffffffff0 +e3ff00a9f7ff08f94dfbfce8df9ffbaaf8ff06df8a9bbfd8ffb7f8ff09d5 +65cffff86d658ee749fbff14ecbacefffffffe8fe5fffe9fff6656896cff +fffff0e3ff00a9f7ff08f94dfbfce8df9ffbaaf8ff06df8a9bbfd8ffb7f8 +ff09d565cffff86d658ee749fbff14ecbacefffffffe8fe5fffe9fff6656 +896cfffffff0e3ff00a9f7ff08f94dfbfce8df9ffbaaf8ff06df8a9bbfd8 +ffb7f8ff09d565cffff86d658ee749fbff14ecbacefffffffe8fe5fffe9f +ff6656896cfffffff0e3ff01fc7df8ff08fd46ebfdd9cb8ef8ccf8ff06fe +df97fff7ff98f7ff09faefffe89e6e859fd75bf5ff0d56a8fffebfffcdfe +dd648dfffff0e3ff01fc7df8ff08fd46ebfdd9cb8ef8ccf8ff06fedf97ff +f7ff98f7ff09faefffe89e6e859fd75bf5ff0d56a8fffebfffcdfedd648d +fffff0e3ff01fc7df8ff08fd46ebfdd9cb8ef8ccf8ff06fedf97fff7ff98 +f7ff09faefffe89e6e859fd75bf5ff0d56a8fffebfffcdfedd648dfffff0 +e2ff01e8cff8ff0797c8febc69caf8fbf6ff04a6ffe7ff6cf4ff1fc5ae7f +fc54bfe767777665555567988899aa86455557aaaaababbbb969fffff0e2 +ff01e8cff8ff0797c8febc69caf8fbf6ff04a6ffe7ff6cf4ff1fc5ae7ffc +54bfe767777665555567988899aa86455557aaaaababbbb969fffff0e2ff +01e8cff8ff0797c8febc69caf8fbf6ff04a6ffe7ff6cf4ff1fc5ae7ffc54 +bfe767777665555567988899aa86455557aaaaababbbb969fffff0e1ff00 +8ef8ff07f999aeae56e8f8fbf7ff05fd89bfbafb8ff4ff1fa5ac9fffd536 +ce4cedeeeecb99aa9cddccbbbbaa99a98aaaaaaaa98989fffff0e1ff008e +f8ff07f999aeae56e8f8fbf7ff05fd89bfbafb8ff4ff1fa5ac9fffd536ce +4cedeeeecb99aa9cddccbbbbaa99a98aaaaaaaa98989fffff0e1ff008ef8 +ff07f999aeae56e8f8fbf7ff05fd89bfbafb8ff4ff1fa5ac9fffd536ce4c +edeeeecb99aa9cddccbbbbaa99a98aaaaaaaa98989fffff0e1ff00edf7ff +0796eaaf859ba7fcdff8ff05ebfcbf7ef6eff4ff079478affffe95344eec +ff03d8fffff0e1ff00edf7ff0796eaaf859ba7fcdff8ff05ebfcbf7ef6ef +f4ff079478affffe95344eecff03d8fffff0e1ff00edf7ff0796eaaf859b +a7fcdff8ff05ebfcbf7ef6eff4ff079478affffe95344eecff03d8fffff0 +d7ff07fdbb9fd85da6bfaff7ff03e9ec8f7cf3ff1ffc75bfffffffd53899 +abccccccbbabbabaaabcdeedcb98888999a9987afffff0d7ff07fdbb9fd8 +5da6bfaff7ff03e9ec8f7cf3ff1ffc75bfffffffd53899abccccccbbabba +baaabcdeedcb98888999a9987afffff0d7ff07fdbb9fd85da6bfaff7ff03 +e9ec8f7cf3ff1ffc75bfffffffd53899abccccccbbabbabaaabcdeedcb98 +888999a9987afffff0d6ff06aad9ff96e86edcf7ff039dd7e8cff2ff00fe +fcff19fed787666556677788888999987667789bcccccccdeefffffff0d6 +ff06aad9ff96e86edcf7ff039dd7e8cff2ff00fefcff19fed78766655667 +7788888999987667789bcccccccdeefffffff0d6ff06aad9ff96e86edcf7 +ff039dd7e8cff2ff00fefcff19fed787666556677788888999987667789b +cccccccdeefffffff0d7ff07fddbfd98e67e77faf8ff03f9cd7ebdd3ffff +f0d7ff07fddbfd98e67e77faf8ff03f9cd7ebdd3fffff0d7ff07fddbfd98 +e67e77faf8ff03f9cd7ebdd3fffff0d7ff08fbaffffecd8ba9adbffaff04 +fe9bc7ebbfd3fffff0d7ff08fbaffffecd8ba9adbffaff04fe9bc7ebbfd3 +fffff0d7ff08fbaffffecd8ba9adbffaff04fe9bc7ebbfd3fffff0d7ff08 +bcdfffffefb7e88fbefbff04edcbee7eacd2fffff0d7ff08bcdfffffefb7 +e88fbefbff04edcbee7eacd2fffff0d7ff08bcdfffffefb7e88fbefbff04 +edcbee7eacd2fffff0d8ff09feb9fffffeecd7e98ffafcff09f857dfe7e9 +efffeca99ed6fffff0d8ff09feb9fffffeecd7e98ffafcff09f857dfe7e9 +efffeca99ed6fffff0d8ff09feb9fffffeecd7e98ffafcff09f857dfe7e9 +efffeca99ed6fffff0d8ff18faf8ffffffc9e8e89efe9fffffffe76cff8d +8cfd98adfbb8ced7fffff0d8ff18faf8ffffffc9e8e89efe9fffffffe76c +ff8d8cfd98adfbb8ced7fffff0d8ff18faf8ffffffc9e8e89efe9fffffff +e76cff8d8cfd98adfbb8ced7fffff0d8ff19f9f8ffffdbe7ca9caeff8fff +ffff8a6ff9c8ce875effeeff8bdfd8fffff0d8ff19f9f8ffffdbe7ca9cae +ff8fffffff8a6ff9c8ce875effeeff8bdfd8fffff0d8ff19f9f8ffffdbe7 +ca9caeff8fffffff8a6ff9c8ce875effeeff8bdfd8fffff0d8ff19f9f9ff +eacf9e9e7eadfbbfffffff6a7fc99cf7c746ca47bfe8bfd8fffff0d8ff19 +f9f9ffeacf9e9e7eadfbbfffffff6a7fc99cf7c746ca47bfe8bfd8fffff0 +d8ff19f9f9ffeacf9e9e7eadfbbfffffff6a7fc99cf7c746ca47bfe8bfd8 +fffff0d8ff09faebfdbfeadf8e8f9ef9fcff0b6a8f89afe77444b8498ff7 +bfd8fffff0d8ff09faebfdbfeadf8e8f9ef9fcff0b6a8f89afe77444b849 +8ff7bfd8fffff0d8ff09faebfdbfeadf8e8f9ef9fcff0b6a8f89afe77444 +b8498ff7bfd8fffff0d8ff09fdddfbfb9eff8b9f8fdbfcff0b5c8e68ff95 +433386447865afd8fffff0d8ff09fdddfbfb9eff8b9f8fdbfcff0b5c8e68 +ff95433386447865afd8fffff0d8ff09fdddfbfb9eff8b9f8fdbfcff0b5c +8e68ff95433386447865afd8fffff0d6ff17ce9effff9c8f9fbdfffffeff +6f7b5eff643343453543688fd8fffff0d6ff17ce9effff9c8f9fbdfffffe +ff6f7b5eff643343453543688fd8fffff0d6ff17ce9effff9c8f9fbdffff +feff6f7b5eff643343453543688fd8fffff0d6ff17e9efffffab6cdb9eff +fffdff6f8b4fff64434437443345bfd8fffff0d6ff17e9efffffab6cdb9e +fffffdff6f8b4fff64434437443345bfd8fffff0d6ff17e9efffffab6cdb +9efffffdff6f8b4fff64434437443345bfd8fffff0d6ff16dbffffffe89a +fabdfffffddf8bca7bff83436434433466d7fffff0d6ff16dbffffffe89a +fabdfffffddf8bca7bff83436434433466d7fffff0d6ff16dbffffffe89a +fabdfffffddf8bca7bff83436434433466d7fffff0d6ff16befffffff9b6 +cbeafeffffafb5fef9bfc359d834433598d7fffff0d6ff16befffffff9b6 +cbeafeffffafb5fef9bfc359d834433598d7fffff0d6ff16befffffff9b6 +cbeafeffffafb5fef9bfc359d834433598d7fffff0d1ff119c8ffbffefff +8ee58fff99e548784433455ed7fffff0d1ff119c8ffbffefff8ee58fff99 +e548784433455ed7fffff0d1ff119c8ffbffefff8ee58fff99e548784433 +455ed7fffff0d1ff01fccffcff0bb9fa8afffb7743333333548ed7fffff0 +d1ff01fccffcff0bb9fa8afffb7743333333548ed7fffff0d1ff01fccffc +ff0bb9fa8afffb7743333333548ed7fffff0d1ff00fafbff0cfa68858eff +fc87433333356549d8fffff0d1ff00fafbff0cfa68858efffc8743333335 +6549d8fffff0d1ff00fafbff0cfa68858efffc87433333356549d8fffff0 +d1ff00ebfaff0cb99a769effffdca7568effe69ad9fffff0d1ff00ebfaff +0cb99a769effffdca7568effe69ad9fffff0d1ff00ebfaff0cb99a769eff +ffdca7568effe69ad9fffff0d1ff00cff9ff03feffc7effcff03efffb68a +d9fffff0d1ff00cff9ff03feffc7effcff03efffb68ad9fffff0d1ff00cf +f9ff03feffc7effcff03efffb68ad9fffff0c7ff01fedffbff02fe645ad9 +fffff0c7ff01fedffbff02fe645ad9fffff0c7ff01fedffbff02fe645ad9 +fffff096fffff096fffff096fffff096fffff096fffff096fffff096ffff +f096fffff096fffff0 +grestore +showpage +%%Trailer diff --git a/contrib/groff/doc/gnu.png b/contrib/groff/doc/gnu.png Binary files differnew file mode 100644 index 0000000..019a7ae --- /dev/null +++ b/contrib/groff/doc/gnu.png diff --git a/contrib/groff/doc/gnu.xpm b/contrib/groff/doc/gnu.xpm new file mode 100644 index 0000000..bc54934 --- /dev/null +++ b/contrib/groff/doc/gnu.xpm @@ -0,0 +1,198 @@ +/* XPM */ +static char *noname[] = { +/* width height ncolors chars_per_pixel */ +"213 177 14 1", +/* colors */ +"` c #FFF", +"a c #DDD", +"b c #BBB", +"c c #999", +"d c #777", +"e c #555", +"f c #333", +"g c #EEE", +"h c #CCC", +"i c #AAA", +"j c #888", +"k c #666", +"l c #444", +"m c #222", +/* pixels */ +"`````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````", +"``````````````````````````````````````````gaahiibaag`````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````", +"``````````````````````````````````````acjjdddldjjkleeekdjia``````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````", +"```````````````````````````````````abbicli`hbjkdbelldddkdelldh```````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````iibkcjellcaeaklcelfljllkekdeeejba````````````````````````````````````````````````````````````````````````````````````````````gha````````````````````````````````````````````````````", +"```````````````````````````````bcagjcldkleljcdaelillfcdllfedeeelffc`````````````````````````````````````````````````````````````````````````````````````acdjddjccjjjch```````````````````````````````````````````````", +"`````````````````````````````hch```jflleeeelkkcbljdlfliellldeeeeeflkh````````````````````````````````````````````````````````````````````````````````hjkch`ah`ic`gaiicjja````````````````````````````````````````````", +"````````````````````````````cb``aeigjlefleellelhdlblllldllllcllekkeelcg``````````g``````````````````````````````````````````````````````````````gjcddiabjjdldkleklllliggcc```````````````````````````````````````````", +"`````````````````````````ggjag`accdehilefelelllehldjllleellleellekllleejb```````dki```````````````````````````````````````````````````````````gjlljbiiekkelllllllefedcdg`hjb`````````````````````````````````````````", +"````````````````````````gdhg`cdhadkdejilelelelekdelbllelelellkleelkfjeehiiihaaidbai``````````````````````````````````````````abg`````````````addijkdellelllelllllljckllkg``hcg```````````````````````````````````````", +"```````````````````````gjgdejijlcghkeljjllllkdhjklkdcleklklllllleleeededg`hidjb``ig`````````````````````````````````````````akdei````````ggacdkkkkjllllflllflflllleekddjcji``big`````````````````````````````````````", +"``````````````````````hdcjjceeekeei`hklkklledg`adebeclljelleleellelclkdlgg`aagg`ai``````````````````````````````````````````cg`bklkklllllllllkkeejlllfflekflellfleeelfllech```gcg````````````````````````````````````", +"`````````````````````cihdckkjkleelldggiklejca``````aahkkceedkekjekkjllclhghbikkhjg``````````````````````````````````````````ij`g`ghbcjekddbkeeeljlllflfleflklfflekledjccccjg````ia```````````````````````````````````", +"````````````````````hd``g``beedeeelkeb`gddhh```ghhhbbiekjhca`gjig`bgajab`gg``acc`````````````````````````````````````````````edagg`jeelleleeeeekeflfffleflefflelflklllelllledc```ba``````````````````````````````````", +"```````````````````gc``aga``gdllelkecec``bg`gckdibbbhahbcdddjccciiihhgg```gbjca```````````````````````````````````````````````clkdcaccklleleeeekcikekklflefflllflllllllllllllekj``bg`````````````````````````````````", +"```````````````````c``heledb``cllelebadj``gcdig`````````````gaaahhbhhhhhhgag```````````````````````````````````````````````````gcklflkjcaeekkjkjjddejdldkekdelllllfffffllleedjch```ig````````````````````````````````", +"``````````````````caagikelllkcgjekekdg`hgbca```````````````````````````````````````````````````````````````````````````````````````aidelllebag````````hkea`gelllfffffffffffffllkg``gb````````````````````````````````", +"`````````````````jbhdeecbbjefleckdciic`gca`````````````````````````````````````````````````````````````````````````````````````````````````````````````gikjgakffffffffflllekdkelkda`i````````````````````````````````", +"```````````````adllkchbklkbabkflecgg``ajg`````````````````````````````````````````````````````````````````````````````````````````````````````````````````hdhaffffllllejjdelfflleda`hh```````````````````````````````", +"```````````````jckllllejjeledahlfkhg`bjg````````````````````````````````````````````````````````````````````````````````````````````````````````````````````jiblleffffffffflekdkkelagb```````````````````````````````", +"``````````````hj``gbdlllleellljcebg`bc```````````````````````````````````````````````````````````````````````````````````````````````````````````````````````bjhcelffffllllllledddkc`i```````````````````````````````", +"`````````````gdhbbhihabklllleekkk``bc`````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````bj`hlfffffffffllleeekjhi```````````````````````````````", +"````````````gdgeeelllekcidllleeja`aj```````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````id`befffllfffffledibbgbg``````````````````````````````", +"````````````cb`hchgidellekjjeeaijbjg````````````````````````````````````````gabbiiiibhg`````````````````````````````````````````````````````````````````````````cdgkfffffffledjjkeekcah``````````````````````````````", +"```````````gd````gg```aclleddkg``da`````````````````````````````````````gbjkddjcccjddjddjia`````````````````````hbhag````````````````````````````````````````````iieffflfflfflkca`````b``````````````````````````````", +"```````````ca```hbiiibhggbeekh``ib````````````````````````````````````gdkchgabbccjjiicibbijjh````````````````gijccjjjcia``````````````````````````````````````````ddflleeeleellllkdh``i``````````````````````````````", +"``````````gj``clllffllllki`bcg`hj````````````````````````````````````hkcijccibag`gghbijkkjiidjh````````````bcibicjjiba`hba````````````````````````````````````````hjdleeelllffflllej``b``````````````````````````````", +"``````````cahjekdjcicjdella```gd```````````````````````````````````adldia```````````````ghjddkkda```````gcdjjdcbhgabicjighb````````````````````````````````````````daiefffffffflllekg`b``````````````````````````````", +"``````````j`ccjjjddkeekdcddb``ia``````````````````````````````````iejg```````ah`g```hg``````gbjelc````acckjhg``bebgh```hjcg````````````````````````````````````````chjeffffffllffllkdchg`````````````````````````````", +"`````````iiallllllekjiijkedka`c``````````````````````````````````ijg`````g````chjjeagkdh``ghcb`ajljaaibcjg````gdeleld````gjc```````````````````````````````````````ac`kleiiklflkcklleghg`````````````````````````````", +"`````````kkkellekekellejaghcb`c`````````````````````````````````cb```````chjacciicljeckdggkdkkh`chkebgjjbg`ahijallldflcig``ajh``````````````````````````````````````dallffldcjlfljkjlgaa`````````````````````````````", +"````````bjjjiiijjddkeeeelhg``ab```````````````````````````````gjh`````hcbciiibkcbdlbkcejkjkeekebikadjkbdeecheakllcleiflkeaicgijg````````````````````````````````````djkllfflflkjefleb`bh`````````````````````````````", +"````````kg`aabcjkeeellleekc``ig```````````````````````````````jg``````jjdbjijhedhkkjjdldejdeldklkeeijkcgkllekkaeljifclffffffebada```````````````````````````````````cillfffflllldcllb`bi`````````````````````````````", +"```````gd``hellllleeeeekkkka`j```````````````````````````````jh`bgijkgieeakcdgekaedeielklejelkeelfeeiklbilellfcbflhlelfflffffleidb``````````````````````````````````caelleeelffllebkeabi`````````````````````````````", +"```````bigcellllllllllleldgggc``````````````````````````````chaacbhkebaeeakdd`ekgedlhlelleckleellflekjeeaeeekeladfjkleffllefffflbcc`````````````````````````````````ibllllfleelfleljjeic`````````````````````````````", +"```````jacllledjbcbhbidefekgch`````````````````````````````ci``dkj`elcgeeijed`eealkfblllleceldklelleekeeibejljllifdjlklfkfdllfffebbj````````````````````````````````biillflllfleelllljgc`````````````````````````````", +"```````d`becbbijdelllllejag`j`````````````````````````````bhgc`iek`klj`keccek`eealdlclllllikedjlekfleeclebkeclblelkhfelfkfjelfffflcbc```````````````````````````````ibilfffleefffllflkgc`````````````````````````````", +"```````d``bjelflkdjjdjdekchgc````````````````````````````gj``ddkee`kle`dekilkgeeildldllellbekkildeleelillkjlkldcjklilelfefdelflflflcch``````````````````````````````jadklffffekjkflllkai`````````````````````````````", +"```````j``jlejcjdkeeekdkkihac```````````````````````````gdggccbllegdelgclecle`elhejlkelellbeddhlkleleljekklejieaehfjklllkelelflflflljkg`````````````````````````````d`jihdffffflddlllk`ig````````````````````````````", +"```````j`gedkellleekkkekdihgc```````````````````````````jabbkicellajelaileilk`klaejleelkllhedkhljejeelkeedjj`gjbjlldjllelklllleflflllkda```````````````````````````gjgeellfffffleedeelhba````````````````````````````", +"```````i`hedeeekkkkeekellljaj``````````````````````````jh``kljcdfehjelbheehekgelaejlleljllhedjaljeikdeelffildh`cklleblleldfellklllfllleka``````````````````````````iigedfffffffffeejelgba````````````````````````````", +"```````a`cilledjiabcjelleb``j`````````````````````````ci```kljjiflhceliaelakkgllalcllllkeebkdcalieheckkkhchlleb`bflfbeleeefkllkellfllllekg`````````````````````````jg`aelfffffffffeeilhbg````````````````````````````", +"`````````kdba`gikelkcjjkeeh`j````````````````````````iia``eeljdhflhcelcallhdkhllblielleelkcdebhliealieea`ahffflelflfddfeeeflllekllflllfllk`````````````````````````d``ilfleffffffffldhgbg````````````````````````````", +"```````h`c`bjelekjdeelffleh`j```````````````````````ij`bcallljkgflidelchleakkileclillllllkkjehildkcljlligegeflkeeelfkjflelfllleelelellffllkg```````````````````````d`aeffflkfflfffflea`bg````````````````````````````", +"```````b`gieejdellllkcdked``j``````````````````````ic``geglllkk`leideejblegedkfkclbllelledlakhcedkeekfldglabdldhiellkjflllflleellellelfefllkg`````````````````````akelflffflklfllffljc`b`````````````````````````````", +"```````iggjjdelllecbjelljh`ach````````````````````ci````ebelekegeljkeldjldalklljkkjllefeledilcec`gcikellaei``blljkjkkjflllflllkllellklfdlllkjg````````````````````cejblffffffklfflfld``i`````````````````````````````", +"```````iahcjelecaiefldjledjiaj```````````````````jb``bb`djllekk`eljeeleeljjllllkljefelfklkkck`gahahjlilkeeeg``ielfeleblllllflldllklleeldkleiadih``````````````````dlaelfffffffelfflfi``b`````````````````````````````", +"```````bcbiekhgceflddelllecj`d`````````````````gdh```he`ckeleek`keeleellejlkideddieekeddb`dddjeeeldidbkjfjfkihggkfleehellellllkledlfkelljledgaci`````````````````bjkkfffffffffflfflfk``i`````````````````````````````", +"```````gjgaigcllllellkellebagib```````````````gda``ghgegbeeelkk`eeeldli`accajliiiceledjjjdlleigahlb`jididkkffleeffebdbjljdllklldicllklllelllj``cc```````````````gdgjflfflfflfffflfflfi`b`````````````````````````````", +"````````dgghekbklflkellleekkhgc``````````````gda````dhdbieekeekkljdjjlckflkkeekddjjjdkkkdjcbg````keacfejhejeleeceliajhdflleefleekklllllfflellh`gkc``````````````dballfflfffflffffffla`bg`````````````````````````````", +"````````dhclddllleelllelllebg`jh````````````gja`````ijjdblkklljjkghdlejig```````````````gg```````gljghefecljlfdcej`cekkibjdabg`ghiickdkdeedledjagkc````````````jdbkfffffffffffffffflg`c``````````````````````````````", +"````````icdbbkllllllejellkllc``jb``````````gdg````ighdbkhlkelebadedch`````````````````````````````hedahkffefklelfiejg`````bdc````````ahbjkeedleeh`cdh``aag``gieeklclffflffffffflffli`ai``````````````````````````````", +"````````hcghklllllljdelldefle```jc````````hjg```gikbhkbljlcecjkkig`````````````````````````````````gdlejjellffflelc`````````bkg``````````abkjeeelb`hkellekbjldgdgkfflffflffffffflfk``cg``````````````````````````````", +"````````gdikllkeleceklljeflklh```jja````acc`````hckcgececedlkig```````````````````g`````````````````gilelejcfffkjla````ag````hk`````````````ieeekfeh`ghjkkjig``dklelmfffflfffffffflb`c```````````````````````````````", +"`````````dakejelkjedlldklldlleg```bcjjjjca``````jcedgekllecg`````````````````gicekj``````````````````ggabjleffcadeb```hed`````bd`````````````ggkllffjgba`bccgihefffeefffffffffffflkdhh```````````````````````````````", +"`````````ibdielkdlkeedkllddellbch``````````aghaieaekglfda````````````````ghiiiaifeg`````````````ggg```ggagblfkgdljd``cijdg`````ci`````````````haeelffllljelfllfffffflffflffffffllldic````````````````````````````````", +"`````````hcgclkklkeedkllejldfleehg`````````ccbjdeadejfj`````````````````hllkkeeffc`````````````gdlleg````g`ceebfflkghjklkg````g`ka````````````abcllfffffffffflfffffffffffffffffflj`gc````````````````````````````````", +"``````````d`cdkleekkklledlklfleedd`aa`````gilildeajlfl`````````````````illlflfffk```````````````ajllig``g```aeefffj`clffi`````h`bd`````````````baelfflfffffffflffllfffffflffffllfa`ia````````````````````````````````", +"``````````jagbledjkklfdkeedffelflecbkd````icldejlbjfed````````````````glfffllffkg````````````````gilkh``g``hkllfejagklfla````gb``k`````````````gccllfffffffffffffffffffffflmffflfhgi`````````````````````````````````", +"``````````bb`bkkckclleeeljlflkfleeljke`igabkleeclikfcg````````````````cflfflffj```````````adeeja```iiih````blfkjia`gkffja`````h``dg`````````````hjllffffffffflflfffffffflfffffffegcg`````````````````````````````````", +"``````````gc`beakbellkeleellleflellkje`ddgdklekdlele`````````````````alffeffdh``````````beffeklk`````hjbb``gijig``gadffiibiiaga``jg``````````````jelfffffffffffflffffffffffffllldbb``````````````````````````````````", +"```````````jheajckeldellklllllflleeeie`dehkkelkklljc`````````````````kffelfjb``````````clkig``dlg`````aej````g`````iclfkja`hjhh``d```````````````bllfffffffffffffffffffffffflldeic```````````````````````````````````", +"```````````ikagjdekedlekllelelllfkelbk`ekikdelelfba`````````````````blfkdlkcb````````hkeh`````jlc`````bkc``````````jjffedh`ggb``gk```````````````akelfffffffflllffflffffffffefiahh```````````````````````````````````", +"```````````gj``idekjekeellklkfllleeeiegekidjleefe``````````````````hefd`ai`e````````ifj```````allg`````iig`````````cjfflb```````bd```````````````bklfflfffffffllffflfffffflfekkgc````````````````````````````````````", +"````````````cg`deckjeledleellfelleeedebleidkellfb`````````````````hedi````hk````````ed`````````cfa`````hejg````````iefffcg`g````jb````````````````jlfflfffffffllffffflffflffb`djh````````````````````````````````````", +"````````````hb`bedcelekjljllllllleeeeljeeckdelfl`````````````````acbi`````ki```````hea```hbcjdkkfc`````gelb````````hefffekddcb``ja`````````````````hllfeffffffllllffffllfklk`gji`````````````````````````````````````", +"`````````````j`gicclejceejlefllllcekledleckkllfd``````````````````gjg````gla```````ifj`beffflffffeh`````hlb````````gcfffffffffecdb``````````````````dlfeflffffflllfflfefeeec`gj``````````````````````````````````````", +"`````````````bi```jkdjhlklllflllehekleellbkkkllb``````````````````gg`````ik````````aflefffflfffjclb``````kb`````````alfellekjdellc``````````````````hlflfffffffllllelfefdhb`ajg``````````````````````````````````````", +"``````````````jg```khjcldlllllllkbekleeeebkdellg`````````````````````````di````````gefffflfffffjbcd``````gia`````````klkleleeeddllg``````````````````effflfffflfffleffek```bkg```````````````````````````````````````", +"``````````````gjg``jgidelldflleljjkelleeebekklj``````````````````````````lg`````````effejlffleffjida``````dc`````````glkcffflfedddh``````````````````kllleffffffllkkkecg`idda````````````````````````````````````````", +"```````````````aca`hgbkeeceffjllieceelekeieeelg`````````````````````````gk`````````glebahlfflllfkgag``````kd`````````gdldfflffldjcg``````````````````blllkfffflllejgkkbdejg``````````````````````````````````````````", +"`````````````````jg`ggkkcilfljlejeblkedklclefh``````````````````````````ci``````````lh``affffflfeaig`````gea````````gghefffffffkb````````````````````akcbklfflejdlbakfkb`````````````````````````````````````````````", +"`````````````````gc```icbkflieldkjiebeeeecelc```````````````````````````dg``````````jj`g`efffffldde``````ji``````````ggblfffffekdkj```````````````````hc`bjdah`gajdkia```````````````````````````````````````````````", +"``````````````````hb``bigjkeclddeakkjleldkee````````````````````````````k```````````gddhahlffflkiek`````````````````````jfffffddjle````````````````````ekkjjddddjba````````````g``a`a````````g```````````````````````", +"```````````````````aigg```aieeblibejkeelcelb```````````````````````````hlg`````````ggailc`ajjcjcbec`````````````````````alleekchclh````````````````````bagagg```````````ag``gejb``kgk````gbagecdbabg`````````````````", +"`````````````````````iba```hbblcgkb`dkeljel````````````````````````````ceg`````````````akdiibdeeej```````````````````````clekkcjeca`````````````````````j```````````````ilh``dfj`gedc`hb`gdkabelcbkeddi``````````````", +"```````````````````````hih`hcliidc`akjeeedj````````````````````````````ecg````````````gg`acjcibag`````````````````````````clddedai``````````````````````ca```````````````bea``ek`alegblja`ieeajlcblkbkg``````````````", +"`````````````````````````gbibg`gh``hagjhaea```````````````````````````gkig```````````````gg```gg```````````````````````````kla```h``````````````````````gj````````````````akg`ajggeaalfkb``jlkaljhlhkg```````````````", +"````````````````````````````bbbbhg``````ge````````````````````````````cjhh``````````````````g`a````````````````````````````aej```cd``````````````````````j`````````````````ik`````ghecfejjdkllklkdeejig``````````````", +"````````````````````````````````ghbhhg``kc````````````````````````````eh`ihg````````````````````````````````````````````````ilh``bej`````````````````````bh`````````````hiiceddkkkklkdjjjcbag``c`````gb``````````````", +"`````````````````````````````````````ahclg```````````````````````````afg`bha`````````````````````````````````````````````````dd``glka`````````````````````c`````````````dbhhjcbhg``````````````i``````b``````````````", +"```````````````````````````````````````ck````````````````````````````dfh`gaa`````````````````````````````````````````````````bla``idjg````````````````````ai````````````j```h``````````````````i`````gb``````````````", +"```````````````````````````````````````lh```````````````````````````aelg```g``````````````````````````````````````````````````cj```eadgg```````````````````cg```````````c``gi`````````gaabbicccdibdciab``````````````", +"``````````````````````````````````````hk````````````````````````````dceka`````````````````````````````````````````````````````geg``djgda```````````````````gc``````````adjdkejicjddkelledjedckijaaeeich``````````````", +"``````````````````````````````````````di```````````````````````````he`bd```````````````````````````````````````````````````````ek``ce`gch```````````````````ab`````````gcidkjlbbbckjadlb``dj`c`ga`cda````````````````", +"`````````````````````````````````````glg```````````````````````````dj`ce````````````````````````````````ga`````````````````````aea`ilg``iig``````````````````ba```````````cbae```gki`cli``dd`c``g`gda````````````````", +"`````````````````````````````````````bk```````````````````````````hlg`bkjg```````````````````````````gggblig``gh````````````````jj`hli```gjcg`````````````````ig``````````jbbe````ki`ilc``dd`c`````da````````````````", +"`````````````````````````````````````di``````````````````````````gec``ajegg`````````````````````````ckkdjcecaaaa````````````````gkbaec`````accig```````````````cjg````````kbhe````ei`ilj``jk`j``g``da````````````````", +"`````````````````````````````````````lg``````````````````````````dd````hkkj```````````````````````````````hjkkdjdjjjjb```````````bkhec````````acjbg`````````````gjg```````diak```gei`blc``de`j`````da````````````````", +"````````````````````````````````````he``````````````````````````ikg`````dela````````````````````````````ghbhhhaaggg```````````````kjei```````````bdjiag```````gbiig```````dbak````lb`bli``de`j`````da````````````````", +"````````````````````````````````````jc````````````````````````gdk````````bkb`````````````````````````akkdjddkeleja````````````````ilkh``````````````hcjjccccjcbg``````````dbhd````ei`hec``dk`j`````ka````````````````", +"````````````````````````````````````eg```````````````````````geea`````````ib`````````````````````````ei````````gbjejg`````````````aelg````````````````````````````````````jbhd```gli`hei``dd`j`````kg````````````````", +"```````````````````````````````````be```````````````````````hlla``````````g`````````````````````````cj````````````adlb`````````````hlbg```````````````````````````````````dbbd```gli`ali``jd`j`````kg````````````````", +"```````````````````````````````````kb``````````````````````allh````````````````````````````````````hla``````````````bejg````````````dla`gahjji````````````````````````````dbbd```glc`glb``dj`d`````kg````````````````", +"``````````````````````````````````be``````````````````````beeh`````````````````````````````````````kh`bklljg``````````iei```````````ckelleedddka``````````````````````````dbbd```glc`glh``dj`j`````kg````````````````", +"`````````````````````````````````geh```````````````````gikejg`````````````````````````````````````gk`jfeddeea``````````akkb````````````g``````aeg`````````````````````````dbij```glc`glh``jj`d`````kg````````````````", +"`````````````````````````````````ec`````````````````gbdledi```````````````````````````````````````ijifd````hg````````````ieda``````````````````ij`````````````````````````dbbj```ali`gla``jc`d`````kg````````````````", +"````````````````````````````````jk````````````ghijdkkdjhha````````````````````````````````````````daefb```````````````````gdeb``````````````````e`````````````````````````dhbj```ali`glh``ih`j`````k`````````````````", +"```````````````````````````````ilg`````````bdelkjbg``gcabcg```````````````````````````````````````kajlg`````````````````````jei`````````````````ka````````````````````````khbj```hlb`bla``jh`d`````e`````````````````", +"``````````````````````````````ila````````cedccb````````ijib```````````````````````````````````````kahe````hdledcg````````````i``````````````````jb````````````````````````khic```hlb`blh``jh`d`````e`````````````````", +"`````````````````````````````ilh````````jlg`gc`````````gjdb```````````````````````````````````````bg`a````deahikeg``````````````````````````````ic````````````````````````kaic```hlb`blh``jb`d`````e`````````````````", +"````````````````````````````dfb````````alb``ca``````````hlg```````````````````````````````````````ah`````glfklfekd``````````````````````````````ic````````````````````````khcc```blb`blh``jh`d`````e`````````````````", +"```````````````````````````cfc`````````kk```d````````````k``````````````````````````````hg```````````````glfffffekcia`````````````````````````abdh````````````````````````eacc```bliiefc``dh`d`````e`````````````````", +"```````````````````````````ed`````````blb```d````````````db```````````````````````````gag````````````````gkffffffbelkg```````````````````````gjde`````````````````````````kaic```bldcahkb`kh`d`````e`````````````````", +"```````````````````````````lg``gikcghjlc```gj````````````je````````````````````````gjkka``````````````````gkfffflaeefi```````````````````````dedd`````````````````````````eabj```blk``ghegkh`d`````e`````````````````", +"```````````````````````````ddjkfeddflda````bc````````````ceb``````````````````````akig``````````````````````bjig``eblk``````````````````````jflld`````````````````````````kghj```bli```cflllcd````ge`````````````````", +"```````````````````````````gccib```ga``````ib````````````jhc``````````````````````ea``````````````````````````````khbfg````````````````````jlfflh`````````````````````````egbc```bfj``glkdleid```gbk`````````````````", +"```````````````````````````````````````````ca````````````j`j``````````````````````````````big`````````````````````ehgli``````````````````gdlfffd``````````````````````````egbj```ile``ge``kh`dgiaaik`````````````````", +"```````````````````````````````````````````ja````````````j`j````````````````````````````helkli`````g`````````````gk``ed````````````````gbklffleg``````````````````````````lgbj```cllh`jj``eb`difdbik`````````````````", +"```````````````````````````````````````````ch````````````cgd````````````````````````````iga`geb``ag``````````````````cc`````````````ggadlffflkb```````````````````````````labc```jlka`ec``kb`difehid`````````````````", +"```````````````````````````````````````````ch````````````ihja````````````````````````````````hla`j```````````````````````````````````hklffffdj````````````````````````````lhic```kfcggjli`eb`djflbcd`````````````````", +"```````````````````````````````````````````ib`````````````ijeg````````````````````````````````dcgj`````````````````````````````````gjefffffekg````````````````````````````laieejelledecieieb`dhkcbcd`````````````````", +"```````````````````````````````````````````bc```````````````cd````````````````````````````````akii````````````````````````````````gdlflffflka`````````````````````````````laijeggabijkellllb`dga`bcd`````````````````", +"```````````````````````````````````````````aj```````````````gkh````````````````````````````````cki```````````````````````````````gdlflffflkg``````````````````````````````eajkkjihg``````geb`dg``hcd`````````````````", +"```````````````````````````````````````````gd````````````````jc````````````````````````````````gej```````````````````````````ggagdllllfflka```````````````````````````````dadlklekeeekkkkjeb`d```acj`````````````````", +"````````````````````````````````````````````d```````````````gbj`````````````````````````````````be``````````````````````````````hjjcdeelecg```````````````````````````````khjeeeb`````ghejeb`d```aij`````````````````", +"````````````````````````````````````````````d```````````````baj``````````````````````````````````kh`````````````````````````````gg``gabi`ajg```ggga``````````````````````gkckecd`g``````aeeb`k```gic`````````````````", +"````````````````````````````````````````````dg``````````````abch`````````````````````````````````bj````````````````````````````````````````bkdkekdklkkka```````````````ajllflkejibhgggghbkli`k```gij`````````````````", +"````````````````````````````````````````````cb```````````````chj``````````````````````````````````dg````````````````````````````````````````hh```gbg`gdi```````````````jkiicjcccijdkllllfkli`k```gic`````````````````", +"````````````````````````````````````````````bi```````````````gceih````````````````````````````````aj`````````````````````````````````````````ba`cdhhgggkg`````````````bjkellkkeekdeclkkkllligk```aci`````````````````", +"````````````````````````````````````````````aj`````````````````bhbjjg``````````````````````````````aj````````````````````````````````````````gcgblfjkg`hd``````````````gbdklcedihbedekellklcae```aji`````````````````", +"`````````````````````````````````````````````d`````````````````hb``ajjg`````````````````````````````hc```````````````````````````````````````adgaelfcg``ji````````````````ge`dig`gkghabaahejak```hji`````````````````", +"`````````````````````````````````````````````d``````````````````biih`adh`````````````````````````````hc```````````````````````````````g``gbiikfjgjeld```aea```````````````ge`kiaghejaggbbiedgk```bji`````````````````", +"`````````````````````````````````````````````ih```````````````````gbch`da`````````````````````````````jkh`````````````````````hckkeeeekdcjkdlielbieeeh```hka`````````````gbebdkeellleekcidfj`k```ijjhhhha````````````", +"`````````````````````````````````````````````ac``````````````````````ibjki````````````````````````````gdlcg``ghbhgg```ggacckelfflllllffffflbagbfkilelddcbghkjg``````````bkllllllllllelllekligk```ajeeeelleka`````````", +"``````````````````````````````````````````````k``````````````````````gccgd``````````````````````````````ileeefflkchahabklfffffffffffffffflc````dflfelkcdkkddlkjjjcjjccccklllleeeeeleeeeeleli`k````jklellllljci```````", +"``````````````````````````````````````````````ja`````````````````````cgj`j```````````````````````````````hllebahabcdelffffffffffflllffllfj`````aleejllkdjba`aihgbiibibibijcccccccccccccjddeh`eg```djbbhbiiiibdd``````", +"``````````````````````````````````````````````aj`````````````````````jacih````````````````````````````````gefllllflfffffffffllfflekkeelfd``````glkkjedghifdbgjdjjdkdjjjjjjddjdccccjiiibbbiebheg```djccjkkkejjkc``````", +"```````````````````````````````````````````````d`````````````````````cjgjg`````````````````````````````````hdlffffflkjjjjdibhbiig`g`agaci```````ljjkkk`gafldhlcaahbbiibbbideilkchjehhhahhbdabeh``gdh```jbak``ch``````", +"```````````````````````````````````````````````d`````````````````````dj`j`````````````````````````````````````gahaaag``````````````````aj```````edbejea`glldhlb```````````jkglcg`id```````jggeh``ada```jhgk``ca``````", +"```````````````````````````````````````````````ja````````````````````djhi``````````````````````````````````````````h```````````````````gd``````gejhkclc`geecbla```````````id`lj`gcc```````j``ea``gka```chgk``ca``````", +"```````````````````````````````````````````````bi````````````````````ckhi``````````````````````````````````````````````````````````````bj``````gejajcee``kehbk````````````ckgej``jj``````adggea```ka```jhad``cg``````", +"````````````````````````````````````````````````d`````````````````````dcj``````````````````````````````````````````````````````````````ka``````aejgddkeg`kkgcd````````````ck`ed``cj``````ad``eg```ka```jaaj``jg``````", +"````````````````````````````````````````````````bi`````````````````````kkh````````````````````````````````````````````````````````````hk```````akcgkkjebgkk`jj````````````ck`ec``cc``````gj`gk````eg```jghc``d```````", +"`````````````````````````````````````````````````d`````````````````````gjd```a```````````````````````````````````````````````````````gda```````hei`kdcfjakd`ki````````````ieaec``jc```````c`gd````eg```j`bi``d```````", +"`````````````````````````````````````````````````ch``````````````````````bb``d`````````````````````````````````````````````````````ajjg````````behgkdcfeadjgeg````````````cehlc``jc```````c`gd````eg```j`ib``k```````", +"`````````````````````````````````````````````````aj```````````````````````iggj```````````````````````````````````````````````g`gbjjig``````````blghjicllbdiae`````````````ckhlc``di```````c`gd````e````j`ca``d```````", +"``````````````````````````````````````````````````dg```````````````````````ihc``a`````````````````````````````````abckdkkeeeedjjh``````````````blgbjakdejdhcd`````````````jkalc`gdi```````c`gd````k````j`jg`gk```````", +"``````````````````````````````````````````````````bj```````````````````````ihc``a```````````````````````````````bklffffflffflg`````````````````ce`iigkiekkadc`````````````jkalc`gki``````gj`gj````k````j`j``ae```````", +"```````````````````````````````````````````````````cb`````````````````````hbbc`gj````````````````````````````gclffffffffffffd``````````````````jk`ji`dakeeaea`````````````jkali``ei``````gd`gj````d````d`d``be```````", +"````````````````````````````````````````````````````dg````````````````````iahc`ia```````````````````````````bellffffflffflfla``````````````````dk`db`cdkekge``````````````ckgfb``lh```````c`gj````d```gj`d``hj```````", +"````````````````````````````````````````````````````ac````````````````````higd`j`g``````````````````````````jffffffffffflffc```````````````````kj`ka`hecldhe``````````````iegfh``liiicdjccj`aj```hlc``gj`d``hb```````", +"`````````````````````````````````````````````````````ih````````````````````dgjhd````````````````````````````chkkekeelkcagkfi```````````````````ec`k``glbljhlkkkdddkkdjddkkekalh``lcbbbiccdj`hd```gelkabj`d``hi```````", +"``````````````````````````````````````````````````````jg```````````````````gjcdd```h``````````````````````````hejgdiach`gjklh`````````````````gec`k``gddkchkggggaaagaagg``heglh`ala``````bc`ad````ihkldjgj``hi```````", +"``````````````````````````````````````````````````````gdg````````````````````ilea``h```abg`a```ig``````````````dhak``hb``b`jk`````````````````bkcgk```alkbalcg````````````hk`fh`glg``````hh`gc```gc``hkdac``bb```````", +"```````````````````````````````````````````````````````gdh```````````````````gdli``h`h`gjhg```bk```````````````icijg`gc````ala````````````````bkhad````eeaijdda```````````bkala`alg``````aa``c```gc```ichi``ia```````", +"`````````````````````````````````````````````````````````cb``````````````````gclk``b`b`bhgb```eh```````````````gjgji`gc`ha``dk````````````````jegcc````jegeiahkcg`````````aklfeeel```````gb``j```gj```jiibg`i````````", +"``````````````````````````````````````````````````````````ic```````````````````cla`b`hgja`c``bii````````````````a`jicbb`aj``bd````````````````aekeh````jkakejggdlc``````````ghbihg```````gj`ge```gc```kkekjckh```````", +"```````````````````````````````````````````````````````````hda`````````````````alkgb`aachbjg`jhh`````````````````ga`cd```d``cj```````````````````ig```gjcgkgjec`adeb``````````````````````ekij```gb```ha`gaaklja`````", +"````````````````````````````````````````````````````````````gjh`````````````````cdhj`gbhkchi`j`b````````````````````ik``gd``kh````````````````````````heigd``helb`gdkddddkkeeeeekdcjjjcciijkleeeediiiiibibbbbckc`````", +"``````````````````````````````````````````````````````````````jg`````````````````cccigigekgj`j`b```````````````````ajcb`bi`bj`````````````````````````ieihc```aefkhglhgagggghbcciichaahhbbbbiiccicjiiiiiiiicjcjc`````", +"``````````````````````````````````````````````````````````````ga``````````````````ckgii`jecbid`ha`````````````````gb`hb`dg`kg`````````````````````````cldji````gcefllg````````````````````````````````````````aj`````", +"```````````````````````````````````````````````````````````````````````````````````abbc`ajeaikb`i```````````````````gcghj`dh```````````````````````````hdeb```````aefjccibhhhhhhbbibbibiiibhaggahbcjjjjccciccjdi`````", +"````````````````````````````````````````````````````````````````````````````````````iiac``ckgjkgah``````````````````caadgjh``````````````````````````````g`````````gadjdkkkeekkdddjjjjjccccjdkkddjcbhhhhhhhagg```````", +"```````````````````````````````````````````````````````````````````````````````````aab`acjgkdgdd`i`````````````````chadgba```````````````````````````````````````````````````````````````````````````````````````````", +"```````````````````````````````````````````````````````````````````````````````````bi````ghajbiciab``````````````gcbhdgbb````````````````````````````````````````````````````````````````````````````````````````````", +"``````````````````````````````````````````````````````````````````````````````````bha`````g`bdgjj`bg``````````gahbggdgih`````````````````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````gbc`````gghadgcj``i`````````jeda`gdgcg```ghiccg`````````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````i`j``````hcgjgjcg`gc```````gdkh``jajh`acjia`bbjhg```````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````c`j````abgdhichig``j```````jik``chjhgjdeg``gg``jba``````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````c`c``gih`cgcgdgia`bb```````kid`hcch`dhdlkhildb`gjb``````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````igb`ab`gia`jgj`cg`c````````kij`jci`gddlllbjlcj``db``````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````aaa`b`bcg``jbc`j`ab````````ehjgkj``celfffjklldjkei``````````````````````````````````````````````````````````````````````````````````", +"````````````````````````````````````````````````````````````````````````````````````hgcg````chj`c`ba`````g``k`dbeg``klfflflefelfkjj``````````````````````````````````````````````````````````````````````````````````", +"````````````````````````````````````````````````````````````````````````````````````gcg`````ibkhabcg`````a``k`jbl```kllfllfdllffleb``````````````````````````````````````````````````````````````````````````````````", +"````````````````````````````````````````````````````````````````````````````````````ab``````gjci`iba`````aa`jbhidb``jflfklfllfflkk```````````````````````````````````````````````````````````````````````````````````", +"````````````````````````````````````````````````````````````````````````````````````bg```````cbkhbgi`g````i`be`g`cb`hfecajfllffecj```````````````````````````````````````````````````````````````````````````````````", +"``````````````````````````````````````````````````````````````````````````````````````````````chj``b``g```jggej```ccgeljdjllffleeg```````````````````````````````````````````````````````````````````````````````````", +"```````````````````````````````````````````````````````````````````````````````````````````````hh`````````bc`iji```bddlfffffffeljg```````````````````````````````````````````````````````````````````````````````````", +"```````````````````````````````````````````````````````````````````````````````````````````````i```````````ikjjejg```hjdlffffffekelc`````````````````````````````````````````````````````````````````````````````````", +"``````````````````````````````````````````````````````````````````````````````````````````````gb````````````bccidkcg````ahidekjg``gkci```````````````````````````````````````````````````````````````````````````````", +"``````````````````````````````````````````````````````````````````````````````````````````````h````````````````g``hdg`````````g```bkji```````````````````````````````````````````````````````````````````````````````", +"```````````````````````````````````````````````````````````````````````````````````````````````````````````````````ga````````````gklei```````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````", +"`````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````" +}; diff --git a/contrib/groff/doc/grnexmpl.me b/contrib/groff/doc/grnexmpl.me index f7f684c..54dbb18 100644 --- a/contrib/groff/doc/grnexmpl.me +++ b/contrib/groff/doc/grnexmpl.me @@ -1,9 +1,7 @@ -.sc .nr pp 12 .nr tp 12 .nr sp 12 .nr fi 0 -.st ug .ls 1 .po 1i .pl 11i diff --git a/contrib/groff/doc/groff b/contrib/groff/doc/groff new file mode 100644 index 0000000..190fc84 --- /dev/null +++ b/contrib/groff/doc/groff @@ -0,0 +1,297 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +Indirect: +groff-1: 1001 +groff-2: 48538 +groff-3: 97766 +groff-4: 140652 +groff-5: 187441 +groff-6: 231433 +groff-7: 275695 +groff-8: 325582 +groff-9: 372274 +groff-10: 420373 +groff-11: 430355 + +Tag Table: +(Indirect) +Node: Top1001 +Node: Introduction2290 +Node: What Is groff?2764 +Node: What Is groff?-Footnotes4270 +Ref: What Is groff?-Footnote-14339 +Node: History4376 +Node: groff Capabilities9327 +Node: Macro Package Intro10513 +Node: Preprocessor Intro11135 +Node: Output device intro12631 +Node: Credits13095 +Node: Invoking groff13599 +Node: Groff Options14876 +Node: Environment24383 +Node: Macro Directories26210 +Node: Font Directories27532 +Node: Invocation Examples29179 +Node: Invocation Examples-Footnotes30377 +Ref: Invocation Examples-Footnote-130456 +Node: grog30689 +Node: Tutorial for Macro Users31958 +Node: Basics32378 +Node: Basics-Footnotes37183 +Ref: Basics-Footnote-137236 +Ref: Basics-Footnote-237330 +Node: Common Features37444 +Node: Paragraphs38230 +Node: Sections and Chapters39728 +Node: Headers and Footers40219 +Node: Page Layout Adjustment41092 +Node: Displays41359 +Node: Footnotes and Annotations42617 +Node: Table of Contents43276 +Node: Indices43790 +Node: Paper Formats44192 +Node: Multiple Columns44565 +Node: Font and Size Changes44813 +Node: Predefined Strings45115 +Node: Preprocessor Support45451 +Node: Configuration and Customization46005 +Node: Macro Packages46372 +Node: man46632 +Node: Man options47036 +Node: Man usage48538 +Node: Man font macros53889 +Node: Miscellaneous man macros55415 +Node: Predefined man strings56246 +Node: Preprocessors in man pages56721 +Node: mdoc57303 +Node: ms57472 +Node: ms Intro57948 +Node: General ms Structure58617 +Node: General ms Structure-Footnotes61058 +Ref: General ms Structure-Footnote-161139 +Node: ms Document Control Registers61185 +Node: ms Cover Page Macros64241 +Node: ms Body Text67159 +Node: Paragraphs in ms67628 +Node: Headings in ms69181 +Node: Highlighting in ms69967 +Node: Lists in ms72429 +Node: Indents in ms75662 +Node: Tabstops in ms76228 +Node: ms Displays and Keeps76625 +Node: ms Insertions80077 +Node: Example multi-page table81628 +Node: ms Footnotes82071 +Node: ms Page Layout82943 +Node: ms Headers and Footers83460 +Node: ms Margins84483 +Node: ms Multiple Columns84724 +Node: ms TOC85525 +Node: ms Strings and Special Characters88230 +Node: ms Strings and Special Characters-Footnotes90886 +Ref: ms Strings and Special Characters-Footnote-190993 +Node: Differences from AT&T ms91080 +Node: Missing ms Macros91379 +Node: Additional ms Macros92123 +Node: me93375 +Node: mm93533 +Node: gtroff Reference93680 +Node: Text94608 +Node: Filling and Adjusting95130 +Node: Hyphenation95843 +Node: Sentences96626 +Node: Tab Stops97766 +Node: Implicit Line Breaks98660 +Node: Input Conventions99647 +Node: Measurements100431 +Node: Measurements-Footnotes102638 +Ref: Measurements-Footnote-1102703 +Node: Default Units102775 +Node: Expressions103821 +Node: Identifiers106535 +Node: Embedded Commands110391 +Node: Requests111138 +Node: Request Arguments112726 +Node: Request Arguments-Footnotes115077 +Ref: Request Arguments-Footnote-1115152 +Ref: Request Arguments-Footnote-2115280 +Node: Macros115634 +Node: Escapes115991 +Node: Comments118872 +Node: Comments-Footnotes121447 +Ref: Comments-Footnote-1121504 +Node: Registers121603 +Node: Setting Registers122106 +Node: Interpolating Registers124388 +Node: Auto-increment125192 +Node: Assigning Formats126722 +Node: Built-in Registers129630 +Node: Manipulating Filling and Adjusting132879 +Node: Manipulating Hyphenation140652 +Node: Manipulating Hyphenation-Footnotes150959 +Ref: Manipulating Hyphenation-Footnote-1151048 +Node: Manipulating Spacing151123 +Node: Tabs and Fields154514 +Node: Tabs and Fields-Footnotes160646 +Ref: Tabs and Fields-Footnote-1160717 +Node: Leaders160795 +Node: Leaders-Footnotes162386 +Ref: Leaders-Footnote-1162441 +Node: Fields162522 +Node: Character Translations163938 +Node: Troff and Nroff Mode173148 +Node: Line Layout175133 +Node: Line Control181040 +Node: Page Layout183713 +Node: Page Control187441 +Node: Fonts190921 +Node: Changing Fonts191458 +Node: Font Families193243 +Node: Font Positions197760 +Node: Using Symbols200875 +Node: Using Symbols-Footnotes208965 +Ref: Using Symbols-Footnote-1209032 +Ref: Using Symbols-Footnote-2209485 +Ref: Using Symbols-Footnote-3209556 +Ref: Using Symbols-Footnote-4209795 +Node: Special Fonts209858 +Node: Artificial Fonts210962 +Node: Ligatures and Kerning216170 +Node: Sizes221992 +Node: Sizes-Footnotes222809 +Ref: Sizes-Footnote-1222860 +Node: Changing Type Sizes223272 +Node: Fractional Type Sizes228416 +Node: Strings231433 +Node: Conditionals and Loops239418 +Node: Operators in Conditionals239635 +Node: Operators in Conditionals-Footnotes242271 +Ref: Operators in Conditionals-Footnote-1242362 +Ref: Operators in Conditionals-Footnote-2242441 +Node: if-else242540 +Node: while244074 +Node: Writing Macros246447 +Node: Copy-in Mode250343 +Node: Parameters251226 +Node: Page Motions253341 +Node: Drawing Requests260414 +Node: Traps268264 +Node: Page Location Traps268869 +Node: Diversion Traps273301 +Node: Input Line Traps273775 +Node: Blank Line Traps274765 +Node: End-of-input Traps275037 +Node: Diversions275695 +Node: Environments282393 +Node: Suppressing output286006 +Node: Colors287820 +Node: I/O290802 +Node: Postprocessor Access298807 +Node: Miscellaneous300362 +Node: Miscellaneous-Footnotes305422 +Ref: Miscellaneous-Footnote-1305489 +Node: Gtroff Internals305559 +Node: Gtroff Internals-Footnotes309281 +Ref: Gtroff Internals-Footnote-1309354 +Node: Debugging309488 +Node: Warnings315098 +Node: Warnings-Footnotes318024 +Ref: Warnings-Footnote-1318081 +Node: Implementation Differences318202 +Node: Implementation Differences-Footnotes322826 +Ref: Implementation Differences-Footnote-1322919 +Node: Preprocessors323054 +Node: geqn323355 +Node: Invoking geqn323481 +Node: gtbl323575 +Node: Invoking gtbl323692 +Node: gpic323786 +Node: Invoking gpic323903 +Node: ggrn323997 +Node: Invoking ggrn324114 +Node: grap324208 +Node: grefer324479 +Node: Invoking grefer324607 +Node: gsoelim324711 +Node: Invoking gsoelim324829 +Node: Output Devices324938 +Node: Special Characters325173 +Node: grotty325337 +Node: Invoking grotty325478 +Node: grops325582 +Node: Invoking grops325733 +Node: Embedding PostScript325861 +Node: grodvi325983 +Node: Invoking grodvi326112 +Node: grolj4326216 +Node: Invoking grolj4326346 +Node: grolbp326450 +Node: Invoking grolbp326581 +Node: grohtml326685 +Node: Invoking grohtml326865 +Node: grohtml specific registers and strings327021 +Node: gxditview327884 +Node: Invoking gxditview328012 +Node: File formats328131 +Node: gtroff Output328401 +Node: gtroff Output-Footnotes330237 +Ref: gtroff Output-Footnote-1330304 +Node: Language Concepts330438 +Node: Separation331175 +Node: Argument Units333413 +Node: Document Parts334553 +Node: Command Reference335942 +Node: Comment Command336344 +Node: Simple Commands336821 +Node: Simple Commands-Footnotes342728 +Ref: Simple Commands-Footnote-1342799 +Node: Graphics Commands342860 +Node: Device Control Commands350194 +Node: Obsolete Command354229 +Node: Intermediate Output Examples355497 +Node: Output Language Compatibility358310 +Node: Font Files360357 +Node: Font Files-Footnotes360966 +Ref: Font Files-Footnote-1361027 +Node: DESC File Format361088 +Node: Font File Format365330 +Node: Font File Format-Footnotes371553 +Ref: Font File Format-Footnote-1371626 +Ref: Font File Format-Footnote-2371717 +Node: Installation371936 +Node: Copying This Manual372058 +Node: GNU Free Documentation License372274 +Node: Request Index392134 +Node: Escape Index401929 +Node: Operator Index406157 +Node: Register Index407262 +Node: Macro Index414789 +Node: String Index420373 +Node: Glyph Name Index424697 +Node: Font File Keyword Index424983 +Node: Program and File Index427384 +Node: Concept Index430355 + +End Tag Table diff --git a/contrib/groff/doc/groff-1 b/contrib/groff/doc/groff-1 new file mode 100644 index 0000000..0f13ab3 --- /dev/null +++ b/contrib/groff/doc/groff-1 @@ -0,0 +1,1386 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: Top, Next: Introduction, Prev: (dir), Up: (dir) + +GNU troff +********* + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +* Menu: + +* Introduction:: +* Invoking groff:: +* Tutorial for Macro Users:: +* Macro Packages:: +* gtroff Reference:: +* Preprocessors:: +* Output Devices:: +* File formats:: +* Installation:: +* Copying This Manual:: +* Request Index:: +* Escape Index:: +* Operator Index:: +* Register Index:: +* Macro Index:: +* String Index:: +* Glyph Name Index:: +* Font File Keyword Index:: +* Program and File Index:: +* Concept Index:: + + +File: groff, Node: Introduction, Next: Invoking groff, Prev: Top, Up: Top + +Introduction +************ + + GNU `troff' (or `groff') is a system for typesetting documents. +`troff' is very flexible and has been in existence (and use) for about +3 decades. It is quite widespread and firmly entrenched in the UNIX +community. + +* Menu: + +* What Is groff?:: +* History:: +* groff Capabilities:: +* Macro Package Intro:: +* Preprocessor Intro:: +* Output device intro:: +* Credits:: + + +File: groff, Node: What Is groff?, Next: History, Prev: Introduction, Up: Introduction + +What Is `groff'? +================ + + `groff' belongs to an older generation of document preparation +systems, which operate more like compilers than the more recent +interactive WYSIWYG(1) (*note What Is groff?-Footnote-1::) systems. +`groff' and its contemporary counterpart, TeX, both work using a +"batch" paradigm: The input (or "source") files are normal text files +with embedded formatting commands. These files can then be processed +by `groff' to produce a typeset document on a variety of devices. + + Likewise, `groff' should not be confused with a "word processor", +since that term connotes an integrated system that includes an editor +and a text formatter. Also, many word processors follow the WYSIWYG +paradigm discussed earlier. + + Although WYSIWYG systems may be easier to use, they have a number of +disadvantages compared to `troff': + + * They must be used on a graphics display to work on a document. + + * Most of the WYSIWYG systems are either non-free or are not very + portable. + + * `troff' is firmly entrenched in all UNIX systems. + + * It is difficult to have a wide range of capabilities available + within the confines of a GUI/window system. + + * It is more difficult to make global changes to a document. + + "GUIs normally make it simple to accomplish simple actions and + impossible to accomplish complex actions." -Doug Gwyn (22/Jun/91 + in `comp.unix.wizards') + + +File: groff, Node: What Is groff?-Footnotes, Up: What Is groff? + + (1) What You See Is What You Get + + +File: groff, Node: History, Next: groff Capabilities, Prev: What Is groff?, Up: Introduction + +History +======= + + `troff' can trace its origins back to a formatting program called +`runoff', written by J. E. Saltzer, which ran on MIT's CTSS operating +system in the mid-sixties. This name came from the common phrase of +the time "I'll run off a document." Bob Morris ported it to the 635 +architecture and called the program `roff' (an abbreviation of +`runoff'). It was rewritten as `rf' for the PDP-7 (before having +UNIX), and at the same time (1969), Doug McIllroy rewrote an extended +and simplified version of `roff' in the BCPL programming language. + + The first version of UNIX was developed on a PDP-7 which was sitting +around Bell Labs. In 1971 the developers wanted to get a PDP-11 for +further work on the operating system. In order to justify the cost for +this system, they proposed that they would implement a document +formatting system for the AT&T patents division. This first formatting +program was a reimplementation of McIllroy's `roff', written by +J. F. Ossanna. + + When they needed a more flexible language, a new version of `roff' +called `nroff' ("Newer `roff'") was written. It had a much more +complicated syntax, but provided the basis for all future versions. +When they got a Graphic Systems CAT Phototypesetter, Ossanna wrote a +version of `nroff' that would drive it. It was dubbed `troff', for +"typesetter `roff'", although many people have speculated that it +actually means "Times `roff'" because of the use of the Times font +family in `troff' by default. As such, the name `troff' is pronounced +`t-roff' rather than `trough'. + + With `troff' came `nroff' (they were actually the same program +except for some `#ifdef's), which was for producing output for line +printers and character terminals. It understood everything `troff' +did, and ignored the commands which were not applicable (e.g. font +changes). + + Since there are several things which cannot be done easily in +`troff', work on several preprocessors began. These programs would +transform certain parts of a document into `troff', which made a very +natural use of pipes in UNIX. + + The `eqn' preprocessor allowed mathematical formulae to be specified +in a much simpler and more intuitive manner. `tbl' is a preprocessor +for formatting tables. The `refer' preprocessor (and the similar +program, `bib') processes citations in a document according to a +bibliographic database. + + Unfortunately, Ossanna's `troff' was written in PDP-11 assembly +language and produced output specifically for the CAT phototypesetter. +He rewrote it in C, although it was now 7000 lines of uncommented code +and still dependent on the CAT. As the CAT became less common, and was +no longer supported by the manufacturer, the need to make it support +other devices became a priority. However, before this could be done, +Ossanna was killed in a car accident. + + So, Brian Kernighan took on the task of rewriting `troff'. The +newly rewritten version produced device independent code which was very +easy for postprocessors to read and translate to the appropriate +printer codes. Also, this new version of `troff' (called `ditroff' for +"device independent `troff'") had several extensions, which included +drawing functions. + + Due to the additional abilities of the new version of `troff', +several new preprocessors appeared. The `pic' preprocessor provides a +wide range of drawing functions. Likewise the `ideal' preprocessor did +the same, although via a much different paradigm. The `grap' +preprocessor took specifications for graphs, but, unlike other +preprocessors, produced `pic' code. + + James Clark began work on a GNU implementation of `ditroff' in +early 1989. The first version, `groff' 0.3.1, was released June 1990. +`groff' included: + + * A replacement for `ditroff' with many extensions. + + * The `soelim', `pic', `tbl', and `eqn' preprocessors. + + * Postprocessors for character devices, POSTSCRIPT, TeX DVI, and + X Windows. GNU `troff' also eliminated the need for a separate + `nroff' program with a postprocessor which would produce ASCII + output. + + * A version of the `me' macros and an implementation of the `man' + macros. + + Also, a front-end was included which could construct the, sometimes +painfully long, pipelines required for all the post- and preprocessors. + + Development of GNU `troff' progressed rapidly, and saw the additions +of a replacement for `refer', an implementation of the `ms' and `mm' +macros, and a program to deduce how to format a document (`grog'). + + It was declared a stable (i.e. non-beta) package with the release of +version 1.04 around November 1991. + + Beginning in 1999, `groff' has new maintainers (the package was an +orphan for a few years). As a result, new features and programs like +`grn', a preprocessor for gremlin images, and an output device to +produce HTML output have been added. + + +File: groff, Node: groff Capabilities, Next: Macro Package Intro, Prev: History, Up: Introduction + +`groff' Capabilities +==================== + + So what exactly is `groff' capable of doing? `groff' provides a +wide range of low-level text formatting operations. Using these, it is +possible to perform a wide range of formatting tasks, such as +footnotes, table of contents, multiple columns, etc. Here's a list of +the most important operations supported by `groff': + + * text filling, adjusting, and centering + + * hyphenation + + * page control + + * font and glyph size control + + * vertical spacing (e.g. double-spacing) + + * line length and indenting + + * macros, strings, diversions, and traps + + * number registers + + * tabs, leaders, and fields + + * input and output conventions and character translation + + * overstrike, bracket, line drawing, and zero-width functions + + * local horizontal and vertical motions and the width function + + * three-part titles + + * output line numbering + + * conditional acceptance of input + + * environment switching + + * insertions from the standard input + + * input/output file switching + + * output and error messages + + +File: groff, Node: Macro Package Intro, Next: Preprocessor Intro, Prev: groff Capabilities, Up: Introduction + +Macro Packages +============== + + Since `groff' provides such low-level facilities, it can be quite +difficult to use by itself. However, `groff' provides a "macro" +facility to specify how certain routine operations (e.g. starting +paragraphs, printing headers and footers, etc.) should be done. These +macros can be collected together into a "macro package". There are a +number of macro packages available; the most common (and the ones +described in this manual) are `man', `mdoc', `me', `ms', and `mm'. + + +File: groff, Node: Preprocessor Intro, Next: Output device intro, Prev: Macro Package Intro, Up: Introduction + +Preprocessors +============= + + Although `groff' provides most functions needed to format a +document, some operations would be unwieldy (e.g. to draw pictures). +Therefore, programs called "preprocessors" were written which +understand their own language and produce the necessary `groff' +operations. These preprocessors are able to differentiate their own +input from the rest of the document via markers. + + To use a preprocessor, UNIX pipes are used to feed the output from +the preprocessor into `groff'. Any number of preprocessors may be used +on a given document; in this case, the preprocessors are linked +together into one pipeline. However, with `groff', the user does not +need to construct the pipe, but only tell `groff' what preprocessors to +use. + + `groff' currently has preprocessors for producing tables (`tbl'), +typesetting equations (`eqn'), drawing pictures (`pic' and `grn'), and +for processing bibliographies (`refer'). An associated program which +is useful when dealing with preprocessors is `soelim'. + + A free implementation of `grap', a preprocessor for drawing graphs, +can be obtained as an extra package; `groff' can use `grap' also. + + There are other preprocessors in existence, but, unfortunately, no +free implementations are available. Among them are preprocessors for +drawing mathematical pictures (`ideal') and chemical structures +(`chem'). + + +File: groff, Node: Output device intro, Next: Credits, Prev: Preprocessor Intro, Up: Introduction + +Output Devices +============== + + `groff' actually produces device independent code which may be fed +into a postprocessor to produce output for a particular device. +Currently, `groff' has postprocessors for POSTSCRIPT devices, character +terminals, X Windows (for previewing), TeX DVI format, HP LaserJet 4 +and Canon LBP printers (which use CAPSL), and HTML. + + +File: groff, Node: Credits, Prev: Output device intro, Up: Introduction + +Credits +======= + + Large portions of this manual were taken from existing documents, +most notably, the manual pages for the `groff' package by James Clark, +and Eric Allman's papers on the `me' macro package. + + The section on the `man' macro package is partly based on Susan G. +Kleinmann's `groff_man' manual page written for the Debian GNU/Linux +system. + + Larry Kollar contributed the section in the `ms' macro package. + + +File: groff, Node: Invoking groff, Next: Tutorial for Macro Users, Prev: Introduction, Up: Top + +Invoking `groff' +**************** + + This section focuses on how to invoke the `groff' front end. This +front end takes care of the details of constructing the pipeline among +the preprocessors, `gtroff' and the postprocessor. + + It has become a tradition that GNU programs get the prefix `g' to +distinguish it from its original counterparts provided by the host (see +*Note Environment::, for more details). Thus, for example, `geqn' is +GNU `eqn'. On operating systems like GNU/Linux or the Hurd, which +don't contain proprietary versions of `troff', and on +MS-DOS/MS-Windows, where `troff' and associated programs are not +available at all, this prefix is omitted since GNU `troff' is the only +used incarnation of `troff'. Exception: `groff' is never replaced by +`roff'. + + In this document, we consequently say `gtroff' when talking about +the GNU `troff' program. All other implementations of `troff' are +called AT&T `troff' which is the common origin of all `troff' derivates +(with more or less compatible changes). Similarly, we say `gpic', +`geqn', etc. + +* Menu: + +* Groff Options:: +* Environment:: +* Macro Directories:: +* Font Directories:: +* Invocation Examples:: + + +File: groff, Node: Groff Options, Next: Environment, Prev: Invoking groff, Up: Invoking groff + +Options +======= + + `groff' normally runs the `gtroff' program and a postprocessor +appropriate for the selected device. The default device is `ps' (but +it can be changed when `groff' is configured and built). It can +optionally preprocess with any of `gpic', `geqn', `gtbl', `ggrn', +`grap', `grefer', or `gsoelim'. + + This section only documents options to the `groff' front end. Many +of the arguments to `groff' are passed on to `gtroff', therefore those +are also included. Arguments to pre- or postprocessors can be found in +*Note Invoking gpic::, *Note Invoking geqn::, *Note Invoking gtbl::, +*Note Invoking ggrn::, *Note Invoking grefer::, *Note Invoking +gsoelim::, *Note Invoking grotty::, *Note Invoking grops::, *Note +Invoking grohtml::, *Note Invoking grodvi::, *Note Invoking grolj4::, +*Note Invoking grolbp::, and *Note Invoking gxditview::. + + The command line format for `groff' is: + + + groff [ -abceghilpstvzCEGNRSUVXZ ] [ -FDIR ] [ -mNAME ] + [ -TDEF ] [ -fFAM ] [ -wNAME ] [ -WNAME ] + [ -MDIR ] [ -dCS ] [ -rCN ] [ -nNUM ] + [ -oLIST ] [ -PARG ] [ -LARG ] [ -IDIR ] + [ FILES... ] + + The command line format for `gtroff' is as follows. + + + gtroff [ -abcivzCERU ] [ -wNAME ] [ -WNAME ] [ -dCS ] + [ -fFAM ] [ -mNAME ] [ -nNUM ] + [ -oLIST ] [ -rCN ] [ -TNAME ] + [ -FDIR ] [ -MDIR ] [ FILES... ] + +Obviously, many of the options to `groff' are actually passed on to +`gtroff'. + + Options without an argument can be grouped behind a single `-'. A +filename of `-' denotes the standard input. It is possible to have +whitespace between an option and its parameter. + + The `grog' command can be used to guess the correct `groff' command +to format a file. + + Here's the description of the command-line options: + +`-h' + Print a help message. + +`-e' + Preprocess with `geqn'. + +`-t' + Preprocess with `gtbl'. + +`-g' + Preprocess with `ggrn'. + +`-G' + Preprocess with `grap'. + +`-p' + Preprocess with `gpic'. + +`-s' + Preprocess with `gsoelim'. + +`-c' + Suppress color output. + +`-R' + Preprocess with `grefer'. No mechanism is provided for passing + arguments to `grefer' because most `grefer' options have + equivalent commands which can be included in the file. *Note + grefer::, for more details. + + Note that `gtroff' also accepts a `-R' option, which is not + accessible via `groff'. This option prevents the loading of the + `troffrc' and `troffrc-end' files. + +`-v' + Make programs run by `groff' print out their version number. + +`-V' + Print the pipeline on `stdout' instead of executing it. + +`-z' + Suppress output from `gtroff'. Only error messages are printed. + +`-Z' + Do not postprocess the output of `gtroff'. Normally `groff' + automatically runs the appropriate postprocessor. + +`-PARG' + Pass ARG to the postprocessor. Each argument should be passed + with a separate `-P' option. Note that `groff' does not prepend + `-' to ARG before passing it to the postprocessor. + +`-l' + Send the output to a spooler for printing. The command used for + this is specified by the `print' command in the device description + file (see *Note Font Files::, for more info). If not present, + `-l' is ignored. + +`-LARG' + Pass ARG to the spooler. Each argument should be passed with a + separate `-L' option. Note that `groff' does not prepend a `-' to + ARG before passing it to the postprocessor. If the `print' + keyword in the device description file is missing, `-L' is ignored. + +`-TDEV' + Prepare output for device DEV. The default device is `ps', unless + changed when `groff' was configured and built. The following are + the output devices currently available: + + `ps' + For POSTSCRIPT printers and previewers. + + `dvi' + For TeX DVI format. + + `X75' + For a 75dpi X11 previewer. + + `X75-12' + For a 75dpi X11 previewer with a 12pt base font in the + document. + + `X100' + For a 100dpi X11 previewer. + + `X100-12' + For a 100dpi X11 previewer with a 12pt base font in the + document. + + `ascii' + For typewriter-like devices using the (7-bit) ASCII character + set. + + `latin1' + For typewriter-like devices that support the Latin-1 + (ISO 8859-1) character set. + + `utf8' + For typewriter-like devices which use the Unicode (ISO 10646) + character set with UTF-8 encoding. + + `cp1047' + For typewriter-like devices which use the EBCDIC encoding IBM + cp1047. + + `lj4' + For HP LaserJet4-compatible (or other PCL5-compatible) + printers. + + `lbp' + For Canon CAPSL printers (LBP-4 and LBP-8 series laser + printers). + + `html' + To produce HTML output. Note that the HTML driver consists + of two parts, a preprocessor (`pre-grohtml') and a + postprocessor (`post-grohtml'). + + The predefined `gtroff' string register `.T' contains the current + output device; the read-only number register `.T' is set to 1 if + this option is used (which is always true if `groff' is used to + call `gtroff'). *Note Built-in Registers::. + + The postprocessor to be used for a device is specified by the + `postpro' command in the device description file. (*Note Font + Files::, for more info.) This can be overridden with the `-X' + option. + +`-X' + Preview with `gxditview' instead of using the usual postprocessor. + This is unlikely to produce good results except with `-Tps'. + + Note that this is not the same as using `-TX75' or `-TX100' to + view a document with `gxditview': The former uses the metrics of + the specified device, whereas the latter uses X-specific fonts and + metrics. + +`-N' + Don't allow newlines with `eqn' delimiters. This is the same as + the `-N' option in `geqn'. + +`-S' + Safer mode. Pass the `-S' option to `gpic' and disable the + `open', `opena', `pso', `sy', and `pi' requests. For security + reasons, this is enabled by default. + +`-U' + Unsafe mode. This enables the `open', `opena', `pso', `sy', and + `pi' requests. + +`-a' + Generate an ASCII approximation of the typeset output. The + read-only register `.A' is then set to 1. *Note Built-in + Registers::. A typical example is + + + groff -a -man -Tdvi troff.man | less + + which shows how lines are broken for the DVI device. Note that + this option is rather useless today since graphic output devices + are available virtually everywhere. + +`-b' + Print a backtrace with each warning or error message. This + backtrace should help track down the cause of the error. The line + numbers given in the backtrace may not always be correct: `gtroff' + can get confused by `as' or `am' requests while counting line + numbers. + +`-i' + Read the standard input after all the named input files have been + processed. + +`-wNAME' + Enable warning NAME. Available warnings are described in *Note + Debugging::. Multiple `-w' options are allowed. + +`-WNAME' + Inhibit warning NAME. Multiple `-W' options are allowed. + +`-E' + Inhibit all error messages. + +`-C' + Enable compatibility mode. *Note Implementation Differences::, + for the list of incompatibilities between `groff' and AT&T `troff'. + +`-dCS' +`-dNAME=S' + Define C or NAME to be a string S. C must be a one-letter name; + NAME can be of arbitrary length. All string assignments happen + before loading any macro file (including the start-up file). + +`-fFAM' + Use FAM as the default font family. *Note Font Families::. + +`-mNAME' + Read in the file `NAME.tmac'. Normally `groff' searches for this + in its macro directories. If it isn't found, it tries `tmac.NAME' + (searching in the same directories). + +`-nNUM' + Number the first page NUM. + +`-oLIST' + Output only pages in LIST, which is a comma-separated list of page + ranges; `N' means print page N, `M-N' means print every page + between M and N, `-N' means print every page up to N, `N-' means + print every page beginning with N. `gtroff' exits after printing + the last page in the list. All the ranges are inclusive on both + ends. + + Within `gtroff', this information can be extracted with the `.P' + register. *Note Built-in Registers::. + + If your document restarts page numbering at the beginning of each + chapter, then `gtroff' prints the specified page range for each + chapter. + +`-rCN' +`-rNAME=N' + Set number register C or NAME to the value N. C must be a + one-letter name; NAME can be of arbitrary length. N can be any + `gtroff' numeric expression. All register assignments happen + before loading any macro file (including the start-up file). + +`-FDIR' + Search `DIR' for subdirectories `devNAME' (NAME is the name of the + device), for the `DESC' file, and for font files before looking in + the standard directories (*note Font Directories::). This option + is passed to all pre- and postprocessors using the + `GROFF_FONT_PATH' environment variable. + +`-MDIR' + Search directory `DIR' for macro files before the standard + directories (*note Macro Directories::). + +`-IDIR' + This option is as described in *Note gsoelim::. It implies the + `-s' option. + + +File: groff, Node: Environment, Next: Macro Directories, Prev: Groff Options, Up: Invoking groff + +Environment +=========== + + There are also several environment variables (of the operating +system, not within `gtroff') which can modify the behavior of `groff'. + +`GROFF_COMMAND_PREFIX' + If this is set to X, then `groff' runs `Xtroff' instead of + `gtroff'. This also applies to `tbl', `pic', `eqn', `grn', + `refer', and `soelim'. It does not apply to `grops', `grodvi', + `grotty', `pre-grohtml', `post-grohtml', `grolj4', and `gxditview'. + + The default command prefix is determined during the installation + process. If a non-GNU troff system is found, prefix `g' is used, + none otherwise. + +`GROFF_TMAC_PATH' + A colon-separated list of directories in which to search for macro + files (before the default directories are tried). *Note Macro + Directories::. + +`GROFF_TYPESETTER' + The default output device. + +`GROFF_FONT_PATH' + A colon-separated list of directories in which to search for the + `dev'NAME directory (before the default directories are tried). + *Note Font Directories::. + +`GROFF_BIN_PATH' + This search path, followed by `PATH', is used for commands executed + by `groff'. + +`GROFF_TMPDIR' + The directory in which `groff' creates temporary files. If this is + not set and `TMPDIR' is set, temporary files are created in that + directory. Otherwise temporary files are created in a + system-dependent default directory (on Unix and GNU/Linux systems, + this is usually `/tmp'). `grops', `grefer', `pre-grohtml', and + `post-grohtml' can create temporary files in this directory. + + Note that MS-DOS and MS-Windows ports of `groff' use semi-colons, +rather than colons, to separate the directories in the lists described +above. + + +File: groff, Node: Macro Directories, Next: Font Directories, Prev: Environment, Up: Invoking groff + +Macro Directories +================= + + All macro file names must be named `NAME.tmac' or `tmac.NAME' to +make the `-mNAME' command line option work. The `mso' request doesn't +have this restriction; any file name can be used, and `gtroff' won't +try to append or prepend the `tmac' string. + + Macro files are kept in the "tmac directories", all of which +constitute the "tmac path". The elements of the search path for macro +files are (in that order): + + * The directories specified with `gtroff''s or `groff''s `-M' + command line option. + + * The directories given in the `GROFF_TMAC_PATH' environment + variable. + + * The current directory (only if in unsafe mode using the `-U' + command line switch). + + * The home directory. + + * A platform-dependent directory, a site-specific + (platform-independent) directory, and the main tmac directory; the + default locations are + + + /usr/local/lib/groff/site-tmac + /usr/local/share/groff/site-tmac + /usr/local/share/groff/1.18/tmac + + assuming that the version of `groff' is 1.18, and the installation + prefix was `/usr/local'. It is possible to fine-tune those + directories during the installation process. + + +File: groff, Node: Font Directories, Next: Invocation Examples, Prev: Macro Directories, Up: Invoking groff + +Font Directories +================ + + Basically, there is no restriction how font files for `groff' are +named and how long font names are; however, to make the font family +mechanism work (*note Font Families::), fonts within a family should +start with the family name, followed by the shape. For example, the +Times family uses `T' for the family name and `R', `B', `I', and `BI' +to indicate the shapes `roman', `bold', `italic', and `bold italic', +respectively. Thus the final font names are `TR', `TB', `TI', and +`TBI'. + + All font files are kept in the "font directories" which constitute +the "font path". The file search functions will always append the +directory `dev'NAME, where NAME is the name of the output device. +Assuming, say, DVI output, and `/foo/bar' as a font directory, the font +files for `grodvi' must be in `/foo/bar/devdvi'. + + The elements of the search path for font files are (in that order): + + * The directories specified with `gtroff''s or `groff''s `-F' + command line option. All device drivers and some preprocessors + also have this option. + + * The directories given in the `GROFF_FONT_PATH' environment + variable. + + * A site-specific directory and the main font directory; the default + locations are + + + /usr/local/share/groff/site-font + /usr/local/share/groff/1.18/font + + assuming that the version of `groff' is 1.18, and the installation + prefix was `/usr/local'. It is possible to fine-tune those + directories during the installation process. + + +File: groff, Node: Invocation Examples, Prev: Font Directories, Up: Invoking groff + +Invocation Examples +=================== + + This section lists several common uses of `groff' and the +corresponding command lines. + + + groff file + +This command processes `file' without a macro package or a +preprocessor. The output device is the default, `ps', and the output +is sent to `stdout'. + + + groff -t -mandoc -Tascii file | less + +This is basically what a call to the `man' program does. `gtroff' +processes the manual page `file' with the `mandoc' macro file (which in +turn either calls the `man' or the `mdoc' macro package), using the +`tbl' preprocessor and the ASCII output device. Finally, the `less' +pager displays the result. + + + groff -X -m me file + +Preview `file' with `gxditview', using the `me' macro package. Since +no `-T' option is specified, use the default device (`ps'). Note that +you can either say `-m me' or `-me'; the latter is an anachronism from +the early days of UNIX.(1) (*note Invocation Examples-Footnote-1::) + + + groff -man -rD1 -z file + +Check `file' with the `man' macro package, forcing double-sided +printing - don't produce any output. + +* Menu: + +* grog:: + + +File: groff, Node: Invocation Examples-Footnotes, Up: Invocation Examples + + (1) The same is true for the other main macro packages that come +with `groff': `man', `mdoc', `ms', `mm', and `mandoc'. This won't work +in general; for example, to load `trace.tmac', either `-mtrace' or +`-m trace' must be used. + + +File: groff, Node: grog, Prev: Invocation Examples, Up: Invocation Examples + +`grog' +------ + + `grog' reads files, guesses which of the `groff' preprocessors +and/or macro packages are required for formatting them, and prints the +`groff' command including those options on the standard output. It +generates one or more of the options `-e', `-man', `-me', `-mm', +`-mom', `-ms', `-mdoc', `-mdoc-old', `-p', `-R', `-g', `-G', `-s', and +`-t'. + + A special file name `-' refers to the standard input. Specifying no +files also means to read the standard input. Any specified options are +included in the printed command. No space is allowed between options +and their arguments. The only options recognized are `-C' (which is +also passed on) to enable compatibility mode, and `-v' to print the +version number and exit. + + For example, + + + grog -Tdvi paper.ms + +guesses the appropriate command to print `paper.ms' and then prints it +to the command line after adding the `-Tdvi' option. For direct +execution, enclose the call to `grog' in backquotes at the UNIX shell +prompt: + + + `grog -Tdvi paper.ms` > paper.dvi + +As seen in the example, it is still necessary to redirect the output to +something meaningful (i.e. either a file or a pager program like +`less'). + + +File: groff, Node: Tutorial for Macro Users, Next: Macro Packages, Prev: Invoking groff, Up: Top + +Tutorial for Macro Users +************************ + + Most users tend to use a macro package to format their papers. This +means that the whole breadth of `groff' is not necessary for most +people. This chapter covers the material needed to efficiently use a +macro package. + +* Menu: + +* Basics:: +* Common Features:: + + +File: groff, Node: Basics, Next: Common Features, Prev: Tutorial for Macro Users, Up: Tutorial for Macro Users + +Basics +====== + + This section covers some of the basic concepts necessary to +understand how to use a macro package.(1) (*note Basics-Footnote-1::) +References are made throughout to more detailed information, if desired. + + `gtroff' reads an input file prepared by the user and outputs a +formatted document suitable for publication or framing. The input +consists of text, or words to be printed, and embedded commands +("requests" and "escapes"), which tell `gtroff' how to format the +output. For more detail on this, see *Note Embedded Commands::. + + The word "argument" is used in this chapter to mean a word or number +which appears on the same line as a request, and which modifies the +meaning of that request. For example, the request + + + .sp + +spaces one line, but + + + .sp 4 + +spaces four lines. The number 4 is an argument to the `sp' request +which says to space four lines instead of one. Arguments are separated +from the request and from each other by spaces (_no_ tabs). More +details on this can be found in *Note Request Arguments::. + + The primary function of `gtroff' is to collect words from input +lines, fill output lines with those words, justify the right-hand margin +by inserting extra spaces in the line, and output the result. For +example, the input: + + + Now is the time + for all good men + to come to the aid + of their party. + Four score and seven + years ago, etc. + +is read, packed onto output lines, and justified to produce: + + Now is the time for all good men to come to the aid of their party. + Four score and seven years ago, etc. + + Sometimes a new output line should be started even though the current +line is not yet full; for example, at the end of a paragraph. To do +this it is possible to cause a "break", which starts a new output line. +Some requests cause a break automatically, as normally do blank input +lines and input lines beginning with a space. + + Not all input lines are text to be formatted. Some input lines are +requests which describe how to format the text. Requests always have a +period (`.') or an apostrophe (`'') as the first character of the input +line. + + The text formatter also does more complex things, such as +automatically numbering pages, skipping over page boundaries, putting +footnotes in the correct place, and so forth. + + Here are a few hints for preparing text for input to `gtroff'. + + * First, keep the input lines short. Short input lines are easier to + edit, and `gtroff' packs words onto longer lines anyhow. + + * In keeping with this, it is helpful to begin a new line after every + comma or phrase, since common corrections are to add or delete + sentences or phrases. + + * End each sentence with two spaces - or better, start each sentence + on a new line. `gtroff' recognizes characters that usually end a + sentence, and inserts sentence space accordingly. + + * Do not hyphenate words at the end of lines - `gtroff' is smart + enough to hyphenate words as needed, but is not smart enough to + take hyphens out and join a word back together. Also, words such + as "mother-in-law" should not be broken over a line, since then a + space can occur where not wanted, such as "mother- in-law". + + `gtroff' double-spaces output text automatically if you use the +request `.ls 2'. Reactivate single-spaced mode by typing `.ls 1'.(2) +(*note Basics-Footnote-2::) + + A number of requests allow to change the way the output looks, +sometimes called the "layout" of the output page. Most of these +requests adjust the placing of "whitespace" (blank lines or spaces). + + The `bp' request starts a new page, causing a line break. + + The request `.sp N' leaves N lines of blank space. N can be omitted +(meaning skip a single line) or can be of the form Ni (for N inches) or +Nc (for N centimeters). For example, the input: + + + .sp 1.5i + My thoughts on the subject + .sp + +leaves one and a half inches of space, followed by the line "My +thoughts on the subject", followed by a single blank line (more +measurement units are available, see *Note Measurements::). + + Text lines can be centered by using the `ce' request. The line +after `ce' is centered (horizontally) on the page. To center more than +one line, use `.ce N' (where N is the number of lines to center), +followed by the N lines. To center many lines without counting them, +type: + + + .ce 1000 + lines to center + .ce 0 + +The `.ce 0' request tells `groff' to center zero more lines, in other +words, stop centering. + + All of these requests cause a break; that is, they always start a new +line. To start a new line without performing any other action, use +`br'. + + +File: groff, Node: Basics-Footnotes, Up: Basics + + (1) This section is derived from `Writing Papers with nroff using +-me' by Eric P. Allman. + + (2) If you need finer granularity of the vertical space, use the +`pvs' request (*note Changing Type Sizes::). + + +File: groff, Node: Common Features, Prev: Basics, Up: Tutorial for Macro Users + +Common Features +=============== + + `gtroff' provides very low-level operations for formatting a +document. There are many common routine operations which are done in +all documents. These common operations are written into "macros" and +collected into a "macro package". + + All macro packages provide certain common capabilities which fall +into the following categories. + +* Menu: + +* Paragraphs:: +* Sections and Chapters:: +* Headers and Footers:: +* Page Layout Adjustment:: +* Displays:: +* Footnotes and Annotations:: +* Table of Contents:: +* Indices:: +* Paper Formats:: +* Multiple Columns:: +* Font and Size Changes:: +* Predefined Strings:: +* Preprocessor Support:: +* Configuration and Customization:: + + +File: groff, Node: Paragraphs, Next: Sections and Chapters, Prev: Common Features, Up: Common Features + +Paragraphs +---------- + + One of the most common and most used capability is starting a +paragraph. There are a number of different types of paragraphs, any of +which can be initiated with macros supplied by the macro package. +Normally, paragraphs start with a blank line and the first line +indented, like the text in this manual. There are also block style +paragraphs, which omit the indentation: + + + Some men look at constitutions with sanctimonious + reverence, and deem them like the ark of the covenant, too + sacred to be touched. + +And there are also indented paragraphs which begin with a tag or label +at the margin and the remaining text indented. + + + one This is the first paragraph. Notice how the first + line of the resulting paragraph lines up with the + other lines in the paragraph. + + + longlabel + This paragraph had a long label. The first + character of text on the first line does not line up + with the text on second and subsequent lines, + although they line up with each other. + + A variation of this is a bulleted list. + + + . Bulleted lists start with a bullet. It is possible + to use other glyphs instead of the bullet. In nroff + mode using the ASCII character set for output, a dot + is used instead of a real bullet. + + +File: groff, Node: Sections and Chapters, Next: Headers and Footers, Prev: Paragraphs, Up: Common Features + +Sections and Chapters +--------------------- + + Most macro packages supply some form of section headers. The +simplest kind is simply the heading on a line by itself in bold type. +Others supply automatically numbered section heading or different +heading styles at different levels. Some, more sophisticated, macro +packages supply macros for starting chapters and appendices. + + +File: groff, Node: Headers and Footers, Next: Page Layout Adjustment, Prev: Sections and Chapters, Up: Common Features + +Headers and Footers +------------------- + + Every macro package gives some way to manipulate the "headers" and +"footers" (also called "titles") on each page. This is text put at the +top and bottom of each page, respectively, which contain data like the +current page number, the current chapter title, and so on. Its +appearance is not affected by the running text. Some packages allow +for different ones on the even and odd pages (for material printed in a +book form). + + The titles are called "three-part titles", that is, there is a +left-justified part, a centered part, and a right-justified part. An +automatically generated page number may be put in any of these fields +with the `%' character (see *Note Page Layout::, for more details). + + +File: groff, Node: Page Layout Adjustment, Next: Displays, Prev: Headers and Footers, Up: Common Features + +Page Layout +----------- + + Most macro packages let the user specify top and bottom margins and +other details about the appearance of the printed pages. + + +File: groff, Node: Displays, Next: Footnotes and Annotations, Prev: Page Layout Adjustment, Up: Common Features + +Displays +-------- + + "Displays" are sections of text to be set off from the body of the +paper. Major quotes, tables, and figures are types of displays, as are +all the examples used in this document. + + "Major quotes" are quotes which are several lines long, and hence +are set in from the rest of the text without quote marks around them. + + A "list" is an indented, single-spaced, unfilled display. Lists +should be used when the material to be printed should not be filled and +justified like normal text, such as columns of figures or the examples +used in this paper. + + A "keep" is a display of lines which are kept on a single page if +possible. An example for a keep might be a diagram. Keeps differ from +lists in that lists may be broken over a page boundary whereas keeps are +not. + + "Floating keeps" move relative to the text. Hence, they are good for +things which are referred to by name, such as "See figure 3". A +floating keep appears at the bottom of the current page if it fits; +otherwise, it appears at the top of the next page. Meanwhile, the +surrounding text `flows' around the keep, thus leaving no blank areas. + + +File: groff, Node: Footnotes and Annotations, Next: Table of Contents, Prev: Displays, Up: Common Features + +Footnotes and Annotations +------------------------- + + There are a number of requests to save text for later printing. + + "Footnotes" are printed at the bottom of the current page. + + "Delayed text" is very similar to a footnote except that it is +printed when called for explicitly. This allows a list of references to +appear (for example) at the end of each chapter, as is the convention in +some disciplines. + + Most macro packages which supply this functionality also supply a +means of automatically numbering either type of annotation. + + +File: groff, Node: Table of Contents, Next: Indices, Prev: Footnotes and Annotations, Up: Common Features + +Table of Contents +----------------- + + "Tables of contents" are a type of delayed text having a tag +(usually the page number) attached to each entry after a row of dots. +The table accumulates throughout the paper until printed, usually after +the paper has ended. Many macro packages provide the ability to have +several tables of contents (e.g. a standard table of contents, a list +of tables, etc). + + +File: groff, Node: Indices, Next: Paper Formats, Prev: Table of Contents, Up: Common Features + +Indices +------- + + While some macro packages use the term "index", none actually +provide that functionality. The facilities they call indices are +actually more appropriate for tables of contents. + + To produce a real index in a document, external tools like the +`makeindex' program are necessary. + + +File: groff, Node: Paper Formats, Next: Multiple Columns, Prev: Indices, Up: Common Features + +Paper Formats +------------- + + Some macro packages provide stock formats for various kinds of +documents. Many of them provide a common format for the title and +opening pages of a technical paper. The `mm' macros in particular +provide formats for letters and memoranda. + + +File: groff, Node: Multiple Columns, Next: Font and Size Changes, Prev: Paper Formats, Up: Common Features + +Multiple Columns +---------------- + + Some macro packages (but not `man') provide the ability to have two +or more columns on a page. + + +File: groff, Node: Font and Size Changes, Next: Predefined Strings, Prev: Multiple Columns, Up: Common Features + +Font and Size Changes +--------------------- + + The built-in font and size functions are not always intuitive, so all +macro packages provide macros to make these operations simpler. + + +File: groff, Node: Predefined Strings, Next: Preprocessor Support, Prev: Font and Size Changes, Up: Common Features + +Predefined Strings +------------------ + + Most macro packages provide various predefined strings for a variety +of uses; examples are sub- and superscripts, printable dates, quotes and +various special characters. + + +File: groff, Node: Preprocessor Support, Next: Configuration and Customization, Prev: Predefined Strings, Up: Common Features + +Preprocessor Support +-------------------- + + All macro packages provide support for various preprocessors and may +extend their functionality. + + For example, all macro packages mark tables (which are processed with +`gtbl') by placing them between `TS' and `TE' macros. The `ms' macro +package has an option, `.TS H', that prints a caption at the top of a +new page (when the table is too long to fit on a single page). + + +File: groff, Node: Configuration and Customization, Prev: Preprocessor Support, Up: Common Features + +Configuration and Customization +------------------------------- + + Some macro packages provide means of customizing many of the details +of how the package behaves. This ranges from setting the default type +size to changing the appearance of section headers. + + +File: groff, Node: Macro Packages, Next: gtroff Reference, Prev: Tutorial for Macro Users, Up: Top + +Macro Packages +************** + + This chapter documents the main macro packages that come with +`groff'. + +* Menu: + +* man:: +* mdoc:: +* ms:: +* me:: +* mm:: + + +File: groff, Node: man, Next: mdoc, Prev: Macro Packages, Up: Macro Packages + +`man' +===== + + This is the most popular and probably the most important macro +package of `groff'. It is easy to use, and a vast majority of manual +pages are based on it. + +* Menu: + +* Man options:: +* Man usage:: +* Man font macros:: +* Miscellaneous man macros:: +* Predefined man strings:: +* Preprocessors in man pages:: + + +File: groff, Node: Man options, Next: Man usage, Prev: man, Up: man + +Options +------- + + The command line format for using the `man' macros with `groff' is: + + + groff -m man [ -rLL=LENGTH ] [ -rLT=LENGTH ] + [ -rcR=1 ] [ -rC1 ] [ -rD1 ] [ -rPNNN ] + [ -rSXX ] [ -rXNNN ] [ FILES... ] + +It is possible to use `-man' instead of `-m man'. + +`-rLL=LENGTH' + Set line length to LENGTH. If not specified, the line length + defaults to 78 en in nroff mode (this is 78 characters per line) + and 6.5 inch otherwise. + +`-rLT=LENGTH' + Set title length to LENGTH. If not specified, the title length + defaults to 78 en in nroff mode (this is 78 characters per line) + and 6.5 inch otherwise. + +`-rcR=1' + This option (the default if a TTY output device is used) creates a + single, very long page instead of multiple pages. Use `-rcR=0' to + disable it. + +`-rC1' + If more than one manual page is given on the command line, number + the pages continuously, rather than starting each at 1. + +`-rD1' + Double-sided printing. Footers for even and odd pages are + formatted differently. + +`-rPNNN' + Page numbering starts with NNN rather than with 1. + +`-rSXX' + Use XX (which can be 10, 11, or 12pt) as the base document font + size instead of the default value of 10pt. + +`-rXNNN' + After page NNN, number pages as NNNa, NNNb, NNNc, etc. For + example, the option `-rX2' produces the following page numbers: 1, + 2, 2a, 2b, 2c, etc. + diff --git a/contrib/groff/doc/groff-10 b/contrib/groff/doc/groff-10 new file mode 100644 index 0000000..85971cf --- /dev/null +++ b/contrib/groff/doc/groff-10 @@ -0,0 +1,208 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: String Index, Next: Glyph Name Index, Prev: Macro Index, Up: Top + +String Index +************ + + The macro package or program a specific string belongs to is +appended in brackets. + + A string name `x' consisting of exactly one character can be +accessed as `\*x'. A string name `xx' consisting of exactly two +characters can be accessed as `\*(xx'. String names `xxx' of any +length can be accessed as `\*[xxx]'. + +* Menu: + +* ! [ms]: ms Strings and Special Characters. +* ' [ms]: ms Strings and Special Characters. +* * [ms]: ms Footnotes. +* *Q [ms]: ms Strings and Special Characters. +* *U [ms]: ms Strings and Special Characters. +* , [ms]: ms Strings and Special Characters. +* - [ms]: ms Strings and Special Characters. +* . [ms]: ms Strings and Special Characters. +* .T: Built-in Registers. +* 3 [ms]: ms Strings and Special Characters. +* 8 [ms]: ms Strings and Special Characters. +* <colon> [ms]: ms Strings and Special Characters. +* ? [ms]: ms Strings and Special Characters. +* ^ [ms]: ms Strings and Special Characters. +* _ [ms]: ms Strings and Special Characters. +* ` [ms]: ms Strings and Special Characters. +* ABSTRACT [ms]: ms Strings and Special Characters. +* Ae [ms]: ms Strings and Special Characters. +* ae [ms]: ms Strings and Special Characters. +* CF [ms]: ms Headers and Footers. +* CH [ms]: ms Headers and Footers. +* d- [ms]: ms Strings and Special Characters. +* D- [ms]: ms Strings and Special Characters. +* LF [ms]: ms Headers and Footers. +* LH [ms]: ms Headers and Footers. +* lq [man]: Predefined man strings. +* MONTH1 [ms]: ms Strings and Special Characters. +* MONTH10 [ms]: ms Strings and Special Characters. +* MONTH11 [ms]: ms Strings and Special Characters. +* MONTH12 [ms]: ms Strings and Special Characters. +* MONTH2 [ms]: ms Strings and Special Characters. +* MONTH3 [ms]: ms Strings and Special Characters. +* MONTH4 [ms]: ms Strings and Special Characters. +* MONTH5 [ms]: ms Strings and Special Characters. +* MONTH6 [ms]: ms Strings and Special Characters. +* MONTH7 [ms]: ms Strings and Special Characters. +* MONTH8 [ms]: ms Strings and Special Characters. +* MONTH9 [ms]: ms Strings and Special Characters. +* o [ms]: ms Strings and Special Characters. +* q [ms]: ms Strings and Special Characters. +* R [man]: Predefined man strings. +* REFERENCES [ms]: ms Strings and Special Characters. +* RF [ms]: ms Headers and Footers. +* RH [ms]: ms Headers and Footers. +* rq [man]: Predefined man strings. +* S [man]: Predefined man strings. +* th [ms]: ms Strings and Special Characters. +* Th [ms]: ms Strings and Special Characters. +* Tm [man]: Predefined man strings. +* TOC [ms]: ms Strings and Special Characters. +* v [ms]: ms Strings and Special Characters. +* www-image-template [grohtml]: grohtml specific registers and strings. +* ~ [ms]: ms Strings and Special Characters. + + +File: groff, Node: Glyph Name Index, Next: Font File Keyword Index, Prev: String Index, Up: Top + +Glyph Name Index +**************** + + A glyph name `xx' consisting of exactly two characters can be +accessed as `\(xx'. Glyph names `xxx' of any length can be accessed as +`\[xxx]'. + + +File: groff, Node: Font File Keyword Index, Next: Program and File Index, Prev: Glyph Name Index, Up: Top + +Font File Keyword Index +*********************** + +* Menu: + +* #: Font File Format. +* ---: Font File Format. +* biggestfont: DESC File Format. +* charset <1>: Font File Format. +* charset: DESC File Format. +* family <1>: DESC File Format. +* family <2>: Font Positions. +* family: Changing Fonts. +* fonts <1>: DESC File Format. +* fonts <2>: Special Fonts. +* fonts: Using Symbols. +* hor: DESC File Format. +* kernpairs: Font File Format. +* ligatures: Font File Format. +* name: Font File Format. +* papersize: DESC File Format. +* pass_filenames: DESC File Format. +* postpro: DESC File Format. +* prepro: DESC File Format. +* print: DESC File Format. +* res: DESC File Format. +* sizes: DESC File Format. +* sizescale: DESC File Format. +* slant: Font File Format. +* spacewidth: Font File Format. +* spare1: DESC File Format. +* spare2: DESC File Format. +* special <1>: Font File Format. +* special: Artificial Fonts. +* styles <1>: DESC File Format. +* styles <2>: Font Positions. +* styles <3>: Font Families. +* styles: Changing Fonts. +* tcommand: DESC File Format. +* unitwidth: DESC File Format. +* use_charnames_in_special <1>: DESC File Format. +* use_charnames_in_special: Postprocessor Access. +* vert: DESC File Format. + + +File: groff, Node: Program and File Index, Next: Concept Index, Prev: Font File Keyword Index, Up: Top + +Program and File Index +********************** + +* Menu: + +* an.tmac: man. +* changebar: Miscellaneous. +* DESC <1>: Special Fonts. +* DESC <2>: Using Symbols. +* DESC <3>: Font Positions. +* DESC <4>: Font Families. +* DESC: Changing Fonts. +* DESC file format: DESC File Format. +* DESC, and font mounting: Font Positions. +* DESC, and use_charnames_in_special: Postprocessor Access. +* ditroff: History. +* eqn: ms Insertions. +* geqn: Groff Options. +* geqn, invocation in manual pages: Preprocessors in man pages. +* ggrn: Groff Options. +* gpic: Groff Options. +* grap: Groff Options. +* grefer: Groff Options. +* grefer, invocation in manual pages: Preprocessors in man pages. +* groff: Groff Options. +* grog: grog. +* grohtml: Miscellaneous man macros. +* gsoelim: Groff Options. +* gtbl: Groff Options. +* gtbl, invocation in manual pages: Preprocessors in man pages. +* gtroff: Groff Options. +* hyphen.us: Manipulating Hyphenation. +* makeindex: Indices. +* man, invocation of preprocessors: Preprocessors in man pages. +* man-old.tmac: man. +* man.local: Man usage. +* man.tmac: man. +* nrchbar: Miscellaneous. +* perl: I/O. +* pic: ms Insertions. +* post-grohtml: Groff Options. +* pre-grohtml: Groff Options. +* refer: ms Insertions. +* soelim: Debugging. +* tbl: ms Insertions. +* trace.tmac: Writing Macros. +* troffrc <1>: Line Layout. +* troffrc <2>: Troff and Nroff Mode. +* troffrc <3>: Manipulating Hyphenation. +* troffrc: Groff Options. +* troffrc-end <1>: Troff and Nroff Mode. +* troffrc-end <2>: Manipulating Hyphenation. +* troffrc-end: Groff Options. +* tty.tmac: Troff and Nroff Mode. + diff --git a/contrib/groff/doc/groff-11 b/contrib/groff/doc/groff-11 new file mode 100644 index 0000000..d1e4c43 --- /dev/null +++ b/contrib/groff/doc/groff-11 @@ -0,0 +1,1536 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: Concept Index, Prev: Program and File Index, Up: Top + +Concept Index +************* + +* Menu: + +* ", at end of sentence <1>: Using Symbols. +* ", at end of sentence: Sentences. +* ", in a macro argument: Request Arguments. +* %, as delimiter: Escapes. +* &, as delimiter: Escapes. +* ', as a comment: Comments. +* ', at end of sentence <1>: Using Symbols. +* ', at end of sentence: Sentences. +* ', delimiting arguments: Escapes. +* (, as delimiter: Escapes. +* (, starting a two-character identifier <1>: Escapes. +* (, starting a two-character identifier: Identifiers. +* ), as delimiter: Escapes. +* ), at end of sentence <1>: Using Symbols. +* ), at end of sentence: Sentences. +* *, as delimiter: Escapes. +* *, at end of sentence <1>: Using Symbols. +* *, at end of sentence: Sentences. +* +, and page motion: Expressions. +* +, as delimiter: Escapes. +* -, and page motion: Expressions. +* -, as delimiter: Escapes. +* ., as delimiter: Escapes. +* .h register, difference to nl: Diversions. +* .ps register, in comparison with .psr: Fractional Type Sizes. +* .s register, in comparison with .sr: Fractional Type Sizes. +* .S register, Plan 9 alias for .tabs: Tabs and Fields. +* .t register, and diversions: Diversion Traps. +* .tabs register, Plan 9 alias (.S): Tabs and Fields. +* .V register, and vs: Changing Type Sizes. +* /, as delimiter: Escapes. +* 8-bit input: Font File Format. +* <, as delimiter: Escapes. +* <colon>, as delimiter: Escapes. +* =, as delimiter: Escapes. +* >, as delimiter: Escapes. +* [, macro names starting with, and refer: Identifiers. +* [, starting an identifier <1>: Escapes. +* [, starting an identifier: Identifiers. +* \!, and output: Diversions. +* \!, and trnt: Character Translations. +* \!, in top-level diversion: Diversions. +* \!, incompatibilities with AT&T troff: Implementation Differences. +* \!, used as delimiter: Escapes. +* \$, when reading text for a macro: Copy-in Mode. +* \%, and translations: Character Translations. +* \%, following \X or \Y: Manipulating Hyphenation. +* \%, in \X: Postprocessor Access. +* \%, incompatibilities with AT&T troff: Implementation Differences. +* \%, used as delimiter: Escapes. +* \&, and glyph definitions: Using Symbols. +* \&, and translations: Character Translations. +* \&, at end of sentence: Sentences. +* \&, escaping control characters: Requests. +* \&, in \X: Postprocessor Access. +* \&, incompatibilities with AT&T troff: Implementation Differences. +* \&, used as delimiter: Escapes. +* \', and translations: Character Translations. +* \', incompatibilities with AT&T troff: Implementation Differences. +* \', used as delimiter: Escapes. +* \(, and translations: Character Translations. +* \), in \X: Postprocessor Access. +* \), used as delimiter: Escapes. +* \*, and warnings: Warnings. +* \*, incompatibilities with AT&T troff: Implementation Differences. +* \*, when reading text for a macro: Copy-in Mode. +* \, disabling (eo): Character Translations. +* \,, used as delimiter: Escapes. +* \-, and translations: Character Translations. +* \-, incompatibilities with AT&T troff: Implementation Differences. +* \-, used as delimiter: Escapes. +* \/, used as delimiter: Escapes. +* \0, used as delimiter: Escapes. +* \<colon>, in \X: Postprocessor Access. +* \<colon>, used as delimiter: Escapes. +* \<RET>, when reading text for a macro: Copy-in Mode. +* \<SP>, difference to \~: Request Arguments. +* \<SP>, incompatibilities with AT&T troff: Implementation Differences. +* \<SP>, used as delimiter: Escapes. +* \?, in top-level diversion: Diversions. +* \?, incompatibilities with AT&T troff: Implementation Differences. +* \?, used as delimiter: Escapes. +* \@, used as delimiter: Escapes. +* \[, and translations: Character Translations. +* \\, when reading text for a macro: Copy-in Mode. +* \^, incompatibilities with AT&T troff: Implementation Differences. +* \^, used as delimiter: Escapes. +* \_, and translations: Character Translations. +* \_, incompatibilities with AT&T troff: Implementation Differences. +* \_, used as delimiter: Escapes. +* \`, and translations: Character Translations. +* \`, incompatibilities with AT&T troff: Implementation Differences. +* \`, used as delimiter: Escapes. +* \A, allowed delimiters: Escapes. +* \a, and translations: Character Translations. +* \A, incompatibilities with AT&T troff: Implementation Differences. +* \a, used as delimiter: Escapes. +* \B, allowed delimiters: Escapes. +* \b, limitations: Drawing Requests. +* \b, possible quote characters: Escapes. +* \C, allowed delimiters: Escapes. +* \c, and fill mode: Line Control. +* \c, and no-fill mode: Line Control. +* \C, and translations: Character Translations. +* \c, incompatibilities with AT&T troff: Implementation Differences. +* \c, used as delimiter: Escapes. +* \D, allowed delimiters: Escapes. +* \d, used as delimiter: Escapes. +* \e, and glyph definitions: Using Symbols. +* \e, and translations: Character Translations. +* \e, incompatibilities with AT&T troff: Implementation Differences. +* \e, used as delimiter: Escapes. +* \E, used as delimiter: Escapes. +* \e, used as delimiter: Escapes. +* \F, and changing fonts: Changing Fonts. +* \F, and font positions: Font Positions. +* \f, and font translations: Changing Fonts. +* \f, incompatibilities with AT&T troff: Implementation Differences. +* \H, allowed delimiters: Escapes. +* \h, allowed delimiters: Escapes. +* \H, incompatibilities with AT&T troff: Implementation Differences. +* \H, using + and -: Expressions. +* \H, with fractional type sizes: Fractional Type Sizes. +* \L, allowed delimiters: Escapes. +* \l, allowed delimiters: Escapes. +* \L, and glyph definitions: Using Symbols. +* \l, and glyph definitions: Using Symbols. +* \N, allowed delimiters: Escapes. +* \N, and translations: Character Translations. +* \n, and warnings: Warnings. +* \n, incompatibilities with AT&T troff: Implementation Differences. +* \n, when reading text for a macro: Copy-in Mode. +* \o, possible quote characters: Escapes. +* \p, used as delimiter: Escapes. +* \R, after \c: Line Control. +* \R, allowed delimiters: Escapes. +* \R, and warnings: Warnings. +* \R, difference to nr: Auto-increment. +* \r, used as delimiter: Escapes. +* \R, using + and -: Expressions. +* \S, allowed delimiters: Escapes. +* \s, allowed delimiters: Escapes. +* \S, incompatibilities with AT&T troff: Implementation Differences. +* \s, incompatibilities with AT&T troff: Implementation Differences. +* \s, using + and -: Expressions. +* \s, with fractional type sizes: Fractional Type Sizes. +* \t, and translations: Character Translations. +* \t, and warnings: Warnings. +* \t, used as delimiter: Escapes. +* \u, used as delimiter: Escapes. +* \v, allowed delimiters: Escapes. +* \v, internal representation: Gtroff Internals. +* \w, allowed delimiters: Escapes. +* \x, allowed delimiters: Escapes. +* \X, and special characters: Postprocessor Access. +* \X, followed by \%: Manipulating Hyphenation. +* \X, possible quote characters: Escapes. +* \Y, followed by \%: Manipulating Hyphenation. +* \Z, allowed delimiters: Escapes. +* \{, incompatibilities with AT&T troff: Implementation Differences. +* \{, used as delimiter: Escapes. +* \|, incompatibilities with AT&T troff: Implementation Differences. +* \|, used as delimiter: Escapes. +* \}, and warnings: Warnings. +* \}, incompatibilities with AT&T troff: Implementation Differences. +* \}, used as delimiter: Escapes. +* \~, and translations: Character Translations. +* \~, difference to \<SP>: Request Arguments. +* \~, used as delimiter: Escapes. +* ], as part of an identifier: Identifiers. +* ], at end of sentence <1>: Using Symbols. +* ], at end of sentence: Sentences. +* ], ending an identifier <1>: Escapes. +* ], ending an identifier: Identifiers. +* ], macro names starting with, and refer: Identifiers. +* aborting (ab): Debugging. +* absolute position operator (|): Expressions. +* accent marks [ms]: ms Strings and Special Characters. +* access of postprocessor: Postprocessor Access. +* accessing unnamed glyphs with \N: Font File Format. +* activating kerning (kern): Ligatures and Kerning. +* activating ligatures (lg): Ligatures and Kerning. +* activating track kerning (tkf): Ligatures and Kerning. +* ad request, and hyphenation margin: Manipulating Hyphenation. +* ad request, and hyphenation space: Manipulating Hyphenation. +* adjusting: Filling and Adjusting. +* adjusting and filling, manipulating: Manipulating Filling and Adjusting. +* adjustment mode register (.j): Manipulating Filling and Adjusting. +* alias, diversion, creating (als): Strings. +* alias, macro, creating (als): Strings. +* alias, number register, creating (aln): Setting Registers. +* alias, string, creating (als): Strings. +* als request, and \$0: Parameters. +* am, am1, ami requests, and warnings: Warnings. +* annotations: Footnotes and Annotations. +* appending to a diversion (da): Diversions. +* appending to a file (opena): I/O. +* appending to a macro (am): Writing Macros. +* appending to a string (as): Strings. +* arc, drawing (\D'a ...'): Drawing Requests. +* argument delimiting characters: Escapes. +* arguments to requests: Request Arguments. +* arguments, macro (\$): Parameters. +* arguments, of strings: Strings. +* arithmetic operators: Expressions. +* artificial fonts: Artificial Fonts. +* as, as1 requests, and comments: Comments. +* as, as1 requests, and warnings: Warnings. +* ASCII approximation output register (.A) <1>: Built-in Registers. +* ASCII approximation output register (.A): Groff Options. +* ASCII, encoding: Groff Options. +* asciify request, and writem: I/O. +* assigning formats (af): Assigning Formats. +* assignments, indirect: Interpolating Registers. +* assignments, nested: Interpolating Registers. +* AT&T troff, ms macro package differences: Differences from AT&T ms. +* auto-increment: Auto-increment. +* available glyphs, list (`groff_char(7)' man page): Using Symbols. +* backslash, printing (\\, \e, \E, \[rs]) <1>: Implementation Differences. +* backslash, printing (\\, \e, \E, \[rs]): Escapes. +* backspace character: Identifiers. +* backspace character, and translations: Character Translations. +* backtrace of input stack (backtrace): Debugging. +* baseline: Sizes. +* basic unit (u): Measurements. +* basics of macros: Basics. +* bd request, and font styles: Font Families. +* bd request, and font translations: Changing Fonts. +* bd request, incompatibilities with AT&T troff: Implementation Differences. +* begin of conditional block (\{): if-else. +* beginning diversion (di): Diversions. +* blank line <1>: Requests. +* blank line: Implicit Line Breaks. +* blank line (sp): Basics. +* blank line macro (blm) <1>: Blank Line Traps. +* blank line macro (blm) <2>: Requests. +* blank line macro (blm): Implicit Line Breaks. +* blank line traps: Blank Line Traps. +* blank lines, disabling: Manipulating Spacing. +* block, conditional, begin (\{): if-else. +* block, condititional, end (\}): if-else. +* bold face [man]: Man font macros. +* bold face, imitating (bd): Artificial Fonts. +* bottom margin: Page Layout. +* bounding box: Miscellaneous. +* box rule glyph (\[br]): Drawing Requests. +* box, boxa requests, and warnings: Warnings. +* bp request, and top-level diversion: Page Control. +* bp request, causing implicit linebreak: Manipulating Filling and Adjusting. +* bp request, using + and -: Expressions. +* br glyph, and cflags: Using Symbols. +* break <1>: Manipulating Filling and Adjusting. +* break: Basics. +* break (br): Basics. +* break request, in a while loop: while. +* break, implicit: Implicit Line Breaks. +* built-in registers: Built-in Registers. +* bulleted list, example markup [ms]: Lists in ms. +* c unit: Measurements. +* calling convention of preprocessors: Preprocessors in man pages. +* capabilities of groff: groff Capabilities. +* ce request, causing implicit linebreak: Manipulating Filling and Adjusting. +* ce request, difference to .ad c: Manipulating Filling and Adjusting. +* centered text: Manipulating Filling and Adjusting. +* centering lines (ce) <1>: Manipulating Filling and Adjusting. +* centering lines (ce): Basics. +* centimeter unit (c): Measurements. +* cf request, causing implicit linebreak: Manipulating Filling and Adjusting. +* changing font family (fam, \F): Font Families. +* changing font position (\f): Font Positions. +* changing font style (sty): Font Families. +* changing fonts (ft, \f): Changing Fonts. +* changing format, and read-only registers: Assigning Formats. +* changing the font height (\H): Artificial Fonts. +* changing the font slant (\S): Artificial Fonts. +* changing the page number character (pc): Page Layout. +* changing trap location (ch): Page Location Traps. +* changing type sizes (ps, \s): Changing Type Sizes. +* changing vertical line spacing (vs): Changing Type Sizes. +* char request, and soft hyphen character: Manipulating Hyphenation. +* char request, and translations: Character Translations. +* char request, used with \N: Using Symbols. +* character: Using Symbols. +* character properties (cflags): Using Symbols. +* character translations: Character Translations. +* character, backspace: Identifiers. +* character, backspace, and translations: Character Translations. +* character, control (.): Requests. +* character, control, changing (cc): Character Translations. +* character, defining (char): Using Symbols. +* character, escape, changing (ec): Character Translations. +* character, escape, while defining glyph: Using Symbols. +* character, field delimiting (fc): Fields. +* character, field padding (fc): Fields. +* character, hyphenation (\%): Manipulating Hyphenation. +* character, leader repetition (lc): Leaders. +* character, leader, and translations: Character Translations. +* character, leader, non-interpreted (\a): Leaders. +* character, named (\C): Using Symbols. +* character, newline: Escapes. +* character, newline, and translations: Character Translations. +* character, no-break control ('): Requests. +* character, no-break control, changing (c2): Character Translations. +* character, soft hyphen, setting (shc): Manipulating Hyphenation. +* character, space: Escapes. +* character, special: Character Translations. +* character, tab: Escapes. +* character, tab repetition (tc): Tabs and Fields. +* character, tab, and translations: Character Translations. +* character, tab, non-interpreted (\t): Tabs and Fields. +* character, tabulator: Tab Stops. +* character, transparent <1>: Using Symbols. +* character, transparent: Sentences. +* character, whitespace: Identifiers. +* character, zero width space (\&) <1>: Drawing Requests. +* character, zero width space (\&) <2>: Ligatures and Kerning. +* character, zero width space (\&): Requests. +* characters, argument delimiting: Escapes. +* characters, end-of-sentence: Using Symbols. +* characters, hyphenation: Using Symbols. +* characters, input, and output glyphs, compatibility with AT&T troff: Implementation Differences. +* characters, invalid for trf request: I/O. +* characters, invalid input: Identifiers. +* characters, overlapping: Using Symbols. +* characters, special: Special Characters. +* characters, unnamed, accessing with \N: Font File Format. +* circle, drawing (\D'c ...'): Drawing Requests. +* circle, solid, drawing (\D'C ...'): Drawing Requests. +* closing file (close): I/O. +* code, hyphenation (hcode): Manipulating Hyphenation. +* color, default: Colors. +* colors: Colors. +* command prefix: Environment. +* command-line options: Groff Options. +* commands, embedded: Embedded Commands. +* comments: Comments. +* comments in font files: Font File Format. +* comments, lining up with tabs: Comments. +* comments, with ds: Strings. +* common features: Common Features. +* common name space of macros, diversions, and strings: Strings. +* comparison operators: Expressions. +* compatibility mode <1>: Implementation Differences. +* compatibility mode: Warnings. +* conditional block, begin (\{): if-else. +* conditional block, end (\}): if-else. +* conditional page break (ne): Page Control. +* conditionals and loops: Conditionals and Loops. +* consecutive hyphenated lines (hlm): Manipulating Hyphenation. +* constant glyph space mode (cs): Artificial Fonts. +* contents, table of <1>: Leaders. +* contents, table of: Table of Contents. +* continuation, input line (\): Line Control. +* continuation, output line (\c): Line Control. +* continue request, in a while loop: while. +* continuous underlining (cu): Artificial Fonts. +* control character (.): Requests. +* control character, changing (cc): Character Translations. +* control character, no-break ('): Requests. +* control character, no-break, changing (c2): Character Translations. +* control, line: Line Control. +* control, page: Page Control. +* conventions for input: Input Conventions. +* copy-in mode: Copy-in Mode. +* copy-in mode, and macro arguments: Parameters. +* copy-in mode, and write requests: I/O. +* copying environment (evc): Environments. +* correction between italic and roman glyph (\/, \,): Ligatures and Kerning. +* correction, italic (\/): Ligatures and Kerning. +* correction, left italic (\,): Ligatures and Kerning. +* cover page macros, [ms]: ms Cover Page Macros. +* cp request, and glyph definitions: Using Symbols. +* cp1047: Groff Options. +* creating alias, for diversion (als): Strings. +* creating alias, for macro (als): Strings. +* creating alias, for number register (aln): Setting Registers. +* creating alias, for string (als): Strings. +* creating new characters (char): Using Symbols. +* credits: Credits. +* cs request, and font styles: Font Families. +* cs request, and font translations: Changing Fonts. +* cs request, incompatibilities with AT&T troff: Implementation Differences. +* cs request, with fractional type sizes: Fractional Type Sizes. +* current directory: Macro Directories. +* current input file name register (.F): Built-in Registers. +* current time: I/O. +* current time, hours (hours): Built-in Registers. +* current time, minutes (minutes): Built-in Registers. +* current time, seconds (seconds): Built-in Registers. +* da request, and warnings: Warnings. +* date, day of the month register (dy): Built-in Registers. +* date, day of the week register (dw): Built-in Registers. +* date, month of the year register (mo): Built-in Registers. +* date, year register (year, yr): Built-in Registers. +* day of the month register (dy): Built-in Registers. +* day of the week register (dw): Built-in Registers. +* de request, and while: while. +* de, de1, dei requests, and warnings: Warnings. +* debugging: Debugging. +* default color: Colors. +* default indentation [man]: Miscellaneous man macros. +* default indentation, resetting [man]: Man usage. +* default units: Default Units. +* defining character (char): Using Symbols. +* defining glyph (char): Using Symbols. +* defining symbol (char): Using Symbols. +* delayed text: Footnotes and Annotations. +* delimited arguments, incompatibilities with AT&T troff: Implementation Differences. +* delimiting character, for fields (fc): Fields. +* delimiting characters for arguments: Escapes. +* DESC file, format: DESC File Format. +* devices for output <1>: Output Devices. +* devices for output: Output device intro. +* dg glyph, at end of sentence <1>: Using Symbols. +* dg glyph, at end of sentence: Sentences. +* di request, and warnings: Warnings. +* differences in implementation: Implementation Differences. +* digit width space (\0): Page Motions. +* digits, and delimiters: Escapes. +* dimensions, line: Line Layout. +* directories for fonts: Font Directories. +* directories for macros: Macro Directories. +* directory, current: Macro Directories. +* directory, for tmac files: Macro Directories. +* directory, home: Macro Directories. +* directory, platform-specific: Macro Directories. +* directory, site-specific <1>: Font Directories. +* directory, site-specific: Macro Directories. +* disabling \ (eo): Character Translations. +* disabling hyphenation (\%): Manipulating Hyphenation. +* displays: Displays. +* displays [ms]: ms Displays and Keeps. +* distance to next trap register (.t): Page Location Traps. +* ditroff, the program: History. +* diversion name register (.z): Diversions. +* diversion trap, setting (dt): Diversion Traps. +* diversion traps: Diversion Traps. +* diversion, appending (da): Diversions. +* diversion, beginning (di): Diversions. +* diversion, creating alias (als): Strings. +* diversion, ending (di): Diversions. +* diversion, nested: Diversions. +* diversion, removing (rm): Strings. +* diversion, renaming (rn): Strings. +* diversion, stripping final newline: Strings. +* diversion, top-level: Diversions. +* diversion, top-level, and \!: Diversions. +* diversion, top-level, and \?: Diversions. +* diversion, top-level, and bp: Page Control. +* diversion, unformatting (asciify): Diversions. +* diversion, vertical position in, register (.d): Diversions. +* diversions: Diversions. +* diversions, shared name space with macros and strings: Strings. +* documents, multi-file: Debugging. +* documents, structuring the source code: Requests. +* double quote, in a macro argument: Request Arguments. +* double-spacing (ls) <1>: Manipulating Spacing. +* double-spacing (ls): Basics. +* double-spacing (vs, pvs): Changing Type Sizes. +* drawing a circle (\D'c ...'): Drawing Requests. +* drawing a line (\D'l ...'): Drawing Requests. +* drawing a polygon (\D'p ...'): Drawing Requests. +* drawing a solid circle (\D'C ...'): Drawing Requests. +* drawing a solid ellipse (\D'E ...'): Drawing Requests. +* drawing a solid polygon (\D'P ...'): Drawing Requests. +* drawing a spline (\D'~ ...'): Drawing Requests. +* drawing an arc (\D'a ...'): Drawing Requests. +* drawing an ellipse (\D'e ...'): Drawing Requests. +* drawing horizontal lines (\l): Drawing Requests. +* drawing requests: Drawing Requests. +* drawing vertical lines (\L): Drawing Requests. +* ds request, and comments: Strings. +* ds request, and double quotes: Request Arguments. +* ds request, and leading spaces: Strings. +* ds, ds1 requests, and comments: Comments. +* ds, ds1 requests, and warnings: Warnings. +* dumping number registers (pnr): Debugging. +* dumping symbol table (pm): Debugging. +* dumping traps (ptr): Debugging. +* EBCDIC encoding <1>: Tab Stops. +* EBCDIC encoding: Groff Options. +* EBCDIC encoding of a tab: Tabs and Fields. +* EBCDIC encoding of backspace: Identifiers. +* el request, and warnings: Warnings. +* ellipse, drawing (\D'e ...'): Drawing Requests. +* ellipse, solid, drawing (\D'E ...'): Drawing Requests. +* em glyph, and cflags: Using Symbols. +* em unit (m): Measurements. +* embedded commands: Embedded Commands. +* embedding PostScript: Embedding PostScript. +* embolding of special fonts: Artificial Fonts. +* empty line: Implicit Line Breaks. +* empty line (sp): Basics. +* empty space before a paragraph [man]: Miscellaneous man macros. +* en unit (n): Measurements. +* enabling vertical position traps (vpt): Page Location Traps. +* encoding, ASCII: Groff Options. +* encoding, cp1047: Groff Options. +* encoding, EBCDIC <1>: Tab Stops. +* encoding, EBCDIC: Groff Options. +* encoding, latin-1: Groff Options. +* encoding, utf-8: Groff Options. +* end of conditional block (\}): if-else. +* end-of-input macro (em): End-of-input Traps. +* end-of-input trap, setting (em): End-of-input Traps. +* end-of-input traps: End-of-input Traps. +* end-of-sentence characters: Using Symbols. +* ending diversion (di): Diversions. +* environment number/name register (.ev): Environments. +* environment variables: Environment. +* environment, copying (evc): Environments. +* environment, last glyph: Environments. +* environment, switching (ev): Environments. +* environments: Environments. +* eqn, the program: geqn. +* equations [ms]: ms Insertions. +* escape character, changing (ec): Character Translations. +* escape character, while defining glyph: Using Symbols. +* escapes: Escapes. +* escaping newline characters, in strings: Strings. +* ex request, use in debugging: Debugging. +* ex request, used with nx and rd: I/O. +* example markup, bulleted list [ms]: Lists in ms. +* example markup, glossary-style list [ms]: Lists in ms. +* example markup, multi-page table [ms]: Example multi-page table. +* example markup, numbered list [ms]: Lists in ms. +* example markup, title page: ms Cover Page Macros. +* examples of invocation: Invocation Examples. +* exiting (ex): Debugging. +* expansion of strings (\*): Strings. +* explicit hyphen (\%): Manipulating Hyphenation. +* expression, order of evaluation: Expressions. +* expressions: Expressions. +* expressions, and space characters: Expressions. +* extra post-vertical line space (\x): Changing Type Sizes. +* extra post-vertical line space register (.a): Manipulating Spacing. +* extra pre-vertical line space (\x): Changing Type Sizes. +* extra spaces: Filling and Adjusting. +* extremum operators (>?, <?): Expressions. +* f unit: Measurements. +* f unit, and colors: Colors. +* fam request, and changing fonts: Changing Fonts. +* fam request, and font positions: Font Positions. +* families, font: Font Families. +* FDL, GNU Free Documentation License: GNU Free Documentation License. +* features, common: Common Features. +* fi request, causing implicit linebreak: Manipulating Filling and Adjusting. +* field delimiting character (fc): Fields. +* field padding character (fc): Fields. +* fields: Fields. +* fields, and tabs: Tabs and Fields. +* figures [ms]: ms Insertions. +* file formats: File formats. +* file, appending to (opena): I/O. +* file, closing (close): I/O. +* file, inclusion (so): I/O. +* file, opening (open): I/O. +* file, processing next (nx): I/O. +* file, writing to (write): I/O. +* files, font: Font Files. +* files, macro, searching: Macro Directories. +* fill mode <1>: Warnings. +* fill mode <2>: Manipulating Filling and Adjusting. +* fill mode: Implicit Line Breaks. +* fill mode (fi): Manipulating Filling and Adjusting. +* fill mode, and \c: Line Control. +* filling: Filling and Adjusting. +* filling and adjusting, manipulating: Manipulating Filling and Adjusting. +* final newline, stripping in diversions: Strings. +* fl request, causing implicit linebreak: Manipulating Filling and Adjusting. +* floating keep: Displays. +* flush output (fl): Debugging. +* font description file, format <1>: Font File Format. +* font description file, format: DESC File Format. +* font directories: Font Directories. +* font families: Font Families. +* font family, changing (fam, \F): Font Families. +* font file, format: Font File Format. +* font files: Font Files. +* font files, comments: Font File Format. +* font for underlining (uf): Artificial Fonts. +* font height, changing (\H): Artificial Fonts. +* font path: Font Directories. +* font position register (.f): Font Positions. +* font position, changing (\f): Font Positions. +* font positions: Font Positions. +* font selection [man]: Man font macros. +* font slant, changing (\S): Artificial Fonts. +* font style, changing (sty): Font Families. +* font styles: Font Families. +* font, mounting (fp): Font Positions. +* font, previous (ft, \f[], \fP): Changing Fonts. +* fonts <1>: Changing Fonts. +* fonts: Fonts. +* fonts, artificial: Artificial Fonts. +* fonts, changing (ft, \f): Changing Fonts. +* fonts, PostScript: Font Families. +* fonts, searching: Font Directories. +* fonts, special: Special Fonts. +* footers <1>: Page Location Traps. +* footers: Page Layout. +* footers [ms]: ms Headers and Footers. +* footnotes: Footnotes and Annotations. +* footnotes [ms]: ms Footnotes. +* form letters: I/O. +* format of font description file: DESC File Format. +* format of font description files: Font File Format. +* format of font files: Font File Format. +* format of register (\g): Assigning Formats. +* formats, assigning (af): Assigning Formats. +* formats, file: File formats. +* fp request, and font translations: Changing Fonts. +* fp request, incompatibilities with AT&T troff: Implementation Differences. +* fractional point sizes <1>: Implementation Differences. +* fractional point sizes: Fractional Type Sizes. +* fractional type sizes <1>: Implementation Differences. +* fractional type sizes: Fractional Type Sizes. +* french-spacing: Sentences. +* fspecial request, and font styles: Font Families. +* fspecial request, and font translations: Changing Fonts. +* fspecial request, and imitating bold: Artificial Fonts. +* ft request, and font translations: Changing Fonts. +* geqn, invoking: Invoking geqn. +* geqn, the program: geqn. +* ggrn, invoking: Invoking ggrn. +* ggrn, the program: ggrn. +* glossary-style list, example markup [ms]: Lists in ms. +* glyph: Using Symbols. +* glyph for line drawing: Drawing Requests. +* glyph pile (\b): Drawing Requests. +* glyph properties (cflags): Using Symbols. +* glyph, box rule (\[br]): Drawing Requests. +* glyph, constant space: Artificial Fonts. +* glyph, defining (char): Using Symbols. +* glyph, for line drawing: Drawing Requests. +* glyph, for margins (mc): Miscellaneous. +* glyph, italic correction (\/): Ligatures and Kerning. +* glyph, leader repetition (lc): Leaders. +* glyph, left italic correction (\,): Ligatures and Kerning. +* glyph, numbered (\N) <1>: Using Symbols. +* glyph, numbered (\N): Character Translations. +* glyph, removing definition (rchar): Using Symbols. +* glyph, soft hyphen (hy): Manipulating Hyphenation. +* glyph, tab repetition (tc): Tabs and Fields. +* glyph, underscore (\[ru]): Drawing Requests. +* glyphs, available, list (`groff_char(7)' man page): Using Symbols. +* glyphs, output, and input characters, compatibility with AT&T troff: Implementation Differences. +* glyphs, overstriking (\o): Page Motions. +* glyphs, unnamed: Using Symbols. +* glyphs, unnamed, accessing with \N: Font File Format. +* GNU-specific register (.g): Built-in Registers. +* gpic, invoking: Invoking gpic. +* gpic, the program: gpic. +* grap, the program: grap. +* gray shading (\D'f ...'): Drawing Requests. +* grefer, invoking: Invoking grefer. +* grefer, the program: grefer. +* grn, the program: ggrn. +* grodvi, invoking: Invoking grodvi. +* grodvi, the program: grodvi. +* groff - what is it?: What Is groff?. +* groff capabilities: groff Capabilities. +* groff invocation: Invoking groff. +* groff, and pi request: I/O. +* GROFF_BIN_PATH, environment variable: Environment. +* GROFF_COMMAND_PREFIX, environment variable: Environment. +* GROFF_FONT_PATH, environment variable <1>: Font Directories. +* GROFF_FONT_PATH, environment variable: Environment. +* GROFF_TMAC_PATH, environment variable <1>: Macro Directories. +* GROFF_TMAC_PATH, environment variable: Environment. +* GROFF_TMPDIR, environment variable: Environment. +* GROFF_TYPESETTER, environment variable: Environment. +* grohtml, invoking: Invoking grohtml. +* grohtml, registers and strings: grohtml specific registers and strings. +* grohtml, the program <1>: grohtml. +* grohtml, the program: Groff Options. +* grolbp, invoking: Invoking grolbp. +* grolbp, the program: grolbp. +* grolj4, invoking: Invoking grolj4. +* grolj4, the program: grolj4. +* grops, invoking: Invoking grops. +* grops, the program: grops. +* grotty, invoking: Invoking grotty. +* grotty, the program: grotty. +* gsoelim, invoking: Invoking gsoelim. +* gsoelim, the program: gsoelim. +* gtbl, invoking: Invoking gtbl. +* gtbl, the program: gtbl. +* gtroff, identification register (.g): Built-in Registers. +* gtroff, interactive use: Debugging. +* gtroff, output: gtroff Output. +* gtroff, process ID register ($$): Built-in Registers. +* gtroff, reference: gtroff Reference. +* gxditview, invoking: Invoking gxditview. +* gxditview, the program: gxditview. +* hanging indentation [man]: Man usage. +* hcode request, and glyph definitions: Using Symbols. +* headers <1>: Page Location Traps. +* headers: Page Layout. +* headers [ms]: ms Headers and Footers. +* height, font, changing (\H): Artificial Fonts. +* high-water mark register (.h): Diversions. +* history: History. +* home directory: Macro Directories. +* horizontal input line position register (hp): Page Motions. +* horizontal input line position, saving (\k): Page Motions. +* horizontal line, drawing (\l): Drawing Requests. +* horizontal motion (\h): Page Motions. +* horizontal output line position register (.k): Page Motions. +* horizontal resolution register (.H): Built-in Registers. +* horizontal space (\h): Page Motions. +* horizontal space, unformatting: Strings. +* hours, current time (hours): Built-in Registers. +* hpf request, and hyphenation language: Manipulating Hyphenation. +* hw request, and hyphenation language: Manipulating Hyphenation. +* hy glyph, and cflags: Using Symbols. +* hyphen, explicit (\%): Manipulating Hyphenation. +* hyphenated lines, consecutive (hlm): Manipulating Hyphenation. +* hyphenating characters: Using Symbols. +* hyphenation: Hyphenation. +* hyphenation character (\%): Manipulating Hyphenation. +* hyphenation code (hcode): Manipulating Hyphenation. +* hyphenation language register (.hla): Manipulating Hyphenation. +* hyphenation margin (hym): Manipulating Hyphenation. +* hyphenation margin register (.hym): Manipulating Hyphenation. +* hyphenation patterns (hpf): Manipulating Hyphenation. +* hyphenation restrictions register (.hy): Manipulating Hyphenation. +* hyphenation space (hys): Manipulating Hyphenation. +* hyphenation space register (.hys): Manipulating Hyphenation. +* hyphenation, disabling (\%): Manipulating Hyphenation. +* hyphenation, manipulating: Manipulating Hyphenation. +* i unit: Measurements. +* i/o: I/O. +* IBM cp1047: Groff Options. +* identifiers: Identifiers. +* identifiers, undefined: Identifiers. +* ie request, and warnings: Warnings. +* if request, and the ! operator: Expressions. +* if request, operators to use with: Operators in Conditionals. +* if-else: if-else. +* imitating bold face (bd): Artificial Fonts. +* implementation differences: Implementation Differences. +* implicit breaks of lines: Implicit Line Breaks. +* implicit line breaks: Implicit Line Breaks. +* in request, causing implicit linebreak: Manipulating Filling and Adjusting. +* in request, using + and -: Expressions. +* inch unit (i): Measurements. +* including a file (so): I/O. +* incompatibilities with AT&T troff: Implementation Differences. +* increment value without changing the register: Auto-increment. +* increment, automatic: Auto-increment. +* indentaion, resetting to default [man]: Man usage. +* indentation (in): Line Layout. +* index, in macro package: Indices. +* indirect assignments: Interpolating Registers. +* input and output requests: I/O. +* input characters and output glyphs, compatibility with AT&T troff: Implementation Differences. +* input characters, invalid: Identifiers. +* input conventions: Input Conventions. +* input file name, current, register (.F): Built-in Registers. +* input level in delimited arguments: Implementation Differences. +* input line continuation (\): Line Control. +* input line number register (.c, c.): Built-in Registers. +* input line number, setting (lf): Debugging. +* input line position, horizontal, saving (\k): Page Motions. +* input line trap, setting (it): Input Line Traps. +* input line traps: Input Line Traps. +* input line traps and interrupted lines (itc): Input Line Traps. +* input line, horizontal position, register (hp): Page Motions. +* input stack, backtrace (backtrace): Debugging. +* input stack, setting limit: Debugging. +* input token: Gtroff Internals. +* input, 8-bit: Font File Format. +* input, standard, reading from (rd): I/O. +* inserting horizontal space (\h): Page Motions. +* installation: Installation. +* interactive use of gtroff: Debugging. +* intermediate output: gtroff Output. +* interpolating registers (\n): Interpolating Registers. +* interpolation of strings (\*): Strings. +* interrupted line: Line Control. +* interrupted line register (.int): Line Control. +* interrupted lines and input line traps (itc): Input Line Traps. +* introduction: Introduction. +* invalid characters for trf request: I/O. +* invalid input characters: Identifiers. +* invocation examples: Invocation Examples. +* invoking geqn: Invoking geqn. +* invoking ggrn: Invoking ggrn. +* invoking gpic: Invoking gpic. +* invoking grefer: Invoking grefer. +* invoking grodvi: Invoking grodvi. +* invoking groff: Invoking groff. +* invoking grohtml: Invoking grohtml. +* invoking grolbp: Invoking grolbp. +* invoking grolj4: Invoking grolj4. +* invoking grops: Invoking grops. +* invoking grotty: Invoking grotty. +* invoking gsoelim: Invoking gsoelim. +* invoking gtbl: Invoking gtbl. +* invoking gxditview: Invoking gxditview. +* italic correction (\/): Ligatures and Kerning. +* italic fonts [man]: Man font macros. +* italic glyph, correction after roman glyph (\,): Ligatures and Kerning. +* italic glyph, correction before roman glyph (\/): Ligatures and Kerning. +* justifying text: Manipulating Filling and Adjusting. +* justifying text (rj): Manipulating Filling and Adjusting. +* keep: Displays. +* keep, floating: Displays. +* keeps [ms]: ms Displays and Keeps. +* kerning and ligatures: Ligatures and Kerning. +* kerning enabled register (.kern): Ligatures and Kerning. +* kerning, activating (kern): Ligatures and Kerning. +* kerning, track: Ligatures and Kerning. +* last-requested point size registers (.psr, .sr): Fractional Type Sizes. +* latin-1, encoding: Groff Options. +* layout, line: Line Layout. +* layout, page: Page Layout. +* lc request, and glyph definitions: Using Symbols. +* leader character: Leaders. +* leader character, and translations: Character Translations. +* leader character, non-interpreted (\a): Leaders. +* leader repetition character (lc): Leaders. +* leaders: Leaders. +* leading: Sizes. +* leading spaces: Filling and Adjusting. +* leading spaces with ds: Strings. +* left italic correction (\,): Ligatures and Kerning. +* left margin (po): Line Layout. +* left margin, how to move [man]: Man usage. +* length of a string (length): Strings. +* length of line (ll): Line Layout. +* length of page (pl): Page Layout. +* length of title line (lt): Page Layout. +* letters, form: I/O. +* level of warnings (warn): Debugging. +* ligature: Using Symbols. +* ligatures and kerning: Ligatures and Kerning. +* ligatures enabled register (.lg): Ligatures and Kerning. +* ligatures, activating (lg): Ligatures and Kerning. +* limitations of \b escape: Drawing Requests. +* line break <1>: Manipulating Filling and Adjusting. +* line break <2>: Implicit Line Breaks. +* line break: Basics. +* line break (br): Basics. +* line breaks, with vertical space [man]: Man usage. +* line breaks, without vertical space [man]: Man usage. +* line control: Line Control. +* line dimensions: Line Layout. +* line drawing glyph: Drawing Requests. +* line indentation (in): Line Layout. +* line layout: Line Layout. +* line length (ll): Line Layout. +* line length register (.l): Line Layout. +* line number, input, register (.c, c.): Built-in Registers. +* line number, output, register (ln): Built-in Registers. +* line numbers, printing (nm): Miscellaneous. +* line space, extra post-vertical (\x): Changing Type Sizes. +* line space, extra pre-vertical (\x): Changing Type Sizes. +* line spacing register (.L): Manipulating Spacing. +* line spacing, post-vertical (pvs): Changing Type Sizes. +* line thickness (\D't ...'): Drawing Requests. +* line, blank: Implicit Line Breaks. +* line, drawing (\D'l ...'): Drawing Requests. +* line, empty (sp): Basics. +* line, horizontal, drawing (\l): Drawing Requests. +* line, implicit breaks: Implicit Line Breaks. +* line, input, continuation (\): Line Control. +* line, input, horizontal position, register (hp): Page Motions. +* line, input, horizontal position, saving (\k): Page Motions. +* line, interrupted: Line Control. +* line, output, continuation (\c): Line Control. +* line, output, horizontal position, register (.k): Page Motions. +* line, vertical, drawing (\L): Drawing Requests. +* line-tabs mode: Tabs and Fields. +* lines, blank, disabling: Manipulating Spacing. +* lines, centering (ce) <1>: Manipulating Filling and Adjusting. +* lines, centering (ce): Basics. +* lines, consecutive hyphenated (hlm): Manipulating Hyphenation. +* lines, interrupted, and input line traps (itc): Input Line Traps. +* list: Displays. +* list of available glyphs (`groff_char(7)' man page): Using Symbols. +* ll request, using + and -: Expressions. +* location, vertical, page, marking (mk): Page Motions. +* location, vertical, page, returning to marked (rt): Page Motions. +* logical operators: Expressions. +* long names: Implementation Differences. +* loops and conditionals: Conditionals and Loops. +* lq glyph, and lq string [man]: Predefined man strings. +* ls request, alternative to (pvs): Changing Type Sizes. +* lt request, using + and -: Expressions. +* M unit: Measurements. +* m unit: Measurements. +* machine unit (u): Measurements. +* macro basics: Basics. +* macro directories: Macro Directories. +* macro files, searching: Macro Directories. +* macro name register (\$0): Parameters. +* macro names, starting with [ or ], and refer: Identifiers. +* macro packages <1>: Macro Packages. +* macro packages: Macro Package Intro. +* macro packages, structuring the source code: Requests. +* macro, appending (am): Writing Macros. +* macro, arguments (\$): Parameters. +* macro, creating alias (als): Strings. +* macro, end-of-input (em): End-of-input Traps. +* macro, removing (rm): Strings. +* macro, renaming (rn): Strings. +* macros: Macros. +* macros for manual pages [man]: Man usage. +* macros, recursive: while. +* macros, searching: Macro Directories. +* macros, shared name space with strings and diversions: Strings. +* macros, tutorial for users: Tutorial for Macro Users. +* macros, writing: Writing Macros. +* major quotes: Displays. +* major version number register (.x): Built-in Registers. +* man macros: Man usage. +* man macros, bold face: Man font macros. +* man macros, default indentation: Miscellaneous man macros. +* man macros, empty space before a paragraph: Miscellaneous man macros. +* man macros, hanging indentation: Man usage. +* man macros, how to set fonts: Man font macros. +* man macros, italic fonts: Man font macros. +* man macros, line breaks with vertical space: Man usage. +* man macros, line breaks without vertical space: Man usage. +* man macros, moving left margin: Man usage. +* man macros, resetting default indentation: Man usage. +* man macros, tab stops: Miscellaneous man macros. +* man pages: man. +* manipulating filling and adjusting: Manipulating Filling and Adjusting. +* manipulating hyphenation: Manipulating Hyphenation. +* manipulating spacing: Manipulating Spacing. +* manual pages: man. +* margin for hyphenation (hym): Manipulating Hyphenation. +* margin glyph (mc): Miscellaneous. +* margin, bottom: Page Layout. +* margin, left (po): Line Layout. +* margin, top: Page Layout. +* mark, high-water, register (.h): Diversions. +* marking vertical page location (mk): Page Motions. +* maximum values of Roman numerals: Assigning Formats. +* mdoc macros: mdoc. +* me macro package: me. +* measurement unit: Measurements. +* measurements: Measurements. +* measurements, specifying safely: Default Units. +* minimum values of Roman numerals: Assigning Formats. +* minor version number register (.y): Built-in Registers. +* minutes, current time (minutes): Built-in Registers. +* mm macro package: mm. +* mode for constant glyph space (cs): Artificial Fonts. +* mode, compatibility: Implementation Differences. +* mode, copy-in: Copy-in Mode. +* mode, copy-in, and write requests: I/O. +* mode, fill <1>: Warnings. +* mode, fill <2>: Manipulating Filling and Adjusting. +* mode, fill: Implicit Line Breaks. +* mode, fill (fi): Manipulating Filling and Adjusting. +* mode, fill, and \c: Line Control. +* mode, line-tabs: Tabs and Fields. +* mode, no-fill (nf): Manipulating Filling and Adjusting. +* mode, no-fill, and \c: Line Control. +* mode, no-space (ns): Manipulating Spacing. +* mode, nroff: Troff and Nroff Mode. +* mode, safer <1>: I/O. +* mode, safer <2>: Macro Directories. +* mode, safer: Groff Options. +* mode, troff: Troff and Nroff Mode. +* mode, unsafe <1>: I/O. +* mode, unsafe <2>: Macro Directories. +* mode, unsafe: Groff Options. +* month of the year register (mo): Built-in Registers. +* motion operators: Expressions. +* motion, horizontal (\h): Page Motions. +* motion, vertical (\v): Page Motions. +* motions, page: Page Motions. +* mounting font (fp): Font Positions. +* ms macros: ms. +* ms macros, accent marks: ms Strings and Special Characters. +* ms macros, body text: ms Body Text. +* ms macros, cover page: ms Cover Page Macros. +* ms macros, creating table of contents: ms TOC. +* ms macros, differences from AT&T: Differences from AT&T ms. +* ms macros, displays: ms Displays and Keeps. +* ms macros, document control registers: ms Document Control Registers. +* ms macros, equations: ms Insertions. +* ms macros, figures: ms Insertions. +* ms macros, footers: ms Headers and Footers. +* ms macros, footnotes: ms Footnotes. +* ms macros, general structure: General ms Structure. +* ms macros, headers: ms Headers and Footers. +* ms macros, headings: Headings in ms. +* ms macros, highlighting: Highlighting in ms. +* ms macros, keeps: ms Displays and Keeps. +* ms macros, lists: Lists in ms. +* ms macros, margins: ms Margins. +* ms macros, multiple columns: ms Multiple Columns. +* ms macros, nested lists: Lists in ms. +* ms macros, page layout: ms Page Layout. +* ms macros, paragraph handling: Paragraphs in ms. +* ms macros, references: ms Insertions. +* ms macros, special characters: ms Strings and Special Characters. +* ms macros, strings: ms Strings and Special Characters. +* ms macros, tables: ms Insertions. +* multi-file documents: Debugging. +* multi-line strings: Strings. +* multi-page table, example markup [ms]: Example multi-page table. +* multiple columns [ms]: ms Multiple Columns. +* n unit: Measurements. +* name space, common, of macros, diversions, and strings: Strings. +* named character (\C): Using Symbols. +* names, long: Implementation Differences. +* ne request, and the .trunc register: Page Location Traps. +* ne request, comparison with sv: Page Control. +* negating register values: Setting Registers. +* nested assignments: Interpolating Registers. +* nested diversions: Diversions. +* nested lists [ms]: Lists in ms. +* new page (bp) <1>: Page Control. +* new page (bp): Basics. +* newline character <1>: Escapes. +* newline character: Identifiers. +* newline character, and translations: Character Translations. +* newline character, in strings, escaping: Strings. +* newline, final, stripping in diversions: Strings. +* next file, processing (nx): I/O. +* next free font position register (.fp): Font Positions. +* nf request, causing implicit linebreak: Manipulating Filling and Adjusting. +* nl register, and .d: Diversions. +* nl register, difference to .h: Diversions. +* nm request, using + and -: Expressions. +* no-break control character ('): Requests. +* no-break control character, changing (c2): Character Translations. +* no-fill mode (nf): Manipulating Filling and Adjusting. +* no-fill mode, and \c: Line Control. +* no-space mode (ns): Manipulating Spacing. +* node, output: Gtroff Internals. +* nr request, and warnings: Warnings. +* nr request, using + and -: Expressions. +* nroff mode: Troff and Nroff Mode. +* nroff, the program: History. +* number of arguments register (.$): Parameters. +* number register, creating alias (aln): Setting Registers. +* number register, removing (rr): Setting Registers. +* number register, renaming (rnn): Setting Registers. +* number registers, dumping (pnr): Debugging. +* number, input line, setting (lf): Debugging. +* number, page (pn): Page Layout. +* numbered glyph (\N) <1>: Using Symbols. +* numbered glyph (\N): Character Translations. +* numbered list, example markup [ms]: Lists in ms. +* numbers, and delimiters: Escapes. +* numbers, line, printing (nm): Miscellaneous. +* numerals, Roman: Assigning Formats. +* numeric expression, valid: Expressions. +* offset, page (po): Line Layout. +* open request, and safer mode: Groff Options. +* opena request, and safer mode: Groff Options. +* opening file (open): I/O. +* operator, scaling: Expressions. +* operators, arithmetic: Expressions. +* operators, as delimiters: Escapes. +* operators, comparison: Expressions. +* operators, extremum (>?, <?): Expressions. +* operators, logical: Expressions. +* operators, motion: Expressions. +* operators, unary: Expressions. +* options: Groff Options. +* order of evaluation in expressions: Expressions. +* orphan lines, preventing with ne: Page Control. +* os request, and no-space mode: Page Control. +* output and input requests: I/O. +* output device name string register (.T) <1>: Built-in Registers. +* output device name string register (.T): Groff Options. +* output device usage number register (.T): Groff Options. +* output devices <1>: Output Devices. +* output devices: Output device intro. +* output glyphs, and input characters,compatibility with AT&T troff: Implementation Differences. +* output line number register (ln): Built-in Registers. +* output line, continuation (\c): Line Control. +* output line, horizontal position, register (.k): Page Motions. +* output node: Gtroff Internals. +* output request, and \!: Diversions. +* output, flush (fl): Debugging. +* output, gtroff: gtroff Output. +* output, intermediate: gtroff Output. +* output, suppressing (\O): Suppressing output. +* output, transparent (\!, \?): Diversions. +* output, transparent (cf, trf): I/O. +* output, transparent, incompatibilities with AT&T troff: Implementation Differences. +* output, troff: gtroff Output. +* overlapping characters: Using Symbols. +* overstriking glyphs (\o): Page Motions. +* P unit: Measurements. +* p unit: Measurements. +* packages, macros: Macro Packages. +* padding character, for fields (fc): Fields. +* page break, conditional (ne): Page Control. +* page control: Page Control. +* page footers: Page Location Traps. +* page headers: Page Location Traps. +* page layout: Page Layout. +* page layout [ms]: ms Page Layout. +* page length (pl): Page Layout. +* page length register (.p): Page Layout. +* page location traps: Page Location Traps. +* page location, vertical, marking (mk): Page Motions. +* page location, vertical, returning to marked (rt): Page Motions. +* page motions: Page Motions. +* page number (pn): Page Layout. +* page number character (%): Page Layout. +* page number character, changing (pc): Page Layout. +* page number register (%): Page Layout. +* page offset (po): Line Layout. +* page, new (bp): Page Control. +* paper formats: Paper Formats. +* paragraphs: Paragraphs. +* parameters: Parameters. +* parentheses: Expressions. +* path, for font files: Font Directories. +* path, for tmac files: Macro Directories. +* patterns for hyphenation (hpf): Manipulating Hyphenation. +* pi request, and groff: I/O. +* pi request, and safer mode: Groff Options. +* pic, the program: gpic. +* pica unit (P): Measurements. +* pile, glyph (\b): Drawing Requests. +* pl request, using + and -: Expressions. +* planting a trap: Traps. +* platform-specific directory: Macro Directories. +* pn request, using + and -: Expressions. +* po request, using + and -: Expressions. +* point size registers (.s, .ps): Changing Type Sizes. +* point size registers, last-requested (.psr, .sr): Fractional Type Sizes. +* point sizes, changing (ps, \s): Changing Type Sizes. +* point sizes, fractional <1>: Implementation Differences. +* point sizes, fractional: Fractional Type Sizes. +* point unit (p): Measurements. +* polygon, drawing (\D'p ...'): Drawing Requests. +* polygon, solid, drawing (\D'P ...'): Drawing Requests. +* position of lowest text line (.h): Diversions. +* position, absolute, operator (|): Expressions. +* position, horizontal input line, saving (\k): Page Motions. +* position, horizontal, in input line, register (hp): Page Motions. +* position, horizontal, in output line, register (.k): Page Motions. +* position, vertical, in diversion, register (.d): Diversions. +* positions, font: Font Positions. +* post-vertical line spacing: Changing Type Sizes. +* post-vertical line spacing register (.pvs): Changing Type Sizes. +* post-vertical line spacing, changing (pvs): Changing Type Sizes. +* postprocessor access: Postprocessor Access. +* postprocessors: Output device intro. +* PostScript fonts: Font Families. +* PostScript, bounding box: Miscellaneous. +* PostScript, embedding: Embedding PostScript. +* prefix, for commands: Environment. +* preprocessor, calling convention: Preprocessors in man pages. +* preprocessors <1>: Preprocessors. +* preprocessors: Preprocessor Intro. +* previous font (ft, \f[], \fP): Changing Fonts. +* print current page register (.P): Groff Options. +* printing backslash (\\, \e, \E, \[rs]) <1>: Implementation Differences. +* printing backslash (\\, \e, \E, \[rs]): Escapes. +* printing line numbers (nm): Miscellaneous. +* printing to stderr (tm, tm1, tmc): Debugging. +* printing, zero-width (\z, \Z): Page Motions. +* process ID of gtroff register ($$): Built-in Registers. +* processing next file (nx): I/O. +* properties of characters (cflags): Using Symbols. +* properties of glyphs (cflags): Using Symbols. +* ps request, and constant glyph space mode: Artificial Fonts. +* ps request, incompatibilities with AT&T troff: Implementation Differences. +* ps request, using + and -: Expressions. +* ps request, with fractional type sizes: Fractional Type Sizes. +* pso request, and safer mode: Groff Options. +* pvs request, using + and -: Expressions. +* quotes, major: Displays. +* quotes, trailing: Strings. +* ragged-left: Manipulating Filling and Adjusting. +* ragged-right: Manipulating Filling and Adjusting. +* rc request, and glyph definitions: Using Symbols. +* read-only register, changing format: Assigning Formats. +* reading from standard input (rd): I/O. +* recursive macros: while. +* refer, and macro names starting with [ or ]: Identifiers. +* refer, the program: grefer. +* reference, gtroff: gtroff Reference. +* references [ms]: ms Insertions. +* register, creating alias (aln): Setting Registers. +* register, format (\g): Assigning Formats. +* register, removing (rr): Setting Registers. +* register, renaming (rnn): Setting Registers. +* registers: Registers. +* registers specific to grohtml: grohtml specific registers and strings. +* registers, built-in: Built-in Registers. +* registers, interpolating (\n): Interpolating Registers. +* registers, setting (nr, \R): Setting Registers. +* removing diversion (rm): Strings. +* removing glyph definition (rchar): Using Symbols. +* removing macro (rm): Strings. +* removing number register (rr): Setting Registers. +* removing request (rm): Strings. +* removing string (rm): Strings. +* renaming diversion (rn): Strings. +* renaming macro (rn): Strings. +* renaming number register (rnn): Setting Registers. +* renaming request (rn): Strings. +* renaming string (rn): Strings. +* request arguments: Request Arguments. +* request, removing (rm): Strings. +* request, renaming (rn): Strings. +* request, undefined: Comments. +* requests: Requests. +* requests for drawing: Drawing Requests. +* requests for input and output: I/O. +* resolution, horizontal, register (.H): Built-in Registers. +* resolution, vertical, register (.V): Built-in Registers. +* returning to marked vertical page location (rt): Page Motions. +* revision number register (.Y): Built-in Registers. +* rf, the program: History. +* right-justifying (rj): Manipulating Filling and Adjusting. +* rj request, causing implicit linebreak: Manipulating Filling and Adjusting. +* rn glyph, and cflags: Using Symbols. +* roff, the program: History. +* roman glyph, correction after italic glyph (\/): Ligatures and Kerning. +* roman glyph, correction before italic glyph (\,): Ligatures and Kerning. +* Roman numerals: Assigning Formats. +* Roman numerals, maximum and minimum: Assigning Formats. +* rq glyph, and rq string [man]: Predefined man strings. +* rq glyph, at end of sentence <1>: Using Symbols. +* rq glyph, at end of sentence: Sentences. +* rt request, using + and -: Expressions. +* ru glyph, and cflags: Using Symbols. +* runoff, the program: History. +* s unit <1>: Fractional Type Sizes. +* s unit: Measurements. +* safer mode <1>: I/O. +* safer mode <2>: Macro Directories. +* safer mode: Groff Options. +* saving horizontal input line position (\k): Page Motions. +* scaling operator: Expressions. +* searching fonts: Font Directories. +* searching macro files: Macro Directories. +* searching macros: Macro Directories. +* seconds, current time (seconds): Built-in Registers. +* sentence space: Sentences. +* sentence space size register (.sss): Manipulating Filling and Adjusting. +* sentences: Sentences. +* setting diversion trap (dt): Diversion Traps. +* setting end-of-input trap (em): End-of-input Traps. +* setting input line number (lf): Debugging. +* setting input line trap (it): Input Line Traps. +* setting registers (nr, \R): Setting Registers. +* shading filled objects (\D'f ...'): Drawing Requests. +* shc request, and translations: Character Translations. +* site-specific directory <1>: Font Directories. +* site-specific directory: Macro Directories. +* size of sentence space register (.sss): Manipulating Filling and Adjusting. +* size of type: Sizes. +* size of word space register (.ss): Manipulating Filling and Adjusting. +* sizes: Sizes. +* sizes, fractional <1>: Implementation Differences. +* sizes, fractional: Fractional Type Sizes. +* slant, font, changing (\S): Artificial Fonts. +* soelim, the program: gsoelim. +* soft hyphen character, setting (shc): Manipulating Hyphenation. +* soft hyphen glyph (hy): Manipulating Hyphenation. +* solid circle, drawing (\D'C ...'): Drawing Requests. +* solid ellipse, drawing (\D'E ...'): Drawing Requests. +* solid polygon, drawing (\D'P ...'): Drawing Requests. +* sp request, and no-space mode: Manipulating Spacing. +* sp request, causing implicit linebreak: Manipulating Filling and Adjusting. +* space between sentences: Sentences. +* space between sentences register (.sss): Manipulating Filling and Adjusting. +* space between words register (.ss): Manipulating Filling and Adjusting. +* space character: Escapes. +* space character, zero width (\&) <1>: Drawing Requests. +* space character, zero width (\&) <2>: Ligatures and Kerning. +* space character, zero width (\&): Requests. +* space characters, in expressions: Expressions. +* space, horizontal (\h): Page Motions. +* space, horizontal, unformatting: Strings. +* space, unbreakable: Page Motions. +* space, vertical, unit (v): Measurements. +* space, width of a digit (\0): Page Motions. +* spaces with ds: Strings. +* spaces, leading and trailing: Filling and Adjusting. +* spacing: Basics. +* spacing, manipulating: Manipulating Spacing. +* spacing, vertical: Sizes. +* special characters <1>: Special Characters. +* special characters: Character Translations. +* special characters [ms]: ms Strings and Special Characters. +* special fonts <1>: Font File Format. +* special fonts <2>: Special Fonts. +* special fonts: Using Symbols. +* special fonts, emboldening: Artificial Fonts. +* special request, and font translations: Changing Fonts. +* spline, drawing (\D'~ ...'): Drawing Requests. +* springing a trap: Traps. +* stacking glyphs (\b): Drawing Requests. +* standard input, reading from (rd): I/O. +* stderr, printing to (tm, tm1, tmc): Debugging. +* stops, tabulator: Tab Stops. +* string arguments: Strings. +* string expansion (\*): Strings. +* string interpolation (\*): Strings. +* string, appending (as): Strings. +* string, creating alias (als): Strings. +* string, length of (length): Strings. +* string, removing (rm): Strings. +* string, renaming (rn): Strings. +* strings: Strings. +* strings [ms]: ms Strings and Special Characters. +* strings specific to grohtml: grohtml specific registers and strings. +* strings, multi-line: Strings. +* strings, shared name space with macros and diversions: Strings. +* stripping final newline in diversions: Strings. +* structuring source code of documents or macro packages: Requests. +* sty request, and changing fonts: Changing Fonts. +* sty request, and font positions: Font Positions. +* sty request, and font translations: Changing Fonts. +* styles, font: Font Families. +* substring (substring): Strings. +* suppressing output (\O): Suppressing output. +* sv request, and no-space mode: Page Control. +* switching environments (ev): Environments. +* sy request, and safer mode: Groff Options. +* symbol: Using Symbols. +* symbol table, dumping (pm): Debugging. +* symbol, defining (char): Using Symbols. +* symbols, using: Using Symbols. +* system() return value register (systat): I/O. +* tab character <1>: Escapes. +* tab character: Tab Stops. +* tab character, and translations: Character Translations. +* tab character, non-interpreted (\t): Tabs and Fields. +* tab repetition character (tc): Tabs and Fields. +* tab settings register (.tabs): Tabs and Fields. +* tab stops: Tab Stops. +* tab stops [man]: Miscellaneous man macros. +* tab stops, for TTY output devices: Tabs and Fields. +* tab, line-tabs mode: Tabs and Fields. +* table of contents <1>: Leaders. +* table of contents: Table of Contents. +* table of contents, creating [ms]: ms TOC. +* tables [ms]: ms Insertions. +* tabs, and fields: Tabs and Fields. +* tabs, before comments: Comments. +* tbl, the program: gtbl. +* text line, position of lowest (.h): Diversions. +* text, gtroff processing: Text. +* text, justifying: Manipulating Filling and Adjusting. +* text, justifying (rj): Manipulating Filling and Adjusting. +* thickness of lines (\D't ...'): Drawing Requests. +* three-part title (tl): Page Layout. +* ti request, causing implicit linebreak: Manipulating Filling and Adjusting. +* ti request, using + and -: Expressions. +* time, current: I/O. +* time, current, hours (hours): Built-in Registers. +* time, current, minutes (minutes): Built-in Registers. +* time, current, seconds (seconds): Built-in Registers. +* title line (tl): Page Layout. +* title line length register (.lt): Page Layout. +* title line, length (lt): Page Layout. +* title page, example markup: ms Cover Page Macros. +* titles: Page Layout. +* tkf request, and font styles: Font Families. +* tkf request, and font translations: Changing Fonts. +* tkf request, with fractional type sizes: Fractional Type Sizes. +* tl request, and mc: Miscellaneous. +* tmac, directory: Macro Directories. +* tmac, path: Macro Directories. +* TMPDIR, environment variable: Environment. +* token, input: Gtroff Internals. +* top margin: Page Layout. +* top-level diversion: Diversions. +* top-level diversion, and \!: Diversions. +* top-level diversion, and \?: Diversions. +* top-level diversion, and bp: Page Control. +* tr request, and glyph definitions: Using Symbols. +* tr request, and soft hyphen character: Manipulating Hyphenation. +* tr request, incompatibilities with AT&T troff: Implementation Differences. +* track kerning: Ligatures and Kerning. +* track kerning, activating (tkf): Ligatures and Kerning. +* trailing quotes: Strings. +* trailing spaces: Filling and Adjusting. +* translations of characters: Character Translations. +* transparent characters <1>: Using Symbols. +* transparent characters: Sentences. +* transparent output (\!, \?): Diversions. +* transparent output (cf, trf): I/O. +* transparent output, incompatibilities with AT&T troff: Implementation Differences. +* trap, changing location (ch): Page Location Traps. +* trap, distance, register (.t): Page Location Traps. +* trap, diversion, setting (dt): Diversion Traps. +* trap, end-of-input, setting (em): End-of-input Traps. +* trap, input line, setting (it): Input Line Traps. +* trap, planting: Traps. +* trap, springing: Traps. +* traps: Traps. +* traps, blank line: Blank Line Traps. +* traps, diversion: Diversion Traps. +* traps, dumping (ptr): Debugging. +* traps, end-of-input: End-of-input Traps. +* traps, input line: Input Line Traps. +* traps, input line, and interrupted lines (itc): Input Line Traps. +* traps, page location: Page Location Traps. +* trf request, and invalid characters: I/O. +* trf request, causing implicit linebreak: Manipulating Filling and Adjusting. +* trin request, and asciify: Diversions. +* troff mode: Troff and Nroff Mode. +* troff output: gtroff Output. +* truncated vertical space register (.trunc): Page Location Traps. +* tutorial for macro users: Tutorial for Macro Users. +* type size: Sizes. +* type size registers (.s, .ps): Changing Type Sizes. +* type sizes, changing (ps, \s): Changing Type Sizes. +* type sizes, fractional <1>: Implementation Differences. +* type sizes, fractional: Fractional Type Sizes. +* u unit: Measurements. +* uf request, and font styles: Font Families. +* ul glyph, and cflags: Using Symbols. +* ul request, and font translations: Changing Fonts. +* unary operators: Expressions. +* unbreakable space: Page Motions. +* undefined identifiers: Identifiers. +* undefined request: Comments. +* underline font (uf): Artificial Fonts. +* underlining (ul): Artificial Fonts. +* underlining, continuous (cu): Artificial Fonts. +* underscore glyph (\[ru]): Drawing Requests. +* unformatting diversions (asciify): Diversions. +* unformatting horizontal space: Strings. +* Unicode <1>: Using Symbols. +* Unicode: Identifiers. +* unit, c: Measurements. +* unit, f: Measurements. +* unit, f, and colors: Colors. +* unit, i: Measurements. +* unit, M: Measurements. +* unit, m: Measurements. +* unit, n: Measurements. +* unit, P: Measurements. +* unit, p: Measurements. +* unit, s <1>: Fractional Type Sizes. +* unit, s: Measurements. +* unit, u: Measurements. +* unit, v: Measurements. +* unit, z <1>: Fractional Type Sizes. +* unit, z: Measurements. +* units of measurement: Measurements. +* units, default: Default Units. +* unnamed glyphs: Using Symbols. +* unnamed glyphs, accessing with \N: Font File Format. +* unsafe mode <1>: I/O. +* unsafe mode <2>: Macro Directories. +* unsafe mode: Groff Options. +* user's macro tutorial: Tutorial for Macro Users. +* user's tutorial for macros: Tutorial for Macro Users. +* using symbols: Using Symbols. +* utf-8, encoding: Groff Options. +* v unit: Measurements. +* valid numeric expression: Expressions. +* value, incrementing without changing the register: Auto-increment. +* variables in environment: Environment. +* version number, major, register (.x): Built-in Registers. +* version number, minor, register (.y): Built-in Registers. +* vertical line drawing (\L): Drawing Requests. +* vertical line spacing register (.v): Changing Type Sizes. +* vertical line spacing, changing (vs): Changing Type Sizes. +* vertical line spacing, effective value: Changing Type Sizes. +* vertical motion (\v): Page Motions. +* vertical page location, marking (mk): Page Motions. +* vertical page location, returning to marked (rt): Page Motions. +* vertical position in diversion register (.d): Diversions. +* vertical position trap enable register (.vpt): Page Location Traps. +* vertical position traps, enabling (vpt): Page Location Traps. +* vertical resolution register (.V): Built-in Registers. +* vertical space unit (v): Measurements. +* vertical spacing: Sizes. +* warnings <1>: Warnings. +* warnings: Debugging. +* warnings, level (warn): Debugging. +* what is groff?: What Is groff?. +* while: while. +* while request, and the ! operator: Expressions. +* while request, confusing with br: while. +* while request, operators to use with: Operators in Conditionals. +* whitespace characters: Identifiers. +* width escape (\w): Page Motions. +* word space size register (.ss): Manipulating Filling and Adjusting. +* writing macros: Writing Macros. +* writing to file (write): I/O. +* year, current, register (year, yr): Built-in Registers. +* z unit <1>: Fractional Type Sizes. +* z unit: Measurements. +* zero width space character (\&) <1>: Drawing Requests. +* zero width space character (\&) <2>: Ligatures and Kerning. +* zero width space character (\&): Requests. +* zero-width printing (\z, \Z): Page Motions. +* |, and page motion: Expressions. + + diff --git a/contrib/groff/doc/groff-2 b/contrib/groff/doc/groff-2 new file mode 100644 index 0000000..d1f7f99 --- /dev/null +++ b/contrib/groff/doc/groff-2 @@ -0,0 +1,1683 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: Man usage, Next: Man font macros, Prev: Man options, Up: man + +Usage +----- + + This section describes the available macros for manual pages. For +further customization, put additional macros and requests into the file +`man.local' which is loaded immediately after the `man' package. + + - Macro: .TH title section [extra1 [extra2 [extra3]]] + Set the title of the man page to TITLE and the section to SECTION, + which must have a value between 1 and 8. The value of SECTION may + also have a string appended, e.g. `.pm', to indicate a specific + subsection of the man pages. + + Both TITLE and SECTION are positioned at the left and right in the + header line (with SECTION in parentheses immediately appended to + TITLE. EXTRA1 is positioned in the middle of the footer line. + EXTRA2 is positioned at the left in the footer line (or at the + left on even pages and at the right on odd pages if double-sided + printing is active). EXTRA3 is centered in the header line. + + For HTML output, headers and footers are completely suppressed. + + Additionally, this macro starts a new page; the new line number + is 1 again (except if the `-rC1' option is given on the command + line) - this feature is intended only for formatting multiple man + pages; a single man page should contain exactly one `TH' macro at + the beginning of the file. + + - Macro: .SH [heading] + Set up an unnumbered section heading sticking out to the left. + Prints out all the text following `SH' up to the end of the line + (or the text in the next line if there is no argument to `SH') in + bold face, one size larger than the base document size. + Additionally, the left margin for the following text is reset to + its default value. + + - Macro: .SS [heading] + Set up an unnumbered (sub)section heading. Prints out all the text + following `SS' up to the end of the line (or the text in the next + line if there is no argument to `SS') in bold face, at the same + size as the base document size. Additionally, the left margin for + the following text is reset to its default value. + + - Macro: .TP [nnn] + Set up an indented paragraph with label. The indentation is set to + NNN if that argument is supplied (the default unit is `n' if + omitted), otherwise it is set to the default indentation value. + + The first line of text following this macro is interpreted as a + string to be printed flush-left, as it is appropriate for a label. + It is not interpreted as part of a paragraph, so there is no + attempt to fill the first line with text from the following input + lines. Nevertheless, if the label is not as wide as the + indentation, then the paragraph starts at the same line (but + indented), continuing on the following lines. If the label is + wider than the indentation, then the descriptive part of the + paragraph begins on the line following the label, entirely + indented. Note that neither font shape nor font size of the label + is set to a default value; on the other hand, the rest of the text + has default font settings. + + - Macro: .LP + - Macro: .PP + - Macro: .P + These macros are mutual aliases. Any of them causes a line break + at the current position, followed by a vertical space downwards by + the amount specified by the `PD' macro. The font size and shape + are reset to the default value (10pt roman if no `-rS' option is + given on the command line). Finally, the current left margin is + restored. + + - Macro: .IP [designator [nnn]] + Set up an indented paragraph, using DESIGNATOR as a tag to mark + its beginning. The indentation is set to NNN if that argument is + supplied (default unit is `n'), otherwise the default indentation + value is used. Font size and face of the paragraph (but not the + designator) are reset to their default values. To start an + indented paragraph with a particular indentation but without a + designator, use `""' (two double quotes) as the first argument of + `IP'. + + For example, to start a paragraph with bullets as the designator + and 4 en indentation, write + + + .IP \(bu 4 + + + - Macro: .HP [nnn] + Set up a paragraph with hanging left indentation. The indentation + is set to NNN if that argument is supplied (default unit is `n'), + otherwise the default indentation value is used. Font size and + face are reset to their default values. + + - Macro: .RS [nnn] + Move the left margin to the right by the value NNN if specified + (default unit is `n'); otherwise the default indentation value is + used. Calls to the `RS' macro can be nested. + + - Macro: .RE [nnn] + Move the left margin back to level NNN; if no argument is given, + it moves one level back. The first level (i.e., no call to `RS' + yet) has number 1, and each call to `RS' increases the level by 1. + + To summarize, the following macros cause a line break with the +insertion of vertical space (which amount can be changed with the `PD' +macro): `SH', `SS', `TP', `LP' (`PP', `P'), `IP', and `HP'. + + The macros `RS' and `RE' also cause a break but do not insert +vertical space. + + Finally, the macros `SH', `SS', `LP' (`PP', `P'), and `RS' reset the +indentation to its default value. + + +File: groff, Node: Man font macros, Next: Miscellaneous man macros, Prev: Man usage, Up: man + +Macros to set fonts +------------------- + + The standard font is roman; the default text size is 10 point. If +command line option `-rS=N' is given, use Npt as the default text size. + + - Macro: .SM [text] + Set the text on the same line or the text on the next line in a + font that is one point size smaller than the default font. + + - Macro: .SB [text] + Set the text on the same line or the text on the next line in bold + face font, one point size smaller than the default font. + + - Macro: .BI text + Set its arguments alternately in bold face and italic. Thus, + + + .BI this "word and" that + + would set "this" and "that" in bold face, and "word and" in + italics. + + - Macro: .IB text + Set its arguments alternately in italic and bold face. + + - Macro: .RI text + Set its arguments alternately in roman and italic. + + - Macro: .IR text + Set its arguments alternately in italic and roman. + + - Macro: .BR text + Set its arguments alternately in bold face and roman. + + - Macro: .RB text + Set its arguments alternately in roman and bold face. + + - Macro: .B [text] + Set TEXT in bold face. If no text is present on the line where + the macro is called, then the text of the next line appears in bold + face. + + - Macro: .I [text] + Set TEXT in italic. If no text is present on the line where the + macro is called, then the text of the next line appears in italic. + + +File: groff, Node: Miscellaneous man macros, Next: Predefined man strings, Prev: Man font macros, Up: man + +Miscellaneous macros +-------------------- + + The default indentation is 7.2 en for all output devices except for +`grohtml' which ignores indentation. + + - Macro: .DT + Set tabs every 0.5 inches. Since this macro is always executed + during a call to the `TH' macro, it makes sense to call it only if + the tab positions have been changed. + + - Macro: .PD [nnn] + Adjust the empty space before a new paragraph (or section). The + optional argument gives the amount of space (default unit is `v'); + without parameter, the value is reset to its default value (1 line + for TTY devices, 0.4v otherwise). + + This affects the macros `SH', `SS', `TP', `LP' (as well as `PP' and +`P'), `IP', and `HP'. + + +File: groff, Node: Predefined man strings, Next: Preprocessors in man pages, Prev: Miscellaneous man macros, Up: man + +Predefined strings +------------------ + + The following strings are defined: + + - String: \*[S] + Switch back to the default font size. + + - String: \*[R] + The `registered' sign. + + - String: \*[Tm] + The `trademark' sign. + + - String: \*[lq] + - String: \*[rq] + Left and right quote. This is equal to `\(lq' and `\(rq', + respectively. + + +File: groff, Node: Preprocessors in man pages, Prev: Predefined man strings, Up: man + +Preprocessors in `man' pages +---------------------------- + + If a preprocessor like `gtbl' or `geqn' is needed, it has become +common usage to make the first line of the man page look like this: + + + '\" WORD + +Note the single space character after the double quote. WORD consists +of letters for the needed preprocessors: `e' for `geqn', `r' for +`grefer', `t' for `gtbl'. Modern implementations of the `man' program +read this first line and automatically call the right preprocessor(s). + + +File: groff, Node: mdoc, Next: ms, Prev: man, Up: Macro Packages + +`mdoc' +====== + + See the `groff_mdoc(7)' man page (type `man groff_mdoc' at the +command line). + + +File: groff, Node: ms, Next: me, Prev: mdoc, Up: Macro Packages + +`ms' +==== + + The `-ms' macros are suitable for reports, letters, books, user +manuals, and so forth. The package provides macros for cover pages, +section headings, paragraphs, lists, footnotes, pagination, and a table +of contents. + +* Menu: + +* ms Intro:: +* General ms Structure:: +* ms Document Control Registers:: +* ms Cover Page Macros:: +* ms Body Text:: +* ms Page Layout:: +* Differences from AT&T ms:: + + +File: groff, Node: ms Intro, Next: General ms Structure, Prev: ms, Up: ms + +Introduction to `ms' +-------------------- + + The original `-ms' macros were included with AT&T `troff' as well as +the `man' macros. While the `man' package is intended for brief +documents that can be read on-line as well as printed, the `ms' macros +are suitable for longer documents that are meant to be printed rather +than read on-line. + + The `ms' macro package included with `groff' is a complete, +bottom-up re-implementation. Several macros (specific to AT&T or +Berkeley) are not included, while several new commands are. *Note +Differences from AT&T ms::, for more information. + + +File: groff, Node: General ms Structure, Next: ms Document Control Registers, Prev: ms Intro, Up: ms + +General structure of an `ms' document +------------------------------------- + + The `ms' macro package expects a certain amount of structure, but +not as much as packages such as `man' or `mdoc'. + + The simplest documents can begin with a paragraph macro (such as +`LP' or `PP'), and consist of text separated by paragraph macros or +even blank lines. Longer documents have a structure as follows: + +*Document type* + If you invoke the `RP' (report) macro on the first line of the + document, `groff' prints the cover page information on its own + page; otherwise it prints the information on the first page with + your document text immediately following. Other document formats + found in AT&T `troff' are specific to AT&T or Berkeley, and are + not supported in `groff'. + +*Format and layout* + By setting number registers, you can change your document's type + (font and size), margins, spacing, headers and footers, and + footnotes. *Note ms Document Control Registers::, for more + details. + +*Cover page* + A cover page consists of a title, the author's name and + institution, an abstract, and the date. (1) (*note General ms + Structure-Footnote-1::) *Note ms Cover Page Macros::, for more + details. + +*Body* + Following the cover page is your document. You can use the `ms' + macros to write reports, letters, books, and so forth. The + package is designed for structured documents, consisting of + paragraphs interspersed with headings and augmented by lists, + footnotes, tables, and other common constructs. *Note ms Body + Text::, for more details. + +*Table of contents* + Longer documents usually include a table of contents, which you + can invoke by placing the `TC' macro at the end of your document. + The `ms' macros have minimal indexing facilities, consisting of the + `IX' macro, which prints an entry on standard error. Printing the + table of contents at the end is necessary since `groff' is a + single-pass text formatter, thus it cannot determine the page + number of each section until that section has actually been set + and printed. Since `ms' output is intended for hardcopy, you can + manually relocate the pages containing the table of contents + between the cover page and the body text after printing. + + +File: groff, Node: General ms Structure-Footnotes, Up: General ms Structure + + (1) Actually, only the title is required. + + +File: groff, Node: ms Document Control Registers, Next: ms Cover Page Macros, Prev: General ms Structure, Up: ms + +Document control registers +-------------------------- + + The following is a list of document control number registers. For +the sake of consistency, set registers related to margins at the +beginning of your document, or just after the `RP' macro. You can set +other registers later in your document, but you should keep them +together at the beginning to make them easy to find and edit as +necessary. + +Margin Settings +............... + + - Register: \n[PO] + Defines the page offset (i.e. the left margin). There is no + explicit right margin setting; the combination of the `PO' and + `LL' registers implicitly define the right margin width. + + Effective: next page. + + Default value: 1i. + + - Register: \n[LL] + Defines the line length (i.e. the width of the body text). + + Effective: next paragraph. + + Default: 6i. + + - Register: \n[LT] + Defines the title length (i.e. the header and footer width). This + is usually the same as `LL', but not necessarily. + + Effective: next paragraph. + + Default: 6i. + + - Register: \n[HM] + Defines the header margin height at the top of the page. + + Effective: next page. + + Default: 1i. + + - Register: \n[FM] + Defines the footer margin height at the bottom of the page. + + Effective: next page. + + Default: 1i. + +Text Settings +............. + + - Register: \n[PS] + Defines the point size of the body text. + + Effective: next paragraph. + + Default: 10p. + + - Register: \n[VS] + Defines the space between lines (line height plus leading). + + Effective: next paragraph. + + Default: 12p. + +Paragraph Settings +.................. + + - Register: \n[PI] + Defines the initial indent of a `.PP' paragraph. + + Effective: next paragraph. + + Default: 5n. + + - Register: \n[PD] + Defines the space between paragraphs. + + Effective: next paragraph. + + Default: 0.3v. + + - Register: \n[QI] + Defines the indent on both sides of a quoted (`.QP') paragraph. + + Effective: next paragraph. + + Default: 5n. + +Footnote Settings +................. + + - Register: \n[FL] + Defines the length of a footnote. + + Effective: next footnote. + + Default: `\n[LL]' * 5 / 6. + + - Register: \n[FI] + Defines the footnote indent. + + Effective: next footnote. + + Default: 2n. + + - Register: \n[FF] + The footnote format: + `0' + Prints the footnote number as a superscript; indents the + footnote (default). + + `1' + Prints the number followed by a period (like 1.) and indents + the footnote. + + `2' + Like 1, without an indent. + + `3' + Like 1, but prints the footnote number as a hanging paragraph. + + Effective: next footnote. + + Default: 0. + +Miscellaneous Number Registers +.............................. + + - Register: \n[MINGW] + Defines the minimum width between columns in a multi-column + document. + + Effective: next page. + + Default: 2n. + + +File: groff, Node: ms Cover Page Macros, Next: ms Body Text, Prev: ms Document Control Registers, Up: ms + +Cover page macros +----------------- + + Use the following macros to create a cover page for your document in +the order shown. + + - Macro: .RP [`no'] + Specifies the report format for your document. The report format + creates a separate cover page. The default action (no `.RP' + macro) is to print a subset of the cover page on page 1 of your + document. + + If you use the word `no' as an optional argument, `groff' prints a + title page but does not repeat any of the title page information + (title, author, abstract, etc.) on page 1 of the document. + + - Macro: .DA [...] + (optional) Print the current date, or the arguments to the macro + if any, on the title page (if specified) and in the footers. This + is the default for `nroff'. + + - Macro: .ND [...] + (optional) Print the current date, or the arguments to the macro + if any, on the title page (if specified) but not in the footers. + This is the default for `troff'. + + - Macro: .TL + Specifies the document title. `groff' collects text following the + `.TL' macro into the title, until reaching the author name or + abstract. + + - Macro: .AU + Specifies the author's name, which appears on the line (or lines) + immediately following. You can specify multiple authors as + follows: + + + .AU + John Doe + .AI + University of West Bumblefuzz + .AU + Martha Buck + .AI + Monolithic Corporation + + ... + + + - Macro: .AI + Specifies the author's institution. You can specify multiple + institutions in the same way that you specify multiple authors. + + - Macro: .AB [`no'] + Begins the abstract. The default is to print the word ABSTRACT, + centered and in italics, above the text of the abstract. The word + `no' as an optional argument suppresses this heading. + + - Macro: .AE + End the abstract. + + The following is example mark-up for a title page. + + + .RP + .TL + The Inevitability of Code Bloat + in Commercial and Free Software + .AU + J. Random Luser + .AI + University of West Bumblefuzz + .AB + This report examines the long-term growth + of the code bases in two large, popular software + packages; the free Emacs and the commercial + Microsoft Word. + While differences appear in the type or order + of features added, due to the different + methodologies used, the results are the same + in the end. + .PP + The free software approach is shown to be + superior in that while free software can + become as bloated as commercial offerings, + free software tends to have fewer serious + bugs and the added features are in line with + user demand. + .AE + + ... the rest of the paper follows ... + + +File: groff, Node: ms Body Text, Next: ms Page Layout, Prev: ms Cover Page Macros, Up: ms + +Body text +--------- + + This section describes macros used to mark up the body of your +document. Examples include paragraphs, sections, and other groups. + +* Menu: + +* Paragraphs in ms:: +* Headings in ms:: +* Highlighting in ms:: +* Lists in ms:: +* Indents in ms:: +* Tabstops in ms:: +* ms Displays and Keeps:: +* ms Insertions:: +* Example multi-page table:: +* ms Footnotes:: + + +File: groff, Node: Paragraphs in ms, Next: Headings in ms, Prev: ms Body Text, Up: ms Body Text + +Paragraphs +.......... + + The following paragraph types are available. + + - Macro: .PP + Sets a paragraph with an initial indent. + + - Macro: .LP + Sets a paragraph with no initial indent. + + - Macro: .QP + Sets a paragraph that is indented at both left and right margins. + The effect is identical to the HTML `<BLOCKQUOTE>' element. The + next paragraph or heading returns margins to normal. + + - Macro: .XP + Sets a paragraph whose lines are indented, except for the first + line. This is a Berkeley extension. + + The following markup uses all four paragraph macros. + + + .NH 2 + Cases used in the study + .LP + The following software and versions were + considered for this report. + .PP + For commercial software, we chose + .B "Microsoft Word for Windows" , + starting with version 1.0 through the + current version (Word 2000). + .PP + For free software, we chose + .B Emacs , + from its first appearance as a standalone + editor through the current version (v20). + See [Bloggs 2002] for details. + .QP + Franklin's Law applied to software: + software expands to outgrow both + RAM and disk space over time. + .LP + Bibliography: + .XP + Bloggs, Joseph R., + .I "Everyone's a Critic" , + Underground Press, March 2002. + A definitive work that answers all questions + and criticisms about the quality and usability of + free software. + + +File: groff, Node: Headings in ms, Next: Highlighting in ms, Prev: Paragraphs in ms, Up: ms Body Text + +Headings +........ + + Use headings to create a hierarchical structure for your document. +The `ms' macros print headings in *bold*, using the same font family +and point size as the body text. + + The following describes the heading macros: + + - Macro: .NH curr-level + - Macro: .NH S level0 ... + Numbered heading. The argument is either a numeric argument to + indicate the level of the heading, or the letter `S' followed by + numeric arguments to set the heading level explicitly. + + If you specify heading levels out of sequence, such as invoking + `.NH 3' after `.NH 1', `groff' prints a warning on standard error. + + - Macro: .SH + Unnumbered subheading. + + +File: groff, Node: Highlighting in ms, Next: Lists in ms, Prev: Headings in ms, Up: ms Body Text + +Highlighting +............ + + The `ms' macros provide a variety of methods to highlight or +emphasize text: + + - Macro: .B [txt [post [pre]]] + Sets its first argument in *bold type*. If you specify a second + argument, `groff' prints it in the previous font after the bold + text, with no intervening space (this allows you to set + punctuation after the highlighted text without highlighting the + punctuation). Similarly, it prints the third argument (if any) in + the previous font *before* the first argument. For example, + + + .B foo ) ( + + prints (*foo*). + + If you give this macro no arguments, `groff' prints all text + following in bold until the next highlighting, paragraph, or + heading macro. + + - Macro: .R [txt [post [pre]]] + Sets its first argument in roman (or regular) type. It operates + similarly to the `B' macro otherwise. + + - Macro: .I [txt [post [pre]]] + Sets its first argument in _italic type_. It operates similarly + to the `B' macro otherwise. + + - Macro: .CW [txt [post [pre]]] + Sets its first argument in a `constant width face'. It operates + similarly to the `B' macro otherwise. + + - Macro: .BI [txt [post [pre]]] + Sets its first argument in bold italic type. It operates + similarly to the `B' macro otherwise. + + - Macro: .BX [txt] + Prints its argument and draws a box around it. If you want to box + a string that contains spaces, use a digit-width space (`\0'). + + - Macro: .UL [txt [post]] + Prints its first argument with an underline. If you specify a + second argument, `groff' prints it in the previous font after the + underlined text, with no intervening space. + + - Macro: .LG + Prints all text following in larger type (two points larger than + the current point size) until the next font size, highlighting, + paragraph, or heading macro. You can specify this macro multiple + times to enlarge the point size as needed. + + - Macro: .SM + Prints all text following in smaller type (two points smaller than + the current point size) until the next type size, highlighting, + paragraph, or heading macro. You can specify this macro multiple + times to reduce the point size as needed. + + - Macro: .NL + Prints all text following in the normal point size (that is, the + value of the `PS' register). + + +File: groff, Node: Lists in ms, Next: Indents in ms, Prev: Highlighting in ms, Up: ms Body Text + +Lists +..... + + The `.IP' macro handles duties for all lists. + + - Macro: .IP [marker [width]] + The MARKER is usually a bullet glyph (`\[bu]') for unordered + lists, a number (or auto-incrementing number register) for + numbered lists, or a word or phrase for indented (glossary-style) + lists. + + The WIDTH specifies the indent for the body of each list item; its + default unit is `n'. Once specified, the indent remains the same + for all list items in the document until specified again. + + The following is an example of a bulleted list. + + + A bulleted list: + .IP \[bu] 2 + lawyers + .IP \[bu] + guns + .IP \[bu] + money + + Produces: + + + A bulleted list: + + o lawyers + + o guns + + o money + + + The following is an example of a numbered list. + + + .nr step 1 1 + A numbered list: + .IP \n[step] 3 + lawyers + .IP \n+[step] + guns + .IP \n+[step] + money + + Produces: + + + A numbered list: + + 1. lawyers + + 2. guns + + 3. money + + Note the use of the auto-incrementing number register in this +example. + + + The following is an example of a glossary-style list. + + + A glossary-style list: + .IP lawyers 0.4i + Two or more attorneys. + .IP guns + Firearms, preferably + large-caliber. + .IP money + Gotta pay for those + lawyers and guns! + + Produces: + + + A glossary-style list: + + lawyers + Two or more attorneys. + + guns Firearms, preferably large-caliber. + + money + Gotta pay for those lawyers and guns! + + In the last example, the `IP' macro places the definition on the +same line as the term if it has enough space; otherwise, it breaks to +the next line and starts the definition below the term. This may or +may not be the effect you want, especially if some of the definitions +break and some do not. The following examples show two possible ways +to force a break. + + The first workaround uses the `br' request to force a break after +printing the term or label. + + + A glossary-style list: + .IP lawyers 0.4i + Two or more attorneys. + .IP guns + .br + Firearms, preferably large-caliber. + .IP money + Gotta pay for those lawyers and guns! + + + The second workaround uses the `\p' escape to force the break. Note +the space following the escape; this is important. If you omit the +space, `groff' prints the first word on the same line as the term or +label (if it fits) *then* breaks the line. + + + A glossary-style list: + .IP lawyers 0.4i + Two or more attorneys. + .IP guns + \p Firearms, preferably large-caliber. + .IP money + Gotta pay for those lawyers and guns! + + + To set nested lists, use the `RS' and `RE' macros. *Note Indents in +ms::, for more information. + + For example: + + + .IP \[bu] 2 + Lawyers: + .RS + .IP \[bu] + Dewey, + .IP \[bu] + Cheatham, + .IP \[bu] + and Howe. + .RE + .IP \[bu] + Guns + + Produces: + + + o Lawyers: + + o Dewey, + + o Cheatham, + + o and Howe. + + o Guns + + +File: groff, Node: Indents in ms, Next: Tabstops in ms, Prev: Lists in ms, Up: ms Body Text + +Indents +....... + + In many situations, you may need to indent a section of text while +still wrapping and filling. *Note Lists in ms::, for an example of +nested lists. + + - Macro: .RS + - Macro: .RE + These macros begin and end an indented section. The `PI' register + controls the amount of indent, allowing the indented text to line + up under hanging and indented paragraphs. + + *Note ms Displays and Keeps::, for macros to indent and turn off +filling. + + +File: groff, Node: Tabstops in ms, Next: ms Displays and Keeps, Prev: Indents in ms, Up: ms Body Text + +Tab Stops +......... + + Use the `ta' request to define tab stops as needed. *Note Tabs and +Fields::. + + - Macro: .TA + Use this macro to reset the tab stops to the default for `ms' + (every 5n). You can redefine the `TA' macro to create a different + set of default tab stops. + + +File: groff, Node: ms Displays and Keeps, Next: ms Insertions, Prev: Tabstops in ms, Up: ms Body Text + +Displays and keeps +.................. + + Use displays to show text-based examples or figures (such as code +listings). + + Displays turn off filling, so lines of code are displayed as-is +without inserting `br' requests in between each line. Displays can be +"kept" on a single page, or allowed to break across pages. + + - Macro: .DS L + - Macro: .LD + - Macro: .DE + Left-justified display. The `.DS L' call generates a page break, + if necessary, to keep the entire display on one page. The `LD' + macro allows the display to break across pages. The `DE' macro + ends the display. + + - Macro: .DS I + - Macro: .ID + - Macro: .DE + Indents the display as defined by the `DI' register. The `.DS I' + call generates a page break, if necessary, to keep the entire + display on one page. The `ID' macro allows the display to break + across pages. The `DE' macro ends the display. + + - Macro: .DS B + - Macro: .BD + - Macro: .DE + Sets a block-centered display: the entire display is + left-justified, but indented so that the longest line in the + display is centered on the page. The `.DS B' call generates a + page break, if necessary, to keep the entire display on one page. + The `BD' macro allows the display to break across pages. The `DE' + macro ends the display. + + - Macro: .DS C + - Macro: .CD + - Macro: .DE + Sets a centered display: each line in the display is centered. + The `.DS C' call generates a page break, if necessary, to keep the + entire display on one page. The `CD' macro allows the display to + break across pages. The `DE' macro ends the display. + + - Macro: .DS R + - Macro: .RD + - Macro: .DE + Right-justifies each line in the display. The `.DS R' call + generates a page break, if necessary, to keep the entire display + on one page. The `RD' macro allows the display to break across + pages. The `DE' macro ends the display. + + + On occasion, you may want to "keep" other text together on a page. +For example, you may want to keep two paragraphs together, or a +paragraph that refers to a table (or list, or other item) immediately +following. The `ms' macros provide the `KS' and `KE' macros for this +purpose. + + - Macro: .KS + - Macro: .KE + The `KS' macro begins a block of text to be kept on a single page, + and the `KE' macro ends the block. + + - Macro: .KF + - Macro: .KE + Specifies a "floating keep"; if the keep cannot fit on the current + page, `groff' holds the contents of the keep and allows text + following the keep (in the source file) to fill in the remainder of + the current page. When the page breaks, whether by an explicit + `bp' request or by reaching the end of the page, `groff' prints + the floating keep at the top of the new page. This is useful for + printing large graphics or tables that do not need to appear + exactly where specified. + + You can also use the `ne' request to force a page break if there is +not enough vertical space remaining on the page. + + + Use the following macros to draw a box around a section of text +(such as a display). + + - Macro: .B1 + - Macro: .B2 + Marks the beginning and ending of text that is to have a box drawn + around it. The `B1' macro begins the box; the `B2' macro ends it. + Text in the box is automatically placed in a diversion (keep). + + +File: groff, Node: ms Insertions, Next: Example multi-page table, Prev: ms Displays and Keeps, Up: ms Body Text + +Tables, figures, equations, and references +.......................................... + + The `ms' macros support the standard `groff' preprocessors: `tbl', +`pic', `eqn', and `refer'. You mark text meant for preprocessors by +enclosing it in pairs of tags as follows. + + - Macro: .TS [`H'] + - Macro: .TE + Denotes a table, to be processed by the `tbl' preprocessor. The + optional argument `H' to `TS' instructs `groff' to create a + running header with the information up to the `TH' macro. `groff' + prints the header at the beginning of the table; if the table runs + onto another page, `groff' prints the header on the next page as + well. + + - Macro: .PS + - Macro: .PE + Denotes a graphic, to be processed by the `pic' preprocessor. You + can create a `pic' file by hand, using the AT&T `pic' manual + available on the Web as a reference, or by using a graphics + program such as `xfig'. + + - Macro: .EQ [align] + - Macro: .EN + Denotes an equation, to be processed by the `eqn' preprocessor. + The optional ALIGN argument can be `C', `L', or `I' to center (the + default), left-justify, or indent the equation. + + - Macro: .[ + - Macro: .] + Denotes a reference, to be processed by the `refer' preprocessor. + The GNU `refer(1)' man page provides a comprehensive reference to + the preprocessor and the format of the bibliographic database. + +* Menu: + +* Example multi-page table:: + + +File: groff, Node: Example multi-page table, Next: ms Footnotes, Prev: ms Insertions, Up: ms Body Text + +An example multi-page table +........................... + + The following is an example of how to set up a table that may print +across two or more pages. + + + .TS H + allbox expand; + cb | cb . + Text ...of heading... + _ + .TH + .T& + l | l . + ... the rest of the table follows... + .CW + .TE + + +File: groff, Node: ms Footnotes, Prev: Example multi-page table, Up: ms Body Text + +Footnotes +......... + + The `ms' macro package has a flexible footnote system. You can +specify either numbered footnotes or symbolic footnotes (that is, using +a marker such as a dagger symbol). + + - String: \*[*] + Specifies the location of a numbered footnote marker in the text. + + - Macro: .FS + - Macro: .FE + Specifies the text of the footnote. The default action is to + create a numbered footnote; you can create a symbolic footnote by + specifying a "mark" glyph (such as `\[dg]' for the dagger glyph) + in the body text and as an argument to the `FS' macro, followed by + the text of the footnote and the `FE' macro. + + You can control how `groff' prints footnote numbers by changing the +value of the `FF' register. *Note ms Document Control Registers::. + + +File: groff, Node: ms Page Layout, Next: Differences from AT&T ms, Prev: ms Body Text, Up: ms + +Page layout +----------- + + The default output from the `ms' macros provides a minimalist page +layout: it prints a single column, with the page number centered at the +top of each page. It prints no footers. + + You can change the layout by setting the proper number registers and +strings. + +* Menu: + +* ms Headers and Footers:: +* ms Margins:: +* ms Multiple Columns:: +* ms TOC:: +* ms Strings and Special Characters:: + + +File: groff, Node: ms Headers and Footers, Next: ms Margins, Prev: ms Page Layout, Up: ms Page Layout + +Headers and footers +................... + + For documents that do not distinguish between odd and even pages, +set the following strings: + + - String: \*[LH] + - String: \*[CH] + - String: \*[RH] + Sets the left, center, and right headers. + + - String: \*[LF] + - String: \*[CF] + - String: \*[RF] + Sets the left, center, and right footers. + + + For documents that need different information printed in the even +and odd pages, use the following macros: + + - Macro: .OH 'left'center'right' + - Macro: .EH 'left'center'right' + - Macro: .OF 'left'center'right' + - Macro: .EF 'left'center'right' + The `OH' and `EH' macros define headers for the odd and even pages; + the `OF' and `EF' macros define footers for the odd and even pages. + This is more flexible than defining the individual strings. + + You can replace the quote (`'') marks with any character not + appearing in the header or footer text. + + +File: groff, Node: ms Margins, Next: ms Multiple Columns, Prev: ms Headers and Footers, Up: ms Page Layout + +Margins +....... + + You control margins using a set of number registers. *Note ms +Document Control Registers::, for details. + + +File: groff, Node: ms Multiple Columns, Next: ms TOC, Prev: ms Margins, Up: ms Page Layout + +Multiple columns +................ + + The `ms' macros can set text in as many columns as will reasonably +fit on the page. The following macros are available; all of them force +a page break if a multi-column mode is already set. However, if the +current mode is single-column, starting a multi-column mode does *not* +force a page break. + + - Macro: .1C + Single-column mode. + + - Macro: .2C + Two-column mode. + + - Macro: .MC [width [gutter]] + Multi-column mode. If you specify no arguments, it is equivalent + to the `2C' macro. Otherwise, WIDTH is the width of each column + and GUTTER is the space between columns. The `MINGW' number + register controls the default gutter width. + + +File: groff, Node: ms TOC, Next: ms Strings and Special Characters, Prev: ms Multiple Columns, Up: ms Page Layout + +Creating a table of contents +............................ + + The facilities in the `ms' macro package for creating a table of +contents are semi-automated at best. Assuming that you want the table +of contents to consist of the document's headings, you need to repeat +those headings wrapped in `XS' and `XE' macros. + + - Macro: .XS [page] + - Macro: .XA [page] + - Macro: .XE + These macros define a table of contents or an individual entry in + the table of contents, depending on their use. The macros are + very simple; they cannot indent a heading based on its level. The + easiest way to work around this is to add tabs to the table of + contents string. The following is an example: + + + .NH 1 + Introduction + .XS + Introduction + .XE + .LP + ... + .CW + .NH 2 + Methodology + .XS + Methodology + .XE + .LP + ... + + You can manually create a table of contents by beginning with the + `XS' macro for the first entry, specifying the page number for + that entry as the argument to `XS'. Add subsequent entries using + the `XA' macro, specifying the page number for that entry as the + argument to `XA'. The following is an example: + + + .XS 1 + Introduction + .XA 2 + A Brief History of the Universe + .XA 729 + Details of Galactic Formation + ... + .XE + + + - Macro: .TC [`no'] + Prints the table of contents on a new page, setting the page + number to *i* (Roman numeral one). You should usually place this + macro at the end of the file, since `groff' is a single-pass + formatter and can only print what has been collected up to the + point that the `TC' macro appears. + + The optional argument `no' suppresses printing the title specified + by the string register `TOC'. + + - Macro: .PX [`no'] + Prints the table of contents on a new page, using the current page + numbering sequence. Use this macro to print a manually-generated + table of contents at the beginning of your document. + + The optional argument `no' suppresses printing the title specified + by the string register `TOC'. + + The `Groff and Friends HOWTO' includes a `sed' script that +automatically inserts `XS' and `XE' macro entries after each heading in +a document. + + Altering the `NH' macro to automatically build the table of contents +is perhaps initially more difficult, but would save a great deal of +time in the long run if you use `ms' regularly. + + +File: groff, Node: ms Strings and Special Characters, Prev: ms TOC, Up: ms Page Layout + +Strings and Special Characters +.............................. + + The `ms' macros provide the following predefined strings. You can +change the string definitions to help in creating documents in +languages other than English. + + - String: \*[REFERENCES] + Contains the string printed at the beginning of the references + (bibliography) page. The default is `References'. + + - String: \*[ABSTRACT] + Contains the string printed at the beginning of the abstract. The + default is `ABSTRACT'. + + - String: \*[TOC] + Contains the string printed at the beginning of the table of + contents. + + - String: \*[MONTH1] + - String: \*[MONTH2] + - String: \*[MONTH3] + - String: \*[MONTH4] + - String: \*[MONTH5] + - String: \*[MONTH6] + - String: \*[MONTH7] + - String: \*[MONTH8] + - String: \*[MONTH9] + - String: \*[MONTH10] + - String: \*[MONTH11] + - String: \*[MONTH12] + Prints the full name of the month in dates. The default is + `January', `February', etc. + + The following special characters are available(1) (*note ms Strings +and Special Characters-Footnote-1::): + + - String: \*[-] + Prints an em dash. + + - String: \*[*Q] + - String: \*[*U] + Prints typographer's quotes in troff, plain quotes in nroff. `*Q' + is the left quote and `*U' is the right quote. + + Improved accent marks are available in the `ms' macros. + + - Macro: .AM + Specify this macro at the beginning of your document to enable + extended accent marks and special characters. This is a Berkeley + extension. + + To use the accent marks, place them *after* the character being + accented. + + The following accent marks are available after invoking the `AM' +macro: + + - String: \*['] + Acute accent. + + - String: \*[`] + Grave accent. + + - String: \*[^] + Circumflex. + + - String: \*[,] + Cedilla. + + - String: \*[~] + Tilde. + + - String: \*[:] + Umlaut. + + - String: \*[v] + Hacek. + + - String: \*[_] + Macron (overbar). + + - String: \*[.] + Underdot. + + - String: \*[o] + Ring above. + + The following are standalone characters available after invoking the +`AM' macro: + + - String: \*[?] + Upside-down question mark. + + - String: \*[!] + Upside-down exclamation point. + + - String: \*[8] + German ss ligature. + + - String: \*[3] + Yogh. + + - String: \*[Th] + Uppercase thorn. + + - String: \*[th] + Lowercase thorn. + + - String: \*[D-] + Uppercase eth. + + - String: \*[d-] + Lowercase eth. + + - String: \*[q] + Hooked o. + + - String: \*[ae] + Lowercase ae ligature. + + - String: \*[Ae] + Uppercase AE ligature. + + +File: groff, Node: ms Strings and Special Characters-Footnotes, Up: ms Strings and Special Characters + + (1) For an explanation what special characters are see *Note Special +Characters::. + + +File: groff, Node: Differences from AT&T ms, Prev: ms Page Layout, Up: ms + +Differences from AT&T `ms' +-------------------------- + + This section lists the (minor) differences between the `groff -ms' +macros and AT&T `troff -ms' macros. + +* Menu: + +* Missing ms Macros:: +* Additional ms Macros:: + + +File: groff, Node: Missing ms Macros, Next: Additional ms Macros, Prev: Differences from AT&T ms, Up: Differences from AT&T ms + +`troff' macros not appearing in `groff' +....................................... + + Macros missing from `groff -ms' are cover page macros specific to +Bell Labs. The macros known to be missing are: + +`.TM' + Technical memorandum; a cover sheet style + +`.IM' + Internal memorandum; a cover sheet style + +`.MR' + Memo for record; a cover sheet style + +`.MF' + Memo for file; a cover sheet style + +`.EG' + Engineer's notes; a cover sheet style + +`.TR' + Computing Science Tech Report; a cover sheet style + +`.OK' + Other keywords + +`.CS' + Cover sheet information + +`.MH' + A cover sheet macro + + +File: groff, Node: Additional ms Macros, Prev: Missing ms Macros, Up: Differences from AT&T ms + +`groff' macros not appearing in AT&T `troff' +............................................ + + The `groff -ms' macros have a few minor extensions compared to the +AT&T `troff -ms' macros. + + - Macro: .AM + Improved accent marks. *Note ms Strings and Special Characters::, + for details. + + - Macro: .DS I + Indented display. The default behavior of AT&T `troff -ms' was to + indent; the `groff' default prints displays flush left with the + body text. + + - Macro: .CW + Print text in `constant width' (Courier) font. + + - Macro: .IX + Indexing term (printed on standard error). You can write a script + to capture and process an index generated in this manner. + + + The following additional number registers appear in `groff -ms': + + - Register: \n[MINGW] + Specifies a minimum space between columns (for multi-column + output); this takes the place of the `GW' register that was + documented but apparently not implemented in AT&T `troff'. + + + Several new string registers are available as well. You can change +these to handle (for example) the local language. *Note ms Strings and +Special Characters::, for details. + + +File: groff, Node: me, Next: mm, Prev: ms, Up: Macro Packages + +`me' +==== + + See the `meintro.me' and `meref.me' documents in groff's `doc' +directory. + + +File: groff, Node: mm, Prev: me, Up: Macro Packages + +`mm' +==== + + See the `groff_mm(7)' man page (type `man groff_mm' at the command +line). + + +File: groff, Node: gtroff Reference, Next: Preprocessors, Prev: Macro Packages, Up: Top + +`gtroff' Reference +****************** + + This chapter covers *all* of the facilities of `gtroff'. Users of +macro packages may skip it if not interested in details. + +* Menu: + +* Text:: +* Input Conventions:: +* Measurements:: +* Expressions:: +* Identifiers:: +* Embedded Commands:: +* Registers:: +* Manipulating Filling and Adjusting:: +* Manipulating Hyphenation:: +* Manipulating Spacing:: +* Tabs and Fields:: +* Character Translations:: +* Troff and Nroff Mode:: +* Line Layout:: +* Line Control:: +* Page Layout:: +* Page Control:: +* Fonts:: +* Sizes:: +* Strings:: +* Conditionals and Loops:: +* Writing Macros:: +* Page Motions:: +* Drawing Requests:: +* Traps:: +* Diversions:: +* Environments:: +* Suppressing output:: +* Colors:: +* I/O:: +* Postprocessor Access:: +* Miscellaneous:: +* Gtroff Internals:: +* Debugging:: +* Implementation Differences:: + + +File: groff, Node: Text, Next: Input Conventions, Prev: gtroff Reference, Up: gtroff Reference + +Text +==== + + `gtroff' input files contain text with control commands interspersed +throughout. But, even without control codes, `gtroff' still does +several things with the input text: + + * filling and adjusting + + * adding additional space after sentences + + * hyphenating + + * inserting implicit line breaks + +* Menu: + +* Filling and Adjusting:: +* Hyphenation:: +* Sentences:: +* Tab Stops:: +* Implicit Line Breaks:: + + +File: groff, Node: Filling and Adjusting, Next: Hyphenation, Prev: Text, Up: Text + +Filling and Adjusting +--------------------- + + When `gtroff' reads text, it collects words from the input and fits +as many of them together on one output line as it can. This is known as +"filling". + + Once `gtroff' has a "filled" line, it tries to "adjust" it. This +means it widens the spacing between words until the text reaches the +right margin (in the default adjustment mode). Extra spaces between +words are preserved, but spaces at the end of lines are ignored. +Spaces at the front of a line cause a "break" (breaks are explained in +*Note Implicit Line Breaks::). + + *Note Manipulating Filling and Adjusting::. + + +File: groff, Node: Hyphenation, Next: Sentences, Prev: Filling and Adjusting, Up: Text + +Hyphenation +----------- + + Since the odds are not great for finding a set of words, for every +output line, which fit nicely on a line without inserting excessive +amounts of space between words, `gtroff' hyphenates words so that it +can justify lines without inserting too much space between words. It +uses an internal hyphenation algorithm (a simplified version of the +algorithm used within TeX) to indicate which words can be hyphenated +and how to do so. When a word is hyphenated, the first part of the +word is added to the current filled line being output (with an attached +hyphen), and the other portion is added to the next line to be filled. + + *Note Manipulating Hyphenation::. + + +File: groff, Node: Sentences, Next: Tab Stops, Prev: Hyphenation, Up: Text + +Sentences +--------- + + Although it is often debated, some typesetting rules say there +should be different amounts of space after various punctuation marks. +For example, the `Chicago typsetting manual' says that a period at the +end of a sentence should have twice as much space following it as would +a comma or a period as part of an abbreviation. + + `gtroff' does this by flagging certain characters (normally `!', +`?', and `.') as "end-of-sentence" characters. When `gtroff' +encounters one of these characters at the end of a line, it appends a +normal space followed by a "sentence space" in the formatted output. +(This justifies one of the conventions mentioned in *Note Input +Conventions::.) + + In addition, the following characters and symbols are treated +transparently while handling end-of-sentence characters: `"', `'', `)', +`]', `*', `\[dg]', and `\[rq]'. + + See the `cflags' request in *Note Using Symbols::, for more details. + + To prevent the insertion of extra space after an end-of-sentence +character (at the end of a line), append `\&'. + diff --git a/contrib/groff/doc/groff-3 b/contrib/groff/doc/groff-3 new file mode 100644 index 0000000..b808a39 --- /dev/null +++ b/contrib/groff/doc/groff-3 @@ -0,0 +1,1374 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: Tab Stops, Next: Implicit Line Breaks, Prev: Sentences, Up: Text + +Tab Stops +--------- + + `gtroff' translates "tabulator characters", also called "tabs" +(normally code point ASCII `0x09' or EBCDIC `0x05'), in the input into +movements to the next tabulator stop. These tab stops are initially +located every half inch across the page. Using this, simple tables can +be made easily. However, it can often be deceptive as the appearance +(and width) of the text on a terminal and the results from `gtroff' can +vary greatly. + + Also, a possible sticking point is that lines beginning with tab +characters are still filled, again producing unexpected results. For +example, the following input + + 1 2 3 + 4 5 + +produces + + 1 2 3 4 5 + + *Note Tabs and Fields::. + + +File: groff, Node: Implicit Line Breaks, Prev: Tab Stops, Up: Text + +Implicit Line Breaks +-------------------- + + An important concept in `gtroff' is the "break". When a break +occurs, `gtroff' outputs the partially filled line (unjustified), and +resumes collecting and filling text on the next output line. + + There are several ways to cause a break in `gtroff'. A blank line +not only causes a break, but it also outputs a one-line vertical space +(effectively a blank line). Note that this behaviour can be modified +with the blank line macro request `blm'. *Note Blank Line Traps::. + + A line that begins with a space causes a break and the space is +output at the beginning of the next line. Note that this space isn't +adjusted, even in fill mode. + + The end of file also causes a break - otherwise the last line of the +document may vanish! + + Certain requests also cause breaks, implicitly or explicitly. This +is discussed in *Note Manipulating Filling and Adjusting::. + + +File: groff, Node: Input Conventions, Next: Measurements, Prev: Text, Up: gtroff Reference + +Input Conventions +================= + + Since `gtroff' does filling automatically, it is traditional in +`groff' not to try and type things in as nicely formatted paragraphs. +These are some conventions commonly used when typing `gtroff' text: + + * Break lines after punctuation, particularly at the end of a + sentence and in other logical places. Keep separate phrases on + lines by themselves, as entire phrases are often added or deleted + when editing. + + * Try to keep lines less than 40-60 characters, to allow space for + inserting more text. + + * Do not try to do any formatting in a WYSIWYG manner (i.e., don't + try using spaces to get proper indentation). + + +File: groff, Node: Measurements, Next: Expressions, Prev: Input Conventions, Up: gtroff Reference + +Measurements +============ + + `gtroff' (like many other programs) requires numeric parameters to +specify various measurements. Most numeric parameters(1) (*note +Measurements-Footnote-1::) may have a "measurement unit" attached. +These units are specified as a single character which immediately +follows the number or expression. Each of these units are understood, +by `gtroff', to be a multiple of its "basic unit". So, whenever a +different measurement unit is specified `gtroff' converts this into its +"basic units". This basic unit, represented by a `u', is a device +dependent measurement which is quite small, ranging from 1/75th to +1/72000th of an inch. The values may be given as fractional numbers; +however, fractional basic units are always rounded to integers. + + Some of the measurement units are completely independent of any of +the current settings (e.g. type size) of `gtroff'. + +`i' + Inches. An antiquated measurement unit still in use in certain + backwards countries with incredibly low-cost computer equipment. + One inch is equal to 2.54cm. + +`c' + Centimeters. One centimeter is equal to 0.3937in. + +`p' + Points. This is a typesetter's measurement used for measure type + size. It is 72 points to an inch. + +`P' + Pica. Another typesetting measurement. 6 Picas to an inch (and + 12 points to a pica). + +`s' +`z' + *Note Fractional Type Sizes::, for a discussion of these units. + +`f' + Fractions. Value is 65536. *Note Colors::, for usage. + + The other measurements understood by `gtroff' depend on settings +currently in effect in `gtroff'. These are very useful for specifying +measurements which should look proper with any size of text. + +`m' + Ems. This unit is equal to the current font size in points. So + called because it is _approximately_ the width of the letter `m' + in the current font. + +`n' + Ens. In `groff', this is half of an em. + +`v' + Vertical space. This is equivalent to the current line spacing. + *Note Sizes::, for more information about this. + +`M' + 100ths of an em. + +* Menu: + +* Default Units:: + + +File: groff, Node: Measurements-Footnotes, Up: Measurements + + (1) those that specify vertical or horizontal motion or a type size + + +File: groff, Node: Default Units, Prev: Measurements, Up: Measurements + +Default Units +------------- + + Many requests take a default unit. While this can be helpful at +times, it can cause strange errors in some expressions. For example, +the line length request expects em units. Here are several attempts to +get a line length of 3.5 inches and their results: + + + 3.5i => 3.5i + 7/2 => 0i + 7/2i => 0i + (7 / 2)u => 0i + 7i/2 => 0.1i + 7i/2u => 3.5i + +Everything is converted to basic units first. In the above example it +is assumed that 1i equals 240u, and 1m equals 10p (thus 1m equals 33u). +The value 7i/2 is first handled as 7i/2m, then converted to 1680u/66u +which is 25u, and this is approximately 0.1i. As can be seen, a +scaling indicator after a closing parenthesis is simply ignored. + + Thus, the safest way to specify measurements is to always attach a +scaling indicator. If you want to multiply or divide by a certain +scalar value, use `u' as the unit for that value. + + +File: groff, Node: Expressions, Next: Identifiers, Prev: Measurements, Up: gtroff Reference + +Expressions +=========== + + `gtroff' has most arithmetic operators common to other languages: + + * Arithmetic: `+' (addition), `-' (subtraction), `/' (division), `*' + (multiplication), `%' (modulo). + + `gtroff' only provides integer arithmetic. The internal type used + for computing results is `int', which is usually a 32bit signed + integer. + + * Comparison: `<' (less than), `>' (greater than), `<=' (less than + or equal), `>=' (greater than or equal), `=' (equal), `==' (the + same as `='). + + * Logical: `&' (logical and), `:' (logical or). + + * Unary operators: `-' (negating, i.e. changing the sign), `+' (just + for completeness; does nothing in expressions), `!' (logical not; + this works only within `if' and `while' requests). See below for + the use of unary operators in motion requests. + + * Extrema: `>?' (maximum), `<?' (minimum). + + Example: + + + .nr x 5 + .nr y 3 + .nr z (\n[x] >? \n[y]) + + The register `z' now contains 5. + + * Scaling: `(C;E)'. Evaluate E using C as the default scaling + indicator. If C is missing, ignore scaling indicators in the + evaluation of E. + + Parentheses may be used as in any other language. However, in +`gtroff' they are necessary to ensure order of evaluation. `gtroff' +has no operator precedence; expressions are evaluated left to right. +This means that `gtroff' evaluates `3+5*4' as if it were parenthesized +like `(3+5)*4', not as `3+(5*4)', as might be expected. + + For many requests which cause a motion on the page, the unary +operators `+' and `-' work differently if leading an expression. They +then indicate a motion relative to the current position (down or up, +respectively). + + Similarly, a leading `|' operator indicates an absolute position. +For vertical movements, it specifies the distance from the top of the +page; for horizontal movements, it gives the distance from the beginning +of the _input_ line. + + `+' and `-' are also treated differently by the following requests +and escapes: `bp', `in', `ll', `lt', `nm', `nr', `pl', `pn', `po', `ps', +`pvs', `rt', `ti', `\H', `\R', and `\s'. Here, leading plus and minus +signs indicate increments and decrements. + + *Note Setting Registers::, for some examples. + + - Escape: \B'ANYTHING' + Return 1 if ANYTHING is a valid numeric expression; or 0 if + ANYTHING is empty or not a valid numeric expression. + + Due to the way arguments are parsed, spaces are not allowed in +expressions, unless the entire expression is surrounded by parentheses. + + *Note Request Arguments::, and *Note Conditionals and Loops::. + + +File: groff, Node: Identifiers, Next: Embedded Commands, Prev: Expressions, Up: gtroff Reference + +Identifiers +=========== + + Like any other language, `gtroff' has rules for properly formed +"identifiers". In `gtroff', an identifier can be made up of almost any +printable character, with the exception of the following characters: + + * Whitespace characters (spaces, tabs, and newlines). + + * Backspace (ASCII `0x08' or EBCDIC `0x16') and character code + `0x01'. + + * The following input characters are invalid and are ignored if + `groff' runs on a machine based on ASCII, causing a warning + message of type `input' (see *Note Debugging::, for more details): + `0x00', `0x0B', `0x0D'-`0x1F', `0x80'-`0x9F'. + + And here are the invalid input characters if `groff' runs on an + EBCDIC host: `0x00', `0x08', `0x09', `0x0B', `0x0D'-`0x14', + `0x17'-`0x1F', `0x30'-`0x3F'. + + Currently, some of these reserved codepoints are used internally, + thus making it non-trivial to extend `gtroff' to cover Unicode or + other character sets and encodings which use characters of these + ranges. + + Note that invalid characters are removed before parsing; an + identifier `foo', followed by an invalid character, followed by + `bar' is treated as `foobar'. + + For example, any of the following is valid. + + + br + PP + (l + end-list + @_ + +Note that identifiers longer than two characters with a closing bracket +(`]') in its name can't be accessed with escape sequences which expect +an identifier as a parameter. For example, `\[foo]]' accesses the +glyph `foo', followed by `]', whereas `\C'foo]'' really asks for glyph +`foo]'. + + To avoid problems with the `refer' preprocessor, macro names should +not start with `[' or `]'. Due to backwards compatibility, everything +after `.[' and `.]' is handled as a special argument to `refer'. For +example, `.[foo' makes `refer' to start a reference, using `foo' as a +parameter. + + - Escape: \A'IDENT' + Test whether an identifier IDENT is valid in `gtroff'. It expands + to the character 1 or 0 according to whether its argument (usually + delimited by quotes) is or is not acceptable as the name of a + string, macro, diversion, number register, environment, or font. + It returns 0 if no argument is given. This is useful for looking + up user input in some sort of associative table. + + + \A'end-list' + => 1 + + + *Note Escapes::, for details on parameter delimiting characters. + + Identifiers in `gtroff' can be any length, but, in some contexts, +`gtroff' needs to be told where identifiers end and text begins (and in +different ways depending on their length): + + * Single character. + + * Two characters. Must be prefixed with `(' in some situations. + + * Arbitrary length (`gtroff' only). Must be bracketed with `[' + and `]' in some situations. Any length identifier can be put in + brackets. + + Unlike many other programming languages, undefined identifiers are +silently ignored or expanded to nothing. When `gtroff' finds an +undefined identifier, it emits a warning, doing the following: + + * If the identifier is a string, macro, or diversion, `gtroff' + defines it as empty. + + * If the identifier is a number register, `gtroff' defines it with a + value of 0. + + *Note Warnings::., *Note Interpolating Registers::, and *Note +Strings::. + + Note that macros, strings, and diversions share the same name space. + + + .de xxx + . nop foo + .. + . + .di xxx + bar + .br + .di + . + .xxx + => bar + +As can be seen in the previous example, `gtroff' reuses the identifier +`xxx', changing it from a macro to a diversion. No warning is emitted! +The contents of the first macro definition is lost. + + *Note Interpolating Registers::, and *Note Strings::. + + +File: groff, Node: Embedded Commands, Next: Registers, Prev: Identifiers, Up: gtroff Reference + +Embedded Commands +================= + + Most documents need more functionality beyond filling, adjusting and +implicit line breaking. In order to gain further functionality, +`gtroff' allows commands to be embedded into the text, in two ways. + + The first is a "request" which takes up an entire line, and does +some large-scale operation (e.g. break lines, start new pages). + + The other is an "escape" which can be usually embedded anywhere in +the text; most requests can accept it even as an argument. Escapes +generally do more minor operations like sub- and superscripts, print a +symbol, etc. + +* Menu: + +* Requests:: +* Macros:: +* Escapes:: + + +File: groff, Node: Requests, Next: Macros, Prev: Embedded Commands, Up: Embedded Commands + +Requests +-------- + + A request line begins with a control character, which is either a +single quote (`'', the "no-break control character") or a period (`.', +the normal "control character"). These can be changed; see *Note +Character Translations::, for details. After this there may be +optional tabs or spaces followed by an identifier which is the name of +the request. This may be followed by any number of space-separated +arguments (_no_ tabs here). + + Since a control character followed by whitespace only is ignored, it +is common practice to use this feature for structuring the source code +of documents or macro packages. + + + .de foo + . tm This is foo. + .. + . + . + .de bar + . tm This is bar. + .. + + Another possibility is to use the blank line macro request `blm' by +assigning an empty macro to it. + + + .de do-nothing + .. + .blm do-nothing \" activate blank line macro + + .de foo + . tm This is foo. + .. + + + .de bar + . tm This is bar. + .. + + .blm \" deactivate blank line macro + + *Note Blank Line Traps::. + + To begin a line with a control character without it being +interpreted, precede it with `\&'. This represents a zero width space, +which means it does not affect the output. + + In most cases the period is used as a control character. Several +requests cause a break implicitly; using the single quote control +character prevents this. + +* Menu: + +* Request Arguments:: + + +File: groff, Node: Request Arguments, Prev: Requests, Up: Requests + +Request Arguments +................. + + Arguments to requests (and macros) are processed much like the shell: +The line is split into arguments according to spaces.(1) (*note Request +Arguments-Footnote-1::) An argument which is intended to contain +spaces can either be enclosed in double quotes, or have the spaces +"escaped" with backslashes. + + Here are a few examples: + + + .uh The Mouse Problem + .uh "The Mouse Problem" + .uh The\ Mouse\ Problem + +The first line is the `uh' macro being called with 3 arguments, `The', +`Mouse', and `Problem'. The latter two have the same effect of calling +the `uh' macro with one argument, `The Mouse Problem'.(2) (*note +Request Arguments-Footnote-2::) + + A double quote which isn't preceded by a space doesn't start a macro +argument. If not closing a string, it is printed literally. + + For example, + + + .xxx a" "b c" "de"fg" + +has the arguments `a"', `b c', `de', and `fg"'. Don't rely on this +obscure behaviour! + + There are two possibilities to get a double quote reliably. + + * Enclose the whole argument with double quotes and use two + consecutive double quotes to represent a single one. This + traditional solution has the disadvantage that double quotes don't + survive argument expansion again if called in compatibility mode + (using the `-C' option of `groff'): + + + .de xx + . tm xx: `\\$1' `\\$2' `\\$3' + . + . yy "\\$1" "\\$2" "\\$3" + .. + .de yy + . tm yy: `\\$1' `\\$2' `\\$3' + .. + .xx A "test with ""quotes""" . + => xx: `A' `test with "quotes"' `.' + => yy: `A' `test with ' `quotes""' + + If not in compatibility mode, you get the expected result + + + xx: `A' `test with "quotes"' `.' + yy: `A' `test with "quotes"' `.' + + since `gtroff' preserves the input level. + + * Use the double quote glyph `\(dq'. This works with and without + compatibility mode enabled since `gtroff' doesn't convert `\(dq' + back to a double quote input character. + + Not that this method won't work with UNIX `troff' in general since + the glyph `dq' isn't defined normally. + + Double quotes in the `ds' request are handled differently. *Note +Strings::, for more details. + + +File: groff, Node: Request Arguments-Footnotes, Up: Request Arguments + + (1) Plan 9's `troff' implementation also allows tabs for argument +separation - `gtroff' intentionally doesn't support this. + + (2) The last solution, i.e., using escaped spaces, is "classical" in +the sense that it can be found in most `troff' documents. +Nevertheless, it is not optimal in all situations, since `\ ' inserts a +fixed-width, non-breaking space character which can't stretch. +`gtroff' provides a different command `\~' to insert a stretchable, +non-breaking space. + + +File: groff, Node: Macros, Next: Escapes, Prev: Requests, Up: Embedded Commands + +Macros +------ + + `gtroff' has a "macro" facility for defining a series of lines which +can be invoked by name. They are called in the same manner as requests +- arguments also may be passed in the same manner. + + *Note Writing Macros::, and *Note Request Arguments::. + + +File: groff, Node: Escapes, Prev: Macros, Up: Embedded Commands + +Escapes +------- + + Escapes may occur anywhere in the input to `gtroff'. They usually +begin with a backslash and are followed by a single character which +indicates the function to be performed. The escape character can be +changed; see *Note Character Translations::. + + Escape sequences which require an identifier as a parameter accept +three possible syntax forms. + + * The next single character is the identifier. + + * If this single character is an opening parenthesis, take the + following two characters as the identifier. Note that there is no + closing parenthesis after the identifier. + + * If this single character is an opening bracket, take all characters + until a closing bracket as the identifier. + +Examples: + + + \fB + \n(XX + \*[TeX] + + Other escapes may require several arguments and/or some special +format. In such cases the argument is traditionally enclosed in single +quotes (and quotes are always used in this manual for the definitions +of escape sequences). The enclosed text is then processed according to +what that escape expects. Example: + + + \l'1.5i\(bu' + + Note that the quote character can be replaced with any other +character which does not occur in the argument (even a newline or a +space character) in the following escapes: `\o', `\b', and `\X'. This +makes e.g. + + + A caf + \o + e\' + + + in Paris + => A cafe' in Paris + +possible, but it is better not to use this feature to avoid confusion. + + The following escapes sequences (which are handled similarly to +characters since they don't take a parameter) are also allowed as +delimiters: `\%', `\ ', `\|', `\^', `\{', `\}', `\'', `\`', `\-', `\_', +`\!', `\?', `\@', `\)', `\/', `\,', `\&', `\:', `\~', `\0', `\a', `\c', +`\d', `\e', `\E', `\p', `\r', `\t', and `\u'. Again, don't use these +if possible. + + No newline characters as delimiters are allowed in the following +escapes: `\A', `\B', `\Z', `\C', and `\w'. + + Finally, the escapes `\D', `\h', `\H', `\l', `\L', `\N', `\R', `\s', +`\S', `\v', and `\x' can't use the following characters as delimiters: + + * The digits `0'-`9'. + + * The (single-character) operators `+-/*%<>=&:().'. + + * The space, tab, and newline characters. + + * All escape sequences except `\%', `\:', `\{', `\}', `\'', `\`', + `\-', `\_', `\!', `\@', `\/', `\c', `\e', and `\p'. + + To have a backslash (actually, the current escape character) appear +in the output several escapes are defined: `\\', `\e' or `\E'. These +are very similar, and only differ with respect to being used in macros +or diversions. *Note Character Translations::, for an exact +description of those escapes. + + *Note Implementation Differences::, *Note Copy-in Mode::, and *Note +Diversions::, *Note Identifiers::, for more information. + +* Menu: + +* Comments:: + + +File: groff, Node: Comments, Prev: Escapes, Up: Escapes + +Comments +........ + + Probably one of the most(1) (*note Comments-Footnote-1::) common +forms of escapes is the comment. + + - Escape: \" + Start a comment. Everything to the end of the input line is + ignored. + + This may sound simple, but it can be tricky to keep the comments + from interfering with the appearance of the final output. + + If the escape is to the right of some text or a request, that + portion of the line is ignored, but the space leading up to it is + noticed by `gtroff'. This only affects the `ds' and `as' request + and its variants. + + One possibly irritating idiosyncracy is that tabs must not be used + to line up comments. Tabs are not treated as whitespace between + the request and macro arguments. + + A comment on a line by itself is treated as a blank line, because + after eliminating the comment, that is all that remains: + + + Test + \" comment + Test + + produces + + + Test + + Test + + To avoid this, it is common to start the line with `.\"' which + causes the line to be treated as an undefined request and thus + ignored completely. + + Another commenting scheme seen sometimes is three consecutive + single quotes (`'''') at the beginning of a line. This works, but + `gtroff' gives a warning about an undefined macro (namely `'''), + which is harmless, but irritating. + + - Escape: \# + To avoid all this, `gtroff' has a new comment mechanism using the + `\#' escape. This escape works the same as `\"' except that the + newline is also ignored: + + + Test + \# comment + Test + + produces + + + Test Test + + as expected. + + - Request: .ig yy + Ignore all input until `gtroff' encounters the macro named `.'YY + on a line by itself (or `..' if YY is not specified). This is + useful for commenting out large blocks of text: + + + text text text... + .ig + This is part of a large block + of text that has been + temporarily(?) commented out. + + We can restore it simply by removing + the .ig request and the ".." at the + end of the block. + .. + More text text text... + + produces + + + text text text... More text text text... + + Note that the commented-out block of text does not cause a break. + + The input is read in copy-mode; auto-incremented registers _are_ + affected (*note Auto-increment::). + + +File: groff, Node: Comments-Footnotes, Up: Comments + + (1) Unfortunately, this is a lie. But hopefully future `gtroff' +hackers will believe it `:-)' + + +File: groff, Node: Registers, Next: Manipulating Filling and Adjusting, Prev: Embedded Commands, Up: gtroff Reference + +Registers +========= + + Numeric variables in `gtroff' are called "registers". There are a +number of built-in registers, supplying anything from the date to +details of formatting parameters. + + *Note Identifiers::, for details on register identifiers. + +* Menu: + +* Setting Registers:: +* Interpolating Registers:: +* Auto-increment:: +* Assigning Formats:: +* Built-in Registers:: + + +File: groff, Node: Setting Registers, Next: Interpolating Registers, Prev: Registers, Up: Registers + +Setting Registers +----------------- + + Define or set registers using the `nr' request or the `\R' escape. + + - Request: .nr ident value + - Escape: \R'IDENT VALUE' + Set number register IDENT to VALUE. If IDENT doesn't exist, + `gtroff' creates it. + + The argument to `\R' usually has to be enclosed in quotes. *Note + Escapes::, for details on parameter delimiting characters. + + The `\R' escape doesn't produce an input token in `gtroff'; with + other words, it vanishes completely after `gtroff' has processed + it. + + For example, the following two lines are equivalent: + + + .nr a (((17 + (3 * 4))) % 4) + \R'a (((17 + (3 * 4))) % 4)' + => 1 + + Both `nr' and `\R' have two additional special forms to increment or +decrement a register. + + - Request: .nr ident +value + - Request: .nr ident -value + - Escape: \R'IDENT +VALUE' + - Escape: \R'IDENT -VALUE' + Increment (decrement) register IDENT by VALUE. + + + .nr a 1 + .nr a +1 + \na + => 2 + + To assign the negated value of a register to another register, + some care must be taken to get the desired result: + + + .nr a 7 + .nr b 3 + .nr a -\nb + \na + => 4 + .nr a (-\nb) + \na + => -3 + + The surrounding parentheses prevent the interpretation of the + minus sign as a decrementing operator. An alternative is to start + the assignment with a `0': + + + .nr a 7 + .nr b -3 + .nr a \nb + \na + => 4 + .nr a 0\nb + \na + => -3 + + + - Request: .rr ident + Remove number register IDENT. If IDENT doesn't exist, the request + is ignored. + + - Request: .rnn ident1 ident2 + Rename number register IDENT1 to IDENT2. If either IDENT1 or + IDENT2 doesn't exist, the request is ignored. + + - Request: .aln ident1 ident2 + Create an alias IDENT1 for a number register IDENT2. The new name + and the old name are exactly equivalent. If IDENT1 is undefined, + a warning of type `reg' is generated, and the request is ignored. + *Note Debugging::, for information about warnings. + + +File: groff, Node: Interpolating Registers, Next: Auto-increment, Prev: Setting Registers, Up: Registers + +Interpolating Registers +----------------------- + + Numeric registers can be accessed via the `\n' escape. + + - Escape: \nI + - Escape: \n(ID + - Escape: \n[IDENT] + Interpolate number register with name IDENT (one-character name I, + two-character name ID). This means that the value of the register + is expanded in-place while `gtroff' is parsing the input line. + Nested assignments (also called indirect assignments) are possible. + + + .nr a 5 + .nr as \na+\na + \n(as + => 10 + + + .nr a1 5 + .nr ab 6 + .ds str b + .ds num 1 + \n[a\n[num]] + => 5 + \n[a\*[str]] + => 6 + + + +File: groff, Node: Auto-increment, Next: Assigning Formats, Prev: Interpolating Registers, Up: Registers + +Auto-increment +-------------- + + Number registers can also be auto-incremented and auto-decremented. +The increment or decrement value can be specified with a third argument +to the `nr' request or `\R' escape. + + - Request: .nr ident value incr + Set number register IDENT to VALUE; the increment for + auto-incrementing is set to INCR. Note that the `\R' escape + doesn't support this notation. + + To activate auto-incrementing, the escape `\n' has a special syntax +form. + + - Escape: \n+I + - Escape: \n-I + - Escape: \n(+ID + - Escape: \n(-ID + - Escape: \n+(ID + - Escape: \n-(ID + - Escape: \n[+IDENT] + - Escape: \n[-IDENT] + - Escape: \n+[IDENT] + - Escape: \n-[IDENT] + Before interpolating, increment or decrement IDENT (one-character + name I, two-character name ID) by the auto-increment value as + specified with the `nr' request (or the `\R' escape). If no + auto-increment value has been specified, these syntax forms are + identical to `\n'. + + For example, + + + .nr a 0 1 + .nr xx 0 5 + .nr foo 0 -2 + \n+a, \n+a, \n+a, \n+a, \n+a + .br + \n-(xx, \n-(xx, \n-(xx, \n-(xx, \n-(xx + .br + \n+[foo], \n+[foo], \n+[foo], \n+[foo], \n+[foo] + +produces + + + 1, 2, 3, 4, 5 + -5, -10, -15, -20, -25 + -2, -4, -6, -8, -10 + + To change the increment value without changing the value of a +register (A in the example), the following can be used: + + + .nr a \na 10 + + +File: groff, Node: Assigning Formats, Next: Built-in Registers, Prev: Auto-increment, Up: Registers + +Assigning Formats +----------------- + + When a register is used in the text of an input file (as opposed to +part of an expression), it is textually replaced (or interpolated) with +a representation of that number. This output format can be changed to +a variety of formats (numbers, Roman numerals, etc.). This is done +using the `af' request. + + - Request: .af ident format + Change the output format of a number register. The first argument + IDENT is the name of the number register to be changed, and the + second argument FORMAT is the output format. The following output + formats are available: + + `1' + Decimal arabic numbers. This is the default format: 0, 1, 2, + 3, .... + + `0...0' + Decimal numbers with as many digits as specified. So, `00' + would result in printing numbers as 01, 02, 03, .... + + In fact, any digit instead of zero will do; `gtroff' only + counts how many digits are specified. As a consequence, + `af''s default format `1' could be specified as `0' also (and + exactly this is returned by the `\g' escape, see below). + + `I' + Upper-case Roman numerals: 0, I, II, III, IV, .... + + `i' + Lower-case Roman numerals: 0, i, ii, iii, iv, .... + + `A' + Upper-case letters: 0, A, B, C, ..., Z, AA, AB, .... + + `a' + Lower-case letters: 0, a, b, c, ..., z, aa, ab, .... + + Omitting the number register format causes a warning of type + `missing'. *Note Debugging::, for more details. Specifying a + nonexistent format causes an error. + + The following example produces `10, X, j, 010': + + + .nr a 10 + .af a 1 \" the default format + \na, + .af a I + \na, + .af a a + \na, + .af a 001 + \na + + The largest number representable for the `i' and `I' formats is + 39999 (or -39999); UNIX `troff' uses `z' and `w' to represent + 10000 and 5000 in Roman numerals, and so does `gtroff'. + Currently, the correct glyphs of Roman numeral five thousand and + Roman numeral ten thousand (Unicode code points `U+2182' and + `U+2181', respectively) are not available. + + If IDENT doesn't exist, it is created. + + Changing the output format of a read-only register causes an + error. It is necessary to first copy the register's value to a + writeable register, then apply the `af' request to this other + register. + + - Escape: \gI + - Escape: \g(ID + - Escape: \g[IDENT] + Return the current format of the specified register IDENT + (one-character name I, two-character name ID). For example, `\ga' + after the previous example would produce the string `000'. If the + register hasn't been defined yet, nothing is returned. + + +File: groff, Node: Built-in Registers, Prev: Assigning Formats, Up: Registers + +Built-in Registers +------------------ + + The following lists some built-in registers which are not described +elsewhere in this manual. Any register which begins with a `.' is +read-only. A complete listing of all built-in registers can be found in +appendix *Note Register Index::. + +`.F' + This string-valued register returns the current input file name. + +`.H' + Horizontal resolution in basic units. + +`.V' + Vertical resolution in basic units. + +`seconds' + The number of seconds after the minute, normally in the range 0 + to 59, but can be up to 61 to allow for leap seconds. Initialized + at start-up of `gtroff'. + +`minutes' + The number of minutes after the hour, in the range 0 to 59. + Initialized at start-up of `gtroff'. + +`hours' + The number of hours past midnight, in the range 0 to 23. + Initialized at start-up of `gtroff'. + +`dw' + Day of the week (1-7). + +`dy' + Day of the month (1-31). + +`mo' + Current month (1-12). + +`year' + The current year. + +`yr' + The current year minus 1900. Unfortunately, the documentation of + UNIX Version 7's `troff' had a year 2000 bug: It incorrectly + claimed that `yr' contains the last two digits of the year. That + claim has never been true of either AT&T `troff' or GNU `troff'. + Old `troff' input that looks like this: + + + '\" The following line stopped working after 1999 + This document was formatted in 19\n(yr. + + can be corrected as follows: + + + This document was formatted in \n[year]. + + or, to be portable to older `troff' versions, as follows: + + + .nr y4 1900+\n(yr + This document was formatted in \n(y4. + +`.c' +`c.' + The current _input_ line number. Register `.c' is read-only, + whereas `c.' (a `gtroff' extension) is writable also, affecting + both `.c' and `c.'. + +`ln' + The current _output_ line number after a call to the `nm' request + to activate line numbering. + + *Note Miscellaneous::, for more information about line numbering. + +`.x' + The major version number. For example, if the version number + is 1.03 then `.x' contains `1'. + +`.y' + The minor version number. For example, if the version number + is 1.03 then `.y' contains `03'. + +`.Y' + The revision number of `groff'. + +`$$' + The process ID of `gtroff'. + +`.g' + Always 1. Macros should use this to determine whether they are + running under GNU `troff'. + +`.A' + If the command line option `-a' is used to produce an ASCII + approximation of the output, this is set to 1, zero otherwise. + *Note Groff Options::. + +`.P' + This register is set to 1 (and to 0 otherwise) if the current page + is actually being printed, i.e., if the `-o' option is being used + to only print selected pages. *Note Groff Options::, for more + information. + +`.T' + If `gtroff' is called with the `-T' command line option, the + number register `.T' is set to 1, and zero otherwise. *Note Groff + Options::. + + Additionally, `gtroff' predefines a single read-write string + register `.T' which contains the current output device (for + example, `latin1' or `ps'). + + +File: groff, Node: Manipulating Filling and Adjusting, Next: Manipulating Hyphenation, Prev: Registers, Up: gtroff Reference + +Manipulating Filling and Adjusting +================================== + + Various ways of causing "breaks" were given in *Note Implicit Line +Breaks::. The `br' request likewise causes a break. Several other +requests also cause breaks, but implicitly. These are `bp', `ce', +`cf', `fi', `fl', `in', `nf', `rj', `sp', `ti', and `trf'. + + - Request: .br + Break the current line, i.e., the input collected so far is emitted + without adjustment. + + If the no-break control character is used, `gtroff' suppresses the + break: + + + a + 'br + b + => a b + + + Initially, `gtroff' fills and adjusts text to both margins. Filling +can be disabled via the `nf' request and re-enabled with the `fi' +request. + + - Request: .fi + - Register: \n[.u] + Activate fill mode (which is the default). This request implicitly + enables adjusting; it also inserts a break in the text currently + being filled. The read-only number register `.u' is set to 1. + + The fill mode status is associated with the current environment + (*note Environments::). + + See *Note Line Control::, for interaction with the `\c' escape. + + - Request: .nf + Activate no-fill mode. Input lines are output as-is, retaining + line breaks and ignoring the current line length. This command + implicitly disables adjusting; it also causes a break. The number + register `.u' is set to 0. + + The fill mode status is associated with the current environment + (*note Environments::). + + See *Note Line Control::, for interaction with the `\c' escape. + + - Request: .ad [mode] + - Register: \n[.j] + Set adjusting mode. + + Activation and deactivation of adjusting is done implicitly with + calls to the `fi' or `nf' requests. + + MODE can have one of the following values: + + `l' + Adjust text to the left margin. This produces what is + traditionally called ragged-right text. + + `r' + Adjust text to the right margin, producing ragged-left text. + + `c' + Center filled text. This is different to the `ce' request + which only centers text without filling. + + `b' + `n' + Justify to both margins. This is the default used by + `gtroff'. + + With no argument, `gtroff' adjusts lines in the same way it did + before adjusting was deactivated (with a call to `na', for + example). + + + text + .ad r + text + .ad c + text + .na + text + .ad \" back to centering + text + + The current adjustment mode is available in the read-only number + register `.j'; it can be stored and subsequently used to set + adjustment. + + The adjustment mode status is associated with the current + environment (*note Environments::). + + - Request: .na + Disable adjusting. This request won't change the current + adjustment mode: A subsequent call to `ad' uses the previous + adjustment setting. + + The adjustment mode status is associated with the current + environment (*note Environments::). + + - Request: .brp + - Escape: \p + Adjust the current line and cause a break. + + In most cases this produces very ugly results since `gtroff' + doesn't have a sophisticated paragraph building algorithm (as TeX + have, for example); instead, `gtroff' fills and adjusts a paragraph + line by line: + + + This is an uninteresting sentence. + This is an uninteresting sentence.\p + This is an uninteresting sentence. + + is formatted as + + + This is an uninteresting sentence. This is an + uninteresting sentence. + This is an uninteresting sentence. + + + - Request: .ss word_space_size [sentence_space_size] + - Register: \n[.ss] + - Register: \n[.sss] + Change the minimum size of a space between filled words. It takes + its units as one twelfth of the space width parameter for the + current font. Initially both the WORD_SPACE_SIZE and + SENTENCE_SPACE_SIZE are 12. + + If two arguments are given to the `ss' request, the second + argument sets the sentence space size. If the second argument is + not given, sentence space size is set to WORD_SPACE_SIZE. The + sentence space size is used in two circumstances: If the end of a + sentence occurs at the end of a line in fill mode, then both an + inter-word space and a sentence space are added; if two spaces + follow the end of a sentence in the middle of a line, then the + second space is a sentence space. If a second argument is never + given to the `ss' request, the behaviour of UNIX `troff' is the + same as that exhibited by GNU `troff'. In GNU `troff', as in UNIX + `troff', a sentence should always be followed by either a newline + or two spaces. + + The read-only number registers `.ss' and `.sss' hold the values of + the parameters set by the first and second arguments of the `ss' + request. + + The word space and sentence space values are associated with the + current environment (*note Environments::). + + Contrary to AT&T `troff', this request is _not_ ignored if a TTY + output device is used; the given values are then rounded down to a + multiple of 12 (*note Implementation Differences::). + + The request is ignored if there is no parameter. + + - Request: .ce [nnn] + - Register: \n[.ce] + Center text. While the `.ad c' request also centers text, it + fills the text as well. `ce' does not fill the text it affects. + This request causes a break. The number of lines still to be + centered is associated with the current environment (*note + Environments::). + + The following example demonstrates the differences. Here the + input: + + + .ll 4i + .ce 1000 + This is a small text fragment which shows the differences + between the `.ce' and the `.ad c' request. + .ce 0 + + .ad c + This is a small text fragment which shows the differences + between the `.ce' and the `.ad c' request. + + And here the result: + + + This is a small text fragment which + shows the differences + between the `.ce' and the `.ad c' request. + + This is a small text fragment which + shows the differences between the `.ce' + and the `.ad c' request. + + With no arguments, `ce' centers the next line of text. NNN + specifies the number of lines to be centered. If the argument is + zero or negative, centering is disabled. + + The basic length for centering text is the line length (as set + with the `ll' request) minus the indentation (as set with the `in' + request). Temporary indentation is ignored. + + As can be seen in the previous example, it is a common idiom to + turn on centering for a large number of lines, and to turn off + centering after text to be centered. This is useful for any + request which takes a number of lines as an argument. + + The `.ce' read-only number register contains the number of lines + remaining to be centered, as set by the `ce' request. + + - Request: .rj [nnn] + - Register: \n[.rj] + Justify unfilled text to the right margin. Arguments are + identical to the `ce' request. The `.rj' read-only number + register is the number of lines to be right-justified as set by + the `rj' request. This request causes a break. The number of + lines still to be right-justified is associated with the current + environment (*note Environments::). + diff --git a/contrib/groff/doc/groff-4 b/contrib/groff/doc/groff-4 new file mode 100644 index 0000000..8b6d91a --- /dev/null +++ b/contrib/groff/doc/groff-4 @@ -0,0 +1,1316 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: Manipulating Hyphenation, Next: Manipulating Spacing, Prev: Manipulating Filling and Adjusting, Up: gtroff Reference + +Manipulating Hyphenation +======================== + + As discussed in *Note Hyphenation::, `gtroff' hyphenates words. +There are a number of ways to influence hyphenation. + + - Request: .hy [mode] + - Register: \n[.hy] + Enable hyphenation. The request has an optional numeric argument, + MODE, to restrict hyphenation if necessary: + + `1' + The default argument if MODE is omitted. Hyphenate without + restrictions. This is also the start-up value of `gtroff'. + + `2' + Do not hyphenate the last word on a page or column. + + `4' + Do not hyphenate the last two characters of a word. + + `8' + Do not hyphenate the first two characters of a word. + + Values in the previous table are additive. For example, the + value 12 causes `gtroff' to neither hyphenate the last two nor the + first two characters of a word. + + The current hyphenation restrictions can be found in the read-only + number register `.hy'. + + The hyphenation mode is associated with the current environment + (*note Environments::). + + - Request: .nh + Disable hyphenation (i.e., set the hyphenation mode to zero). Note + that the hyphenation mode of the last call to `hy' is not + remembered. + + The hyphenation mode is associated with the current environment + (*note Environments::). + + - Request: .hlm [nnn] + - Register: \n[.hlm] + - Register: \n[.hlc] + Set the maximum number of consecutive hyphenated lines to NNN. If + this number is negative, there is no maximum. The default value + is -1 if NNN is omitted. This value is associated with the + current environment (*note Environments::). Only lines output + from a given environment count towards the maximum associated with + that environment. Hyphens resulting from `\%' are counted; + explicit hyphens are not. + + The current setting of `hlm' is available in the `.hlm' read-only + number register. Also the number of immediately preceding + consecutive hyphenated lines are available in the read-only number + register `.hlc'. + + - Request: .hw word1 word2 ... + Define how WORD1, WORD2, etc. are to be hyphenated. The words + must be given with hyphens at the hyphenation points. For example: + + + .hw in-sa-lub-rious + + Besides the space character, any character whose hyphenation code + value is zero can be used to separate the arguments of `hw' (see + the documentation for the `hcode' request below for more + information). In addition, this request can be used more than + once. + + Hyphenation exceptions specified with the `hw' request are + associated with the current hyphenation language; it causes an + error if there is no current hyphenation language. + + This request is ignored if there is no parameter. + + In old versions of `troff' there was a limited amount of space to + store such information; fortunately, with `gtroff', this is no + longer a restriction. + + - Escape: \% + - Escape: \: + To tell `gtroff' how to hyphenate words on the fly, use the `\%' + escape, also known as the "hyphenation character". Preceding a + word with this character prevents it from being hyphenated; + putting it inside a word indicates to `gtroff' that the word may + be hyphenated at that point. Note that this mechanism only + affects that one occurrence of the word; to change the hyphenation + of a word for the entire document, use the `hw' request. + + The `\:' escape inserts a zero-width break point (that is, the + word breaks but without adding a hyphen). + + + ... check the /var/log/\:httpd/\:access_log file ... + + Note that `\X' and `\Y' start a word, that is, the `\%' escape in + (say) ` \X'...'\%foobar' and ` \Y'...'\%foobar' no longer prevents + hyphenation but inserts a hyphenation point at the beginning of + `foobar'; most likely this isn't what you want to do. + + - Request: .hc [char] + Change the hyphenation character to CHAR. This character then + works the same as the `\%' escape, and thus, no longer appears in + the output. Without an argument, `hc' resets the hyphenation + character to be `\%' (the default) only. + + The hyphenation character is associated with the current + environment (*note Environments::). + + - Request: .hpf pattern_file + - Request: .hpfa pattern_file + - Request: .hpfcode a b [c d ...] + Read in a file of hyphenation patterns. This file is searched for + in the same way as `NAME.tmac' (or `tmac.NAME') is searched for if + the `-mNAME' option is specified. + + It should have the same format as (simple) TeX patterns files. + More specifically, the following scanning rules are implemented. + + * A percent sign starts a comment (up to the end of the line) + even if preceded by a backslash. + + * No support for `digraphs' like `\$'. + + * `^^XX' (X is 0-9 or a-f) and `^^X' (character code of X in + the range 0-127) are recognized; other use of `^' causes an + error. + + * No macro expansion. + + * `hpf' checks for the expression `\patterns{...}' (possibly + with whitespace before and after the braces). Everything + between the braces is taken as hyphenation patterns. + Consequently, `{' and `}' are not allowed in patterns. + + * Similarly, `\hyphenation{...}' gives a list of hyphenation + exceptions. + + * `\endinput' is recognized also. + + * For backwards compatibility, if `\patterns' is missing, the + whole file is treated as a list of hyphenation patterns (only + recognizing the `%' character as the start of a comment). + + If no `hpf' request is specified (either in the document or in a + macro package), `gtroff' won't hyphenate at all. + + The `hpfa' request appends a file of patterns to the current list. + + The `hpfcode' request defines mapping values for character codes in + hyphenation patterns. `hpf' or `hpfa' then apply the mapping + (after reading the patterns) before replacing or appending them to + the current list of patterns. Its arguments are pairs of + character codes - integers from 0 to 255. The request maps + character code A to code B, code C to code D, and so on. You can + use character codes which would be invalid otherwise. + + The set of hyphenation patterns is associated with the current + language set by the `hla' request. The `hpf' request is usually + invoked by the `troffrc' or `troffrc-end' file; by default, + `troffrc' loads hyphenation patterns for American English (in file + `hyphen.us'). + + A second call to `hpf' (for the same language) will replace the + hyphenation patterns with the new ones. + + Invoking `hpf' causes an error if there is no current hyphenation + language. + + - Request: .hcode c1 code1 c2 code2 ... + Set the hyphenation code of character C1 to CODE1, that of C2 to + CODE2, etc. A hyphenation code must be a single input character + (not a special character) other than a digit or a space. + Initially each lower-case letter (`a'-`z') has its hyphenation + code set to itself, and each upper-case letter (`A'-`Z') has a + hyphenation code which is the lower-case version of itself. + + This request is ignored if it has no parameter. + + - Request: .hym [length] + - Register: \n[.hym] + Set the (right) hyphenation margin to LENGTH. If the current + adjustment mode is not `b' or `n', the line is not hyphenated if + it is shorter than LENGTH. Without an argument, the hyphenation + margin is reset to its default value, which is 0. The default + scaling indicator for this request is `m'. The hyphenation margin + is associated with the current environment (*note Environments::). + + A negative argument resets the hyphenation margin to zero, emitting + a warning of type `range'. + + The current hyphenation margin is available in the `.hym' read-only + number register. + + - Request: .hys [hyphenation_space] + - Register: \n[.hys] + Set the hyphenation space to HYPHENATION_SPACE. If the current + adjustment mode is `b' or `n', don't hyphenate the line if it can + be justified by adding no more than HYPHENATION_SPACE extra space + to each word space. Without argument, the hyphenation space is + set to its default value, which is 0. The default scaling + indicator for this request is `m'. The hyphenation space is + associated with the current environment (*note Environments::). + + A negative argument resets the hyphenation space to zero, emitting + a warning of type `range'. + + The current hyphenation space is available in the `.hys' read-only + number register. + + - Request: .shc [glyph] + Set the "soft hyphen character" to GLYPH.(1) (*note Manipulating + Hyphenation-Footnote-1::) If the argument is omitted, the soft + hyphen character is set to the default glyph `\(hy' (this is the + start-up value of `gtroff' also). The soft hyphen character is + the glyph that is inserted when a word is hyphenated at a line + break. If the soft hyphen character does not exist in the font of + the character immediately preceding a potential break point, then + the line is not broken at that point. Neither definitions + (specified with the `char' request) nor translations (specified + with the `tr' request) are considered when finding the soft hyphen + character. + + - Request: .hla language + - Register: \n[.hla] + Set the current hyphenation language to the string LANGUAGE. + Hyphenation exceptions specified with the `hw' request and + hyphenation patterns specified with the `hpf' and `hpfa' requests + are both associated with the current hyphenation language. The + `hla' request is usually invoked by the `troffrc' or the + `troffrc-end' files; `troffrc' sets the default language to `us'. + + The current hyphenation language is available as a string in the + read-only number register `.hla'. + + + .ds curr_language \n[.hla] + \*[curr_language] + => us + + + +File: groff, Node: Manipulating Hyphenation-Footnotes, Up: Manipulating Hyphenation + + (1) "Soft hyphen character" is a misnomer since it is an output +glyph. + + +File: groff, Node: Manipulating Spacing, Next: Tabs and Fields, Prev: Manipulating Hyphenation, Up: gtroff Reference + +Manipulating Spacing +==================== + + - Request: .sp [distance] + Space downwards DISTANCE. With no argument it advances 1 line. A + negative argument causes `gtroff' to move up the page the + specified distance. If the argument is preceded by a `|' then + `gtroff' moves that distance from the top of the page. This + request causes a line break. The default scaling indicator is `v'. + + - Request: .ls [nnn] + - Register: \n[.L] + Output NNN-1 blank lines after each line of text. With no + argument, `gtroff' uses the previous value before the last `ls' + call. + + + .ls 2 \" This causes double-spaced output + .ls 3 \" This causes triple-spaced output + .ls \" Again double-spaced + + The line spacing is associated with the current environment (*note + Environments::). + + The read-only number register `.L' contains the current line + spacing setting. + + *Note Changing Type Sizes::, for the requests `vs' and `pvs' as +alternatives to `ls'. + + - Escape: \x'SPACING' + - Register: \n[.a] + Sometimes, extra vertical spacing is only needed occasionally, e.g. + to allow space for a tall construct (like an equation). The `\x' + escape does this. The escape is given a numerical argument, + usually enclosed in quotes (like `\x'3p''); the default scaling + indicator is `v'. If this number is positive extra vertical space + is inserted below the current line. A negative number adds space + above. If this escape is used multiple times on the same line, + the maximum of the values is used. + + *Note Escapes::, for details on parameter delimiting characters. + + The `.a' read-only number register contains the most recent + (nonnegative) extra vertical line space. + + Using `\x' can be necessary in combination with the `\b' escape, + as the following example shows. + + + This is a test with the \[rs]b escape. + .br + This is a test with the \[rs]b escape. + .br + This is a test with \b'xyz'\x'-1m'\x'1m'. + .br + This is a test with the \[rs]b escape. + .br + This is a test with the \[rs]b escape. + + produces + + + This is a test with the \b escape. + This is a test with the \b escape. + x + This is a test with y. + z + This is a test with the \b escape. + This is a test with the \b escape. + + + - Request: .ns + - Request: .rs + - Register: \n[.ns] + Enable "no-space mode". In this mode, spacing (either via `sp' or + via blank lines) is disabled. The `bp' request to advance to the + next page is also disabled, except if it is accompanied by a page + number (see *Note Page Control::, for more information). This + mode ends when actual text is output or the `rs' request is + encountered which ends no-space mode. The read-only number + register `.ns' is set to 1 as long as no-space mode is active. + + This request is useful for macros that conditionally insert + vertical space before the text starts (for example, a paragraph + macro could insert some space except when it is the first + paragraph after a section header). + + +File: groff, Node: Tabs and Fields, Next: Character Translations, Prev: Manipulating Spacing, Up: gtroff Reference + +Tabs and Fields +=============== + + A tab character (ASCII char 9, EBCDIC char 5) causes a horizontal +movement to the next tab stop (much like it did on a typewriter). + + - Escape: \t + This escape is a non-interpreted tab character. In copy mode + (*note Copy-in Mode::), `\t' is the same as a real tab character. + + - Request: .ta [n1 n2 ... nn T r1 r2 ... rn] + - Register: \n[.tabs] + Change tab stop positions. This request takes a series of tab + specifiers as arguments (optionally divided into two groups with + the letter `T') which indicate where each tab stop is to be + (overriding any previous settings). + + Tab stops can be specified absolutely, i.e., as the distance from + the left margin. For example, the following sets 6 tab stops every + one inch. + + + .ta 1i 2i 3i 4i 5i 6i + + Tab stops can also be specified using a leading `+' which means + that the specified tab stop is set relative to the previous tab + stop. For example, the following is equivalent to the previous + example. + + + .ta 1i +1i +1i +1i +1i +1i + + `gtroff' supports an extended syntax to specify repeat values after + the `T' mark (these values are always taken as relative) - this is + the usual way to specify tabs set at equal intervals. The + following is, yet again, the same as the previous examples. It + does even more since it defines an infinite number of tab stops + separated by one inch. + + + .ta T 1i + + Now we are ready to interpret the full syntax given at the + beginning: Set tabs at positions N1, N2, ..., NN and then set tabs + at NN+R1, NN+R2, ..., NN+RN and then at NN+RN+R1, NN+RN+R2, ..., + NN+RN+RN, and so on. + + Example: `4c +6c T 3c 5c 2c' is equivalent to `4c 10c 13c 18c 20c + 23c 28c 30c ...'. + + The material in each tab column (i.e., the column between two tab + stops) may be justified to the right or left or centered in the + column. This is specified by appending `R', `L', or `C' to the tab + specifier. The default justification is `L'. Example: + + + .ta 1i 2iC 3iR + + Some notes: + + * The default unit of the `ta' request is `m'. + + * A tab stop is converted into a non-breakable horizontal + movement which can be neither stretched nor squeezed. For + example, + + + .ds foo a\tb\tc + .ta T 5i + \*[foo] + + creates a single line which is a bit longer than 10 inches (a + string is used to show exactly where the tab characters are). + Now consider the following: + + + .ds bar a\tb b\tc + .ta T 5i + \*[bar] + + `gtroff' first converts the tab stops of the line into + unbreakable horizontal movements, then splits the line after + the second `b' (assuming a sufficiently short line length). + Usually, this isn't what the user wants. + + * Superfluous tabs (i.e., tab characters which do not + correspond to a tab stop) are ignored except the first one + which delimits the characters belonging to the last tab stop + for right-justifying or centering. Consider the following + example + + + .ds Z foo\tbar\tfoo + .ds ZZ foo\tbar\tfoobar + .ds ZZZ foo\tbar\tfoo\tbar + .ta 2i 4iR + \*[Z] + .br + \*[ZZ] + .br + \*[ZZZ] + .br + + which produces the following output: + + + foo bar foo + foo bar foobar + foo bar foobar + + The first line right-justifies the second `foo' relative to + the tab stop. The second line right-justifies `foobar'. The + third line finally right-justifies only `foo' because of the + additional tab character which marks the end of the string + belonging to the last defined tab stop. + + * Tab stops are associated with the current environment (*note + Environments::). + + * Calling `ta' without an argument removes all tab stops. + + * The start-up value of `gtroff' is `T 0.5i' in troff mode and + `T 0.8i' in nroff mode (the latter is done with an explicit + call to the `ta' request in the file `tty.tmac'. + + The read-only number register `.tabs' contains a string + representation of the current tab settings suitable for use as an + argument to the `ta' request. + + + .ds tab-string \n[.tabs] + \*[tab-string] + => T120u + + The `troff' version of the Plan 9 operating system uses register + `.S' for the same purpose. + + - Request: .tc [fill-glyph] + Normally `gtroff' fills the space to the next tab stop with + whitespace. This can be changed with the `tc' request. With no + argument `gtroff' reverts to using whitespace, which is the + default. The value of this "tab repetition character" is + associated with the current environment (*note Environments::).(1) + (*note Tabs and Fields-Footnote-1::) + + - Request: .linetabs n + - Register: \n[.linetabs] + If N is missing or not zero, enable "line-tabs" mode, or disable + it otherwise (the default). In line-tabs mode, `gtroff' computes + tab distances relative to the (current) output line instead of the + input line. + + For example, the following code: + + + .ds x a\t\c + .ds y b\t\c + .ds z c + .ta 1i 3i + \*x + \*y + \*z + + in normal mode, results in the output + + + a b c + + in line-tabs mode, the same code outputs + + + a b c + + Line-tabs mode is associated with the current environment. The + read-only register `.linetabs' is set to 1 if in line-tabs mode, + and 0 in normal mode. + +* Menu: + +* Leaders:: +* Fields:: + + +File: groff, Node: Tabs and Fields-Footnotes, Up: Tabs and Fields + + (1) "Tab repetition character" is a misnomer since it is an output +glyph. + + +File: groff, Node: Leaders, Next: Fields, Prev: Tabs and Fields, Up: Tabs and Fields + +Leaders +------- + + Sometimes it may may be desirable to use the `tc' request to fill a +particular tab stop with a given glyph (for example dots in a table of +contents), but also normal tab stops on the rest of the line. For this +`gtroff' provides an alternate tab mechanism, called "leaders" which +does just that. + + A leader character (character code 1) behaves similarly to a tab +character: It moves to the next tab stop. The only difference is that +for this movement, the fill glyph defaults to a period character and +not to space. + + - Escape: \a + This escape is a non-interpreted leader character. In copy mode + (*note Copy-in Mode::), `\a' is the same as a real leader + character. + + - Request: .lc [fill-glyph] + Declare the "leader repetition character".(1) (*note + Leaders-Footnote-1::) Without an argument, leaders act the same as + tabs (i.e., using whitespace for filling). `gtroff''s start-up + value is a dot (`.'). The value of the leader repetition + character is associated with the current environment (*note + Environments::). + + For a table of contents, to name an example, tab stops may be +defined so that the section number is one tab stop, the title is the +second with the remaining space being filled with a line of dots, and +then the page number slightly separated from the dots. + + + .ds entry 1.1\tFoo\a\t12 + .lc . + .ta 1i 5i +.25i + \*[entry] + +This produces + + + 1.1 Foo.......................................... 12 + + +File: groff, Node: Leaders-Footnotes, Up: Leaders + + (1) "Leader repetition character" is a misnomer since it is an +output glyph. + + +File: groff, Node: Fields, Prev: Leaders, Up: Tabs and Fields + +Fields +------ + + "Fields" are a more general way of laying out tabular data. A field +is defined as the data between a pair of "delimiting characters". It +contains substrings which are separated by "padding characters". The +width of a field is the distance on the _input_ line from the position +where the field starts to the next tab stop. A padding character +inserts stretchable space similar to TeX's `\hss' command (thus it can +even be negative) to make the sum of all substring lengths plus the +stretchable space equal to the field width. If more than one padding +character is inserted, the available space is evenly distributed among +them. + + - Request: .fc [delim-char [padding-char]] + Define a delimiting and a padding character for fields. If the + latter is missing, the padding character defaults to a space + character. If there is no argument at all, the field mechanism is + disabled (which is the default). Note that contrary to e.g. the + tab repetition character, delimiting and padding characters are + _not_ associated to the current environment (*note Environments::). + + Example: + + + .fc # ^ + .ta T 3i + #foo^bar^smurf# + .br + #foo^^bar^smurf# + + and here the result: + + + foo bar smurf + foo bar smurf + + + +File: groff, Node: Character Translations, Next: Troff and Nroff Mode, Prev: Tabs and Fields, Up: gtroff Reference + +Character Translations +====================== + + The control character (`.') and the no-break control character (`'') +can be changed with the `cc' and `c2' requests, respectively. + + - Request: .cc [c] + Set the control character to C. With no argument the default + control character `.' is restored. The value of the control + character is associated with the current environment (*note + Environments::). + + - Request: .c2 [c] + Set the no-break control character to C. With no argument the + default control character `'' is restored. The value of the + no-break control character is associated with the current + environment (*note Environments::). + + - Request: .eo + Disable the escape mechanism completely. After executing this + request, the backslash character `\' no longer starts an escape + sequence. + + This request can be very helpful in writing macros since it is not + necessary then to double the escape character. Here an example: + + + .\" This is a simplified version of the + .\" .BR request from the man macro package + .eo + .de BR + . ds result \& + . while (\n[.$] >= 2) \{\ + . as result \fB\$1\fR\$2 + . shift 2 + . \} + . if \n[.$] .as result \fB\$1 + \*[result] + . ft R + .. + .ec + + + - Request: .ec [c] + Set the escape character to C. With no argument the default + escape character `\' is restored. It can be also used to + re-enable the escape mechanism after an `eo' request. + + Note that changing the escape character globally will likely break + macro packages since `gtroff' has no mechanism to `intern' macros, + i.e., to convert a macro definition into an internal form which is + independent of its representation (TeX has this mechanism). If a + macro is called, it is executed literally. + + - Request: .ecs + - Request: .ecr + The `ecs' request saves the current escape character in an + internal register. Use this request in combination with the `ec' + request to temporarily change the escape character. + + The `ecr' request restores the escape character saved with `ecs'. + Without a previous call to `ecs', this request sets the escape + character to `\'. + + - Escape: \\ + - Escape: \e + - Escape: \E + Print the current escape character (which is the backslash + character `\' by default). + + `\\' is a `delayed' backslash; more precisely, it is the default + escape character followed by a backslash, which no longer has + special meaning due to the leading escape character. It is _not_ + an escape sequence in the usual sense! In any unknown escape + sequence `\X' the escape character is ignored and X is printed. + But if X is equal to the current escape character, no warning is + emitted. + + As a consequence, only at top-level or in a diversion a backslash + glyph is printed; in copy-in mode, it expands to a single + backslash which then combines with the following character to an + escape sequence. + + The `\E' escape differs from `\e' by printing an escape character + that is not interpreted in copy mode. Use this to define strings + with escapes that work when used in copy mode (for example, as a + macro argument). The following example defines strings to begin + and end a superscript: + + + .ds { \v'-.3m'\s'\Es[.s]*60/100' + .ds } \s0\v'.3m' + + Another example to demonstrate the differences between the various + escape sequences, using a strange escape character, `-'. + + + .ec - + .de xxx + --A'123' + .. + .xxx + => -A'foo' + + The result is surprising for most users, expecting `1' since `foo' + is a valid identifier. What has happened? As mentioned above, + the leading escape character makes the following character + ordinary. Written with the default escape character the sequence + `--' becomes `\-' - this is the minus sign. + + If the escape character followed by itself is a valid escape + sequence, only `\E' yields the expected result: + + + .ec - + .de xxx + -EA'123' + .. + .xxx + => 1 + + + - Escape: \. + Similar to `\\', the sequence `\.' isn't a real escape sequence. + As before, a warning message is suppressed if the escape character + is followed by a dot, and the dot itself is printed. + + + .de foo + . nop foo + . + . de bar + . nop bar + \\.. + . + .. + .foo + .bar + => foo bar + + The first backslash is consumed while the macro is read, and the + second is swallowed while exexuting macro `foo'. + + A "translation" is a mapping of an input character to an output +glyph. The mapping occurs at output time, i.e., the input character +gets assigned the metric information of the mapped output character +right before input tokens are converted to nodes (*note Gtroff +Internals::, for more on this process). + + - Request: .tr abcd... + - Request: .trin abcd... + Translate character A to glyph B, character C to glyph D, etc. If + there is an odd number of arguments, the last one is translated to + an unstretchable space (`\ '). + + The `trin' request is identical to `tr', but when you unformat a + diversion with `asciify' it ignores the translation. *Note + Diversions::, for details about the `asciify' request. + + Some notes: + + * Special characters (`\(XX', `\[XXX]', `\C'XXX'', `\'', `\`', + `\-', `\_'), glyphs defined with the `char' request, and + numbered glyphs (`\N'XXX'') can be translated also. + + * The `\e' escape can be translated also. + + * Characters can be mapped onto the `\%' and `\~' escapes (but + `\%' and `\~' can't be mapped onto another glyph). + + * The following characters can't be translated: space (with one + exception, see below), backspace, newline, leader (and `\a'), + tab (and `\t'). + + * Translations are not considered for finding the soft hyphen + character set with the `shc' request. + + * The pair `C\&' (this is an arbitrary character C followed by + the zero width space character) maps this character to + nothing. + + + .tr a\& + foo bar + => foo br + + It is even possible to map the space character to nothing: + + + .tr aa \& + foo bar + => foobar + + As shown in the example, the space character can't be the + first character/glyph pair as an argument of `tr'. + Additionally, it is not possible to map the space character + to any other glyph; requests like `.tr aa x' undo `.tr aa \&' + instead. + + If justification is active, lines are justified in spite of + the `empty' space character (but there is no minimal + distance, i.e. the space character, between words). + + * After an output glyph has been constructed (this happens at + the moment immediately before the glyph is appended to an + output glyph list, either by direct output, in a macro, + diversion, or string), it is no longer affected by `tr'. + + * Translating character to glyphs where one of them or both are + undefined is possible also; `tr' does not check whether the + entities in its argument do exist. + + *Note Gtroff Internals::. + + * `troff' no longer has a hard-coded dependency on Latin-1; all + `charXXX' entities have been removed from the font + description files. This has a notable consequence which + shows up in warnings like `can't find character with input + code XXX' if the `tr' request isn't handled properly. + + Consider the following translation: + + + .tr e'E' + + This maps input character `e'' onto glyph `E'', which is + identical to glyph `char201'. But this glyph intentionally + doesn't exist! Instead, `\[char201]' is treated as an input + character entity and is by default mapped onto `\['E]', and + `gtroff' doesn't handle translations of translations. + + The right way to write the above translation is + + + .tr e'\['E] + + With other words, the first argument of `tr' should be an + input character or entity, and the second one a glyph entity. + + * Without an argument, the `tr' request is ignored. + + - Request: .trnt abcd... + `trnt' is the same as the `tr' request except that the + translations do not apply to text that is transparently throughput + into a diversion with `\!'. *Note Diversions::, for more + information. + + For example, + + + .tr ab + .di x + \!.tm a + .di + .x + + prints `b' to the standard error stream; if `trnt' is used instead + of `tr' it prints `a'. + + +File: groff, Node: Troff and Nroff Mode, Next: Line Layout, Prev: Character Translations, Up: gtroff Reference + +Troff and Nroff Mode +==================== + + Originally, `nroff' and `troff' were two separate programs, the +former for TTY output, the latter for everything else. With GNU +`troff', both programs are merged into one executable, sending its +output to a device driver (`grotty' for TTY devices, `grops' for +POSTSCRIPT, etc.) which interprets the intermediate output of `gtroff'. +For UNIX `troff' it makes sense to talk about "Nroff mode" and "Troff +mode" since the differences are hardcoded. For GNU `troff', this +distinction is not appropriate because `gtroff' simply takes the +information given in the font files for a particular device without +handling requests specially if a TTY output device is used. + + Usually, a macro package can be used with all output devices. +Nevertheless, it is sometimes necessary to make a distinction between +TTY and non-TTY devices: `gtroff' provides two built-in conditions `n' +and `t' for the `if', `ie', and `while' requests to decide whether +`gtroff' shall behave like `nroff' or like `troff'. + + - Request: .troff + Make the `t' built-in condition true (and the `n' built-in + condition false) for `if', `ie', and `while' conditional requests. + This is the default if `gtroff' (_not_ `groff') is started with + the `-R' switch to avoid loading of the start-up files `troffrc' + and `troffrc-end'. Without `-R', `gtroff' stays in troff mode if + the output device is not a TTY (e.g. `ps'). + + - Request: .nroff + Make the `n' built-in condition true (and the `t' built-in + condition false) for `if', `ie', and `while' conditional requests. + This is the default if `gtroff' uses a TTY output device; the + code for switching to nroff mode is in the file `tty.tmac' which + is loaded by the start-up file `troffrc'. + + *Note Conditionals and Loops::, for more details on built-in +conditions. + + +File: groff, Node: Line Layout, Next: Line Control, Prev: Troff and Nroff Mode, Up: gtroff Reference + +Line Layout +=========== + + The following drawing shows the dimensions which `gtroff' uses for +placing a line of output onto the page. They are labeled with the +request which manipulates each dimension. + + + -->| in |<-- + |<-----------ll------------>| + +----+----+----------------------+----+ + | : : : | + +----+----+----------------------+----+ + -->| po |<-- + |<--------paper width---------------->| + +These dimensions are: + +`po' + "Page offset" - this is the leftmost position of text on the final + output, defining the "left margin". + +`in' + "Indentation" - this is the distance from the left margin where + text is printed. + +`ll' + "Line length" - this is the distance from the left margin to right + margin. + + A simple demonstration: + + + .ll 3i + This is text without indentation. + The line length has been set to 3\~inch. + .in +.5i + .ll -.5i + Now the left and right margins are both increased. + .in + .ll + Calling .in and .ll without parameters restore + the previous values. + + Result: + + + This is text without indenta- + tion. The line length has + been set to 3 inch. + Now the left and + right margins are + both increased. + Calling .in and .ll without + parameters restore the previ- + ous values. + + - Request: .po [offset] + - Request: .po +offset + - Request: .po -offset + - Register: \n[.o] + Set horizontal page offset to OFFSET (or increment or decrement + the current value by OFFSET). Note that this request does not + cause a break, so changing the page offset in the middle of text + being filled may not yield the expected result. The initial value + is 1i. For TTY output devices, it is set to 0 in the startup file + `troffrc'; the default scaling indicator is `m' (and not `v' as + incorrectly documented in the original UNIX troff manual). + + The current page offset can be found in the read-only number + register `.o'. + + If `po' is called without an argument, the page offset is reset to + the previous value before the last call to `po'. + + + .po 3i + \n[.o] + => 720 + .po -1i + \n[.o] + => 480 + .po + \n[.o] + => 720 + + + - Request: .in [indent] + - Request: .in +indent + - Request: .in -indent + - Register: \n[.i] + Set indentation to INDENT (or increment or decrement the current + value by INDENT). This request causes a break. Initially, there + is no indentation. + + If `in' is called without an argument, the indentation is reset to + the previous value before the last call to `in'. The default + scaling indicator is `m'. + + The indentation is associated with the current environment (*note + Environments::). + + If a negative indentation value is specified (which is not + allowed), `gtroff' emits a warning of type `range' and sets the + indentation to zero. + + The effect of `in' is delayed until a partially collected line (if + it exists) is output. A temporary indent value is reset to zero + also. + + The current indentation (as set by `in') can be found in the + read-only number register `.i'. + + - Request: .ti offset + - Request: .ti +offset + - Request: .ti -offset + - Register: \n[.in] + Temporarily indent the next output line by OFFSET. If an + increment or decrement value is specified, adjust the temporary + indentation relative to the value set by the `in' request. + + This request causes a break; its value is associated with the + current environment (*note Environments::). The default scaling + indicator is `m'. A call of `ti' without an argument is ignored. + + If the total indentation value is negative (which is not allowed), + `gtroff' emits a warning of type `range' and sets the temporary + indentation to zero. `Total indentation' is either OFFSET if + specified as an absolute value, or the temporary plus normal + indentation, if OFFSET is given as a relative value. + + The effect of `ti' is delayed until a partially collected line (if + it exists) is output. + + The read-only number register `.in' is the indentation that applies + to the current output line. + + The difference between `.i' and `.in' is that the latter takes + into account whether a partially collected line still uses the old + indentation value or a temporary indentation value is active. + + - Request: .ll [length] + - Request: .ll +length + - Request: .ll -length + - Register: \n[.l] + - Register: \n[.ll] + Set the line length to LENGTH (or increment or decrement the + current value by LENGTH). Initially, the line length is set to + 6.5i. The effect of `ll' is delayed until a partially collected + line (if it exists) is output. The default scaling indicator is + `m'. + + If `ll' is called without an argument, the line length is reset to + the previous value before the last call to `ll'. If a negative + line length is specified (which is not allowed), `gtroff' emits a + warning of type `range' and sets the line length to zero. + + The line length is associated with the current environment (*note + Environments::). + + The current line length (as set by `ll') can be found in the + read-only number register `.l'. The read-only number register + `.ll' is the line length that applies to the current output line. + + Similar to `.i' and `.in', the difference between `.l' and `.ll' + is that the latter takes into account whether a partially + collected line still uses the old line length value. + + +File: groff, Node: Line Control, Next: Page Layout, Prev: Line Layout, Up: gtroff Reference + +Line Control +============ + + It is important to understand how `gtroff' handles input and output +lines. + + Many escapes use positioning relative to the input line. For +example, this + + + This is a \h'|1.2i'test. + + This is a + \h'|1.2i'test. + +produces + + + This is a test. + + This is a test. + + The main usage of this feature is to define macros which act exactly +at the place where called. + + + .\" A simple macro to underline a word + .de underline + . nop \\$1\l'|0\[ul]' + .. + +In the above example, `|0' specifies a negative distance from the +current position (at the end of the just emitted argument `\$1') back +to the beginning of the input line. Thus, the `\l' escape draws a line +from right to left. + + `gtroff' makes a difference between input and output line +continuation; the latter is also called "interrupting" a line. + + - Escape: \<RET> + - Escape: \c + - Register: \n[.int] + Continue a line. `\<RET>' (this is a backslash at the end of a + line immediately followed by a newline) works on the input level, + suppressing the effects of the following newline in the input. + + + This is a \ + .test + => This is a .test + + The `|' operator is also affected. + + `\c' works on the output level. Anything after this escape on the + same line is ignored, except `\R' which works as usual. Anything + before `\c' on the same line will be appended to the current + partial output line. The next non-command line after an + interrupted line counts as a new input line. + + The visual results depend on whether no-fill mode is active. + + * If no-fill mode is active (using the `nf' request), the next + input text line after `\c' will be handled as a continuation + of the same input text line. + + + .nf + This is a \c + test. + => This is a test. + + * If fill mode is active (using the `fi' request), a word + interrupted with `\c' will be continued with the text on the + next input text line, without an intervening space. + + + This is a te\c + st. + => This is a test. + + + Note that an intervening control line which causes a break is + stronger than `\c', flushing out the current partial line in the + usual way. + + The `.int' register contains a positive value if the last output + line was interrupted with `\c'; this is associated with the + current environment (*note Environments::). + + + +File: groff, Node: Page Layout, Next: Page Control, Prev: Line Control, Up: gtroff Reference + +Page Layout +=========== + + `gtroff' provides some very primitive operations for controlling +page layout. + + - Request: .pl [length] + - Request: .pl +length + - Request: .pl -length + - Register: \n[.p] + Set the "page length" to LENGTH (or increment or decrement the + current value by LENGTH). This is the length of the physical + output page. The default scaling indicator is `v'. + + The current setting can be found in the read-only number register + `.p'. + + Note that this only specifies the size of the page, not the top and + bottom margins. Those are not set by `gtroff' directly. *Note + Traps::, for further information on how to do this. + + Negative `pl' values are possible also, but not very useful: No + trap is sprung, and each line is output on a single page (thus + suppressing all vertical spacing). + + If no argument or an invalid argument is given, `pl' sets the page + length to 11i. + + `gtroff' provides several operations which help in setting up top +and bottom titles (or headers and footers). + + - Request: .tl 'left'center'right' + Print a "title line". It consists of three parts: a left + justified portion, a centered portion, and a right justified + portion. The argument separator `'' can be replaced with any + character not occurring in the title line. The `%' character is + replaced with the current page number. This character can be + changed with the `pc' request (see below). + + Without argument, `tl' is ignored. + + Some notes: + + * A title line is not restricted to the top or bottom of a page. + + * `tl' prints the title line immediately, ignoring a partially + filled line (which stays untouched). + + * It is not an error to omit closing delimiters. For example, + `.tl /foo' is equivalent to `.tl /foo///': It prints a title + line with the left justified word `foo'; the centered and + right justfied parts are empty. + + * `tl' accepts the same parameter delimiting characters as the + `\A' escape; see *Note Escapes::. + + - Request: .lt [length] + - Request: .lt +length + - Request: .lt -length + - Register: \n[.lt] + The title line is printed using its own line length, which is + specified (or incremented or decremented) with the `lt' request. + Initially, the title line length is set to 6.5i. If a negative + line length is specified (which is not allowed), `gtroff' emits a + warning of type `range' and sets the title line length to zero. + The default scaling indicator is `m'. If `lt' is called without + an argument, the title length is reset to the previous value + before the last call to `lt'. + + The current setting of this is available in the `.lt' read-only + number register; it is associated with the current environment + (*note Environments::). + + + - Request: .pn page + - Request: .pn +page + - Request: .pn -page + - Register: \n[.pn] + Change (increase or decrease) the page number of the _next_ page. + The only argument is the page number; the request is ignored + without a parameter. + + The read-only number register `.pn' contains the number of the next + page: either the value set by a `pn' request, or the number of the + current page plus 1. + + - Register: \n[%] + A read-write register holding the current page number. + + - Request: .pc [char] + Change the page number character (used by the `tl' request) to a + different character. With no argument, this mechanism is disabled. + Note that this doesn't affect the number register `%'. + + *Note Traps::. + diff --git a/contrib/groff/doc/groff-5 b/contrib/groff/doc/groff-5 new file mode 100644 index 0000000..3a93483 --- /dev/null +++ b/contrib/groff/doc/groff-5 @@ -0,0 +1,1185 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: Page Control, Next: Fonts, Prev: Page Layout, Up: gtroff Reference + +Page Control +============ + + - Request: .bp [page] + - Request: .bp +page + - Request: .bp -page + Stop processing the current page and move to the next page. This + request causes a break. It can also take an argument to set + (increase, decrease) the page number of the next page. The only + difference between `bp' and `pn' is that `pn' does not cause a + break or actually eject a page. + + + .de newpage \" define macro + 'bp \" begin page + 'sp .5i \" vertical space + .tl 'left top'center top'right top' \" title + 'sp .3i \" vertical space + .. \" end macro + + `bp' has no effect if not called within the top-level diversion + (*note Diversions::). + + - Request: .ne [space] + It is often necessary to force a certain amount of space before a + new page occurs. This is most useful to make sure that there is + not a single "orphan" line left at the bottom of a page. The `ne' + request ensures that there is a certain distance, specified by the + first argument, before the next page is triggered (see *Note + Traps::, for further information). The default scaling indicator + for `ne' is `v'; the default value of SPACE is 1v if no argument + is given. + + For example, to make sure that no fewer than 2 lines get orphaned, + do the following before each paragraph: + + + .ne 2 + text text text + + `ne' will then automatically cause a page break if there is space + for one line only. + + - Request: .sv [space] + - Request: .os + `sv' is similar to the `ne' request; it reserves the specified + amount of vertical space. If the desired amount of space exists + before the next trap (or the bottom page boundary if no trap is + set), the space is output immediately (ignoring a partially filled + line which stays untouched). If there is not enough space, it is + stored for later output via the `os' request. The default value + is 1v if no argument is given; the default scaling indicator is + `v'. + + Both `sv' and `os' ignore no-space mode. While the `sv' request + allows negative values for SPACE, `os' will ignore them. + + - Register: \n[nl] + This register contains the current vertical position. If the + vertical position is zero and the top of page transition hasn't + happened yet, `nl' is set to negative value. `gtroff' itself does + this at the very beginning of a document before anything has been + printed, but the main usage is to plant a header trap on a page if + this page has already started. + + Consider the following: + + + .de xxx + . sp + . tl ''Header'' + . sp + .. + . + First page. + .bp + .wh 0 xxx + .nr nl (-1) + Second page. + + Result: + + + First page. + + ... + + Header + + Second page. + + ... + + Without resetting `nl' to a negative value, the just planted trap + would be active beginning with the _next_ page, not the current + one. + + *Note Diversions::, for a comparison with the `.h' and `.d' + registers. + + +File: groff, Node: Fonts, Next: Sizes, Prev: Page Control, Up: gtroff Reference + +Fonts +===== + + `gtroff' can switch fonts at any point in the text. + + The basic set of fonts is `R', `I', `B', and `BI'. These are Times +Roman, Italic, Bold, and Bold Italic. For non-TTY devices, there is +also at least one symbol font which contains various special symbols +(Greek, mathematics). + +* Menu: + +* Changing Fonts:: +* Font Families:: +* Font Positions:: +* Using Symbols:: +* Special Fonts:: +* Artificial Fonts:: +* Ligatures and Kerning:: + + +File: groff, Node: Changing Fonts, Next: Font Families, Prev: Fonts, Up: Fonts + +Changing Fonts +-------------- + + - Request: .ft [font] + - Escape: \fF + - Escape: \f(FN + - Escape: \f[FONT] + The `ft' request and the `\f' escape change the current font to + FONT (one-character name F, two-character name FN). + + If FONT is a style name (as set with the `sty' request or with the + `styles' command in the `DESC' file), use it within the current + font family (as set with the `fam' request, `\F' escape, or with + the `family' command in the `DESC' file). + + With no argument or using `P' as an argument, `.ft' switches to + the previous font. Use `\f[]' to do this with the escape. The + old syntax forms `\fP' or `\f[P]' are also supported. + + Fonts are generally specified as upper-case strings, which are + usually 1 to 4 characters representing an abbreviation or acronym + of the font name. This is no limitation, just a convention. + + The example below produces two identical lines. + + + eggs, bacon, + .ft B + spam + .ft + and sausage. + + eggs, bacon, \fBspam\fP and sausage. + + Note that `\f' doesn't produce an input token in `gtroff'. As a + consequence, it can be used in requests like `mc' (which expects a + single character as an argument) to change the font on the fly: + + + .mc \f[I]x\f[] + + *Note Font Positions::, for an alternative syntax. + + - Request: .ftr f [g] + Translate font F to font G. Whenever a font named F is referred + to in a `\f' escape sequence, or in the `ft', `ul', `bd', `cs', + `tkf', `special', `fspecial', `fp', or `sty' requests, font G is + used. If G is missing or equal to F the translation is undone. + + +File: groff, Node: Font Families, Next: Font Positions, Prev: Changing Fonts, Up: Fonts + +Font Families +------------- + + Due to the variety of fonts available, `gtroff' has added the +concept of "font families" and "font styles". The fonts are specified +as the concatenation of the font family and style. Specifying a font +without the family part causes `gtroff' to use that style of the +current family. + + Currently, fonts for the devices `-Tps', `-Tdvi', and `-Tlbp' are +set up to this mechanism. By default, `gtroff' uses the Times family +with the four styles `R', `I', `B', and `BI'. + + This way, it is possible to use the basic four fonts and to select a +different font family on the command line (*note Groff Options::). + + - Request: .fam [family] + - Register: \n[.fam] + - Escape: \FF + - Escape: \F(FM + - Escape: \F[FAMILY] + - Register: \n[.fn] + Switch font family to FAMILY (one-character name F, two-character + name FM). If no argument is given, switch back to the previous + font family. Use `\F[]' to do this with the escape. Note that + `\FP' doesn't work; it selects font family `P' instead. + + The value at start-up is `T'. The current font family is + available in the read-only number register `.fam' (this is a + string-valued register); it is associated with the current + environment. + + + spam, + .fam H \" helvetica family + spam, \" used font is family H + style R = HR + .ft B \" family H + style B = font HB + spam, + .fam T \" times family + spam, \" used font is family T + style B = TB + .ft AR \" font AR (not a style) + baked beans, + .ft R \" family T + style R = font TR + and spam. + + Note that `\F' doesn't produce an input token in `gtroff'. As a + consequence, it can be used in requests like `mc' (which expects a + single character as an argument) to change the font family on the + fly: + + + .mc \F[P]x\F[] + + The `.fn' register contains the current "real font name" of the + current font. This is a string-valued register. If the current + font is a style, the value of `\n[.fn]' is the proper + concatenation of family and style name. + + - Request: .sty n style + Associate STYLE with font position N. A font position can be + associated either with a font or with a style. The current font + is the index of a font position and so is also either a font or a + style. If it is a style, the font that is actually used is the + font which name is the concatenation of the name of the current + family and the name of the current style. For example, if the + current font is 1 and font position 1 is associated with style `R' + and the current font family is `T', then font `TR' will be used. + If the current font is not a style, then the current family is + ignored. If the requests `cs', `bd', `tkf', `uf', or `fspecial' + are applied to a style, they will instead be applied to the member + of the current family corresponding to that style. + + N must be a non-negative integer value. + + The default family can be set with the `-f' option (*note Groff + Options::). The `styles' command in the `DESC' file controls + which font positions (if any) are initially associated with styles + rather than fonts. For example, the default setting for + POSTSCRIPT fonts + + + styles R I B BI + + is equivalent to + + + .sty 1 R + .sty 2 I + .sty 3 B + .sty 4 BI + + `fam' and `\F' always check whether the current font position is + valid; this can give surprising results if the current font + position is associated with a style. + + In the following example, we want to access the POSTSCRIPT font + `FooBar' from the font family `Foo': + + + .sty \n[.fp] Bar + .fam Foo + => warning: can't find font `FooR' + + The default font position at start-up is 1; for the POSTSCRIPT + device, this is associated with style `R', so `gtroff' tries to + open `FooR'. + + A solution to this problem is to use a dummy font like the + following: + + + .fp 0 dummy TR \" set up dummy font at position 0 + .sty \n[.fp] Bar \" register style `Bar' + .ft 0 \" switch to font at position 0 + .fam Foo \" activate family `Foo' + .ft Bar \" switch to font `FooBar' + + *Note Font Positions::. + + +File: groff, Node: Font Positions, Next: Using Symbols, Prev: Font Families, Up: Fonts + +Font Positions +-------------- + + For the sake of old phototypesetters and compatibility with old +versions of `troff', `gtroff' has the concept of font "positions", on +which various fonts are mounted. + + - Request: .fp pos font [external-name] + - Register: \n[.f] + - Register: \n[.fp] + Mount font FONT at position POS (which must be a non-negative + integer). This numeric position can then be referred to with font + changing commands. When `gtroff' starts it is using font + position 1 (which must exist; position 0 is unused usually at + start-up). + + The current font in use, as a font position, is available in the + read-only number register `.f'. This can be useful to remember the + current font for later recall. It is associated with the current + environment (*note Environments::). + + + .nr save-font \n[.f] + .ft B + ... text text text ... + .ft \n[save-font] + + The number of the next free font position is available in the + read-only number register `.fp'. This is useful when mounting a + new font, like so: + + + .fp \n[.fp] NEATOFONT + + Fonts not listed in the `DESC' file are automatically mounted on + the next available font position when they are referenced. If a + font is to be mounted explicitly with the `fp' request on an unused + font position, it should be mounted on the first unused font + position, which can be found in the `.fp' register. Although + `gtroff' does not enforce this strictly, it is not allowed to + mount a font at a position whose number is much greater (approx. + 1000 positions) than that of any currently used position. + + The `fp' request has an optional third argument. This argument + gives the external name of the font, which is used for finding the + font description file. The second argument gives the internal + name of the font which is used to refer to the font in `gtroff' + after it has been mounted. If there is no third argument then the + internal name is used as the external name. This feature makes it + possible to use fonts with long names in compatibility mode. + + Both the `ft' request and the `\f' escape have alternative syntax +forms to access font positions. + + - Request: .ft nnn + - Escape: \fN + - Escape: \f(NN + - Escape: \f[NNN] + Change the current font position to NNN (one-digit position N, + two-digit position NN), which must be a non-negative integer. + + If NNN is associated with a style (as set with the `sty' request + or with the `styles' command in the `DESC' file), use it within + the current font family (as set with the `fam' request, the `\F' + escape, or with the `family' command in the `DESC' file). + + + this is font 1 + .ft 2 + this is font 2 + .ft \" switch back to font 1 + .ft 3 + this is font 3 + .ft + this is font 1 again + + *Note Changing Fonts::, for the standard syntax form. + + +File: groff, Node: Using Symbols, Next: Special Fonts, Prev: Font Positions, Up: Fonts + +Using Symbols +------------- + + A "glyph" is a graphical representation of a "character". While a +character is an abstract entity containing semantic information, a +glyph is something which can be actually seen on screen or paper. It +is possible that a character has multiple glyph representation forms +(for example, the character `A' can be either written in a roman or an +italic font, yielding two different glyphs); sometimes more than one +character maps to a single glyph (this is a "ligature" - the most +common is `fi'). + + A "symbol" is simply a named glyph. Within `gtroff', all glyph +names of a particular font are defined in its font file. If the user +requests a glyph not available in this font, `gtroff' looks up an +ordered list of "special fonts". By default, the POSTSCRIPT output +device supports the two special fonts `SS' (slanted symbols) and `S' +(symbols) (the former is looked up before the latter). Other output +devices use different names for special fonts. Fonts mounted with the +`fonts' keyword in the `DESC' file are globally available. To install +additional special fonts locally (i.e. for a particular font), use the +`fspecial' request. + + In summary, `gtroff' tries the following to find a given symbol: + + * If the symbol has been defined with the `char' request, use it. + This hides a symbol with the same name in the current font. + + * Check the current font. + + * If the symbol has been defined with the `fchar' request, use it. + + * Check all fonts given with the `fspecial' request, in the order of + appearance in `fspecial' calls. + + * Check all fonts given with the `special' request, in the order of + appearance in `special' calls (inclusively the special fonts + defined in the `DESC' file, which come first). + + * As a last resort, consult all fonts loaded up to now (in the order + they have been called the first time) for special fonts and check + them. + + *Note Font Files::, and *Note Special Fonts::, for more details. + + - Escape: \(NM + - Escape: \[NAME] + Insert a symbol NAME (two-character name NM). There is no special + syntax for one-character names - the natural form `\N' would + collide with escapes.(1) (*note Using Symbols-Footnote-1::) + + If NAME is undefined, a warning of type `char' is generated, and + the escape is ignored. *Note Debugging::, for information about + warnings. + + The list of available symbols is device dependent; see the + `groff_char(7)' man page for a complete list for the given output + device. For example, say + + + man -Tdvi groff_char > groff_char.dvi + + for a list using the default DVI fonts (not all versions of the + `man' program support the `-T' option). If you want to use an + additional macro package to change the used fonts, `groff' must be + called directly: + + + groff -Tdvi -mec -man groff_char.7 > groff_char.dvi + + + - Escape: \C'XXX' + Typeset the glyph named XXX.(2) (*note Using Symbols-Footnote-2::) + Normally it is more convenient to use `\[XXX]', but `\C' has the + advantage that it is compatible with newer versions of AT&T + `troff' and is available in compatibility mode. + + - Escape: \N'N' + Typeset the glyph with code N in the current font (`n' is *not* + the input character code). The number N can be any non-negative + decimal integer. Most devices only have glyphs with codes between + 0 and 255; the Unicode output device uses codes in the range + 0-65535. If the current font does not contain a glyph with that + code, special fonts are _not_ searched. The `\N' escape sequence + can be conveniently used in conjunction with the `char' request: + + + .char \[phone] \f[ZD]\N'37' + + The code of each glyph is given in the fourth column in the font + description file after the `charset' command. It is possible to + include unnamed glyphs in the font description file by using a + name of `---'; the `\N' escape sequence is the only way to use + these. + + Some escape sequences directly map onto special glyphs. + + - Escape: \' + This is a backslash followed by the apostrophe character, ASCII + character `0x27' (EBCDIC character `0x7D'). The same as `\[aa]', + the acute accent. + + - Escape: \` + This is a backslash followed by ASCII character `0x60' (EBCDIC + character `0x79' usually). The same as `\[ga]', the grave accent. + + - Escape: \- + This is the same as `\[-]', the minus sign in the current font. + + - Request: .cflags n c1 c2 ... + Input characters and symbols have certain properties associated + with it.(3) (*note Using Symbols-Footnote-3::) These properties + can be modified with the `cflags' request. The first argument is + the sum of the desired flags and the remaining arguments are the + characters or symbols to have those properties. It is possible to + omit the spaces between the characters or symbols. + + `1' + The character ends sentences (initially characters `.?!' have + this property). + + `2' + Lines can be broken before the character (initially no + characters have this property). + + `4' + Lines can be broken after the character (initially the + character `-' and the symbols `\(hy' and `\(em' have this + property). + + `8' + The character overlaps horizontally (initially the symbols + `\(ul\(rn\(ru' have this property). + + `16' + The character overlaps vertically (initially symbol `\(br' has + this property). + + `32' + An end-of-sentence character followed by any number of + characters with this property is treated as the end of a + sentence if followed by a newline or two spaces; in other + words the character is "transparent" for the purposes of + end-of-sentence recognition - this is the same as having a + zero space factor in TeX (initially characters `"')]*' and + the symbols `\(dg\(rq' have this property). + + - Request: .char g [string] + - Request: .fchar g [string] + Define a new glyph G to be STRING (which can be empty).(4) (*note + Using Symbols-Footnote-4::) Every time glyph G needs to be + printed, STRING is processed in a temporary environment and the + result is wrapped up into a single object. Compatibility mode is + turned off and the escape character is set to `\' while STRING is + being processed. Any emboldening, constant spacing or track + kerning is applied to this object rather than to individual + characters in STRING. + + A glyph defined by this request can be used just like a normal + glyph provided by the output device. In particular, other + characters can be translated to it with the `tr' or `trin' + requests; it can be made the leader character by the `lc' request; + repeated patterns can be drawn with the glyph using the `\l' and + `\L' escape sequences; words containing the glyph can be + hyphenated correctly if the `hcode' request is used to give the + glyph's symbol a hyphenation code. + + There is a special anti-recursion feature: Use of `g' within the + glyph's definition is handled like normal characters and symbols + not defined with `char'. + + Note that the `tr' and `trin' requests take precedence if `char' + accesses the same symbol. + + + .tr XY + X + => Y + .char X Z + X + => Y + .tr XX + X + => Z + + The `fchar' request defines a fallback glyph: `gtroff' only checks + for glyphs defined with `fchar' if it cannot find the glyph in the + current font. `gtroff' carries out this test before checking + special fonts. + + - Request: .rchar c1 c2 ... + Remove the definitions of glyphs C1, C2, .... This undoes the + effect of a `char' or `fchar' request. + + It is possible to omit the whitespace between arguments. + + *Note Special Characters::. + + +File: groff, Node: Using Symbols-Footnotes, Up: Using Symbols + + (1) Note that a one-character symbol is not the same as an input +character, i.e., the character `a' is not the same as `\[a]'. By +default, `groff' defines only a single one-character symbol, `\[-]'; it +is usually accessed as `\-'. On the other hand, `gtroff' has the +special feature that `\[charXXX]' is the same as the input character +with character code XXX. For example, `\[char97]' is identical to the +letter `a' if ASCII encoding is active. + + (2) `\C' is actually a misnomer since it accesses an output glyph. + + (3) Note that the output glyphs themselves don't have such +properties. For `gtroff', a glyph is a numbered box with a given +width, depth, and height, nothing else. All manipulations with the +`cflags' request work on the input level. + + (4) `char' is a misnomer since an output glyph is defined. + + +File: groff, Node: Special Fonts, Next: Artificial Fonts, Prev: Using Symbols, Up: Fonts + +Special Fonts +------------- + + Special fonts are those that `gtroff' searches when it cannot find +the requested glyph in the current font. The Symbol font is usually a +special font. + + `gtroff' provides the following two requests to add more special +fonts. *Note Using Symbols::, for a detailed description of the glyph +searching mechanism in `gtroff'. + + Usually, only non-TTY devices have special fonts. + + - Request: .special s1 s2 ... + - Request: .fspecial f s1 s2 ... + Use the `special' request to define special fonts. They are + appended to the list of global special fonts in the given order. + The first entries in this list are the fonts defined with the + `fonts' command in the `DESC' file which are marked as special in + the corresponding font description files. + + Use the `fspecial' request to designate special fonts only when + font F font is active. They are appended to the list of special + fonts for F in the given order. Initially, this list is empty. + + +File: groff, Node: Artificial Fonts, Next: Ligatures and Kerning, Prev: Special Fonts, Up: Fonts + +Artificial Fonts +---------------- + + There are a number of requests and escapes for artificially creating +fonts. These are largely vestiges of the days when output devices did +not have a wide variety of fonts, and when `nroff' and `troff' were +separate programs. Most of them are no longer necessary in GNU +`troff'. Nevertheless, they are supported. + + - Escape: \H'HEIGHT' + - Escape: \H'+HEIGHT' + - Escape: \H'-HEIGHT' + Change (increment, decrement) the height of the current font, but + not the width. If HEIGHT is zero, restore the original height. + Default scaling indicator is `z'. + + Currently, only the `-Tps' device supports this feature. + + Note that `\H' doesn't produce an input token in `gtroff'. As a + consequence, it can be used in requests like `mc' (which expects a + single character as an argument) to change the font on the fly: + + + .mc \H'+5z'x\H'0' + + In compatibility mode, `gtroff' behaves differently: If an + increment or decrement is used, it is always taken relative to the + current point size and not relative to the previously selected font + height. Thus, + + + .cp 1 + \H'+5'test \H'+5'test + + prints the word `test' twice with the same font height (five + points larger than the current font size). + + - Escape: \S'SLANT' + Slant the current font by SLANT degrees. Positive values slant to + the right. + + Currently, only the `-Tps' device supports this feature. + + Note that `\S' doesn't produce an input token in `gtroff'. As a + consequence, it can be used in requests like `mc' (which expects a + single character as an argument) to change the font on the fly: + + + .mc \S'20'x\S'0' + + This request is incorrectly documented in the original UNIX troff + manual; the slant is always set to an absolute value. + + - Request: .ul [lines] + The `ul' request normally underlines subsequent lines if a TTY + output device is used. Otherwise, the lines are printed in italics + (only the term `underlined' is used in the following). The single + argument is the number of input lines to be underlined; with no + argument, the next line is underlined. If LINES is zero or + negative, stop the effects of `ul' (if it was active). Requests + and empty lines do not count for computing the number of underlined + input lines, even if they produce some output like `tl'. Lines + inserted by macros (e.g. invoked by a trap) do count. + + At the beginning of `ul', the current font is stored and the + underline font is activated. Within the span of a `ul' request, + it is possible to change fonts, but after the last line affected by + `ul' the saved font is restored. + + This number of lines still to be underlined is associated with the + current environment (*note Environments::). The underline font + can be changed with the `uf' request. + + The `ul' request does not underline spaces. + + - Request: .cu [lines] + The `cu' request is similar to `ul' but underlines spaces as well + (if a TTY output device is used). + + - Request: .uf font + Set the underline font (globally) used by `ul' and `cu'. By + default, this is the font at position 2. FONT can be either a + non-negative font position or the name of a font. + + - Request: .bd font [offset] + - Request: .bd font1 font2 [offset] + - Register: \n[.b] + Artificially create a bold font by printing each glyph twice, + slightly offset. + + Two syntax forms are available. + + * Imitate a bold font unconditionally. The first argument + specifies the font to embolden, and the second is the number + of basic units, minus one, by which the two glyphs are + offset. If the second argument is missing, emboldening is + turned off. + + FONT can be either a non-negative font position or the name + of a font. + + OFFSET is available in the `.b' read-only register if a + special font is active; in the `bd' request, its default unit + is `u'. + + * Imitate a bold form conditionally. Embolden FONT1 by OFFSET + only if font FONT2 is the current font. This command can be + issued repeatedly to set up different emboldening values for + different current fonts. If the second argument is missing, + emboldening is turned off for this particular current font. + + This affects special fonts only (either set up with the + `special' command in font files or with the `fspecial' + request). + + - Request: .cs font [width [em-size]] + Switch to and from "constant glyph space mode". If activated, the + width of every glyph is WIDTH/36 ems. The em size is given + absolutely by EM-SIZE; if this argument is missing, the em value + is taken from the current font size (as set with the `ps' request) + when the font is effectively in use. Without second and third + argument, constant glyph space mode is deactivated. + + Default scaling indicator for EM-SIZE is `z'; WIDTH is an integer. + + +File: groff, Node: Ligatures and Kerning, Prev: Artificial Fonts, Up: Fonts + +Ligatures and Kerning +--------------------- + + Ligatures are groups of characters that are run together, i.e, +producing a single glyph. For example, the letters `f' and `i' can +form a ligature `fi' as in the word `file'. This produces a cleaner +look (albeit subtle) to the printed output. Usually, ligatures are not +available in fonts for TTY output devices. + + Most POSTSCRIPT fonts support the fi and fl ligatures. The C/A/T +typesetter that was the target of AT&T `troff' also supported `ff', +`ffi', and `ffl' ligatures. Advanced typesetters or `expert' fonts may +include ligatures for `ft' and `ct', although GNU `troff' does not +support these (yet). + + - Request: .lg [flag] + - Register: \n[.lg] + Switch the ligature mechanism on or off; if the parameter is + non-zero or missing, ligatures are enabled, otherwise disabled. + Default is on. The current ligature mode can be found in the + read-only number register `.lg' (set to 1 or 2 if ligatures are + enabled, 0 otherwise). + + Setting the ligature mode to 2 enables the two-character ligatures + (fi, fl, and ff) and disables the three-character ligatures (ffi + and ffl). + + "Pairwise kerning" is another subtle typesetting mechanism that +modifies the distance between a glyph pair to improve readability. In +most cases (but not always) the distance is decreased. Typewriter-like +fonts and fonts for terminals where all glyphs have the same width +don't use kerning. + + - Request: .kern [flag] + - Register: \n[.kern] + Switch kerning on or off. If the parameter is non-zero or missing, + enable pairwise kerning, otherwise disable it. The read-only + number register `.kern' is set to 1 if pairwise kerning is enabled, + 0 otherwise. + + If the font description file contains pairwise kerning information, + glyphs from that font are kerned. Kerning between two glyphs can + be inhibited by placing `\&' between them: `V\&A'. + + *Note Font File Format::. + + "Track kerning" expands or reduces the space between glyphs. This +can be handy, for example, if you need to squeeze a long word onto a +single line or spread some text to fill a narrow column. It must be +used with great care since it is usually considered bad typography if +the reader notices the effect. + + - Request: .tkf f s1 n1 s2 n2 + Enable track kerning for font F. If the current font is F the + width of every glyph is increased by an amount between N1 and N2 + (N1, N2 can be negative); if the current point size is less than + or equal to S1 the width is increased by N1; if it is greater than + or equal to S2 the width is increased by N2; if the point size is + greater than or equal to S1 and less than or equal to S2 the + increase in width is a linear function of the point size. + + The default scaling indicator is `z' for S1 and S2, `p' for N1 and + N2. + + Note that the track kerning amount is added even to the rightmost + glyph in a line; for large values it is thus recommended to + increase the line length by the same amount to compensate it. + + Sometimes, when typesetting letters of different fonts, more or less +space at such boundaries are needed. There are two escapes to help +with this. + + - Escape: \/ + Increase the width of the preceding glyph so that the spacing + between that glyph and the following glyph is correct if the + following glyph is a roman glyph. For example, if an italic `f' + is immediately followed by a roman right parenthesis, then in many + fonts the top right portion of the `f' overlaps the top left of + the right parenthesis. Use this escape sequence whenever an + italic glyph is immediately followed by a roman glyph without any + intervening space. This small amount of space is also called + "italic correction". + + + - Escape: \, + Modify the spacing of the following glyph so that the spacing + between that glyph and the preceding glyph is correct if the + preceding glyph is a roman glyph. Use this escape sequence + whenever a roman glyph is immediately followed by an italic glyph + without any intervening space. In analogy to above, this space + could be called "left italic correction", but this term isn't used + widely. + + + - Escape: \& + Insert a zero-width character, which is invisible. Its intended + use is to stop interaction of a character with its surrounding. + + * It prevents the insertion of extra space after an + end-of-sentence character. + + + Test. + Test. + => Test. Test. + Test.\& + Test. + => Test. Test. + + * It prevents interpretation of a control character at the + beginning of an input line. + + + .Test + => warning: `Test' not defined + \&.Test + => .Test + + * It prevents kerning between two glyphs. + + * It is needed to map an arbitrary character to nothing in the + `tr' request (*note Character Translations::). + + - Escape: \) + This escape is similar to `\&' except that it behaves like a + character declared with the `cflags' request to be transparent for + the purposes of an end-of-sentence character. + + Its main usage is in macro definitions to protect against arguments + starting with a control character. + + + .de xxx + \)\\$1 + .. + .de yyy + \&\\$1 + .. + This is a test.\c + .xxx ' + This is a test. + =>This is a test.' This is a test. + This is a test.\c + .yyy ' + This is a test. + =>This is a test.' This is a test. + + + +File: groff, Node: Sizes, Next: Strings, Prev: Fonts, Up: gtroff Reference + +Sizes +===== + + `gtroff' uses two dimensions with each line of text, type size and +vertical spacing. The "type size" is approximately the height of the +tallest glyph.(1) (*note Sizes-Footnote-1::) "Vertical spacing" is the +amount of space `gtroff' allows for a line of text; normally, this is +about 20% larger than the current type size. Ratios smaller than this +can result in hard-to-read text; larger than this, it spreads the text +out more vertically (useful for term papers). By default, `gtroff' +uses 10 point type on 12 point spacing. + + The difference between type size and vertical spacing is known, by +typesetters, as "leading" (this is pronounced `ledding'). + +* Menu: + +* Changing Type Sizes:: +* Fractional Type Sizes:: + + +File: groff, Node: Sizes-Footnotes, Up: Sizes + + (1) This is usually the parenthesis. Note that in most cases the +real dimensions of the glyphs in a font are _not_ related to its type +size! For example, the standard POSTSCRIPT font families `Times +Roman', `Helvetica', and `Courier' can't be used together at 10pt; to +get acceptable output, the size of `Helvetica' has to be reduced by one +point, and the size of `Courier' must be increased by one point. + + +File: groff, Node: Changing Type Sizes, Next: Fractional Type Sizes, Prev: Sizes, Up: Sizes + +Changing Type Sizes +------------------- + + - Request: .ps [size] + - Request: .ps +size + - Request: .ps -size + - Escape: \sSIZE + - Register: \n[.s] + Use the `ps' request or the `\s' escape to change (increase, + decrease) the type size (in points). Specify SIZE as either an + absolute point size, or as a relative change from the current size. + The size 0, or no argument, goes back to the previous size. + + Default scaling indicator of `size' is `z'. If `size' is zero or + negative, it is set to 1u. + + The read-only number register `.s' returns the point size in + points as a decimal fraction. This is a string. To get the point + size in scaled points, use the `.ps' register instead. + + `.s' is associated with the current environment (*note + Environments::). + + + snap, snap, + .ps +2 + grin, grin, + .ps +2 + wink, wink, \s+2nudge, nudge,\s+8 say no more! + .ps 10 + + The `\s' escape may be called in a variety of ways. Much like + other escapes there must be a way to determine where the argument + ends and the text begins. Any of the following forms are valid: + + `\sN' + Set the point size to N points. N must be either 0 or in the + range 4 to 39. + + `\s+N' + `\s-N' + Increase or decrease the point size by N points. N must be + exactly one digit. + + `\s(NN' + Set the point size to NN points. NN must be exactly two + digits. + + `\s+(NN' + `\s-(NN' + `\s(+NN' + `\s(-NN' + Increase or decrease the point size by NN points. NN must be + exactly two digits. + + Note that `\s' doesn't produce an input token in `gtroff'. As a + consequence, it can be used in requests like `mc' (which expects a + single character as an argument) to change the font on the fly: + + + .mc \s[20]x\s[0] + + *Note Fractional Type Sizes::, for yet another syntactical form of + using the `\s' escape. + + - Request: .sizes s1 s2 ... sn [0] + Some devices may only have certain permissible sizes, in which case + `gtroff' rounds to the nearest permissible size. The `DESC' file + specifies which sizes are permissible for the device. + + Use the `sizes' request to change the permissible sizes for the + current output device. Arguments are in scaled points; the + `sizescale' line in the `DESC' file for the output device provides + the scaling factor. For example, if the scaling factor is 1000, + then the value 12000 is 12 points. + + Each argument can be a single point size (such as `12000'), or a + range of sizes (such as `4000-72000'). You can optionally end the + list with a zero. + + - Request: .vs [space] + - Request: .vs +space + - Request: .vs -space + - Register: \n[.v] + Change (increase, decrease) the vertical spacing by SPACE. The + default scaling indicator is `p'. + + If `vs' is called without an argument, the vertical spacing is + reset to the previous value before the last call to `vs'. + + `gtroff' creates a warning of type `range' if SPACE is zero or + negative; the vertical spacing is then set to the vertical + resolution (as given in the `.V' register). + + The read-only number register `.v' contains the current vertical + spacing; it is associated with the current environment (*note + Environments::). + + The effective vertical line spacing consists of four components. + + * The vertical line spacing as set with the `vs' request. + + * The "post-vertical line spacing" as set with the `pvs' request. + This is vertical space which will be added after a line has been + output. + + * The "extra pre-vertical line space" as set with the `\x' request, + using a negative value. This is vertical space which will be + added once before the current line has been output. + + * The "extra post-vertical line space" as set with the `\x' request, + using a positive value. This is vertical space which will be + added once after the current line has been output. + + It is usually better to use `vs' or `pvs' instead of `ls' to produce +double-spaced documents: `vs' and `pvs' have a finer granularity for +the inserted vertical space compared to `ls'; furthermore, certain +preprocessors assume single-spacing. + + *Note Manipulating Spacing::, for more details on the `\x' escape +and the `ls' request. + + - Request: .pvs [space] + - Request: .pvs +space + - Request: .pvs -space + - Register: \n[.pvs] + Change (increase, decrease) the post-vertical spacing by SPACE. + The default scaling indicator is `p'. + + If `pvs' is called without an argument, the post-vertical spacing + is reset to the previous value before the last call to `pvs'. + + `gtroff' creates a warning of type `range' if SPACE is zero or + negative; the vertical spacing is then set to zero. + + The read-only number register `.pvs' contains the current + post-vertical spacing; it is associated with the current + environment (*note Environments::). + + +File: groff, Node: Fractional Type Sizes, Prev: Changing Type Sizes, Up: Sizes + +Fractional Type Sizes +--------------------- + + A "scaled point" is equal to 1/SIZESCALE points, where SIZESCALE is +specified in the `DESC' file (1 by default). There is a new scale +indicator `z' which has the effect of multiplying by SIZESCALE. +Requests and escape sequences in `gtroff' interpret arguments that +represent a point size as being in units of scaled points, but they +evaluate each such argument using a default scale indicator of `z'. +Arguments treated in this way are the argument to the `ps' request, the +third argument to the `cs' request, the second and fourth arguments to +the `tkf' request, the argument to the `\H' escape sequence, and those +variants of the `\s' escape sequence that take a numeric expression as +their argument (see below). + + For example, suppose SIZESCALE is 1000; then a scaled point is +equivalent to a millipoint; the request `.ps 10.25' is equivalent to +`.ps 10.25z' and thus sets the point size to 10250 scaled points, which +is equal to 10.25 points. + + `gtroff' disallows the use of the `z' scale indicator in instances +where it would make no sense, such as a numeric expression whose +default scale indicator was neither `u' nor `z'. Similarly it would +make no sense to use a scaling indicator other than `z' or `u' in a +numeric expression whose default scale indicator was `z', and so +`gtroff' disallows this as well. + + There is also new scale indicator `s' which multiplies by the number +of units in a scaled point. So, for example, `\n[.ps]s' is equal to +`1m'. Be sure not to confuse the `s' and `z' scale indicators. + + - Register: \n[.ps] + A read-only number register returning the point size in scaled + points. + + `.ps' is associated with the current environment (*note + Environments::). + + - Register: \n[.psr] + - Register: \n[.sr] + The last-requested point size in scaled points is contained in the + `.psr' read-only number register. The last requested point size + in points as a decimal fraction can be found in `.sr'. This is a + string-valued read-only number register. + + Note that the requested point sizes are device-independent, whereas + the values returned by the `.ps' and `.s' registers are not. For + example, if a point size of 11pt is requested, and a `sizes' + request (or a `sizescale' line in a `DESC' file) specifies 10.95pt + instead, this value is actually used. + + Both registers are associated with the current environment (*note + Environments::). + + The `\s' escape has the following syntax for working with fractional +type sizes: + +`\s[N]' +`\s'N'' + Set the point size to N scaled points; N is a numeric expression + with a default scale indicator of `z'. + +`\s[+N]' +`\s[-N]' +`\s+[N]' +`\s-[N]' +`\s'+N'' +`\s'-N'' +`\s+'N'' +`\s-'N'' + Increase or or decrease the point size by N scaled points; N is a + numeric expression with a default scale indicator of `z'. + + *Note Font Files::. + diff --git a/contrib/groff/doc/groff-6 b/contrib/groff/doc/groff-6 new file mode 100644 index 0000000..c7d9b81 --- /dev/null +++ b/contrib/groff/doc/groff-6 @@ -0,0 +1,1415 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: Strings, Next: Conditionals and Loops, Prev: Sizes, Up: gtroff Reference + +Strings +======= + + `gtroff' has string variables, which are entirely for user +convenience (i.e. there are no built-in strings exept `.T', but even +this is a read-write string variable). + + - Request: .ds name [string] + - Request: .ds1 name [string] + - Escape: \*N + - Escape: \*(NM + - Escape: \*[NAME ARG1 ARG2 ...] + Define and access a string variable NAME (one-character name N, + two-character name NM). If NAME already exists, `ds' overwrites + the previous definition. Only the syntax form using brackets can + take arguments which are handled identically to macro arguments; + the single exception is that a closing bracket as an argument must + be enclosed in double quotes. *Note Request Arguments::, and + *Note Parameters::. + + Example: + + + .ds foo a \\$1 test + . + This is \*[foo nice]. + => This is a nice test. + + The `\*' escape "interpolates" (expands in-place) a + previously-defined string variable. To be more precise, the stored + string is pushed onto the input stack which is then parsed by + `gtroff'. Similar to number registers, it is possible to nest + strings, i.e. string variables can be called within string + variables. + + If the string named by the `\*' escape does not exist, it is + defined as empty, and a warning of type `mac' is emitted (see + *Note Debugging::, for more details). + + *Caution:* Unlike other requests, the second argument to the `ds' + request takes up the entire line including trailing spaces. This + means that comments on a line with such a request can introduce + unwanted space into a string. + + + .ds UX \s-1UNIX\s0\u\s-3tm\s0\d \" UNIX trademark + + Instead the comment should be put on another line or have the + comment escape adjacent with the end of the string. + + + .ds UX \s-1UNIX\s0\u\s-3tm\s0\d\" UNIX trademark + + To produce leading space the string can be started with a double + quote. No trailing quote is needed; in fact, any trailing quote is + included in your string. + + + .ds sign " Yours in a white wine sauce, + + Strings are not limited to a single line of text. A string can + span several lines by escaping the newlines with a backslash. The + resulting string is stored _without_ the newlines. + + + .ds foo lots and lots \ + of text are on these \ + next several lines + + It is not possible to have real newlines in a string. To put a + single double quote character into a string, use two consecutive + double quote characters. + + The `ds1' request turns off compatibility mode while interpreting + a string. To be more precise, a "compatibility save" input token + is inserted at the beginning of the string, and a "compatibility + restore" input token at the end. + + + .nr xxx 12345 + .ds aa The value of xxx is \\n[xxx]. + .ds1 bb The value of xxx ix \\n[xxx]. + . + .cp 1 + . + \*(aa + => warning: number register `[' not defined + => The value of xxx is 0xxx]. + \*(bb + => The value of xxx ix 12345. + + Strings, macros, and diversions (and boxes) share the same name + space. Internally, even the same mechanism is used to store them. + This has some interesting consequences. For example, it is + possible to call a macro with string syntax and vice versa. + + + .de xxx + a funny test. + .. + This is \*[xxx] + => This is a funny test. + + .ds yyy a funny test + This is + .yyy + => This is a funny test. + + Diversions and boxes can be also called with string syntax. + + Another consequence is that you can copy one-line diversions or + boxes to a string. + + + .di xxx + a \fItest\fR + .br + .di + .ds yyy This is \*[xxx]\c + \*[yyy]. + => This is a test. + + As the previous example shows, it is possible to store formatted + output in strings. The `\c' escape prevents the insertion of an + additional blank line in the output. + + Copying diversions longer than a single output line produces + unexpected results. + + + .di xxx + a funny + .br + test + .br + .di + .ds yyy This is \*[xxx]\c + \*[yyy]. + => test This is a funny. + + Usually, it is not predictable whether a diversion contains one or + more output lines, so this mechanism should be avoided. With UNIX + `troff', this was the only solution to strip off a final newline + from a diversion. Another disadvantage is that the spaces in the + copied string are already formatted, making them unstretchable. + This can cause ugly results. + + A clean solution to this problem is available in GNU `troff', + using the requests `chop' to remove the final newline of a + diversion, and `unformat' to make the horizontal spaces + stretchable again. + + + .box xxx + a funny + .br + test + .br + .box + .chop xxx + .unformat xxx + This is \*[xxx]. + => This is a funny test. + + *Note Gtroff Internals::, for more information. + + - Request: .as name [string] + - Request: .as1 name [string] + The `as' request is similar to `ds' but appends STRING to the + string stored as NAME instead of redefining it. If NAME doesn't + exist yet, it is created. + + + .as sign " with shallots, onions and garlic, + + The `as1' request is similar to `as', but compatibility mode is + switched off while the appended string is interpreted. To be more + precise, a "compatibility save" input token is inserted at the + beginning of the appended string, and a "compatibility restore" + input token at the end. + + Rudimentary string manipulation routines are given with the next two +requests. + + - Request: .substring str n1 [n2] + Replace the string named STR with the substring defined by the + indices N1 and N2. The first character in the string has index 0. + If N2 is omitted, it is taken to be equal to the string's length. + If the index value N1 or N2 is negative, it is counted from the + end of the string, going backwards: The last character has + index -1, the character before the last character has index -2, + etc. + + + .ds xxx abcdefgh + .substring xxx 1 -4 + \*[xxx] + => bcde + + + - Request: .length reg str + Compute the number of characters of STR and return it in the + number register REG. If REG doesn't exist, it is created. `str' + is read in copy mode. + + + .ds xxx abcd\h'3i'efgh + .length yyy \n[xxx] + \n[yyy] + => 14 + + + - Request: .rn xx yy + Rename the request, macro, diversion, or string XX to YY. + + - Request: .rm xx + Remove the request, macro, diversion, or string XX. `gtroff' + treats subsequent invocations as if the object had never been + defined. + + - Request: .als new old + Create an alias named NEW for the request, string, macro, or + diversion object named OLD. The new name and the old name are + exactly equivalent (it is similar to a hard rather than a soft + link). If OLD is undefined, `gtroff' generates a warning of type + `mac' and ignores the request. + + - Request: .chop xx + Remove (chop) the last character from the macro, string, or + diversion named XX. This is useful for removing the newline from + the end of diversions that are to be interpolated as strings. + This command can be used repeatedly; see *Note Gtroff Internals::, + for details on nodes inserted additionally by `gtroff'. + + *Note Identifiers::, and *Note Comments::. + + +File: groff, Node: Conditionals and Loops, Next: Writing Macros, Prev: Strings, Up: gtroff Reference + +Conditionals and Loops +====================== + +* Menu: + +* Operators in Conditionals:: +* if-else:: +* while:: + + +File: groff, Node: Operators in Conditionals, Next: if-else, Prev: Conditionals and Loops, Up: Conditionals and Loops + +Operators in Conditionals +------------------------- + + In `if' and `while' requests, there are several more operators +available: + +`e' +`o' + True if the current page is even or odd numbered (respectively). + +`n' + True if the document is being processed in nroff mode (i.e., the + `.nroff' command has been issued). + +`t' + True if the document is being processed in troff mode (i.e., the + `.troff' command has been issued). + +`v' + Always false. This condition is for compatibility with other + `troff' versions only. + +`'XXX'YYY'' + True if the string XXX is equal to the string YYY. Other + characters can be used in place of the single quotes; the same set + of delimiters as for the `\D' escape is used (*note Escapes::). + `gtroff' formats the strings before being compared: + + + .ie "|"\fR|\fP" \ + true + .el \ + false + => true + + The resulting motions, glyph sizes, and fonts have to match,(1) + (*note Operators in Conditionals-Footnote-1::) and not the + individual motion, size, and font requests. In the previous + example, `|' and `\fR|\fP' both result in a roman `|' glyph with + the same point size and at the same location on the page, so the + strings are equal. If `.ft I' had been added before the `.ie', + the result would be "false" because (the first) `|' produces an + italic `|' rather than a roman one. + +`r XXX' + True if there is a number register named XXX. + +`d XXX' + True if there is a string, macro, diversion, or request named XXX. + +`m XXX' + True if there is a color named XXX. + +`c G' + True if there is a glyph G available(2) (*note Operators in + Conditionals-Footnote-2::); G is either an ASCII character or a + special character (`\(GG' or `\[GGG]'); the condition is also true + if G has been defined by the `char' request. + + Note that these operators can't be combined with other operators like +`:' or `&'; only a leading `!' (without whitespace between the +exclamation mark and the operator) can be used to negate the result. + + + .nr xxx 1 + .ie !r xxx \ + true + .el \ + false + => false + + A whitespace after `!' always evaluates to zero (this bizarre +behaviour is due to compatibility with UNIX `troff'). + + + .nr xxx 1 + .ie ! r xxx \ + true + .el \ + false + => r xxx true + + It is possible to omit the whitespace before the argument to the +`r', `d', and `c' operators. + + *Note Expressions::. + + +File: groff, Node: Operators in Conditionals-Footnotes, Up: Operators in Conditionals + + (1) The created output nodes must be identical. *Note Gtroff +Internals::. + + (2) The name of this conditional operator is a misnomer since it +tests names of output glyphs. + + +File: groff, Node: if-else, Next: while, Prev: Operators in Conditionals, Up: Conditionals and Loops + +if-else +------- + + `gtroff' has if-then-else constructs like other languages, although +the formatting can be painful. + + - Request: .if expr anything + Evaluate the expression EXPR, and executes ANYTHING (the remainder + of the line) if EXPR evaluates to non-zero (true). ANYTHING is + interpreted as though it was on a line by itself (except that + leading spaces are swallowed). *Note Expressions::, for more info. + + + .nr xxx 1 + .nr yyy 2 + .if ((\n[xxx] == 1) & (\n[yyy] == 2)) true + => true + + + - Request: .nop anything + Executes ANYTHING. This is similar to `.if 1'. + + - Request: .ie expr anything + - Request: .el anything + Use the `ie' and `el' requests to write an if-then-else. The + first request is the `if' part and the latter is the `else' part. + + + .ie n .ls 2 \" double-spacing in nroff + .el .ls 1 \" single-spacing in troff + + + - Escape: \{ + - Escape: \} + In many cases, an if (or if-else) construct needs to execute more + than one request. This can be done using the `\{' and `\}' + escapes. The following example shows the possible ways to use + these escapes (note the position of the opening and closing + braces). + + + .ie t \{\ + . ds lq `` + . ds rq '' + .\} + .el \ + .\{\ + . ds lq " + . ds rq "\} + + + *Note Expressions::. + + +File: groff, Node: while, Prev: if-else, Up: Conditionals and Loops + +while +----- + + `gtroff' provides a looping construct using the `while' request, +which is used much like the `if' (and related) requests. + + - Request: .while expr anything + Evaluate the expression EXPR, and repeatedly execute ANYTHING (the + remainder of the line) until EXPR evaluates to 0. + + + .nr a 0 1 + .while (\na < 9) \{\ + \n+a, + .\} + \n+a + => 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 + + Some remarks. + + * The body of a `while' request is treated like the body of a + `de' request: `gtroff' temporarily stores it in a macro which + is deleted after the loop has been exited. It can + considerably slow down a macro if the body of the `while' + request (within the macro) is large. Each time the macro is + executed, the `while' body is parsed and stored again as a + temporary macro. + + + .de xxx + . nr num 10 + . while (\\n[num] > 0) \{\ + . \" many lines of code + . nr num -1 + . \} + .. + + The traditional and ofter better solution (UNIX `troff' + doesn't have the `while' request) is to use a recursive macro + instead which is parsed only once during its definition. + + + .de yyy + . if (\\n[num] > 0) \{\ + . \" many lines of code + . nr num -1 + . yyy + . \} + .. + . + .de xxx + . nr num 10 + . yyy + .. + + Note that the number of available recursion levels is set + to 1000 (this is a compile-time constant value of `gtroff'). + + * The closing brace of a `while' body must end a line. + + + .if 1 \{\ + . nr a 0 1 + . while (\n[a] < 10) \{\ + . nop \n+[a] + .\}\} + => unbalanced \{ \} + + + - Request: .break + Break out of a `while' loop. Be sure not to confuse this with the + `br' request (causing a line break). + + - Request: .continue + Finish the current iteration of a `while' loop, immediately + restarting the next iteration. + + *Note Expressions::. + + +File: groff, Node: Writing Macros, Next: Page Motions, Prev: Conditionals and Loops, Up: gtroff Reference + +Writing Macros +============== + + A "macro" is a collection of text and embedded commands which can be +invoked multiple times. Use macros to define common operations. + + - Request: .de name [end] + - Request: .de1 name [end] + - Request: .dei name [end] + Define a new macro named NAME. `gtroff' copies subsequent lines + (starting with the next one) into an internal buffer until it + encounters the line `..' (two dots). The optional second argument + to `de' changes this to a macro to `.END'. + + There can be whitespace after the first dot in the line containing + the ending token (either `.' or macro `END'). + + Here a small example macro called `P' which causes a break and + inserts some vertical space. It could be used to separate + paragraphs. + + + .de P + . br + . sp .8v + .. + + The following example defines a macro within another. Remember + that expansion must be protected twice; once for reading the macro + and once for executing. + + + \# a dummy macro to avoid a warning + .de end + .. + . + .de foo + . de bar end + . nop \f[B]Hallo \\\\$1!\f[] + . end + .. + . + .foo + .bar Joe + => Hallo Joe! + + Since `\f' has no expansion, it isn't necessary to protect its + backslash. Had we defined another macro within `bar' which takes + a parameter, eight backslashes would be necessary before `$1'. + + The `de1' request turns off compatibility mode while executing the + macro. On entry, the current compatibility mode is saved and + restored at exit. + + + .nr xxx 12345 + . + .de aa + The value of xxx is \\n[xxx]. + .. + .de1 bb + The value of xxx ix \\n[xxx]. + .. + . + .cp 1 + . + .aa + => warning: number register ' not defined + => The value of xxx is 0xxx]. + .bb + => The value of xxx ix 12345. + + The `dei' request defines a macro indirectly. That is, it expands + strings whose names are NAME or END before performing the append. + + This: + + + .ds xx aa + .ds yy bb + .dei xx yy + + is equivalent to: + + + .de aa bb + + Using `trace.tmac', you can trace calls to `de' and `de1'. + + Note that macro identifiers are shared with identifiers for + strings and diversions. + + - Request: .am xx + - Request: .am1 xx + - Request: .ami xx yy + Works similarly to `de' except it appends onto the macro named XX. + So, to make the previously defined `P' macro actually do indented + instead of block paragraphs, add the necessary code to the + existing macro like this: + + + .am P + .ti +5n + .. + + The `am1' request turns off compatibility mode while executing the + appended macro piece. To be more precise, a "compatibility save" + input token is inserted at the beginning of the appended code, and + a "compatibility restore" input token at the end. + + The `ami' request appends indirectly, meaning that `gtroff' + expands strings whose names are XX or YY before performing the + append. + + Using `trace.tmac', you can trace calls to `am' and `am1'. + + *Note Strings::, for the `als' request to rename a macro. + + The `de', `am', `di', `da', `ds', and `as' requests (together with +its variants) only create a new object if the name of the macro, +diversion or string diversion is currently undefined or if it is +defined to be a request; normally they modify the value of an existing +object. + + - Request: .return + Exit a macro, immediately returning to the caller. + +* Menu: + +* Copy-in Mode:: +* Parameters:: + + +File: groff, Node: Copy-in Mode, Next: Parameters, Prev: Writing Macros, Up: Writing Macros + +Copy-in Mode +------------ + + When `gtroff' reads in the text for a macro, string, or diversion, +it copies the text (including request lines, but excluding escapes) into +an internal buffer. Escapes are converted into an internal form, +except for `\n', `\$', `\*', `\\' and `\<RET>' which are evaluated and +inserted into the text where the escape was located. This is known as +"copy-in" mode or "copy" mode. + + What this means is that you can specify when these escapes are to be +evaluated (either at copy-in time or at the time of use) by insulating +the escapes with an extra backslash. Compare this to the `\def' and +`\edef' commands in TeX. + + The following example prints the numbers 20 and 10: + + + .nr x 20 + .de y + .nr x 10 + \&\nx + \&\\nx + .. + .y + + +File: groff, Node: Parameters, Prev: Copy-in Mode, Up: Writing Macros + +Parameters +---------- + + The arguments to a macro or string can be examined using a variety of +escapes. + + - Register: \n[.$] + The number of arguments passed to a macro or string. This is a + read-only number register. + + Any individual argument can be retrieved with one of the following +escapes: + + - Escape: \$N + - Escape: \$(NN + - Escape: \$[NNN] + Retrieve the Nth, NNth or NNNth argument. As usual, the first + form only accepts a single number (larger than zero), the second a + two-digit number (larger or equal to 10), and the third any + positive integer value (larger than zero). Macros and strings can + have an unlimited number of arguments. Note that due to copy-in + mode, use two backslashes on these in actual use to prevent + interpolation until the macro is actually invoked. + + - Request: .shift [n] + Shift the arguments 1 position, or as many positions as specified + by its argument. After executing this request, argument I becomes + argument I-N; arguments 1 to N are no longer available. Shifting + by negative amounts is currently undefined. + + - Escape: \$* + - Escape: \$@ + In some cases it is convenient to use all of the arguments at once + (for example, to pass the arguments along to another macro). The + `\$*' escape concatenates all the arguments separated by spaces. A + similar escape is `\$@', which concatenates all the arguments with + each surrounded by double quotes, and separated by spaces. If not + in compatibility mode, the input level of double quotes is + preserved (see *Note Request Arguments::). + + - Escape: \$0 + The name used to invoke the current macro. The `als' request can + make a macro have more than one name. + + + .de generic-macro + . ... + . if \\n[error] \{\ + . tm \\$0: Houston, we have a problem. + . return + . \} + .. + . + .als foo generic-macro + .als bar generic-macro + + + *Note Request Arguments::. + + +File: groff, Node: Page Motions, Next: Drawing Requests, Prev: Writing Macros, Up: gtroff Reference + +Page Motions +============ + + *Note Manipulating Spacing::, for a discussion of the main request +for vertical motion, `sp'. + + - Request: .mk [reg] + - Request: .rt [dist] + The request `mk' can be used to mark a location on a page, for + movement to later. This request takes a register name as an + argument in which to store the current page location. With no + argument it stores the location in an internal register. The + results of this can be used later by the `rt' or the `sp' request + (or the `\v' escape). + + The `rt' request returns _upwards_ to the location marked with the + last `mk' request. If used with an argument, return to a position + which distance from the top of the page is DIST (no previous call + to `mk' is necessary in this case). Default scaling indicator is + `v'. + + Here a primitive solution for a two-column macro. + + + .nr column-length 1.5i + .nr column-gap 4m + .nr bottom-margin 1m + . + + + .de 2c + . br + . mk + . ll \\n[column-length]u + . wh -\\n[bottom-margin]u 2c-trap + . nr right-side 0 + .. + . + + + .de 2c-trap + . ie \\n[right-side] \{\ + . nr right-side 0 + . po -(\\n[column-length]u + \\n[column-gap]u) + . \" remove trap + . wh -\\n[bottom-margin]u + . \} + . el \{\ + . \" switch to right side + . nr right-side 1 + . po +(\\n[column-length]u + \\n[column-gap]u) + . rt + . \} + .. + . + + + .pl 1.5i + .ll 4i + This is a small test which shows how the + rt request works in combination with mk. + + .2c + Starting here, text is typeset in two columns. + Note that this implementation isn't robust + and thus not suited for a real two-column + macro. + + Result: + + + This is a small test which shows how the + rt request works in combination with mk. + + Starting here, isn't robust + text is typeset and thus not + in two columns. suited for a + Note that this real two-column + implementation macro. + + + The following escapes give fine control of movements about the page. + + - Escape: \v'E' + Move vertically, usually from the current location on the page (if + no absolute position operator `|' is used). The argument E + specifies the distance to move; positive is downwards and negative + upwards. The default scaling indicator for this escape is `v'. + Beware, however, that `gtroff' continues text processing at the + point where the motion ends, so you should always balance motions + to avoid interference with text processing. + + `\v' doesn't trigger a trap. This can be quite useful; for + example, consider a page bottom trap macro which prints a marker + in the margin to indicate continuation of a footnote or something + similar. + + There are some special-case escapes for vertical motion. + + - Escape: \r + Move upwards 1v. + + - Escape: \u + Move upwards .5v. + + - Escape: \d + Move down .5v. + + - Escape: \h'E' + Move horizontally, usually from the current location (if no + absolute position operator `|' is used). The expression E + indicates how far to move: positive is rightwards and negative + leftwards. The default scaling indicator for this escape is `m'. + + There are a number of special-case escapes for horizontal motion. + + - Escape: \<SP> + An unbreakable and unpaddable (i.e. not expanded during filling) + space. (Note: This is a backslash followed by a space.) + + - Escape: \~ + An unbreakable space that stretches like a normal inter-word space + when a line is adjusted. + + - Escape: \| + A 1/6th em space. Ignored for TTY output devices (rounded to + zero). + + - Escape: \^ + A 1/12th em space. Ignored for TTY output devices (rounded to + zero). + + - Escape: \0 + A space the size of a digit. + + The following string sets the TeX logo: + + + .ds TeX T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X + + - Escape: \w'TEXT' + - Register: \n[st] + - Register: \n[sb] + - Register: \n[rst] + - Register: \n[rsb] + - Register: \n[ct] + - Register: \n[ssc] + - Register: \n[skw] + Return the width of the specified TEXT in basic units. This + allows horizontal movement based on the width of some arbitrary + text (e.g. given as an argument to a macro). + + + The length of the string `abc' is \w'abc'u. + => The length of the string `abc' is 72u. + + Font changes may occur in TEXT which don't affect current settings. + + After use, `\w' sets several registers: + + `st' + `sb' + The highest and lowest point of the baseline, respectively, + in TEXT. + + `rst' + `rsb' + Like the `st' and `sb' registers, but takes account of the + heights and depths of glyphs. With other words, this gives + the highest and lowest point of TEXT. + + `ct' + Defines the kinds of glyphs occurring in TEXT: + + 0 + only short glyphs, no descenders or tall glyphs. + + 1 + at least one descender. + + 2 + at least one tall glyph. + + 3 + at least one each of a descender and a tall glyph. + + `ssc' + The amount of horizontal space (possibly negative) that + should be added to the last glyph before a subscript. + + `skw' + How far to right of the center of the last glyph in the `\w' + argument, the center of an accent from a roman font should be + placed over that glyph. + + - Escape: \kP + - Escape: \k(PS + - Escape: \k[POSITION] + Store the current horizontal position in the _input_ line in + number register with name POSITION (one-character name P, + two-character name PS). Use this, for example, to return to the + beginning of a string for highlighting or other decoration. + + - Register: \n[hp] + The current horizontal position at the input line. + + - Register: \n[.k] + A read-only number register containing the current horizontal + output position. + + - Escape: \o'ABC' + Overstrike glyphs A, B, C, ...; the glyphs are centered, and the + resulting spacing is the largest width of the affected glyphs. + + - Escape: \zG + Print glyph G with zero width, i.e., without spacing. Use this to + overstrike glyphs left-aligned. + + - Escape: \Z'ANYTHING' + Print ANYTHING, then restore the horizontal and vertical position. + The argument may not contain tabs or leaders. + + The following is an example of a strike-through macro: + + + .de ST + .nr ww \w'\\$1' + \Z@\v'-.25m'\l'\\n[ww]u'@\\$1 + .. + . + This is + .ST "a test" + an actual emergency! + + + +File: groff, Node: Drawing Requests, Next: Traps, Prev: Page Motions, Up: gtroff Reference + +Drawing Requests +================ + + `gtroff' provides a number of ways to draw lines and other figures +on the page. Used in combination with the page motion commands (see +*Note Page Motions::, for more info), a wide variety of figures can be +drawn. However, for complex drawings these operations can be quite +cumbersome, and it may be wise to use graphic preprocessors like `gpic' +or `ggrn'. *Note gpic::, and *Note ggrn::, for more information. + + All drawing is done via escapes. + + - Escape: \l'L' + - Escape: \l'LG' + Draw a line horizontally. L is the length of the line to be + drawn. If it is positive, start the line at the current location + and draw to the right; its end point is the new current location. + Negative values are handled differently: The line starts at the + current location and draws to the left, but the current location + doesn't move. + + L can also be specified absolutely (i.e. with a leading `|') which + draws back to the beginning of the input line. Default scaling + indicator is `m'. + + The optional second parameter G is a glyph to draw the line with. + If this second argument is not specified, `gtroff' uses the + underscore glyph, `\[ru]'. + + To separate the two arguments (to prevent `gtroff' from + interpreting a drawing glyph as a scaling indicator if the glyph is + represented by a single character) use `\&'. + + Here a small useful example: + + + .de box + \[br]\\$*\[br]\l'|0\[rn]'\l'|0\[ul]' + .. + + Note that this works by outputting a box rule (a vertical line), + then the text given as an argument and then another box rule. + Finally, the line drawing escapes both draw from the current + location to the beginning of the _input_ line - this works because + the line length is negative, not moving the current point. + + - Escape: \L'L' + - Escape: \L'LG' + Draw vertical lines. Its parameters are similar to the `\l' + escape, except that the default scaling indicator is `v'. The + movement is downwards for positive values, and upwards for + negative values. The default glyph is the box rule glyph, + `\[br]'. As with the vertical motion escapes, text processing + blindly continues where the line ends. + + + This is a \L'3v'test. + + Here the result, produced with `grotty'. + + + This is a + | + | + |test. + + + - Escape: \D'COMMAND ARG ...' + The `\D' escape provides a variety of drawing functions. Note + that on character devices, only vertical and horizontal lines are + supported within `grotty'; other devices may only support a subset + of the available drawing functions. + + The default scaling indicator for all subcommands of `\D' is `m' + for horizontal distances and `v' for vertical ones. Exceptions + are `\D'f ...'' and `\D't ...'' which use `u' as the default. + + `\D'l DX DY'' + Draw a line from the current location to the relative point + specified by (DX,DY). + + The following example is a macro for creating a box around a + text string; for simplicity, the box margin is taken as a + fixed value, 0.2m. + + + .de BOX + . nr @wd \w'\\$1' + \h'.2m'\ + \h'-.2m'\v'(.2m - \\n[rsb]u)'\ + \D'l 0 -(\\n[rst]u - \\n[rsb]u + .4m)'\ + \D'l (\\n[@wd]u + .4m) 0'\ + \D'l 0 (\\n[rst]u - \\n[rsb]u + .4m)'\ + \D'l -(\\n[@wd]u + .4m) 0'\ + \h'.2m'\v'-(.2m - \\n[rsb]u)'\ + \\$1\ + \h'.2m' + .. + + First, the width of the string is stored in register `@wd'. + Then, four lines are drawn to form a box, properly offset by + the box margin. The registers `rst' and `rsb' are set by the + `\w' escape, containing the largest height and depth of the + whole string. + + `\D'c D'' + Draw a circle with a diameter of D with the leftmost point at + the current position. + + `\D'C D'' + Draw a solid circle with the same parameters as an outlined + circle. No outline is drawn. + + `\D'e X Y'' + Draw an ellipse with a horizontal diameter of X and a vertical + diameter of Y with the leftmost point at the current position. + + `\D'E X Y'' + Draw a solid ellipse with the same parameters as an outlined + ellipse. No outline is drawn. + + `\D'a DX1 DY1 DX2 DY2'' + Draw an arc clockwise from the current location through the + two specified relative locations (DX1,DY1) and (DX2,DY2). + The coordinates of the first point are relative to the + current position, and the coordinates of the second point are + relative to the first point. + + `\D'~ DX1 DY1 DX2 DY2 ...'' + Draw a spline from the current location to the relative point + (DX1,DY1) and then to (DX2,DY2), and so on. + + `\D'f N'' + Set the shade of gray to be used for filling solid objects + to N; N must be an integer between 0 and 1000, where 0 + corresponds solid white and 1000 to solid black, and values + in between correspond to intermediate shades of gray. This + applies only to solid circles, solid ellipses, and solid + polygons. By default, a level of 1000 is used. + + `\D'p DX1 DY1 DX2 DY2 ...'' + Draw a polygon from the current location to the relative + position (DX1,DY1) and then to (DX2,DY2) and so on. When the + specified data points are exhausted, a line is drawn back to + the starting point. + + `\D'P DX1 DY1 DX2 DY2 ...'' + Draw a solid polygon with the same parameters as an outlined + polygon. No outline is drawn. + + Here a better variant of the box macro to fill the box with + some color. Note that the box must be drawn before the text + since colors in `gtroff' are not transparent; the filled + polygon would hide the text completely. + + + .de BOX + . nr @wd \w'\\$1' + \h'.2m'\ + \h'-.2m'\v'(.2m - \\n[rsb]u)'\ + \M[lightcyan]\ + \D'P 0 -(\\n[rst]u - \\n[rsb]u + .4m) \ + (\\n[@wd]u + .4m) 0 \ + 0 (\\n[rst]u - \\n[rsb]u + .4m) \ + -(\\n[@wd]u + .4m) 0'\ + \h'.2m'\v'-(.2m - \\n[rsb]u)'\ + \M[]\ + \\$1\ + \h'.2m' + .. + + `\D't N'' + Set the current line thickness to N machine units. A value of + zero selects the smallest available line thickness. A + negative value makes the line thickness proportional to the + current point size (this is the default behaviour of AT&T + `troff'). + + *Note Graphics Commands::. + + - Escape: \b'STRING' + "Pile" a sequence of glyphs vertically, and center it vertically + on the current line. Use it to build large brackets and braces. + + Here an example how to create a large opening brace: + + + \b'\[lt]\[bv]\[lk]\[bv]\[lb]' + + The first glyph is on the top, the last glyph in STRING is at the + bottom. Note that `gtroff' separates the glyphs vertically by 1m, + and the whole object is centered 0.5m above the current baseline; + the largest glyph width is used as the width for the whole object. + This rather unflexible positioning algorithm doesn't work with + `-Tdvi' since the bracket pieces vary in height for this device. + Instead, use the `eqn' preprocessor. + + *Note Manipulating Spacing::, how to adjust the vertical spacing + with the `\x' escape. + + +File: groff, Node: Traps, Next: Diversions, Prev: Drawing Requests, Up: gtroff Reference + +Traps +===== + + "Traps" are locations, which, when reached, call a specified macro. +These traps can occur at a given location on the page, at a given +location in the current diversion, at a blank line, after a certain +number of input lines, or at the end of input. + + Setting a trap is also called "planting". It is also said that a +trap is "sprung" if the associated macro is executed. + +* Menu: + +* Page Location Traps:: +* Diversion Traps:: +* Input Line Traps:: +* Blank Line Traps:: +* End-of-input Traps:: + + +File: groff, Node: Page Location Traps, Next: Diversion Traps, Prev: Traps, Up: Traps + +Page Location Traps +------------------- + + "Page location traps" perform an action when `gtroff' reaches or +passes a certain vertical location on the page. Page location traps +have a variety of purposes, including: + + * setting headers and footers + + * setting body text in multiple columns + + * setting footnotes + + - Request: .vpt flag + - Register: \n[.vpt] + Enable vertical position traps if FLAG is non-zero, or disables + them otherwise. Vertical position traps are traps set by the `wh' + or `dt' requests. Traps set by the `it' request are not vertical + position traps. The parameter that controls whether vertical + position traps are enabled is global. Initially vertical position + traps are enabled. The current setting of this is available in the + `.vpt' read-only number register. + + - Request: .wh dist [macro] + Set a page location trap. Positive values for DIST set the trap + relative to the top of the page; negative values set the trap + relative to the bottom of the page. Default scaling indicator is + `v'. + + MACRO is the name of the macro to execute when the trap is sprung. + If MACRO is missing, remove the first trap (if any) at DIST. + + The following is a simple example of how many macro packages set + headers and footers. + + + .de hd \" Page header + ' sp .5i + . tl 'Title''date' + ' sp .3i + .. + . + .de fo \" Page footer + ' sp 1v + . tl ''%'' + ' bp + .. + . + .wh 0 hd \" trap at top of the page + .wh -1i fo \" trap one inch from bottom + + A trap at or below the bottom of the page is ignored; it can be + made active by either moving it up or increasing the page length + so that the trap is on the page. + + It is possible to have more than one trap at the same location; to + do so, the traps must be defined at different locations, then + moved together with the `ch' request; otherwise the second trap + would replace the first one. Earlier defined traps hide later + defined traps if moved to the same position (the many empty lines + caused by the `bp' request are omitted): + + + .de a + . nop a + .. + .de b + . nop b + .. + .de c + . nop c + .. + . + .wh 1i a + .wh 2i b + .wh 3i c + .bp + => a b c + + + .ch b 1i + .ch c 1i + .bp + => a + + + .ch a 0.5i + .bp + => a b + + + - Register: \n[.t] + A read-only number register holding the distance to the next trap. + + If there are no traps between the current position and the bottom + of the page, it contains the distance to the page bottom. In a + diversion, the distance to the page bottom is infinite (the + returned value is the biggest integer which can be represented in + `groff') if there are no diversion traps. + + - Request: .ch macro dist + Change the location of a trap. The first argument is the name of + the macro to be invoked at the trap, and the second argument is + the new location for the trap (note that the parameters are + specified the opposite of the `wh' request). This is useful for + building up footnotes in a diversion to allow more space at the + bottom of the page for them. + + Default scaling indicator for DIST is `v'. If DIST is missing, + the trap is removed. + + + - Register: \n[.ne] + The read-only number register `.ne' contains the amount of space + that was needed in the last `ne' request that caused a trap to be + sprung. Useful in conjunction with the `.trunc' register. *Note + Page Control::, for more information. + + - Register: \n[.trunc] + A read-only register containing the amount of vertical space + truncated by the most recently sprung vertical position trap, or, + if the trap was sprung by an `ne' request, minus the amount of + vertical motion produced by the `ne' request. In other words, at + the point a trap is sprung, it represents the difference of what + the vertical position would have been but for the trap, and what + the vertical position actually is. + + +File: groff, Node: Diversion Traps, Next: Input Line Traps, Prev: Page Location Traps, Up: Traps + +Diversion Traps +--------------- + + - Request: .dt dist macro + Set a trap _within_ a diversion. DIST is the location of the trap + (identical to the `.wh' request; default scaling indicator is `v') + and MACRO is the name of the macro to be invoked. The number + register `.t' still works within diversions. *Note Diversions::, + for more information. + + +File: groff, Node: Input Line Traps, Next: Blank Line Traps, Prev: Diversion Traps, Up: Traps + +Input Line Traps +---------------- + + - Request: .it n macro + - Request: .itc n macro + Set an input line trap. N is the number of lines of input which + may be read before springing the trap, MACRO is the macro to be + invoked. Request lines are not counted as input lines. + + For example, one possible use is to have a macro which prints the + next N lines in a bold font. + + + .de B + . it \\$1 B-end + . ft B + .. + . + .de B-end + . ft R + .. + + The `itc' request is identical, except that a line interrupted + with `\c' counts as one input line. + + Both requests are associated with the current environment (*note + Environments::); switching to another environment disables the + current input trap, and going back reactivates it, restoring the + number of already processed lines. + + +File: groff, Node: Blank Line Traps, Next: End-of-input Traps, Prev: Input Line Traps, Up: Traps + +Blank Line Traps +---------------- + + - Request: .blm macro + Set a blank line trap. `gtroff' executes MACRO when it encounters + a blank line in the input file. + + +File: groff, Node: End-of-input Traps, Prev: Blank Line Traps, Up: Traps + +End-of-input Traps +------------------ + + - Request: .em macro + Set a trap at the end of input. MACRO is executed after the last + line of the input file has been processed. + + For example, if the document had to have a section at the bottom + of the last page for someone to approve it, the `em' request could + be used. + + + .de approval + . ne 5v + . sp |(\\n[.t] - 6v) + . in +4i + . lc _ + . br + Approved:\t\a + . sp + Date:\t\t\a + .. + . + .em approval + + diff --git a/contrib/groff/doc/groff-7 b/contrib/groff/doc/groff-7 new file mode 100644 index 0000000..382e218 --- /dev/null +++ b/contrib/groff/doc/groff-7 @@ -0,0 +1,1608 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: Diversions, Next: Environments, Prev: Traps, Up: gtroff Reference + +Diversions +========== + + In `gtroff' it is possible to "divert" text into a named storage +area. Due to the similarity to defining macros it is sometimes said to +be stored in a macro. This is used for saving text for output at a +later time, which is useful for keeping blocks of text on the same +page, footnotes, tables of contents, and indices. + + For orthogonality it is said that `gtroff' is in the "top-level +diversion" if no diversion is active (i.e., the data is diverted to the +output device). + + - Request: .di macro + - Request: .da macro + Begin a diversion. Like the `de' request, it takes an argument of + a macro name to divert subsequent text into. The `da' macro + appends to an existing diversion. + + `di' or `da' without an argument ends the diversion. + + - Request: .box macro + - Request: .boxa macro + Begin (or appends to) a diversion like the `di' and `da' requests. + The difference is that `box' and `boxa' do not include a + partially-filled line in the diversion. + + Compare this: + + + Before the box. + .box xxx + In the box. + .br + .box + After the box. + .br + => Before the box. After the box. + .xxx + => In the box. + + with this: + + + Before the diversion. + .di yyy + In the diversion. + .br + .di + After the diversion. + .br + => After the diversion. + .yyy + => Before the diversion. In the diversion. + + `box' or `boxa' without an argument ends the diversion. + + - Register: \n[.z] + - Register: \n[.d] + Diversions may be nested. The read-only number register `.z' + contains the name of the current diversion (this is a string-valued + register). The read-only number register `.d' contains the current + vertical place in the diversion. If not in a diversion it is the + same as the register `nl'. + + - Register: \n[.h] + The "high-water mark" on the current page. It corresponds to the + text baseline of the lowest line on the page. This is a read-only + register. + + + .tm .h==\n[.h], nl==\n[nl] + => .h==0, nl==-1 + This is a test. + .br + .sp 2 + .tm .h==\n[.h], nl==\n[nl] + => .h==40, nl==120 + + As can be seen in the previous example, empty lines are not + considered in the return value of the `.h' register. + + - Register: \n[dn] + - Register: \n[dl] + After completing a diversion, the read-write number registers `dn' + and `dl' contain the vertical and horizontal size of the diversion. + + + .\" Center text both horizontally & vertically + . + .\" Enclose macro definitions in .eo and .ec + .\" to avoid the doubling of the backslash + .eo + .\" macro .(c starts centering mode + .de (c + . br + . ev (c + . evc 0 + . in 0 + . nf + . di @c + .. + + + .\" macro .)c terminates centering mode + .de )c + . br + . ev + . di + . nr @s (((\n[.t]u - \n[dn]u) / 2u) - 1v) + . sp \n[@s]u + . ce 1000 + . @c + . ce 0 + . sp \n[@s]u + . br + . fi + . rr @s + . rm @s + . rm @c + .. + .\" End of macro definitions, restore escape mechanism + .ec + + + - Escape: \! + - Escape: \?ANYTHING\? + Prevent requests, macros, and escapes from being interpreted when + read into a diversion. This takes the given text and + "transparently" embeds it into the diversion. This is useful for + macros which shouldn't be invoked until the diverted text is + actually output. + + The `\!' escape transparently embeds text up to and including the + end of the line. The `\?' escape transparently embeds text until + the next occurrence of the `\?' escape. For example: + + + \?ANYTHING\? + + ANYTHING may not contain newlines; use `\!' to embed newlines in + a diversion. The escape sequence `\?' is also recognized in copy + mode and turned into a single internal code; it is this code that + terminates ANYTHING. Thus the following example prints 4. + + + .nr x 1 + .nf + .di d + \?\\?\\\\?\\\\\\\\nx\\\\?\\?\? + .di + .nr x 2 + .di e + .d + .di + .nr x 3 + .di f + .e + .di + .nr x 4 + .f + + Both escapes read the data in copy mode. + + If `\!' is used in the top-level diversion, its argument is + directly embedded into the `gtroff' intermediate output. This can + be used for example to control a postprocessor which processes the + data before it is sent to the device driver. + + The `\?' escape used in the top-level diversion produces no output + at all; its argument is simply ignored. + + - Request: .output string + Emit STRING directly to the `gtroff' intermediate output (subject + to copy-mode interpretation); this is similar to `\!' used at the + top level. An initial double quote in STRING is stripped off to + allow initial blanks. + + This request can't be used before the first page has started - if + you get an error, simply insert `.br' before the `output' request. + + Without argument, `output' is ignored. + + Use with caution! It is normally only needed for mark-up used by a + postprocessor which does something with the output before sending + it to the output device, filtering out `string' again. + + - Request: .asciify div + "Unformat" the diversion specified by DIV in such a way that ASCII + characters, characters translated with the `trin' request, space + characters, and some escape sequences that were formatted and + diverted are treated like ordinary input characters when the + diversion is reread. It can be also used for gross hacks; for + example, the following sets register `n' to 1. + + + .tr @. + .di x + @nr n 1 + .br + .di + .tr @@ + .asciify x + .x + + *Note Copy-in Mode::. + + - Request: .unformat div + Like `asciify', unformat the specified diversion. However, + `unformat' only unformats spaces and tabs between words. + Unformatted tabs are treated as input tokens, and spaces are + stretchable again. + + The vertical size of lines is not preserved; glyph information + (font, font size, space width, etc.) is retained. + + +File: groff, Node: Environments, Next: Suppressing output, Prev: Diversions, Up: gtroff Reference + +Environments +============ + + It happens frequently that some text should be printed in a certain +format regardless of what may be in effect at the time, for example, in +a trap invoked macro to print headers and footers. To solve this +`gtroff' processes text in "environments". An environment contains +most of the parameters that control text processing. It is possible to +switch amongst these environments; by default `gtroff' processes text +in environment 0. The following is the information kept in an +environment. + + * font parameters (size, family, style, glyph height and slant, space + and sentence space size) + + * page parameters (line length, title length, vertical spacing, line + spacing, indentation, line numbering, centering, right-justifying, + underlining, hyphenation data) + + * fill and adjust mode + + * tab stops, tab and leader characters, escape character, no-break + and hyphen indicators, margin character data + + * partially collected lines + + * input traps + + * drawing and fill colours + + These environments may be given arbitrary names (see *Note +Identifiers::, for more info). Old versions of `troff' only had +environments named `0', `1', and `2'. + + - Request: .ev [env] + - Register: \n[.ev] + Switch to another environment. The argument ENV is the name of + the environment to switch to. With no argument, `gtroff' switches + back to the previous environment. There is no limit on the number + of named environments; they are created the first time that they + are referenced. The `.ev' read-only register contains the name or + number of the current environment. This is a string-valued + register. + + Note that a call to `ev' (with argument) pushes the previously + active environment onto a stack. If, say, environments `foo', + `bar', and `zap' are called (in that order), the first `ev' + request without parameter switches back to environment `bar' + (which is popped off the stack), and a second call switches back + to environment `foo'. + + Here is an example: + + + .ev footnote-env + .fam N + .ps 6 + .vs 8 + .ll -.5i + .ev + + ... + + .ev footnote-env + \(dg Note the large, friendly letters. + .ev + + + - Request: .evc env + Copy the environment ENV into the current environment. + + The following environment data is not copied: + + * Partially filled lines. + + * The status whether the previous line was interrupted. + + * The number of lines still to center, or to right-justify, or + to underline (with or without underlined spaces); they are + set to zero. + + * The status whether a temporary indent is active. + + * Input traps and its associated data. + + * Line numbering mode is disabled; it can be reactivated with + `.nm +0'. + + * The number of consecutive hyphenated lines (set to zero). + + - Register: \n[.cht] + - Register: \n[.cdp] + - Register: \n[.csk] + The `\n[.cht]' register contains the maximum extent (above the + baseline) of the last glyph added to the current environment. + + The `\n[.cdp]' register contains the maximum extent (below the + baseline) of the last glyph added to the current environment. + + The `\n[.csk]' register contains the "skew" (how far to the right + of the glyph's center that `gtroff' shold place an accent) of the + last glyph added to the current environment. + + +File: groff, Node: Suppressing output, Next: Colors, Prev: Environments, Up: gtroff Reference + +Suppressing output +================== + + - Escape: \ONUM + Disable or enable output depending on the value of NUM: + + `\O0' + Disable any glyphs from being emitted to the device driver, + provided that the escape occurs at the outer level (see + `\O[3]' and `\O[4]'). Motion is not suppressed so + effectively `\O[0]' means _pen up_. + + `\O1' + Enable output of glyphs, provided that the escape occurs at + the outer level. + + `\O0' and `\O1' also reset the four registers `opminx', `opminy', + `opmaxx', and `opmaxy' to -1. *Note Register Index::. These four + registers mark the top left and bottom right hand corners of a box + which encompasses all written glyphs. + + For example the input text: + + + Hello \O[0]world \O[1]this is a test. + + produces the following output: + + + Hello this is a test. + + `\O2' + Provided that the escape occurs at the outer level, enable + output of glyphs and also write out to `stderr' the page + number and four registers encompassing the glyphs previously + written since the last call to `\O'. + + `\O3' + Begin a nesting level. At start-up, `gtroff' is at outer + level. + + `\O4' + End a nesting level. + + `\O[5PFILENAME]' + This escape is `grohtml' specific. Provided that this escape + occurs at the outer nesting level write the `filename' to + `stderr'. The position of the image, P, must be specified + and must be one of `l', `r', `c', or `i' (left, right, + centered, inline). FILENAME will be associated with the + production of the next inline image. + + +File: groff, Node: Colors, Next: I/O, Prev: Suppressing output, Up: gtroff Reference + +Colors +====== + + - Request: .color [n] + - Register: \n[.color] + If N is missing or non-zero, activate colors (this is the default); + otherwise, turn it off. + + The read-only number register `.color' is 1 if colors are active, + 0 otherwise. + + Internally, `color' sets a global flag; it does not produce a + token. Similar to the `cp' request, you should use it at the + beginning of your document to control color output. + + Colors can be also turned off with the `-c' command line option. + + - Request: .defcolor ident scheme color_components + Define color with name IDENT. SCHEME can be one of the following + values: `rgb' (three components), `cym' (three components), `cmyk' + (four components), and `gray' or `grey' (one component). + + Color components can be given either as a hexadecimal string or as + positive decimal integers in the range 0-65535. A hexadecimal + string contains all color components concatenated. It must start + with either `#' or `##'; the former specifies hex values in the + range 0-255 (which are internally multiplied by 257), the latter + in the range 0-65535. Examples: `#FFC0CB' (pink), `##ffff0000ffff' + (magenta). The default color name value is device-specific + (usually black). It is possible that the default color for `\m' + and `\M' is not identical. + + A new scaling indicator `f' has been introduced which multiplies + its value by 65536; this makes it convenient to specify color + components as fractions in the range 0 to 1 (1f equals 65536u). + Example: + + + .defcolor darkgreen rgb 0.1f 0.5f 0.2f + + Note that `f' is the default scaling indicator for the `defcolor' + request, thus the above statement is equivalent to + + + .defcolor darkgreen rgb 0.1 0.5 0.2 + + + - Escape: \mC + - Escape: \m(CO + - Escape: \m[COLOR] + Set drawing color. The following example shows how to turn the + next four words red. + + + \m[red]these are in red\m[] and these words are in black. + + The escape `\m[]' returns to the previous color. + + The drawing color is associated with the current environment + (*note Environments::). + + Note that `\m' doesn't produce an input token in `gtroff'. As a + consequence, it can be used in requests like `mc' (which expects a + single character as an argument) to change the color on the fly: + + + .mc \m[red]x\m[] + + + - Escape: \MC + - Escape: \M(CO + - Escape: \M[COLOR] + Set background color for filled objects drawn with the `\D'...'' + commands. + + A red ellipse can be created with the following code: + + + \M[red]\h'0.5i'\D'E 2i 1i'\M[] + + The escape `\M[]' returns to the previous fill color. + + The fill color is associated with the current environment (*note + Environments::). + + Note that `\M' doesn't produce an input token in `gtroff'. + + +File: groff, Node: I/O, Next: Postprocessor Access, Prev: Colors, Up: gtroff Reference + +I/O +=== + + `gtroff' has several requests for including files: + + - Request: .so file + Read in the specified FILE and includes it in place of the `so' + request. This is quite useful for large documents, e.g. keeping + each chapter in a separate file. *Note gsoelim::, for more + information. + + Since `gtroff' replaces the `so' request with the contents of + `file', it makes a difference whether the data is terminated with + a newline or not: Assuming that file `xxx' contains the word `foo' + without a final newline, this + + + This is + .so xxx + bar + + yields `This is foobar'. + + - Request: .pso command + Read the standard output from the specified COMMAND and includes + it in place of the `pso' request. + + This request causes an error if used in safer mode (which is the + default). Use `groff''s or `troff''s `-U' option to activate + unsafe mode. + + The comment regarding a final newline for the `so' request is valid + for `pso' also. + + - Request: .mso file + Identical to the `so' request except that `gtroff' searches for + the specified FILE in the same directories as macro files for the + the `-m' command line option. If the file name to be included has + the form `NAME.tmac' and it isn't found, `mso' tries to include + `tmac.NAME' and vice versa. + + - Request: .trf file + - Request: .cf file + Transparently output the contents of FILE. Each line is output as + if it were preceded by `\!'; however, the lines are not subject to + copy mode interpretation. If the file does not end with a newline, + then a newline is added (`trf' only). For example, to define a + macro `x' containing the contents of file `f', use + + + .di x + .trf f + .di + + Both `trf' and `cf', when used in a diversion, embeds an object in + the diversion which, when reread, causes the contents of FILE to + be transparently copied through to the output. In UNIX `troff', + the contents of FILE is immediately copied through to the output + regardless of whether there is a current diversion; this behaviour + is so anomalous that it must be considered a bug. + + While `cf' copies the contents of FILE completely unprocessed, + `trf' disallows characters such as NUL that are not valid `gtroff' + input characters (*note Identifiers::). + + Both requests cause a line break. + + - Request: .nx [file] + Force `gtroff' to continue processing of the file specified as an + argument. If no argument is given, immediately jump to the end of + file. + + - Request: .rd [prompt [arg1 arg2 ...]] + Read from standard input, and include what is read as though it + were part of the input file. Text is read until a blank line is + encountered. + + If standard input is a TTY input device (keyboard), write PROMPT + to standard error, followed by a colon (or send BEL for a beep if + no argument is given). + + Arguments after PROMPT are available for the input. For example, + the line + + + .rd data foo bar + + with the input `This is \$2.' prints + + + This is bar. + + + Using the `nx' and `rd' requests, it is easy to set up form letters. +The form letter template is constructed like this, putting the +following lines into a file called `repeat.let': + + + .ce + \*(td + .sp 2 + .nf + .rd + .sp + .rd + .fi + Body of letter. + .bp + .nx repeat.let + +When this is run, a file containing the following lines should be +redirected in. Note that requests included in this file are executed +as though they were part of the form letter. The last block of input +is the `ex' request which tells `groff' to stop processing. If this +was not there, `groff' would not know when to stop. + + + Trent A. Fisher + 708 NW 19th Av., #202 + Portland, OR 97209 + + Dear Trent, + + Len Adollar + 4315 Sierra Vista + San Diego, CA 92103 + + Dear Mr. Adollar, + + .ex + + - Request: .pi pipe + Pipe the output of `gtroff' to the shell command(s) specified by + PIPE. This request must occur before `gtroff' has a chance to + print anything. + + `pi' causes an error if used in safer mode (which is the default). + Use `groff''s or `troff''s `-U' option to activate unsafe mode. + + Multiple calls to `pi' are allowed, acting as a chain. For + example, + + + .pi foo + .pi bar + ... + + is the same as `.pi foo | bar'. + + Note that the intermediate output format of `gtroff' is piped to + the specified commands. Consequently, calling `groff' without the + `-Z' option normally causes a fatal error. + + - Request: .sy cmds + - Register: \n[systat] + Execute the shell command(s) specified by CMDS. The output is not + saved anyplace, so it is up to the user to do so. + + This request causes an error if used in safer mode (which is the + default). Use `groff''s or `troff''s `-U' option to activate + unsafe mode. + + For example, the following code fragment introduces the current + time into a document: + + + .sy perl -e 'printf ".nr H %d\\n.nr M %d\\n.nr S %d\\n",\ + (localtime(time))[2,1,0]' > /tmp/x\n[$$] + .so /tmp/x\n[$$] + .sy rm /tmp/x\n[$$] + \nH:\nM:\nS + + Note that this works by having the `perl' script (run by `sy') + print out the `nr' requests which set the number registers `H', + `M', and `S', and then reads those commands in with the `so' + request. + + For most practical purposes, the number registers `seconds', + `minutes', and `hours' which are initialized at start-up of + `gtroff' should be sufficient. Use the `af' request to get a + formatted output: + + + .af hours 00 + .af minutes 00 + .af seconds 00 + \n[hours]:\n[minutes]:\n[seconds] + + The `systat' read-write number register contains the return value + of the `system()' function executed by the last `sy' request. + + - Request: .open stream file + - Request: .opena stream file + Open the specified FILE for writing and associates the specified + STREAM with it. + + The `opena' request is like `open', but if the file exists, append + to it instead of truncating it. + + Both `open' and `opena' cause an error if used in safer mode + (which is the default). Use `groff''s or `troff''s `-U' option to + activate unsafe mode. + + - Request: .write stream data + - Request: .writec stream data + Write to the file associated with the specified STREAM. The + stream must previously have been the subject of an open request. + The remainder of the line is interpreted as the `ds' request reads + its second argument: A leading `"' is stripped, and it is read in + copy-in mode. + + The `writec' request is like `write', but only `write' appends a + newline to the data. + + - Request: .writem stream xx + Write the contents of the macro or string XX to the file + associated with the specified STREAM. + + XX is read in copy mode, i.e., already formatted elements are + ignored. Consequently, diversions must be unformatted with the + `asciify' request before calling `writem'. Usually, this means a + loss of information. + + - Request: .close stream + Close the specified STREAM; the stream is no longer an acceptable + argument to the `write' request. + + Here a simple macro to write an index entry. + + + .open idx test.idx + . + .de IX + . write idx \\n[%] \\$* + .. + . + .IX test entry + . + .close idx + + + - Escape: \VE + - Escape: \V(EV + - Escape: \V[ENV] + Interpolate the contents of the specified environment variable ENV + (one-character name E, two-character name EV) as returned by the + function `getenv'. `\V' is interpreted in copy-in mode. + + +File: groff, Node: Postprocessor Access, Next: Miscellaneous, Prev: I/O, Up: gtroff Reference + +Postprocessor Access +==================== + + There are two escapes which give information directly to the +postprocessor. This is particularly useful for embedding POSTSCRIPT +into the final document. + + - Escape: \X'XXX' + Embeds its argument into the `gtroff' output preceded with `x X'. + + The escapes `\&', `\)', `\%', and `\:' are ignored within `\X', + `\ ' and `\~' are converted to single space characters. All other + escapes (except `\\' which produces a backslash) cause an error. + + If the `use_charnames_in_special' keyword is set in the `DESC' + file, special characters no longer cause an error; the name XX is + represented as `\(XX)' in the `x X' output command. Additionally, + the backslash is represented as `\\'. + + `use_charnames_in_special' is currently used by `grohtml' only. + + - Escape: \YN + - Escape: \Y(NM + - Escape: \Y[NAME] + This is approximately equivalent to `\X'\*[NAME]'' (one-character + name N, two-character name NM). However, the contents of the + string or macro NAME are not interpreted; also it is permitted for + NAME to have been defined as a macro and thus contain newlines (it + is not permitted for the argument to `\X' to contain newlines). + The inclusion of newlines requires an extension to the UNIX `troff' + output format, and confuses drivers that do not know about this + extension (*note Device Control Commands::). + + *Note Output Devices::. + + +File: groff, Node: Miscellaneous, Next: Gtroff Internals, Prev: Postprocessor Access, Up: gtroff Reference + +Miscellaneous +============= + + This section documents parts of `gtroff' which cannot (yet) be +categorized elsewhere in this manual. + + - Request: .nm [start [inc [space [indent]]]] + Print line numbers. START is the line number of the _next_ output + line. INC indicates which line numbers are printed. For example, + the value 5 means to emit only line numbers which are multiples + of 5; this defaults to 1. SPACE is the space to be left between + the number and the text; this defaults to one digit space. The + fourth argument is the indentation of the line numbers, defaulting + to zero. Both SPACE and INDENT are given as multiples of digit + spaces; they can be negative also. Without any arguments, line + numbers are turned off. + + `gtroff' reserves three digit spaces for the line number (which is + printed right-justified) plus the amount given by INDENT; the + output lines are concatenated to the line numbers, separated by + SPACE, and _without_ reducing the line length. Depending on the + value of the horizontal page offset (as set with the `po' + request), line numbers which are longer than the reserved space + stick out to the left, or the whole line is moved to the right. + + Parameters corresponding to missing arguments are not changed; any + non-digit argument (to be more precise, any argument starting with + a character valid as a delimiter for identifiers) is also treated + as missing. + + If line numbering has been disabled with a call to `nm' without an + argument, it can be reactivated with `.nm +0', using the + previously active line numbering parameters. + + The parameters of `nm' are associated with the current environment + (*note Environments::). The current output line number is + available in the number register `ln'. + + + .po 1m + .ll 2i + This test shows how line numbering works with groff. + .nm 999 + This test shows how line numbering works with groff. + .br + .nm xxx 3 2 + .ll -\w'0'u + This test shows how line numbering works with groff. + .nn 2 + This test shows how line numbering works with groff. + + And here the result: + + + This test shows how + line numbering works + 999 with groff. This + 1000 test shows how line + 1001 numbering works with + 1002 groff. + This test shows how + line numbering + works with groff. + This test shows how + 1005 line numbering + works with groff. + + + - Request: .nn [skip] + Temporarily turn off line numbering. The argument is the number + of lines not to be numbered; this defaults to 1. + + - Request: .mc glyph [dist] + Print a "margin character" to the right of the text.(1) (*note + Miscellaneous-Footnote-1::) The first argument is the glyph to be + printed. The second argument is the distance away from the right + margin. If missing, the previously set value is used; default is + 10pt). For text lines that are too long (that is, longer than the + text length plus DIST), the margin character is directly appended + to the lines. + + With no arguments the margin character is turned off. If this + occurs before a break, no margin character is printed. + + For empty lines and lines produced by the `tl' request no margin + character is emitted. + + The margin character is associated with the current environment + (*note Environments::). + + This is quite useful for indicating text that has changed, and, in + fact, there are programs available for doing this (they are called + `nrchbar' and `changebar' and can be found in any + `comp.sources.unix' archive. + + + .ll 3i + .mc | + This paragraph is highlighted with a margin + character. + .sp + Note that vertical space isn't marked. + .br + \& + .br + But we can fake it with `\&'. + + Result: + + + This paragraph is highlighted | + with a margin character. | + + Note that vertical space isn't | + marked. | + | + But we can fake it with `\&'. | + + + - Request: .psbb filename + - Register: \n[llx] + - Register: \n[lly] + - Register: \n[urx] + - Register: \n[ury] + Retrieve the bounding box of the PostScript image found in + FILENAME. The file must conform to Adobe's "Document Structuring + Conventions" (DSC); the command searches for a `%%BoundingBox' + comment and extracts the bounding box values into the number + registers `llx', `lly', `urx', and `ury'. If an error occurs (for + example, `psbb' cannot find the `%%BoundingBox' comment), it sets + the four number registers to zero. + + +File: groff, Node: Miscellaneous-Footnotes, Up: Miscellaneous + + (1) "Margin character" is a misnomer since it is an output glyph. + + +File: groff, Node: Gtroff Internals, Next: Debugging, Prev: Miscellaneous, Up: gtroff Reference + +`gtroff' Internals +================== + + `gtroff' processes input in three steps. One or more input +characters are converted to an "input token".(1) (*note Gtroff +Internals-Footnote-1::) Then, one or more input tokens are converted +to an "output node". Finally, output nodes are converted to the +intermediate output language understood by all output devices. + + Actually, before step one happens, `gtroff' converts certain escape +sequences into reserved input characters (not accessible by the user); +such reserved characters are used for other internal processing also - +this is the very reason why not all characters are valid input. *Note +Identifiers::, for more on this topic. + + For example, the input string `fi\[:u]' is converted into a +character token `f', a character token `i', and a special token `:u' +(representing u umlaut). Later on, the character tokens `f' and `i' +are merged to a single output node representing the ligature glyph `fi' +(provided the current font has a glyph for this ligature); the same +happens with `:u'. All output glyph nodes are `processed' which means +that they are invariably associated with a given font, font size, +advance width, etc. During the formatting process, `gtroff' itself +adds various nodes to control the data flow. + + Macros, diversions, and strings collect elements in two chained +lists: a list of input tokens which have been passed unprocessed, and a +list of output nodes. Consider the following the diversion. + + + .di xxx + a + \!b + c + .br + .di + +It contains these elements. + +node list token list element number +line start node -- 1 +glyph node `a' -- 2 +word space node -- 3 +-- `b' 4 +-- `\n' 5 +glyph node `c' -- 6 +vertical size node -- 7 +vertical size node -- 8 +-- `\n' 9 + +Elements 1, 7, and 8 are inserted by `gtroff'; the latter two (which +are always present) specify the vertical extent of the last line, +possibly modified by `\x'. The `br' request finishes the current +partial line, inserting a newline input token which is subsequently +converted to a space when the diversion is reread. Note that the word +space node has a fixed width which isn't stretchable anymore. To +convert horizontal space nodes back to input tokens, use the `unformat' +request. + + Macros only contain elements in the token list (and the node list is +empty); diversions and strings can contain elements in both lists. + + Note that the `chop' request simply reduces the number of elements +in a macro, string, or diversion by one. Exceptions are "compatibility +save" and "compatibility ignore" input tokens which are ignored. The +`substring' request also ignores those input tokens. + + Some requests like `tr' or `cflags' work on glyph identifiers only; +this means that the associated glyph can be changed without destroying +this association. This can be very helpful for substituting glyphs. +In the following example, we assume that glyph `foo' isn't available by +default, so we provide a substitution using the `fchar' request and map +it to input character `x'. + + + .fchar \[foo] foo + .tr x \[foo] + +Now let us assume that we install an additional special font `bar' +which has glyph `foo'. + + + .special bar + .rchar \[foo] + +Since glyphs defined with `fchar' are searched before glyphs in special +fonts, we must call `rchar' to remove the definition of the fallback +glyph. Anyway, the translation is still active; `x' now maps to the +real glyph `foo'. + + +File: groff, Node: Gtroff Internals-Footnotes, Up: Gtroff Internals + + (1) Except the escapes `\f', `\F', `\H', `\m', `\M', `\R', `\s', and +`\S' which are processed immediately if not in copy-in mode. + + +File: groff, Node: Debugging, Next: Implementation Differences, Prev: Gtroff Internals, Up: gtroff Reference + +Debugging +========= + + `gtroff' is not easy to debug, but there are some useful features +and strategies for debugging. + + - Request: .lf line filename + Change the line number and the file name `gtroff' shall use for + error and warning messages. LINE is the input line number of the + _next_ line. + + Without argument, the request is ignored. + + This is a debugging aid for documents which are split into many + files, then put together with `soelim' and other preprocessors. + Usually, it isn't invoked manually. + + - Request: .tm string + - Request: .tm1 string + - Request: .tmc string + Send STRING to the standard error output; this is very useful for + printing debugging messages among other things. + + STRING is read in copy mode. + + The `tm' request ignores leading spaces of STRING; `tm1' handles + its argument similar to the `ds' request: a leading double quote + in STRING is stripped to allow initial blanks. + + The `tmc' request is similar to `tm1' but does not append a + newline (as is done in `tm' and `tm1'). + + - Request: .ab [string] + Similar to the `tm' request, except that it causes `gtroff' to + stop processing. With no argument it prints `User Abort.' to + standard error. + + - Request: .ex + The `ex' request also causes `gtroff' to stop processing; see also + *Note I/O::. + + When doing something involved it is useful to leave the debugging +statements in the code and have them turned on by a command line flag. + + + .if \n(DB .tm debugging output + +To activate these statements say + + + groff -rDB=1 file + + If it is known in advance that there will be many errors and no +useful output, `gtroff' can be forced to suppress formatted output with +the `-z' flag. + + - Request: .pm + Print the entire symbol table on `stderr'. Names of all defined + macros, strings, and diversions are print together with their size + in bytes. Since `gtroff' sometimes adds nodes by itself, the + returned size can be larger than expected. + + This request differs from UNIX `troff': `gtroff' reports the sizes + of diversions, ignores an additional argument to print only the + total of the sizes, and the size isn't returned in blocks of 128 + characters. + + - Request: .pnr + Print the names and contents of all currently defined number + registers on `stderr'. + + - Request: .ptr + Print the names and positions of all traps (not including input + line traps and diversion traps) on `stderr'. Empty slots in the + page trap list are printed as well, because they can affect the + priority of subsequently planted traps. + + - Request: .fl + Instruct `gtroff' to flush its output immediately. The intent is + for interactive use, but this behaviour is currently not + implemented in `gtroff'. Contrary to UNIX `troff', TTY output is + sent to a device driver also (`grotty'), making it non-trivial to + communicate interactively. + + This request causes a line break. + + - Request: .backtrace + Print a backtrace of the input stack to the standard error stream. + + Consider the following in file `test': + + + .de xxx + . backtrace + .. + .de yyy + . xxx + .. + . + .yyy + + On execution, `gtroff' prints the following: + + + test:2: backtrace: macro `xxx' + test:5: backtrace: macro `yyy' + test:8: backtrace: file `test' + + The option `-b' of `gtroff' internally calls a variant of this + request on each error and warning. + + - Register: \n[slimit] + Use the `slimit' number register to set the maximum number of + objects on the input stack. If `slimit' is less than or equal + to 0, there is no limit set. With no limit, a buggy recursive + macro can exhaust virtual memory. + + The default value is 1000; this is a compile-time constant. + + - Request: .warnscale si + Set the scaling indicator used in warnings to SI. Valid values for + SI are `u', `i', `c', `p', and `P'. At startup, it is set to `i'. + + - Request: .spreadwarn [limit] + Make `gtroff' emit a warning if the additional space inserted for + each space between words in an output line is larger or equal to + LIMIT. A negative value is changed to zero; no argument toggles + the warning on and off without changing LIMIT. The default scaling + indicator is `m'. At startup, `spreadwarn' is deactivated, and + LIMIT is set to 3m. + + For example, + + + .spreadwarn 0.2m + + will cause a warning if `gtroff' must add 0.2m or more for each + interword space in a line. + + This request is active only if text is justified to both margins + (using `.ad b'). + + `gtroff' has command line options for printing out more warnings +(`-w') and for printing backtraces (`-b') when a warning or an error +occurs. The most verbose level of warnings is `-ww'. + + - Request: .warn [flags] + - Register: \n[.warn] + Control the level of warnings checked for. The FLAGS are the sum + of the numbers associated with each warning that is to be enabled; + all other warnings are disabled. The number associated with each + warning is listed below. For example, `.warn 0' disables all + warnings, and `.warn 1' disables all warnings except that about + missing glyphs. If no argument is given, all warnings are enabled. + + The read-only number register `.warn' contains the current warning + level. + +* Menu: + +* Warnings:: + + +File: groff, Node: Warnings, Prev: Debugging, Up: Debugging + +Warnings +-------- + + The warnings that can be given to `gtroff' are divided into the +following categories. The name associated with each warning is used by +the `-w' and `-W' options; the number is used by the `warn' request and +by the `.warn' register. + +`char' +`1' + Non-existent glyphs.(1) (*note Warnings-Footnote-1::) This is + enabled by default. + +`number' +`2' + Invalid numeric expressions. This is enabled by default. *Note + Expressions::. + +`break' +`4' + In fill mode, lines which could not be broken so that their length + was less than the line length. This is enabled by default. + +`delim' +`8' + Missing or mismatched closing delimiters. + +`el' +`16' + Use of the `el' request with no matching `ie' request. *Note + if-else::. + +`scale' +`32' + Meaningless scaling indicators. + +`range' +`64' + Out of range arguments. + +`syntax' +`128' + Dubious syntax in numeric expressions. + +`di' +`256' + Use of `di' or `da' without an argument when there is no current + diversion. + +`mac' +`512' + Use of undefined strings, macros and diversions. When an undefined + string, macro, or diversion is used, that string is automatically + defined as empty. So, in most cases, at most one warning is given + for each name. + +`reg' +`1024' + Use of undefined number registers. When an undefined number + register is used, that register is automatically defined to have a + value of 0. So, in most cases, at most one warning is given for + use of a particular name. + +`tab' +`2048' + Use of a tab character where a number was expected. + +`right-brace' +`4096' + Use of `\}' where a number was expected. + +`missing' +`8192' + Requests that are missing non-optional arguments. + +`input' +`16384' + Invalid input characters. + +`escape' +`32768' + Unrecognized escape sequences. When an unrecognized escape + sequence `\X' is encountered, the escape character is ignored, and + X is printed. + +`space' +`65536' + Missing space between a request or macro and its argument. This + warning is given when an undefined name longer than two characters + is encountered, and the first two characters of the name make a + defined name. The request or macro is not invoked. When this + warning is given, no macro is automatically defined. This is + enabled by default. This warning never occurs in compatibility + mode. + +`font' +`131072' + Non-existent fonts. This is enabled by default. + +`ig' +`262144' + Invalid escapes in text ignored with the `ig' request. These are + conditions that are errors when they do not occur in ignored text. + +`color' +`524288' + Color related warnings. + +`all' + All warnings except `di', `mac' and `reg'. It is intended that + this covers all warnings that are useful with traditional macro + packages. + +`w' + All warnings. + + +File: groff, Node: Warnings-Footnotes, Up: Warnings + + (1) `char' is a misnomer since it reports missing glyphs - there +aren't missing input characters, only invalid ones. + + +File: groff, Node: Implementation Differences, Prev: Debugging, Up: gtroff Reference + +Implementation Differences +========================== + + GNU `troff' has a number of features which cause incompatibilities +with documents written with old versions of `troff'. + + Long names cause some incompatibilities. UNIX `troff' interprets + + + .dsabcd + +as defining a string `ab' with contents `cd'. Normally, GNU `troff' +interprets this as a call of a macro named `dsabcd'. Also UNIX `troff' +interprets `\*[' or `\n[' as references to a string or number register +called `['. In GNU `troff', however, this is normally interpreted as +the start of a long name. In compatibility mode GNU `troff' interprets +long names in the traditional way (which means that they are not +recognized as names). + + - Request: .cp [n] + - Request: .do cmd + - Register: \n[.C] + If N is missing or non-zero, turn on compatibility mode; + otherwise, turn it off. + + The read-only number register `.C' is 1 if compatibility mode is + on, 0 otherwise. + + Compatibility mode can be also turned on with the `-C' command line + option. + + The `do' request turns off compatibility mode while executing its + arguments as a `gtroff' command. + + + .do fam T + + executes the `fam' request when compatibility mode is enabled. + + `gtroff' restores the previous compatibility setting before + interpreting any files sourced by the CMD. + + Two other features are controlled by `-C'. If not in compatibility +mode, GNU `troff' preserves the input level in delimited arguments: + + + .ds xx ' + \w'abc\*(xxdef' + +In compatibility mode, the string `72def'' is returned; without `-C' +the resulting string is `168' (assuming a TTY output device). + + Finally, the escapes `\f', `\H', `\m', `\M', `\R', `\s', and `\S' +are transparent for recognizing the beginning of a line only in +compatibility mode (this is a rather obscure feature). For example, +the code + + + .de xx + Hallo! + .. + \fB.xx\fP + + prints `Hallo!' in bold face if in compatibility mode, and `.xx' in +bold face otherwise. + + GNU `troff' does not allow the use of the escape sequences `\|', +`\^', `\&', `\{', `\}', `\<SP>', `\'', `\`', `\-', `\_', `\!', `\%', +and `\c' in names of strings, macros, diversions, number registers, +fonts or environments; UNIX `troff' does. The `\A' escape sequence +(*note Identifiers::) may be helpful in avoiding use of these escape +sequences in names. + + Fractional point sizes cause one noteworthy incompatibility. In +UNIX `troff' the `ps' request ignores scale indicators and thus + + + .ps 10u + +sets the point size to 10 points, whereas in GNU `troff' it sets the +point size to 10 scaled points. *Note Fractional Type Sizes::, for +more information. + + In GNU `troff' there is a fundamental difference between +(unformatted) input characters and (formatted) output glyphs. +Everything that affects how a glyph is output is stored with the glyph +node; once a glyph node has been constructed it is unaffected by any +subsequent requests that are executed, including `bd', `cs', `tkf', +`tr', or `fp' requests. Normally glyphs are constructed from input +characters at the moment immediately before the glyph is added to the +current output line. Macros, diversions and strings are all, in fact, +the same type of object; they contain lists of input characters and +glyph nodes in any combination. A glyph node does not behave like an +input character for the purposes of macro processing; it does not +inherit any of the special properties that the input character from +which it was constructed might have had. For example, + + + .di x + \\\\ + .br + .di + .x + +prints `\\' in GNU `troff'; each pair of input backslashes is turned +into one output backslash and the resulting output backslashes are not +interpreted as escape characters when they are reread. UNIX `troff' +would interpret them as escape characters when they were reread and +would end up printing one `\'. The correct way to obtain a printable +backslash is to use the `\e' escape sequence: This always prints a +single instance of the current escape character, regardless of whether +or not it is used in a diversion; it also works in both GNU `troff' and +UNIX `troff'.(1) (*note Implementation Differences-Footnote-1::) To +store, for some reason, an escape sequence in a diversion that will be +interpreted when the diversion is reread, either use the traditional +`\!' transparent output facility, or, if this is unsuitable, the new +`\?' escape sequence. + + *Note Diversions::, and *Note Gtroff Internals::, for more +information. + + +File: groff, Node: Implementation Differences-Footnotes, Up: Implementation Differences + + (1) To be completely independent of the current escape character, +use `\(rs' which represents a reverse solidus (backslash) glyph. + + +File: groff, Node: Preprocessors, Next: Output Devices, Prev: gtroff Reference, Up: Top + +Preprocessors +************* + + This chapter describes all preprocessors that come with `groff' or +which are freely available. + +* Menu: + +* geqn:: +* gtbl:: +* gpic:: +* ggrn:: +* grap:: +* grefer:: +* gsoelim:: + + +File: groff, Node: geqn, Next: gtbl, Prev: Preprocessors, Up: Preprocessors + +`geqn' +====== + +* Menu: + +* Invoking geqn:: + + +File: groff, Node: Invoking geqn, Prev: geqn, Up: geqn + +Invoking `geqn' +--------------- + + +File: groff, Node: gtbl, Next: gpic, Prev: geqn, Up: Preprocessors + +`gtbl' +====== + +* Menu: + +* Invoking gtbl:: + + +File: groff, Node: Invoking gtbl, Prev: gtbl, Up: gtbl + +Invoking `gtbl' +--------------- + + +File: groff, Node: gpic, Next: ggrn, Prev: gtbl, Up: Preprocessors + +`gpic' +====== + +* Menu: + +* Invoking gpic:: + + +File: groff, Node: Invoking gpic, Prev: gpic, Up: gpic + +Invoking `gpic' +--------------- + + +File: groff, Node: ggrn, Next: grap, Prev: gpic, Up: Preprocessors + +`ggrn' +====== + +* Menu: + +* Invoking ggrn:: + + +File: groff, Node: Invoking ggrn, Prev: ggrn, Up: ggrn + +Invoking `ggrn' +--------------- + + +File: groff, Node: grap, Next: grefer, Prev: ggrn, Up: Preprocessors + +`grap' +====== + + A free implementation of `grap', written by Ted Faber, is available +as an extra package from the following address: + + <http://www.lunabase.org/~faber/Vault/software/grap/> + + +File: groff, Node: grefer, Next: gsoelim, Prev: grap, Up: Preprocessors + +`grefer' +======== + +* Menu: + +* Invoking grefer:: + + +File: groff, Node: Invoking grefer, Prev: grefer, Up: grefer + +Invoking `grefer' +----------------- + + +File: groff, Node: gsoelim, Prev: grefer, Up: Preprocessors + +`gsoelim' +========= + +* Menu: + +* Invoking gsoelim:: + + +File: groff, Node: Invoking gsoelim, Prev: gsoelim, Up: gsoelim + +Invoking `gsoelim' +------------------ + + +File: groff, Node: Output Devices, Next: File formats, Prev: Preprocessors, Up: Top + +Output Devices +************** + +* Menu: + +* Special Characters:: +* grotty:: +* grops:: +* grodvi:: +* grolj4:: +* grolbp:: +* grohtml:: +* gxditview:: + + +File: groff, Node: Special Characters, Next: grotty, Prev: Output Devices, Up: Output Devices + +Special Characters +================== + + *Note Font Files::. + + +File: groff, Node: grotty, Next: grops, Prev: Special Characters, Up: Output Devices + +`grotty' +======== + +* Menu: + +* Invoking grotty:: + + +File: groff, Node: Invoking grotty, Prev: grotty, Up: grotty + +Invoking `grotty' +----------------- + diff --git a/contrib/groff/doc/groff-8 b/contrib/groff/doc/groff-8 new file mode 100644 index 0000000..540f8fd --- /dev/null +++ b/contrib/groff/doc/groff-8 @@ -0,0 +1,1268 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: grops, Next: grodvi, Prev: grotty, Up: Output Devices + +`grops' +======= + +* Menu: + +* Invoking grops:: +* Embedding PostScript:: + + +File: groff, Node: Invoking grops, Next: Embedding PostScript, Prev: grops, Up: grops + +Invoking `grops' +---------------- + + +File: groff, Node: Embedding PostScript, Prev: Invoking grops, Up: grops + +Embedding POSTSCRIPT +-------------------- + + +File: groff, Node: grodvi, Next: grolj4, Prev: grops, Up: Output Devices + +`grodvi' +======== + +* Menu: + +* Invoking grodvi:: + + +File: groff, Node: Invoking grodvi, Prev: grodvi, Up: grodvi + +Invoking `grodvi' +----------------- + + +File: groff, Node: grolj4, Next: grolbp, Prev: grodvi, Up: Output Devices + +`grolj4' +======== + +* Menu: + +* Invoking grolj4:: + + +File: groff, Node: Invoking grolj4, Prev: grolj4, Up: grolj4 + +Invoking `grolj4' +----------------- + + +File: groff, Node: grolbp, Next: grohtml, Prev: grolj4, Up: Output Devices + +`grolbp' +======== + +* Menu: + +* Invoking grolbp:: + + +File: groff, Node: Invoking grolbp, Prev: grolbp, Up: grolbp + +Invoking `grolbp' +----------------- + + +File: groff, Node: grohtml, Next: gxditview, Prev: grolbp, Up: Output Devices + +`grohtml' +========= + +* Menu: + +* Invoking grohtml:: +* grohtml specific registers and strings:: + + +File: groff, Node: Invoking grohtml, Next: grohtml specific registers and strings, Prev: grohtml, Up: grohtml + +Invoking `grohtml' +------------------ + + +File: groff, Node: grohtml specific registers and strings, Prev: Invoking grohtml, Up: grohtml + +`grohtml' specific registers and strings +---------------------------------------- + + - Register: \n[ps4html] + - String: \*[www-image-template] + The registers `ps4html' and `www-image-template' are defined by + the `pre-grohtml' preprocessor. `pre-grohtml' reads in the + `troff' input, marks up the inline equations and passes the result + firstly to + + + troff -Tps -rps4html=1 -dwww-image-template=TEMPLATE + + and secondly to + + + troff -Thtml + + The PostScript device is used to create all the image files, and + the register `ps4html' enables the macro sets to ignore floating + keeps, footers, and headings. + + The register `www-image-template' is set to the user specified + template name or the default name. + + +File: groff, Node: gxditview, Prev: grohtml, Up: Output Devices + +`gxditview' +=========== + +* Menu: + +* Invoking gxditview:: + + +File: groff, Node: Invoking gxditview, Prev: gxditview, Up: gxditview + +Invoking `gxditview' +-------------------- + + +File: groff, Node: File formats, Next: Installation, Prev: Output Devices, Up: Top + +File formats +************ + + All files read and written by `gtroff' are text files. The +following two sections describe their format. + +* Menu: + +* gtroff Output:: +* Font Files:: + + +File: groff, Node: gtroff Output, Next: Font Files, Prev: File formats, Up: File formats + +`gtroff' Output +=============== + + This section describes the intermediate output format of GNU +`troff'. This output is produced by a run of `gtroff' before it is fed +into a device postprocessor program. + + As `groff' is a wrapper program around `gtroff' that automatically +calls a postprocessor, this output does not show up normally. This is +why it is called "intermediate". `groff' provides the option `-Z' to +inhibit postprocessing, such that the produced intermediate output is +sent to standard output just like calling `gtroff' manually. + + Here, the term "troff output" describes what is output by `gtroff', +while "intermediate output" refers to the language that is accepted by +the parser that prepares this output for the postprocessors. This +parser is smarter on whitespace and implements obsolete elements for +compatibility, otherwise both formats are the same.(1) (*note gtroff +Output-Footnote-1::) + + The main purpose of the intermediate output concept is to facilitate +the development of postprocessors by providing a common programming +interface for all devices. It has a language of its own that is +completely different from the `gtroff' language. While the `gtroff' +language is a high-level programming language for text processing, the +intermediate output language is a kind of low-level assembler language +by specifying all positions on the page for writing and drawing. + + The intermediate output produced by `gtroff' is fairly readable, +while output from AT&T `troff' is rather hard to understand because of +strange habits that are still supported, but not used any longer by +`gtroff'. + +* Menu: + +* Language Concepts:: +* Command Reference:: +* Intermediate Output Examples:: +* Output Language Compatibility:: + + +File: groff, Node: gtroff Output-Footnotes, Up: gtroff Output + + (1) The parser and postprocessor for intermediate output can be +found in the file +`GROFF-SOURCE-DIR/src/libs/libdriver/input.cc'. + + +File: groff, Node: Language Concepts, Next: Command Reference, Prev: gtroff Output, Up: gtroff Output + +Language Concepts +----------------- + + During the run of `gtroff', the input data is cracked down to the +information on what has to be printed at what position on the intended +device. So the language of the intermediate output format can be quite +small. Its only elements are commands with and without arguments. In +this section, the term "command" always refers to the intermediate +output language, and never to the `gtroff' language used for document +formatting. There are commands for positioning and text writing, for +drawing, and for device controlling. + +* Menu: + +* Separation:: +* Argument Units:: +* Document Parts:: + + +File: groff, Node: Separation, Next: Argument Units, Prev: Language Concepts, Up: Language Concepts + +Separation +.......... + + AT&T `troff' output has strange requirements on whitespace. The +`gtroff' output parser, however, is smart about whitespace by making it +maximally optional. The whitespace characters, i.e., the tab, space, +and newline characters, always have a syntactical meaning. They are +never printable because spacing within the output is always done by +positioning commands. + + Any sequence of space or tab characters is treated as a single +"syntactical space". It separates commands and arguments, but is only +required when there would occur a clashing between the command code and +the arguments without the space. Most often, this happens when +variable-length command names, arguments, argument lists, or command +clusters meet. Commands and arguments with a known, fixed length need +not be separated by syntactical space. + + A line break is a syntactical element, too. Every command argument +can be followed by whitespace, a comment, or a newline character. Thus +a "syntactical line break" is defined to consist of optional +syntactical space that is optionally followed by a comment, and a +newline character. + + The normal commands, those for positioning and text, consist of a +single letter taking a fixed number of arguments. For historical +reasons, the parser allows to stack such commands on the same line, but +fortunately, in `gtroff''s intermediate output, every command with at +least one argument is followed by a line break, thus providing +excellent readability. + + The other commands - those for drawing and device controlling - have +a more complicated structure; some recognize long command names, and +some take a variable number of arguments. So all `D' and `x' commands +were designed to request a syntactical line break after their last +argument. Only one command, `x X', has an argument that can stretch +over several lines; all other commands must have all of their arguments +on the same line as the command, i.e., the arguments may not be +splitted by a line break. + + Empty lines (these are lines containing only space and/or a +comment), can occur everywhere. They are just ignored. + + +File: groff, Node: Argument Units, Next: Document Parts, Prev: Separation, Up: Language Concepts + +Argument Units +.............. + + Some commands take integer arguments that are assumed to represent +values in a measurement unit, but the letter for the corresponding +scale indicator is not written with the output command arguments. Most +commands assume the scale indicator `u', the basic unit of the device, +some use `z', the scaled point unit of the device, while others, such +as the color commands, expect plain integers. + + Note that single characters can have the eighth bit set, as can the +names of fonts and special characters. The names of characters and +fonts can be of arbitrary length. A character that is to be printed +will always be in the current font. + + A string argument is always terminated by the next whitespace +character (space, tab, or newline); an embedded `#' character is +regarded as part of the argument, not as the beginning of a comment +command. An integer argument is already terminated by the next +non-digit character, which then is regarded as the first character of +the next argument or command. + + +File: groff, Node: Document Parts, Prev: Argument Units, Up: Language Concepts + +Document Parts +.............. + + A correct intermediate output document consists of two parts, the +"prologue" and the "body". + + The task of the prologue is to set the general device parameters +using three exactly specified commands. `gtroff''s prologue is +guaranteed to consist of the following three lines (in that order): + + + x T DEVICE + x res N H V + x init + +with the arguments set as outlined in *Note Device Control Commands::. +Note that the parser for the intermediate output format is able to +swallow additional whitespace and comments as well even in the prologue. + + The body is the main section for processing the document data. +Syntactically, it is a sequence of any commands different from the ones +used in the prologue. Processing is terminated as soon as the first +`x stop' command is encountered; the last line of any `gtroff' +intermediate output always contains such a command. + + Semantically, the body is page oriented. A new page is started by a +`p' command. Positioning, writing, and drawing commands are always +done within the current page, so they cannot occur before the first `p' +command. Absolute positioning (by the `H' and `V' commands) is done +relative to the current page; all other positioning is done relative to +the current location within this page. + + +File: groff, Node: Command Reference, Next: Intermediate Output Examples, Prev: Language Concepts, Up: gtroff Output + +Command Reference +----------------- + + This section describes all intermediate output commands, both from +AT&T `troff' as well as the `gtroff' extensions. + +* Menu: + +* Comment Command:: +* Simple Commands:: +* Graphics Commands:: +* Device Control Commands:: +* Obsolete Command:: + + +File: groff, Node: Comment Command, Next: Simple Commands, Prev: Command Reference, Up: Command Reference + +Comment Command +............... + +`#ANYTHING<end of line>' + A comment. Ignore any characters from the `#' character up to the + next newline character. + + This command is the only possibility for commenting in the + intermediate output. Each comment can be preceded by arbitrary + syntactical space; every command can be terminated by a comment. + + +File: groff, Node: Simple Commands, Next: Graphics Commands, Prev: Comment Command, Up: Command Reference + +Simple Commands +............... + + The commands in this subsection have a command code consisting of a +single character, taking a fixed number of arguments. Most of them are +commands for positioning and text writing. These commands are smart +about whitespace. Optionally, syntactical space can be inserted +before, after, and between the command letter and its arguments. All +of these commands are stackable, i.e., they can be preceded by other +simple commands or followed by arbitrary other commands on the same +line. A separating syntactical space is only necessary when two +integer arguments would clash or if the preceding argument ends with a +string argument. + +`C XXX<whitespace>' + Print a special character named XXX. The trailing syntactical + space or line break is necessary to allow glyph names of arbitrary + length. The glyph is printed at the current print position; the + glyph's size is read from the font file. The print position is + not changed. + +`c G' + Print glyph G at the current print position;(1) (*note Simple + Commands-Footnote-1::) the glyph's size is read from the font + file. The print position is not changed. + +`f N' + Set font to font number N (a non-negative integer). + +`H N' + Move right to the absolute vertical position N (a non-negative + integer in basic units `u' relative to left edge of current page. + +`h N' + Move N (a non-negative integer) basic units `u' horizontally to + the right. The original UNIX troff manual allows negative values + for N also, but `gtroff' doesn't use this. + +`m COLOR-SCHEME [COMPONENT ...]' + Set the color for text (glyphs), line drawing, and the outline of + graphic objects using different color schemes; the analoguous + command for the filling color of graphic objects is `DF'. The + color components are specified as integer arguments between 0 and + 65536. The number of color components and their meaning vary for + the different color schemes. These commands are generated by + `gtroff''s escape sequence `\m'. No position changing. These + commands are a `gtroff' extension. + + `mc CYAN MAGENTA YELLOW' + Set color using the CMY color scheme, having the 3 color + components CYAN, MAGENTA, and YELLOW. + + `md' + Set color to the default color value (black in most cases). + No component arguments. + + `mg GRAY' + Set color to the shade of gray given by the argument, an + integer between 0 (black) and 65536 (white). + + `mk CYAN MAGENTA YELLOW BLACK' + Set color using the CMYK color scheme, having the 4 color + components CYAN, MAGENTA, YELLOW, and BLACK. + + `mr RED GREEN BLUE' + Set color using the RGB color scheme, having the 3 color + components RED, GREEN, and BLUE. + +`N N' + Print glyph with index N (a non-negative integer) of the current + font. This command is a `gtroff' extension. + +`n B A' + Inform the device about a line break, but no positioning is done by + this command. In AT&T `troff', the integer arguments B and A + informed about the space before and after the current line to make + the intermediate output more human readable without performing any + action. In `groff', they are just ignored, but they must be + provided for compatibility reasons. + +`p N' + Begin a new page in the outprint. The page number is set to N. + This page is completely independent of pages formerly processed + even if those have the same page number. The vertical position on + the outprint is automatically set to 0. All positioning, writing, + and drawing is always done relative to a page, so a `p' command + must be issued before any of these commands. + +`s N' + Set point size to N scaled points (this is unit `z'). AT&T + `troff' used the unit points (`p') instead. *Note Output Language + Compatibility::. + +`t XXX<whitespace>' +`t XXX DUMMY-ARG<whitespace>' + Print a word, i.e., a sequence of characters XXX representing + output glyphs which names are single characters, terminated by a + space character or a line break; an optional second integer + argument is ignored (this allows the formatter to generate an even + number of arguments). The first glyph should be printed at the + current position, the current horizontal position should then be + increased by the width of the first glyph, and so on for each + glyph. The widths of the glyphs are read from the font file, + scaled for the current point size, and rounded to a multiple of + the horizontal resolution. Special characters cannot be printed + using this command (use the `C' command for special characters). + This command is a `gtroff' extension; it is only used for devices + whose `DESC' file contains the `tcommand' keyword (*note DESC File + Format::). + +`u N XXX<whitespace>' + Print word with track kerning. This is the same as the `t' + command except that after printing each glyph, the current + horizontal position is increased by the sum of the width of that + glyph and N (an integer in basic units `u'). This command is a + `gtroff' extension; it is only used for devices whose `DESC' file + contains the `tcommand' keyword (*note DESC File Format::). + +`V N' + Move down to the absolute vertical position N (a non-negative + integer in basic units `u') relative to upper edge of current page. + +`v N' + Move N basic units `u' down (N is a non-negative integer). The + original UNIX troff manual allows negative values for N also, but + `gtroff' doesn't use this. + +`w' + Informs about a paddable white space to increase readability. The + spacing itself must be performed explicitly by a move command. + + +File: groff, Node: Simple Commands-Footnotes, Up: Simple Commands + + (1) `c' is actually a misnomer since it outputs a glyph. + + +File: groff, Node: Graphics Commands, Next: Device Control Commands, Prev: Simple Commands, Up: Command Reference + +Graphics Commands +................. + + Each graphics or drawing command in the intermediate output starts +with the letter `D', followed by one or two characters that specify a +subcommand; this is followed by a fixed or variable number of integer +arguments that are separated by a single space character. A `D' +command may not be followed by another command on the same line (apart +from a comment), so each `D' command is terminated by a syntactical +line break. + + `gtroff' output follows the classical spacing rules (no space +between command and subcommand, all arguments are preceded by a single +space character), but the parser allows optional space between the +command letters and makes the space before the first argument optional. +As usual, each space can be any sequence of tab and space characters. + + Some graphics commands can take a variable number of arguments. In +this case, they are integers representing a size measured in basic +units `u'. The arguments called H1, H2, ..., HN stand for horizontal +distances where positive means right, negative left. The arguments +called V1, V2, ..., VN stand for vertical distances where positive +means down, negative up. All these distances are offsets relative to +the current location. + + Unless indicated otherwise, each graphics command directly +corresponds to a similar `gtroff' `\D' escape sequence. *Note Drawing +Requests::. + + Unknown `D' commands are assumed to be device-specific. Its +arguments are parsed as strings; the whole information is then sent to +the postprocessor. + + In the following command reference, the syntax element <line break> +means a syntactical line break as defined above. + +`D~ H1 V1 H2 V2 ... HN VN<line break>' + Draw B-spline from current position to offset (H1,V1), then to + offset (H2,V2), if given, etc. up to (HN,VN). This command takes + a variable number of argument pairs; the current position is moved + to the terminal point of the drawn curve. + +`Da H1 V1 H2 V2<line break>' + Draw arc from current position to (H1,V1)+(H2,V2) with center at + (H1,V1); then move the current position to the final point of the + arc. + +`DC D<line break>' +`DC D DUMMY-ARG<line break>' + Draw a solid circle using the current fill color with diameter D + (integer in basic units `u') with leftmost point at the current + position; then move the current position to the rightmost point of + the circle. An optional second integer argument is ignored (this + allows the formatter to generate an even number of arguments). + This command is a `gtroff' extension. + +`Dc D<line break>' + Draw circle line with diameter D (integer in basic units `u') with + leftmost point at the current position; then move the current + position to the rightmost point of the circle. + +`DE H V<line break>' + Draw a solid ellipse in the current fill color with a horizontal + diameter of H and a vertical diameter of V (both integers in basic + units `u') with the leftmost point at the current position; then + move to the rightmost point of the ellipse. This command is a + `gtroff' extension. + +`De H V<line break>' + Draw an outlined ellipse with a horizontal diameter of H and a + vertical diameter of V (both integers in basic units `u') with the + leftmost point at current position; then move to the rightmost + point of the ellipse. + +`DF COLOR-SCHEME [COMPONENT ...]<line break>' + Set fill color for solid drawing objects using different color + schemes; the analoguous command for setting the color of text, line + graphics, and the outline of graphic objects is `m'. The color + components are specified as integer arguments between 0 and 65536. + The number of color components and their meaning vary for the + different color schemes. These commands are generated by + `gtroff''s escape sequences `\D'F ...'' and `\M' (with no other + corresponding graphics commands). No position changing. This + command is a `gtroff' extension. + + `DFc CYAN MAGENTA YELLOW<line break>' + Set fill color for solid drawing objects using the CMY color + scheme, having the 3 color components CYAN, MAGENTA, and + YELLOW. + + `DFd<line break>' + Set fill color for solid drawing objects to the default fill + color value (black in most cases). No component arguments. + + `DFg GRAY<line break>' + Set fill color for solid drawing objects to the shade of gray + given by the argument, an integer between 0 (black) and 65536 + (white). + + `DFk CYAN MAGENTA YELLOW BLACK<line break>' + Set fill color for solid drawing objects using the CMYK color + scheme, having the 4 color components CYAN, MAGENTA, YELLOW, + and BLACK. + + `DFr RED GREEN BLUE<line break>' + Set fill color for solid drawing objects using the RGB color + scheme, having the 3 color components RED, GREEN, and BLUE. + +`Df N<line break>' + The argument N must be an integer in the range -32767 to 32767. + + 0 <= N <= 1000 + Set the color for filling solid drawing objects to a shade of + gray, where 0 corresponds to solid white, 1000 (the default) + to solid black, and values in between to intermediate shades + of gray; this is obsoleted by command `DFg'. + + N < 0 or N < 1000 + Set the filling color to the color that is currently being + used for the text and the outline, see command `m'. For + example, the command sequence + + + mg 0 0 65536 + Df -1 + + sets all colors to blue. + + No position changing. This command is a `gtroff' extension. + +`Dl H V<line break>' + Draw line from current position to offset (H,V) (integers in basic + units `u'); then set current position to the end of the drawn line. + +`Dp H1 V1 H2 V2 ... HN VN<line break>' + Draw a polygon line from current position to offset (H1,V1), from + there to offset (H2,V2), etc. up to offset (HN,VN), and from there + back to the starting position. For historical reasons, the + position is changed by adding the sum of all arguments with odd + index to the actual horizontal position and the even ones to the + vertical position. Although this doesn't make sense it is kept + for compatibility. This command is a `gtroff' extension. + +`Dp H1 V1 H2 V2 ... HN VN<line break>' + Draw a solid polygon in the current fill color rather than an + outlined polygon, using the same arguments and positioning as the + corresponding `Dp' command. This command is a `gtroff' extension. + +`Dt N<line break>' + Set the current line thickness to N (an integer in basic units + `u') if N>0; if N=0 select the smallest available line thickness; + if N<0 set the line thickness proportional to the point size (this + is the default before the first `Dt' command was specified). For + historical reasons, the horizontal position is changed by adding + the argument to the actual horizontal position, while the vertical + position is not changed. Although this doesn't make sense it is + kept for compatibility. This command is a `gtroff' extension. + + +File: groff, Node: Device Control Commands, Next: Obsolete Command, Prev: Graphics Commands, Up: Command Reference + +Device Control Commands +....................... + + Each device control command starts with the letter `x', followed by +a space character (optional or arbitrary space or tab in `gtroff') and +a subcommand letter or word; each argument (if any) must be preceded by +a syntactical space. All `x' commands are terminated by a syntactical +line break; no device control command can be followed by another +command on the same line (except a comment). + + The subcommand is basically a single letter, but to increase +readability, it can be written as a word, i.e., an arbitrary sequence +of characters terminated by the next tab, space, or newline character. +All characters of the subcommand word but the first are simply ignored. +For example, `gtroff' outputs the initialization command `x i' as +`x init' and the resolution command `x r' as `x res'. + + In the following, the syntax element <line break> means a +syntactical line break (*note Separation::). + +`xF NAME<line break>' + The `F' stands for FILENAME. + + Use NAME as the intended name for the current file in error + reports. This is useful for remembering the original file name + when `gtroff' uses an internal piping mechanism. The input file is + not changed by this command. This command is a `gtroff' extension. + +`xf N S<line break>' + The `f' stands for FONT. + + Mount font position N (a non-negative integer) with font named S + (a text word). *Note Font Positions::. + +`xH N<line break>' + The `H' stands for HEIGHT. + + Set glyph height to N (a positive integer in scaled points `z'). + AT&T `troff' uses the unit points (`p') instead. *Note Output + Language Compatibility::. + +`xi<line break>' + The `i' stands for INIT. + + Initialize device. This is the third command of the prologue. + +`xp<line break>' + The `p' stands for PAUSE. + + Parsed but ignored. The original UNIX troff manual writes + + pause device, can be restarted + +`xr N H V<line break>' + The `r' stands for RESOLUTION. + + Resolution is N, while H is the minimal horizontal motion, and V + the minimal vertical motion possible with this device; all + arguments are positive integers in basic units `u' per inch. This + is the second command of the prologue. + +`xS N<line break>' + The `S' stands for SLANT. + + Set slant to N (an integer in basic units `u'). + +`xs<line break>' + The `s' stands for STOP. + + Terminates the processing of the current file; issued as the last + command of any intermediate troff output. + +`xt<line break>' + The `t' stands for TRAILER. + + Generate trailer information, if any. In GTROFF, this is actually + just ignored. + +`xT XXX<line break>' + The `T' stands for TYPESETTER. + + Set name of device to word XXX, a sequence of characters ended by + the next white space character. The possible device names coincide + with those from the `groff' `-T' option. This is the first + command of the prologue. + +`xu N<line break>' + The `u' stands for UNDERLINE. + + Configure underlining of spaces. If N is 1, start underlining of + spaces; if N is 0, stop underlining of spaces. This is needed for + the `cu' request in nroff mode and is ignored otherwise. This + command is a `gtroff' extension. + +`xX ANYTHING<line break>' + The `x' stands for X-ESCAPE. + + Send string ANYTHING uninterpreted to the device. If the line + following this command starts with a `+' character this line is + interpreted as a continuation line in the following sense. The + `+' is ignored, but a newline character is sent instead to the + device, the rest of the line is sent uninterpreted. The same + applies to all following lines until the first character of a line + is not a `+' character. This command is generated by the `gtroff' + escape sequence `\X'. The line-continuing feature is a `gtroff' + extension. + + +File: groff, Node: Obsolete Command, Prev: Device Control Commands, Up: Command Reference + +Obsolete Command +................ + + In AT&T `troff' output, the writing of a single glyph is mostly done +by a very strange command that combines a horizontal move and a single +character giving the glyph name. It doesn't have a command code, but +is represented by a 3-character argument consisting of exactly 2 digits +and a character. + +DDG + Move right DD (exactly two decimal digits) basic units `u', then + print glyph G (represented as a single character). + + In `gtroff', arbitrary syntactical space around and within this + command is allowed to be added. Only when a preceding command on + the same line ends with an argument of variable length a + separating space is obligatory. In AT&T `troff', large clusters + of these and other commands are used, mostly without spaces; this + made such output almost unreadable. + + For modern high-resolution devices, this command does not make sense +because the width of the glyphs can become much larger than two decimal +digits. In `gtroff', this is only used for the devices `X75', +`X75-12', `X100', and `X100-12'. For other devices, the commands `t' +and `u' provide a better functionality. + + +File: groff, Node: Intermediate Output Examples, Next: Output Language Compatibility, Prev: Command Reference, Up: gtroff Output + +Intermediate Output Examples +---------------------------- + + This section presents the intermediate output generated from the same +input for three different devices. The input is the sentence `hell +world' fed into `gtroff' on the command line. + +High-resolution device `ps' + This is the standard output of `gtroff' if no `-T' option is given. + + shell> echo "hell world" | groff -Z -T ps + + x T ps + x res 72000 1 1 + x init + p1 + x font 5 TR + f5 + s10000 + V12000 + H72000 + thell + wh2500 + tw + H96620 + torld + n12000 0 + x trailer + V792000 + x stop + + This output can be fed into `grops' to get its representation as a + PostScript file. + +Low-resolution device `latin1' + This is similar to the high-resolution device except that the + positioning is done at a minor scale. Some comments (lines + starting with `#') were added for clarification; they were not + generated by the formatter. + + shell> echo "hell world" | groff -Z -T latin1 + + # prologue + x T latin1 + x res 240 24 40 + x init + # begin a new page + p1 + # font setup + x font 1 R + f1 + s10 + # initial positioning on the page + V40 + H0 + # write text `hell' + thell + # inform about space, and issue a horizontal jump + wh24 + # write text `world' + tworld + # announce line break, but do nothing because ... + n40 0 + # ... the end of the document has been reached + x trailer + V2640 + x stop + + This output can be fed into `grotty' to get a formatted text + document. + +AT&T `troff' output + Since a computer monitor has a very low resolution compared to + modern printers the intermediate output for the X Window devices + can use the jump-and-write command with its 2-digit displacements. + + shell> echo "hell world" | groff -Z -T X100 + + x T X100 + x res 100 1 1 + x init + p1 + x font 5 TR + f5 + s10 + V16 + H100 + # write text with jump-and-write commands + ch07e07l03lw06w11o07r05l03dh7 + n16 0 + x trailer + V1100 + x stop + + This output can be fed into `xditview' or `gxditview' for + displaying in X. + + Due to the obsolete jump-and-write command, the text clusters in + the AT&T `troff' output are almost unreadable. + + +File: groff, Node: Output Language Compatibility, Prev: Intermediate Output Examples, Up: gtroff Output + +Output Language Compatibility +----------------------------- + + The intermediate output language of AT&T `troff' was first +documented in the UNIX troff manual, with later additions documented in +`A Typesetter-indenpendent TROFF', written by Brian Kernighan. + + The `gtroff' intermediate output format is compatible with this +specification except for the following features. + + * The classical quasi device independence is not yet implemented. + + * The old hardware was very different from what we use today. So the + `groff' devices are also fundamentally different from the ones in + AT&T `troff'. For example, the AT&T PostScript device is called + `post' and has a resolution of only 720 units per inch, suitable + for printers 20 years ago, while `groff''s `ps' device has a + resolution of 72000 units per inch. Maybe, by implementing some + rescaling mechanism similar to the classical quasi device + independence, `groff' could emulate AT&T's `post' device. + + * The B-spline command `D~' is correctly handled by the intermediate + output parser, but the drawing routines aren't implemented in some + of the postprocessor programs. + + * The argument of the commands `s' and `x H' has the implicit unit + scaled point `z' in `gtroff', while AT&T `troff' has point (`p'). + This isn't an incompatibility but a compatible extension, for both + units coincide for all devices without a `sizescale' parameter in + the `DESC' file, including all postprocessors from AT&T and + `groff''s text devices. The few `groff' devices with a + `sizescale' parameter either do not exist for AT&T `troff', have a + different name, or seem to have a different resolution. So + conflicts are very unlikely. + + * The position changing after the commands `Dp', `DP', and `Dt' is + illogical, but as old versions of `gtroff' used this feature it is + kept for compatibility reasons. + + + +File: groff, Node: Font Files, Prev: gtroff Output, Up: File formats + +Font Files +========== + + The `gtroff' font format is roughly a superset of the `ditroff' font +format (as used in later versions of AT&T `troff' and its descendants). +Unlike the `ditroff' font format, there is no associated binary +format; all files are text files.(1) (*note Font Files-Footnote-1::) +The font files for device NAME are stored in a directory `devNAME'. +There are two types of file: a device description file called `DESC' +and for each font F a font file called `F'. + +* Menu: + +* DESC File Format:: +* Font File Format:: + + +File: groff, Node: Font Files-Footnotes, Up: Font Files + + (1) Plan 9 `troff' has also abandoned the binary format. + + +File: groff, Node: DESC File Format, Next: Font File Format, Prev: Font Files, Up: Font Files + +`DESC' File Format +------------------ + + The `DESC' file can contain the following types of line. Except for +the `charset' keyword which must comes last (if at all), the order of +the lines is not important. + +`res N' + There are N machine units per inch. + +`hor N' + The horizontal resolution is N machine units. + +`vert N' + The vertical resolution is N machine units. + +`sizescale N' + The scale factor for point sizes. By default this has a value + of 1. One scaled point is equal to one point/N. The arguments to + the `unitwidth' and `sizes' commands are given in scaled points. + *Note Fractional Type Sizes::, for more information. + +`unitwidth N' + Quantities in the font files are given in machine units for fonts + whose point size is N scaled points. + +`prepro PROGRAM' + Call PROGRAM as a preprocessor. Currently, this keyword is used + by `groff' with option `-Thtml' only. + +`postpro PROGRAM' + Call PROGRAM as a postprocessor. For example, the line + + + postpro grodvi + + in the file `devdvi/DESC' makes `groff' call `grodvi' if option + `-Tdvi' is given (and `-Z' isn't used). + +`tcommand' + This means that the postprocessor can handle the `t' and `u' + intermediate output commands. + +`sizes S1 S2 ... SN 0' + This means that the device has fonts at S1, S2, ... SN scaled + points. The list of sizes must be terminated by 0 (this is digit + zero). Each SI can also be a range of sizes M-N. The list can + extend over more than one line. + +`styles S1 S2 ... SM' + The first M font positions are associated with styles S1 ... SM. + +`fonts N F1 F2 F3 ... FN' + Fonts F1 ... FN are mounted in the font positions M+1, ..., M+N + where M is the number of styles. This command may extend over + more than one line. A font name of 0 means no font is mounted on + the corresponding font position. + +`family FAM' + The default font family is FAM. + +`use_charnames_in_special' + This command indicates that `gtroff' should encode special + characters inside special commands. Currently, this is only used + by the HTML output device. *Note Postprocessor Access::. + +`papersize STRING ...' + Select a paper size. Valid values for STRING are the ISO paper + types `A0'-`A7', `B0'-`B7', `C0'-`C7', `D0'-`D7', `DL', and the US + paper types `letter', `legal', `tabloid', `ledger', `statement', + `executive', `com10', and `monarch'. Case is not significant for + STRING if it holds predefined paper types. Alternatively, STRING + can be a file name (e.g. `/etc/papersize'); if the file can be + opened, `groff' reads the first line and tests for the above paper + sizes. Finally, STRING can be a custom paper size in the format + `LENGTH,WIDTH' (no spaces before and after the comma). Both + LENGTH and WIDTH must have a unit appended; valid values are `i' + for inches, `C' for centimeters, `p' for points, and `P' for + picas. Example: `12c,235p'. An argument which starts with a + digit is always treated as a custom paper format. `papersize' + sets both the vertical and horizontal dimension of the output + medium. + + More than one argument can be specified; `groff' scans from left to + right and uses the first valid paper specification. + +`pass_filenames' + Tell `gtroff' to emit the name of the source file currently being + processed. This is achieved by the intermediate output command + `F'. Currently, this is only used by the HTML output device. + +`print PROGRAM' + Use PROGRAM as a spooler program for printing. If omitted, the + `-l' and `-L' options of `groff' are ignored. + +`charset' + This line and everything following in the file are ignored. It is + allowed for the sake of backwards compatibility. + + The `res', `unitwidth', `fonts', and `sizes' lines are mandatory. +Other commands are ignored by `gtroff' but may be used by +postprocessors to store arbitrary information about the device in the +`DESC' file. + + Here a list of obsolete keywords which are recognized by `groff' but +completely ignored: `spare1', `spare2', `biggestfont'. + + +File: groff, Node: Font File Format, Prev: DESC File Format, Up: Font Files + +Font File Format +---------------- + + A "font file", also (and probably better) called a "font description +file", has two sections. The first section is a sequence of lines each +containing a sequence of blank delimited words; the first word in the +line is a key, and subsequent words give a value for that key. + +`name F' + The name of the font is F. + +`spacewidth N' + The normal width of a space is N. + +`slant N' + The glyphs of the font have a slant of N degrees. (Positive means + forward.) + +`ligatures LIG1 LIG2 ... LIGN [0]' + Glyphs LIG1, LIG2, ..., LIGN are ligatures; possible ligatures are + `ff', `fi', `fl', `ffi' and `ffl'. For backwards compatibility, + the list of ligatures may be terminated with a 0. The list of + ligatures may not extend over more than one line. + +`special' + The font is "special"; this means that when a glyph is requested + that is not present in the current font, it is searched for in any + special fonts that are mounted. + + Other commands are ignored by `gtroff' but may be used by +postprocessors to store arbitrary information about the font in the font +file. + + The first section can contain comments which start with the `#' +character and extend to the end of a line. + + The second section contains one or two subsections. It must contain +a `charset' subsection and it may also contain a `kernpairs' +subsection. These subsections can appear in any order. Each +subsection starts with a word on a line by itself. + + The word `charset' starts the character set subsection.(1) (*note +Font File Format-Footnote-1::) The `charset' line is followed by a +sequence of lines. Each line gives information for one glyph. A line +comprises a number of fields separated by blanks or tabs. The format is + + NAME METRICS TYPE CODE [ENTITY-NAME] [`--' COMMENT] + +NAME identifies the glyph name(2) (*note Font File Format-Footnote-2::): +If NAME is a single character C then it corresponds to the `gtroff' +input character C; if it is of the form `\C' where C is a single +character, then it corresponds to the special character `\[C]'; +otherwise it corresponds to the special character `\[NAME]'. If it is +exactly two characters XX it can be entered as `\(XX'. Note that +single-letter special characters can't be accessed as `\C'; the only +exception is `\-' which is identical to `\[-]'. + + `gtroff' supports 8-bit input characters; however some utilities +have difficulties with eight-bit characters. For this reason, there is +a convention that the entity name `charN' is equivalent to the single +input character whose code is N. For example, `char163' would be +equivalent to the character with code 163 which is the pounds sterling +sign in the ISO Latin-1 character set. You shouldn't use `charN' +entities in font description files since they are related to input, not +output. Otherwise, you get hard-coded connections between input and +output encoding which prevents use of different (input) character sets. + + The name `---' is special and indicates that the glyph is unnamed; +such glyphs can only be used by means of the `\N' escape sequence in +`gtroff'. + + The TYPE field gives the glyph type: + +`1' + the glyph has a descender, for example, `p'; + +`2' + the glyph has an ascender, for example, `b'; + +`3' + the glyph has both an ascender and a descender, for example, `('. + + The CODE field gives the code which the postprocessor uses to print +the glyph. The glyph can also be input to `gtroff' using this code by +means of the `\N' escape sequence. CODE can be any integer. If it +starts with `0' it is interpreted as octal; if it starts with `0x' or +`0X' it is interpreted as hexadecimal. Note, however, that the `\N' +escape sequence only accepts a decimal integer. + + The ENTITY-NAME field gives an ASCII string identifying the glyph +which the postprocessor uses to print the `gtroff' glyph NAME. This +field is optional and has been introduced so that the HTML device +driver can encode its character set. For example, the glyph `\[Po]' is +represented as `£' in HTML 4.0. + + Anything on the line after the ENTITY-NAME field resp. after `--' +will be ignored. + + The METRICS field has the form: + + WIDTH[`,'HEIGHT[`,'DEPTH[`,'ITALIC-CORRECTION + [`,'LEFT-ITALIC-CORRECTION[`,'SUBSCRIPT-CORRECTION]]]]] + +There must not be any spaces between these subfields (it has been split +here into two lines for better legibility only). Missing subfields are +assumed to be 0. The subfields are all decimal integers. Since there +is no associated binary format, these values are not required to fit +into a variable of type `char' as they are in `ditroff'. The WIDTH +subfield gives the width of the glyph. The HEIGHT subfield gives the +height of the glyph (upwards is positive); if a glyph does not extend +above the baseline, it should be given a zero height, rather than a +negative height. The DEPTH subfield gives the depth of the glyph, that +is, the distance from the baseline to the lowest point below the +baseline to which the glyph extends (downwards is positive); if a glyph +does not extend below the baseline, it should be given a zero depth, +rather than a negative depth. The ITALIC-CORRECTION subfield gives the +amount of space that should be added after the glyph when it is +immediately to be followed by a glyph from a roman font. The +LEFT-ITALIC-CORRECTION subfield gives the amount of space that should +be added before the glyph when it is immediately to be preceded by a +glyph from a roman font. The SUBSCRIPT-CORRECTION gives the amount of +space that should be added after a glyph before adding a subscript. +This should be less than the italic correction. + + A line in the `charset' section can also have the format + + + NAME " + +This indicates that NAME is just another name for the glyph mentioned +in the preceding line. + + The word `kernpairs' starts the kernpairs section. This contains a +sequence of lines of the form: + + + C1 C2 N + +This means that when glyph C1 appears next to glyph C2 the space +between them should be increased by N. Most entries in the kernpairs +section have a negative value for N. + + +File: groff, Node: Font File Format-Footnotes, Up: Font File Format + + (1) This keyword is misnamed since it starts a list of ordered +glyphs, not characters. + + (2) The distinction between input, characters, and output, glyphs, +is not clearly separated in the terminology of `groff'; for example, +the `char' request should be called `glyph' since it defines an output +entity. + + +File: groff, Node: Installation, Next: Copying This Manual, Prev: File formats, Up: Top + +Installation +************ + + +File: groff, Node: Copying This Manual, Next: Request Index, Prev: Installation, Up: Top + +Copying This Manual +******************* + +* Menu: + +* GNU Free Documentation License:: License for copying this manual. + diff --git a/contrib/groff/doc/groff-9 b/contrib/groff/doc/groff-9 new file mode 100644 index 0000000..4f4cc68 --- /dev/null +++ b/contrib/groff/doc/groff-9 @@ -0,0 +1,931 @@ +This is groff, produced by makeinfo version 4.2 from ./groff.texinfo. + +This manual documents GNU `troff' version 1.18. + + Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover texts + being `A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + `GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: `You have freedom to copy and + modify this GNU Manual, like GNU software. Copies published by + the Free Software Foundation raise funds for GNU development." + +INFO-DIR-SECTION Miscellaneous +START-INFO-DIR-ENTRY +* Groff: (groff). The GNU troff document formatting system. +END-INFO-DIR-ENTRY + + +File: groff, Node: GNU Free Documentation License, Up: Copying This Manual + +GNU Free Documentation License +============================== + + Version 1.1, March 2000 + Copyright (C) 2000 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + 0. PREAMBLE + + The purpose of this License is to make a manual, textbook, or other + written document "free" in the sense of freedom: to assure everyone + the effective freedom to copy and redistribute it, with or without + modifying it, either commercially or noncommercially. Secondarily, + this License preserves for the author and publisher a way to get + credit for their work, while not being considered responsible for + modifications made by others. + + This License is a kind of "copyleft", which means that derivative + works of the document must themselves be free in the same sense. + It complements the GNU General Public License, which is a copyleft + license designed for free software. + + We have designed this License in order to use it for manuals for + free software, because free software needs free documentation: a + free program should come with manuals providing the same freedoms + that the software does. But this License is not limited to + software manuals; it can be used for any textual work, regardless + of subject matter or whether it is published as a printed book. + We recommend this License principally for works whose purpose is + instruction or reference. + + 1. APPLICABILITY AND DEFINITIONS + + This License applies to any manual or other work that contains a + notice placed by the copyright holder saying it can be distributed + under the terms of this License. The "Document", below, refers to + any such manual or work. Any member of the public is a licensee, + and is addressed as "you". + + A "Modified Version" of the Document means any work containing the + Document or a portion of it, either copied verbatim, or with + modifications and/or translated into another language. + + A "Secondary Section" is a named appendix or a front-matter + section of the Document that deals exclusively with the + relationship of the publishers or authors of the Document to the + Document's overall subject (or to related matters) and contains + nothing that could fall directly within that overall subject. + (For example, if the Document is in part a textbook of + mathematics, a Secondary Section may not explain any mathematics.) + The relationship could be a matter of historical connection with + the subject or with related matters, or of legal, commercial, + philosophical, ethical or political position regarding them. + + The "Invariant Sections" are certain Secondary Sections whose + titles are designated, as being those of Invariant Sections, in + the notice that says that the Document is released under this + License. + + The "Cover Texts" are certain short passages of text that are + listed, as Front-Cover Texts or Back-Cover Texts, in the notice + that says that the Document is released under this License. + + A "Transparent" copy of the Document means a machine-readable copy, + represented in a format whose specification is available to the + general public, whose contents can be viewed and edited directly + and straightforwardly with generic text editors or (for images + composed of pixels) generic paint programs or (for drawings) some + widely available drawing editor, and that is suitable for input to + text formatters or for automatic translation to a variety of + formats suitable for input to text formatters. A copy made in an + otherwise Transparent file format whose markup has been designed + to thwart or discourage subsequent modification by readers is not + Transparent. A copy that is not "Transparent" is called "Opaque". + + Examples of suitable formats for Transparent copies include plain + ASCII without markup, Texinfo input format, LaTeX input format, + SGML or XML using a publicly available DTD, and + standard-conforming simple HTML designed for human modification. + Opaque formats include PostScript, PDF, proprietary formats that + can be read and edited only by proprietary word processors, SGML + or XML for which the DTD and/or processing tools are not generally + available, and the machine-generated HTML produced by some word + processors for output purposes only. + + The "Title Page" means, for a printed book, the title page itself, + plus such following pages as are needed to hold, legibly, the + material this License requires to appear in the title page. For + works in formats which do not have any title page as such, "Title + Page" means the text near the most prominent appearance of the + work's title, preceding the beginning of the body of the text. + + 2. VERBATIM COPYING + + You may copy and distribute the Document in any medium, either + commercially or noncommercially, provided that this License, the + copyright notices, and the license notice saying this License + applies to the Document are reproduced in all copies, and that you + add no other conditions whatsoever to those of this License. You + may not use technical measures to obstruct or control the reading + or further copying of the copies you make or distribute. However, + you may accept compensation in exchange for copies. If you + distribute a large enough number of copies you must also follow + the conditions in section 3. + + You may also lend copies, under the same conditions stated above, + and you may publicly display copies. + + 3. COPYING IN QUANTITY + + If you publish printed copies of the Document numbering more than + 100, and the Document's license notice requires Cover Texts, you + must enclose the copies in covers that carry, clearly and legibly, + all these Cover Texts: Front-Cover Texts on the front cover, and + Back-Cover Texts on the back cover. Both covers must also clearly + and legibly identify you as the publisher of these copies. The + front cover must present the full title with all words of the + title equally prominent and visible. You may add other material + on the covers in addition. Copying with changes limited to the + covers, as long as they preserve the title of the Document and + satisfy these conditions, can be treated as verbatim copying in + other respects. + + If the required texts for either cover are too voluminous to fit + legibly, you should put the first ones listed (as many as fit + reasonably) on the actual cover, and continue the rest onto + adjacent pages. + + If you publish or distribute Opaque copies of the Document + numbering more than 100, you must either include a + machine-readable Transparent copy along with each Opaque copy, or + state in or with each Opaque copy a publicly-accessible + computer-network location containing a complete Transparent copy + of the Document, free of added material, which the general + network-using public has access to download anonymously at no + charge using public-standard network protocols. If you use the + latter option, you must take reasonably prudent steps, when you + begin distribution of Opaque copies in quantity, to ensure that + this Transparent copy will remain thus accessible at the stated + location until at least one year after the last time you + distribute an Opaque copy (directly or through your agents or + retailers) of that edition to the public. + + It is requested, but not required, that you contact the authors of + the Document well before redistributing any large number of + copies, to give them a chance to provide you with an updated + version of the Document. + + 4. MODIFICATIONS + + You may copy and distribute a Modified Version of the Document + under the conditions of sections 2 and 3 above, provided that you + release the Modified Version under precisely this License, with + the Modified Version filling the role of the Document, thus + licensing distribution and modification of the Modified Version to + whoever possesses a copy of it. In addition, you must do these + things in the Modified Version: + + A. Use in the Title Page (and on the covers, if any) a title + distinct from that of the Document, and from those of + previous versions (which should, if there were any, be listed + in the History section of the Document). You may use the + same title as a previous version if the original publisher of + that version gives permission. + + B. List on the Title Page, as authors, one or more persons or + entities responsible for authorship of the modifications in + the Modified Version, together with at least five of the + principal authors of the Document (all of its principal + authors, if it has less than five). + + C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. + + D. Preserve all the copyright notices of the Document. + + E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. + + F. Include, immediately after the copyright notices, a license + notice giving the public permission to use the Modified + Version under the terms of this License, in the form shown in + the Addendum below. + + G. Preserve in that license notice the full lists of Invariant + Sections and required Cover Texts given in the Document's + license notice. + + H. Include an unaltered copy of this License. + + I. Preserve the section entitled "History", and its title, and + add to it an item stating at least the title, year, new + authors, and publisher of the Modified Version as given on + the Title Page. If there is no section entitled "History" in + the Document, create one stating the title, year, authors, + and publisher of the Document as given on its Title Page, + then add an item describing the Modified Version as stated in + the previous sentence. + + J. Preserve the network location, if any, given in the Document + for public access to a Transparent copy of the Document, and + likewise the network locations given in the Document for + previous versions it was based on. These may be placed in + the "History" section. You may omit a network location for a + work that was published at least four years before the + Document itself, or if the original publisher of the version + it refers to gives permission. + + K. In any section entitled "Acknowledgments" or "Dedications", + preserve the section's title, and preserve in the section all + the substance and tone of each of the contributor + acknowledgments and/or dedications given therein. + + L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section + titles. + + M. Delete any section entitled "Endorsements". Such a section + may not be included in the Modified Version. + + N. Do not retitle any existing section as "Endorsements" or to + conflict in title with any Invariant Section. + + If the Modified Version includes new front-matter sections or + appendices that qualify as Secondary Sections and contain no + material copied from the Document, you may at your option + designate some or all of these sections as invariant. To do this, + add their titles to the list of Invariant Sections in the Modified + Version's license notice. These titles must be distinct from any + other section titles. + + You may add a section entitled "Endorsements", provided it contains + nothing but endorsements of your Modified Version by various + parties--for example, statements of peer review or that the text + has been approved by an organization as the authoritative + definition of a standard. + + You may add a passage of up to five words as a Front-Cover Text, + and a passage of up to 25 words as a Back-Cover Text, to the end + of the list of Cover Texts in the Modified Version. Only one + passage of Front-Cover Text and one of Back-Cover Text may be + added by (or through arrangements made by) any one entity. If the + Document already includes a cover text for the same cover, + previously added by you or by arrangement made by the same entity + you are acting on behalf of, you may not add another; but you may + replace the old one, on explicit permission from the previous + publisher that added the old one. + + The author(s) and publisher(s) of the Document do not by this + License give permission to use their names for publicity for or to + assert or imply endorsement of any Modified Version. + + 5. COMBINING DOCUMENTS + + You may combine the Document with other documents released under + this License, under the terms defined in section 4 above for + modified versions, provided that you include in the combination + all of the Invariant Sections of all of the original documents, + unmodified, and list them all as Invariant Sections of your + combined work in its license notice. + + The combined work need only contain one copy of this License, and + multiple identical Invariant Sections may be replaced with a single + copy. If there are multiple Invariant Sections with the same name + but different contents, make the title of each such section unique + by adding at the end of it, in parentheses, the name of the + original author or publisher of that section if known, or else a + unique number. Make the same adjustment to the section titles in + the list of Invariant Sections in the license notice of the + combined work. + + In the combination, you must combine any sections entitled + "History" in the various original documents, forming one section + entitled "History"; likewise combine any sections entitled + "Acknowledgments", and any sections entitled "Dedications". You + must delete all sections entitled "Endorsements." + + 6. COLLECTIONS OF DOCUMENTS + + You may make a collection consisting of the Document and other + documents released under this License, and replace the individual + copies of this License in the various documents with a single copy + that is included in the collection, provided that you follow the + rules of this License for verbatim copying of each of the + documents in all other respects. + + You may extract a single document from such a collection, and + distribute it individually under this License, provided you insert + a copy of this License into the extracted document, and follow + this License in all other respects regarding verbatim copying of + that document. + + 7. AGGREGATION WITH INDEPENDENT WORKS + + A compilation of the Document or its derivatives with other + separate and independent documents or works, in or on a volume of + a storage or distribution medium, does not as a whole count as a + Modified Version of the Document, provided no compilation + copyright is claimed for the compilation. Such a compilation is + called an "aggregate", and this License does not apply to the + other self-contained works thus compiled with the Document, on + account of their being thus compiled, if they are not themselves + derivative works of the Document. + + If the Cover Text requirement of section 3 is applicable to these + copies of the Document, then if the Document is less than one + quarter of the entire aggregate, the Document's Cover Texts may be + placed on covers that surround only the Document within the + aggregate. Otherwise they must appear on covers around the whole + aggregate. + + 8. TRANSLATION + + Translation is considered a kind of modification, so you may + distribute translations of the Document under the terms of section + 4. Replacing Invariant Sections with translations requires special + permission from their copyright holders, but you may include + translations of some or all Invariant Sections in addition to the + original versions of these Invariant Sections. You may include a + translation of this License provided that you also include the + original English version of this License. In case of a + disagreement between the translation and the original English + version of this License, the original English version will prevail. + + 9. TERMINATION + + You may not copy, modify, sublicense, or distribute the Document + except as expressly provided for under this License. Any other + attempt to copy, modify, sublicense or distribute the Document is + void, and will automatically terminate your rights under this + License. However, parties who have received copies, or rights, + from you under this License will not have their licenses + terminated so long as such parties remain in full compliance. + + 10. FUTURE REVISIONS OF THIS LICENSE + + The Free Software Foundation may publish new, revised versions of + the GNU Free Documentation License from time to time. Such new + versions will be similar in spirit to the present version, but may + differ in detail to address new problems or concerns. See + `http://www.gnu.org/copyleft/'. + + Each version of the License is given a distinguishing version + number. If the Document specifies that a particular numbered + version of this License "or any later version" applies to it, you + have the option of following the terms and conditions either of + that specified version or of any later version that has been + published (not as a draft) by the Free Software Foundation. If + the Document does not specify a version number of this License, + you may choose any version ever published (not as a draft) by the + Free Software Foundation. + +ADDENDUM: How to use this License for your documents +---------------------------------------------------- + + To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and license +notices just after the title page: + + Copyright (C) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.1 + or any later version published by the Free Software Foundation; + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + A copy of the license is included in the section entitled ``GNU + Free Documentation License''. + + If you have no Invariant Sections, write "with no Invariant Sections" +instead of saying which ones are invariant. If you have no Front-Cover +Texts, write "no Front-Cover Texts" instead of "Front-Cover Texts being +LIST"; likewise for Back-Cover Texts. + + If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, to +permit their use in free software. + + +File: groff, Node: Request Index, Next: Escape Index, Prev: Copying This Manual, Up: Top + +Request Index +************* + + Requests appear without the leading control character (normally +either `.' or `''). + +* Menu: + +* ab: Debugging. +* ad: Manipulating Filling and Adjusting. +* af: Assigning Formats. +* aln: Setting Registers. +* als: Strings. +* am: Writing Macros. +* am1: Writing Macros. +* ami: Writing Macros. +* as: Strings. +* as1: Strings. +* asciify: Diversions. +* backtrace: Debugging. +* bd: Artificial Fonts. +* blm: Blank Line Traps. +* box: Diversions. +* boxa: Diversions. +* bp: Page Control. +* br: Manipulating Filling and Adjusting. +* break: while. +* brp: Manipulating Filling and Adjusting. +* c2: Character Translations. +* cc: Character Translations. +* ce: Manipulating Filling and Adjusting. +* cf: I/O. +* cflags: Using Symbols. +* ch: Page Location Traps. +* char: Using Symbols. +* chop: Strings. +* close: I/O. +* color: Colors. +* continue: while. +* cp: Implementation Differences. +* cs: Artificial Fonts. +* cu: Artificial Fonts. +* da: Diversions. +* de: Writing Macros. +* de1: Writing Macros. +* defcolor: Colors. +* dei: Writing Macros. +* di: Diversions. +* do: Implementation Differences. +* ds: Strings. +* ds1: Strings. +* dt: Diversion Traps. +* ec: Character Translations. +* ecr: Character Translations. +* ecs: Character Translations. +* el: if-else. +* em: End-of-input Traps. +* eo: Character Translations. +* ev: Environments. +* evc: Environments. +* ex: Debugging. +* fam: Font Families. +* fc: Fields. +* fchar: Using Symbols. +* fi: Manipulating Filling and Adjusting. +* fl: Debugging. +* fp: Font Positions. +* fspecial: Special Fonts. +* ft <1>: Font Positions. +* ft: Changing Fonts. +* ftr: Changing Fonts. +* hc: Manipulating Hyphenation. +* hcode: Manipulating Hyphenation. +* hla: Manipulating Hyphenation. +* hlm: Manipulating Hyphenation. +* hpf: Manipulating Hyphenation. +* hpfa: Manipulating Hyphenation. +* hpfcode: Manipulating Hyphenation. +* hw: Manipulating Hyphenation. +* hy: Manipulating Hyphenation. +* hym: Manipulating Hyphenation. +* hys: Manipulating Hyphenation. +* ie: if-else. +* if: if-else. +* ig: Comments. +* in: Line Layout. +* it: Input Line Traps. +* itc: Input Line Traps. +* kern: Ligatures and Kerning. +* lc: Leaders. +* length: Strings. +* lf: Debugging. +* lg: Ligatures and Kerning. +* linetabs: Tabs and Fields. +* ll: Line Layout. +* ls: Manipulating Spacing. +* lt: Page Layout. +* mc: Miscellaneous. +* mk: Page Motions. +* mso: I/O. +* na: Manipulating Filling and Adjusting. +* ne: Page Control. +* nf: Manipulating Filling and Adjusting. +* nh: Manipulating Hyphenation. +* nm: Miscellaneous. +* nn: Miscellaneous. +* nop: if-else. +* nr <1>: Auto-increment. +* nr: Setting Registers. +* nroff: Troff and Nroff Mode. +* ns: Manipulating Spacing. +* nx: I/O. +* open: I/O. +* opena: I/O. +* os: Page Control. +* output: Diversions. +* pc: Page Layout. +* pi: I/O. +* pl: Page Layout. +* pm: Debugging. +* pn: Page Layout. +* pnr: Debugging. +* po: Line Layout. +* ps: Changing Type Sizes. +* psbb: Miscellaneous. +* pso: I/O. +* ptr: Debugging. +* pvs: Changing Type Sizes. +* rchar: Using Symbols. +* rd: I/O. +* return: Writing Macros. +* rj: Manipulating Filling and Adjusting. +* rm: Strings. +* rn: Strings. +* rnn: Setting Registers. +* rr: Setting Registers. +* rs: Manipulating Spacing. +* rt: Page Motions. +* shc: Manipulating Hyphenation. +* shift: Parameters. +* sizes: Changing Type Sizes. +* so: I/O. +* sp: Manipulating Spacing. +* special: Special Fonts. +* spreadwarn: Debugging. +* ss: Manipulating Filling and Adjusting. +* sty: Font Families. +* substring: Strings. +* sv: Page Control. +* sy: I/O. +* ta: Tabs and Fields. +* tc: Tabs and Fields. +* ti: Line Layout. +* tkf: Ligatures and Kerning. +* tl: Page Layout. +* tm: Debugging. +* tm1: Debugging. +* tmc: Debugging. +* tr: Character Translations. +* trf: I/O. +* trin: Character Translations. +* trnt: Character Translations. +* troff: Troff and Nroff Mode. +* uf: Artificial Fonts. +* ul: Artificial Fonts. +* unformat: Diversions. +* vpt: Page Location Traps. +* vs: Changing Type Sizes. +* warn: Debugging. +* warnscale: Debugging. +* wh: Page Location Traps. +* while: while. +* write: I/O. +* writec: I/O. +* writem: I/O. + + +File: groff, Node: Escape Index, Next: Operator Index, Prev: Request Index, Up: Top + +Escape Index +************ + + Any escape sequence `\X' with X not in the list below emits a +warning, printing glyph X. + +* Menu: + +* <colon>: Manipulating Hyphenation. +* \: Using Symbols. +* \!: Diversions. +* \": Comments. +* \#: Comments. +* \$: Parameters. +* \$*: Parameters. +* \$0: Parameters. +* \$@: Parameters. +* \%: Manipulating Hyphenation. +* \&: Ligatures and Kerning. +* \': Using Symbols. +* \): Ligatures and Kerning. +* \*: Strings. +* \,: Ligatures and Kerning. +* \-: Using Symbols. +* \.: Character Translations. +* \/: Ligatures and Kerning. +* \0: Page Motions. +* \<RET>: Line Control. +* \<SP>: Page Motions. +* \?: Diversions. +* \\: Character Translations. +* \^: Page Motions. +* \`: Using Symbols. +* \a: Leaders. +* \A: Identifiers. +* \b: Drawing Requests. +* \B: Expressions. +* \C: Using Symbols. +* \c: Line Control. +* \D: Drawing Requests. +* \d: Page Motions. +* \E: Character Translations. +* \e: Character Translations. +* \f: Font Positions. +* \F: Font Families. +* \f: Changing Fonts. +* \g: Assigning Formats. +* \h: Page Motions. +* \H: Artificial Fonts. +* \k: Page Motions. +* \L: Drawing Requests. +* \l: Drawing Requests. +* \M: Colors. +* \m: Colors. +* \N: Using Symbols. +* \n <1>: Auto-increment. +* \n: Interpolating Registers. +* \O: Suppressing output. +* \o: Page Motions. +* \p: Manipulating Filling and Adjusting. +* \r: Page Motions. +* \R: Setting Registers. +* \s: Changing Type Sizes. +* \S: Artificial Fonts. +* \t: Tabs and Fields. +* \u: Page Motions. +* \V: I/O. +* \v: Page Motions. +* \w: Page Motions. +* \X: Postprocessor Access. +* \x: Manipulating Spacing. +* \Y: Postprocessor Access. +* \Z: Page Motions. +* \z: Page Motions. +* \{: if-else. +* \|: Page Motions. +* \}: if-else. +* \~: Page Motions. + + +File: groff, Node: Operator Index, Next: Register Index, Prev: Escape Index, Up: Top + +Operator Index +************** + +* Menu: + +* !: Expressions. +* %: Expressions. +* &: Expressions. +* (: Expressions. +* ): Expressions. +* *: Expressions. +* +: Expressions. +* -: Expressions. +* /: Expressions. +* <: Expressions. +* <=: Expressions. +* <?: Expressions. +* <colon>: Expressions. +* =: Expressions. +* ==: Expressions. +* >: Expressions. +* >=: Expressions. +* >?: Expressions. + + +File: groff, Node: Register Index, Next: Macro Index, Prev: Operator Index, Up: Top + +Register Index +************** + + The macro package or program a specific register belongs to is +appended in brackets. + + A register name `x' consisting of exactly one character can be +accessed as `\nx'. A register name `xx' consisting of exactly two +characters can be accessed as `\n(xx'. Register names `xxx' of any +length can be accessed as `\n[xxx]'. + +* Menu: + +* $$: Built-in Registers. +* %: Page Layout. +* .$: Parameters. +* .a: Manipulating Spacing. +* .A: Built-in Registers. +* .b: Artificial Fonts. +* .C: Implementation Differences. +* .c: Built-in Registers. +* .cdp: Environments. +* .ce: Manipulating Filling and Adjusting. +* .cht: Environments. +* .color: Colors. +* .csk: Environments. +* .d: Diversions. +* .ev: Environments. +* .f: Font Positions. +* .F: Built-in Registers. +* .fam: Font Families. +* .fn: Font Families. +* .fp: Font Positions. +* .g: Built-in Registers. +* .h: Diversions. +* .H: Built-in Registers. +* .hla: Manipulating Hyphenation. +* .hlc: Manipulating Hyphenation. +* .hlm: Manipulating Hyphenation. +* .hy: Manipulating Hyphenation. +* .hym: Manipulating Hyphenation. +* .hys: Manipulating Hyphenation. +* .i: Line Layout. +* .in: Line Layout. +* .int: Line Control. +* .j: Manipulating Filling and Adjusting. +* .k: Page Motions. +* .kern: Ligatures and Kerning. +* .l: Line Layout. +* .L: Manipulating Spacing. +* .lg: Ligatures and Kerning. +* .linetabs: Tabs and Fields. +* .ll: Line Layout. +* .lt: Page Layout. +* .ne: Page Location Traps. +* .ns: Manipulating Spacing. +* .o: Line Layout. +* .p: Page Layout. +* .P: Built-in Registers. +* .pn: Page Layout. +* .ps: Fractional Type Sizes. +* .psr: Fractional Type Sizes. +* .pvs: Changing Type Sizes. +* .rj: Manipulating Filling and Adjusting. +* .s: Changing Type Sizes. +* .sr: Fractional Type Sizes. +* .ss: Manipulating Filling and Adjusting. +* .sss: Manipulating Filling and Adjusting. +* .t: Page Location Traps. +* .T: Built-in Registers. +* .tabs: Tabs and Fields. +* .trunc: Page Location Traps. +* .u: Manipulating Filling and Adjusting. +* .v: Changing Type Sizes. +* .V: Built-in Registers. +* .vpt: Page Location Traps. +* .warn: Debugging. +* .x: Built-in Registers. +* .Y: Built-in Registers. +* .y: Built-in Registers. +* .z: Diversions. +* c.: Built-in Registers. +* ct: Page Motions. +* dl: Diversions. +* dn: Diversions. +* dw: Built-in Registers. +* dy: Built-in Registers. +* FF [ms]: ms Document Control Registers. +* FI [ms]: ms Document Control Registers. +* FL [ms]: ms Document Control Registers. +* FM [ms]: ms Document Control Registers. +* HM [ms]: ms Document Control Registers. +* hours: Built-in Registers. +* hp: Page Motions. +* LL [ms]: ms Document Control Registers. +* llx: Miscellaneous. +* lly: Miscellaneous. +* ln: Built-in Registers. +* LT [ms]: ms Document Control Registers. +* MINGW [ms] <1>: Additional ms Macros. +* MINGW [ms]: ms Document Control Registers. +* minutes: Built-in Registers. +* mo: Built-in Registers. +* nl: Page Control. +* opmaxx: Suppressing output. +* opmaxy: Suppressing output. +* opminx: Suppressing output. +* opminy: Suppressing output. +* PD [ms]: ms Document Control Registers. +* PI [ms]: ms Document Control Registers. +* PO [ms]: ms Document Control Registers. +* PS [ms]: ms Document Control Registers. +* ps4html [grohtml]: grohtml specific registers and strings. +* QI [ms]: ms Document Control Registers. +* rsb: Page Motions. +* rst: Page Motions. +* sb: Page Motions. +* seconds: Built-in Registers. +* skw: Page Motions. +* slimit: Debugging. +* ssc: Page Motions. +* st: Page Motions. +* systat: I/O. +* urx: Miscellaneous. +* ury: Miscellaneous. +* VS [ms]: ms Document Control Registers. +* year: Built-in Registers. +* yr: Built-in Registers. + + +File: groff, Node: Macro Index, Next: String Index, Prev: Register Index, Up: Top + +Macro Index +*********** + + The macro package a specific macro belongs to is appended in +brackets. They appear without the leading control character (normally +`.'). + +* Menu: + +* 1C [ms]: ms Multiple Columns. +* 2C [ms]: ms Multiple Columns. +* [ [ms]: ms Insertions. +* ] [ms]: ms Insertions. +* AB [ms]: ms Cover Page Macros. +* AE [ms]: ms Cover Page Macros. +* AI [ms]: ms Cover Page Macros. +* AM [ms] <1>: Additional ms Macros. +* AM [ms]: ms Strings and Special Characters. +* AU [ms]: ms Cover Page Macros. +* B [man]: Man font macros. +* B [ms]: Highlighting in ms. +* B1 [ms]: ms Displays and Keeps. +* B2 [ms]: ms Displays and Keeps. +* BD [ms]: ms Displays and Keeps. +* BI [man]: Man font macros. +* BI [ms]: Highlighting in ms. +* BR [man]: Man font macros. +* BX [ms]: Highlighting in ms. +* CD [ms]: ms Displays and Keeps. +* CW [ms] <1>: Additional ms Macros. +* CW [ms]: Highlighting in ms. +* DA [ms]: ms Cover Page Macros. +* DE [ms]: ms Displays and Keeps. +* DS [ms] <1>: Additional ms Macros. +* DS [ms]: ms Displays and Keeps. +* DT [man]: Miscellaneous man macros. +* EF [ms]: ms Headers and Footers. +* EH [ms]: ms Headers and Footers. +* EN [ms]: ms Insertions. +* EQ [ms]: ms Insertions. +* FE [ms]: ms Footnotes. +* FS [ms]: ms Footnotes. +* HP [man]: Man usage. +* I [man]: Man font macros. +* I [ms]: Highlighting in ms. +* IB [man]: Man font macros. +* ID [ms]: ms Displays and Keeps. +* IP [man]: Man usage. +* IP [ms]: Lists in ms. +* IR [man]: Man font macros. +* IX [ms]: Additional ms Macros. +* KE [ms]: ms Displays and Keeps. +* KF [ms]: ms Displays and Keeps. +* KS [ms]: ms Displays and Keeps. +* LD [ms]: ms Displays and Keeps. +* LG [ms]: Highlighting in ms. +* LP [man]: Man usage. +* LP [ms]: Paragraphs in ms. +* MC [ms]: ms Multiple Columns. +* ND [ms]: ms Cover Page Macros. +* NH [ms]: Headings in ms. +* NL [ms]: Highlighting in ms. +* OF [ms]: ms Headers and Footers. +* OH [ms]: ms Headers and Footers. +* P [man]: Man usage. +* PD [man]: Miscellaneous man macros. +* PE [ms]: ms Insertions. +* PP [man]: Man usage. +* PP [ms]: Paragraphs in ms. +* PS [ms]: ms Insertions. +* PX [ms]: ms TOC. +* QP [ms]: Paragraphs in ms. +* R [ms]: Highlighting in ms. +* RB [man]: Man font macros. +* RD [ms]: ms Displays and Keeps. +* RE [man]: Man usage. +* RE [ms]: Indents in ms. +* RI [man]: Man font macros. +* RP [ms]: ms Cover Page Macros. +* RS [man]: Man usage. +* RS [ms]: Indents in ms. +* SB [man]: Man font macros. +* SH [man]: Man usage. +* SH [ms]: Headings in ms. +* SM [man]: Man font macros. +* SM [ms]: Highlighting in ms. +* SS [man]: Man usage. +* TA [ms]: Tabstops in ms. +* TC [ms]: ms TOC. +* TE [ms]: ms Insertions. +* TH [man]: Man usage. +* TL [ms]: ms Cover Page Macros. +* TP [man]: Man usage. +* TS [ms]: ms Insertions. +* UL [ms]: Highlighting in ms. +* XA [ms]: ms TOC. +* XE [ms]: ms TOC. +* XP [ms]: Paragraphs in ms. +* XS [ms]: ms TOC. + diff --git a/contrib/groff/doc/groff.texinfo b/contrib/groff/doc/groff.texinfo index c8965c7..410a9d5 100644 --- a/contrib/groff/doc/groff.texinfo +++ b/contrib/groff/doc/groff.texinfo @@ -4,15 +4,43 @@ @c Please convert this manual with `texi2dvi -e groff.texinfo' due to a bug @c in texinfo regarding expansion of user-defined macros. @c +@c You need texinfo 4.2 or newer to format this document! +@c @c %**start of header (This is for running Texinfo on a region.) -@setfilename groff +@setfilename groff @settitle The GNU Troff Manual @setchapternewpage odd @footnotestyle separate @c %**end of header (This is for running Texinfo on a region.) +@smallbook + +@finalout + + +@copying +This manual documents GNU @code{troff} version 1.18. + +Copyright @copyright{} 1994-2000, 2001, 2002 Free Software Foundation, Inc. + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover texts being `A GNU Manual,'' +and with the Back-Cover Texts as in (a) below. A copy of the +license is included in the section entitled `GNU Free Documentation +License.'' + +(a) The FSF's Back-Cover Text is: `You have freedom to copy and modify +this GNU Manual, like GNU software. Copies published by the Free +Software Foundation raise funds for GNU development.'' +@end quotation +@end copying + + @c We use the following indices: @c @c cindex: concepts @@ -24,7 +52,6 @@ @c tindex: environment variables @c maindex: macros @c stindex: strings -@c glindex: glyph names @c opindex: operators @c @c tindex and cindex are merged. @@ -33,7 +60,6 @@ @defcodeindex es @defcodeindex ma @defcodeindex st -@defcodeindex gl @defcodeindex op @syncodeindex tp cp @@ -53,16 +79,66 @@ @end tex +@c To assure correct HTML translation, some ugly hacks are necessary. +@c While processing a @def... request, the HTML translator looks at the +@c next line to decide whether it should start indentation or not. If +@c it is something starting with @def... (e.g. @deffnx), it doesn't. +@c So we must assure during macro expansion that a @def... is seen. +@c +@c The following macros have to be used: +@c +@c One item: +@c +@c @Def... +@c +@c Two items: +@c +@c @Def...List +@c @Def...ListEnd +@c +@c More than two: +@c +@c @Def...List +@c @Def...Item +@c @Def...Item +@c ... +@c @Def...ListEnd +@c +@c The definition block must end with +@c +@c @endDef... +@c +@c The above is valid for texinfo 4.0f. + + +@c a dummy macro to assure the `@def...' + +@macro defdummy +@end macro + + @c definition of requests @macro Defreq{name, arg} +@deffn Request @t{.\name\} \arg\ @rqindex \name\ +@end macro + +@macro DefreqList{name, arg} @deffn Request @t{.\name\} \arg\ +@defdummy +@rqindex \name\ @end macro -@macro Defreqx{name, arg} +@macro DefreqItem{name, arg} +@deffnx Request @t{.\name\} \arg\ +@defdummy @rqindex \name\ +@end macro + +@macro DefreqListEnd{name, arg} @deffnx Request @t{.\name\} \arg\ +@rqindex \name\ @end macro @macro endDefreq @@ -73,13 +149,25 @@ @c definition of escapes @macro Defesc{name, delimI, arg, delimII} +@deffn Escape @t{\name\\delimI\}@var{\arg\}@t{\delimII\} @esindex \name\ +@end macro + +@macro DefescList{name, delimI, arg, delimII} @deffn Escape @t{\name\\delimI\}@var{\arg\}@t{\delimII\} +@defdummy +@esindex \name\ @end macro -@macro Defescx{name, delimI, arg, delimII} +@macro DefescItem{name, delimI, arg, delimII} +@deffnx Escape @t{\name\\delimI\}@var{\arg\}@t{\delimII\} +@defdummy @esindex \name\ +@end macro + +@macro DefescListEnd{name, delimI, arg, delimII} @deffnx Escape @t{\name\\delimI\}@var{\arg\}@t{\delimII\} +@esindex \name\ @end macro @macro endDefesc @@ -90,13 +178,25 @@ @c definition of registers @macro Defreg{name} +@deffn Register @t{\\n[\name\]} @vindex \name\ +@end macro + +@macro DefregList{name} @deffn Register @t{\\n[\name\]} +@defdummy +@vindex \name\ @end macro -@macro Defregx{name} +@macro DefregItem{name} +@deffnx Register @t{\\n[\name\]} +@defdummy @vindex \name\ +@end macro + +@macro DefregListEnd{name} @deffnx Register @t{\\n[\name\]} +@vindex \name\ @end macro @macro endDefreg @@ -104,16 +204,57 @@ @end macro +@c definition of registers specific to macro packages, preprocessors, etc. + +@macro Defmpreg{name, package} +@deffn Register @t{\\n[\name\]} +@vindex \name\ @r{[}\package\@r{]} +@end macro + +@macro DefmpregList{name, package} +@deffn Register @t{\\n[\name\]} +@defdummy +@vindex \name\ @r{[}\package\@r{]} +@end macro + +@macro DefmpregItem{name, package} +@deffnx Register @t{\\n[\name\]} +@defdummy +@vindex \name\ @r{[}\package\@r{]} +@end macro + +@macro DefmpregListEnd{name, package} +@deffnx Register @t{\\n[\name\]} +@vindex \name\ @r{[}\package\@r{]} +@end macro + +@macro endDefmpreg +@end deffn +@end macro + + @c definition of macros -@macro Defmac{name, arg} -@maindex \name\ +@macro Defmac{name, arg, package} @defmac @t{.\name\} \arg\ +@maindex \name\ @r{[}\package\@r{]} +@end macro + +@macro DefmacList{name, arg, package} +@defmac @t{.\name\} \arg\ +@defdummy +@maindex \name\ @r{[}\package\@r{]} +@end macro + +@macro DefmacItem{name, arg, package} +@defmacx @t{.\name\} \arg\ +@defdummy +@maindex \name\ @r{[}\package\@r{]} @end macro -@macro Defmacx{name, arg} -@maindex \name\ +@macro DefmacListEnd{name, arg, package} @defmacx @t{.\name\} \arg\ +@maindex \name\ @r{[}\package\@r{]} @end macro @macro endDefmac @@ -123,14 +264,26 @@ @c definition of strings -@macro Defstr{name, arg} -@stindex \name\ -@deffn String @t{\name\} \arg\ +@macro Defstr{name, package} +@deffn String @t{\\*[\name\]} +@stindex \name\ @r{[}\package\@r{]} +@end macro + +@macro DefstrList{name, package} +@deffn String @t{\\*[\name\]} +@defdummy +@stindex \name\ @r{[}\package\@r{]} +@end macro + +@macro DefstrItem{name, package} +@deffnx String @t{\\*[\name\]} +@defdummy +@stindex \name\ @r{[}\package\@r{]} @end macro -@macro Defstrx{name, arg} -@stindex \name\ -@deffnx String @t{\name\} \arg\ +@macro DefstrListEnd{name, package} +@deffnx String @t{\\*[\name\]} +@stindex \name\ @r{[}\package\@r{]} @end macro @macro endDefstr @@ -151,15 +304,50 @@ @end macro +@c <text> + +@tex +\gdef\angles#1{\angleleft{}\r{#1}\angleright{}} +@end tex + +@macro angles{text} +<\text\> +@end macro + + +@c a <= sign + +@tex +\gdef\LE{\le} +@end tex + +@macro LE +<= +@end macro + + +@c due to a bug in texinfo 4.2, the spacing of `<' is bad in @item + +@tex +\gdef\LT{\string<} +@end tex + +@macro LT +< +@end macro + + @c We need special parentheses and brackets: @c @c . Real parentheses in @deffn produce an error while compiling with @c TeX @c . Real brackets use the wrong font in @deffn, overriding @t{}. @c +@c Since macros aren't expanded in @deffn during -E, the following +@c definitions are for non-TeX only. +@c @c This is true for texinfo 4.0. -@ifnottex @macro lparen ( @end macro @@ -172,147 +360,54 @@ @macro rbrack ] @end macro -@end ifnottex -@iftex -@macro lparen -@@lparen -@end macro -@macro rparen -@@rparen -@end macro -@macro lbrack -@@lbrack -@end macro -@macro rbrack -@@rbrack -@end macro -@end iftex - -@c Note: We say `Roman numerals' but `roman font'. +@tex +\gdef\gobblefirst#1#2{#2} +\gdef\putwordAppendix{\gobblefirst} +@end tex -@c XXX comment all examples +@c Note: We say `Roman numerals' but `roman font'. @dircategory Miscellaneous @direntry -* Groff: (groff). The GNU troff document formatting system. +* Groff: (groff). The GNU troff document formatting system. @end direntry -@smallbook - - -@iftex -@finalout -@end iftex - - -@ifinfo -This Info file documents GNU troff version 1.16. - -Published by the Free Software Foundation -59 Temple Place, Suite 330 -Boston, MA 02111-1307 USA - -Copyright (C) 1994-2000 Free Software Foundation, Inc. - -Permission is granted to make and distribute verbatim copies of this -manual provided the copyright notice and this permission notice are -preserved on all copies. - -@ignore -Permission is granted to process this file through TeX and print the -results, provided the printed document carries copying permission notice -identical to this one except for the removal of this paragraph (this -paragraph not being relevant to the printed manual). - -@end ignore -Permission is granted to copy and distribute modified versions of this -manual under the conditions for verbatim copying, provided that the -entire resulting derived work is distributed under the terms of a -permission notice identical to this one. - -Permission is granted to copy and distribute translations of this manual -into another language, under the above conditions for modified versions, -except that this permission notice may be stated in a translation -approved by the Foundation. - -Permission is granted to copy and distribute modified versions of this -manual under the conditions for verbatim copying, provided also that the -section entitled ``GNU General Public License'' is included exactly as -in the original, and provided that the entire resulting derived work is -distributed under the terms of a permission notice identical to this -one. - -Permission is granted to copy and distribute translations of this manual -into another language, under the above conditions for modified versions, -except that the section entitled ``GNU General Public License'' may be -included in a translation approved by the Free Software Foundation -instead of in the original English. -@end ifinfo - - @titlepage @title groff @subtitle The GNU implementation of @code{troff} -@subtitle Edition 1.16 -@subtitle Spring 2000 +@subtitle Edition 1.18 +@subtitle Spring 2002 @author by Trent A.@w{ }Fisher -@author and Werner Lemberg - -@c Include the Distribution inside the titlepage environment so -@c that headings are turned off. Headings on and off do not work. +@author and Werner Lemberg (@email{bug-groff@@gnu.org}) @page @vskip 0pt plus 1filll -Copyright @copyright@w{ }1994-2000 Free Software Foundation,@w{ }Inc. -@sp 2 -Version 1.16 of @code{groff}, @* -Spring 2000 -@sp 2 -Published by the Free Software Foundation @* -59 Temple Place, Suite 330 @* -Boston, MA 02111-1307 USA - - -Permission is granted to make and distribute verbatim copies of this -manual provided the copyright notice and this permission notice are -preserved on all copies. - -Permission is granted to copy and distribute modified versions of this -manual under the conditions for verbatim copying, provided also that the -section entitled ``GNU General Public License'' is included exactly as -in the original, and provided that the entire resulting derived work is -distributed under the terms of a permission notice identical to this -one. - -Permission is granted to copy and distribute translations of this manual -into another language, under the above conditions for modified versions, -except that the section entitled ``GNU General Public License'' may be -included in a translation approved by the Free Software Foundation -instead of in the original English. - -Cover art by Etienne Suvasa. +@insertcopying @end titlepage -@page - -@node Top, Copying, (dir), (dir) +@contents @ifinfo -This Info file documents groff version 1.16, the GNU implementation of -the troff typesetting system. +@node Top, Introduction, (dir), (dir) +@top GNU troff -This is an in-progress document; contributions, comments, or -contributions are welcome. Send them to bug-groff@@gnu.org. +@insertcopying @end ifinfo +@ifhtml +@node Top, Introduction, (dir), (dir) +@top GNU troff + +@insertcopying +@end ifhtml + @menu -* Copying:: * Introduction:: * Invoking groff:: * Tutorial for Macro Users:: @@ -322,6 +417,7 @@ contributions are welcome. Send them to bug-groff@@gnu.org. * Output Devices:: * File formats:: * Installation:: +* Copying This Manual:: * Request Index:: * Escape Index:: * Operator Index:: @@ -336,406 +432,10 @@ contributions are welcome. Send them to bug-groff@@gnu.org. -@node Copying, Introduction, Top, Top -@cindex copying -@unnumbered GNU GENERAL PUBLIC LICENSE -@center Version 2, June 1991 - -@display -Copyright @copyright{}@w{ }1989, 1991 Free Software Foundation, Inc. -59@w{ }Temple Place, Suite@w{ }330, Boston, MA@w{ }02111, USA - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. -@end display - -@unnumberedsec Preamble - -The licenses for most software are designed to take away your freedom to -share and change it. By contrast, the GNU General Public License is -intended to guarantee your freedom to share and change free software -- -to make sure the software is free for all its users. This General -Public License applies to most of the Free Software Foundation's -software and to any other program whose authors commit to using it. -(Some other Free Software Foundation software is covered by the GNU -Library General Public License instead.) You can apply it to your -programs, too. - -When we speak of free software, we are referring to freedom, not price. -Our General Public Licenses are designed to make sure that you have the -freedom to distribute copies of free software (and charge for this -service if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs; and that you know you can do these things. - -To protect your rights, we need to make restrictions that forbid anyone -to deny you these rights or to ask you to surrender the rights. These -restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - -For example, if you distribute copies of such a program, whether gratis -or for a fee, you must give the recipients all the rights that you have. -You must make sure that they, too, receive or can get the source code. -And you must show them these terms so they know their rights. - -We protect your rights with two steps: (1)@w{ }copyright the software, -and (2)@w{ }offer you this license which gives you legal permission to -copy, distribute and/or modify the software. - -Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - -Finally, any free program is threatened constantly by software patents. -We wish to avoid the danger that redistributors of a free program will -individually obtain patent licenses, in effect making the program -proprietary. To prevent this, we have made it clear that any patent -must be licensed for everyone's free use or not licensed at all. - -The precise terms and conditions for copying, distribution and -modification follow. - -@iftex -@unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION -@end iftex -@ifinfo -@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION -@end ifinfo - -@enumerate 0 -@item -This License applies to any program or other work which contains a -notice placed by the copyright holder saying it may be distributed under -the terms of this General Public License. The ``Program'', below, -refers to any such program or work, and a ``work based on the Program'' -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, either -verbatim or with modifications and/or translated into another language. -(Hereinafter, translation is included without limitation in the term -``modification''.) Each licensee is addressed as ``you''. - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of running -the Program is not restricted, and the output from the Program is -covered only if its contents constitute a work based on the Program -(independent of having been made by running the Program). Whether that -is true depends on what the Program does. - -@item -You may copy and distribute verbatim copies of the Program's source code -as you receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice and -disclaimer of warranty; keep intact all the notices that refer to this -License and to the absence of any warranty; and give any other -recipients of the Program a copy of this License along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - -@item -You may modify your copy or copies of the Program or any portion of it, -thus forming a work based on the Program, and copy and distribute such -modifications or work under the terms of Section@w{ }1 above, provided -that you also meet all of these conditions: - -@enumerate a -@item -You must cause the modified files to carry prominent notices stating -that you changed the files and the date of any change. - -@item -You must cause any work that you distribute or publish, that in whole or -in part contains or is derived from the Program or any part thereof, to -be licensed as a whole at no charge to all third parties under the terms -of this License. - -@item -If the modified program normally reads commands interactively when run, -you must cause it, when started running for such interactive use in the -most ordinary way, to print or display an announcement including an -appropriate copyright notice and a notice that there is no warranty (or -else, saying that you provide a warranty) and that users may -redistribute the program under these conditions, and telling the user -how to view a copy of this License. (Exception: if the Program itself -is interactive but does not normally print such an announcement, your -work based on the Program is not required to print an announcement.) -@end enumerate - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, and -can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based on -the Program, the distribution of the whole must be on the terms of this -License, whose permissions for other licensees extend to the entire -whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of a -storage or distribution medium does not bring the other work under the -scope of this License. - -@item -You may copy and distribute the Program (or a work based on it, under -Section@w{ }2) in object code or executable form under the terms of -Sections@w{ }1 and@w{ }2 above provided that you also do one of the -following: - -@enumerate a -@item -Accompany it with the complete corresponding machine-readable source -code, which must be distributed under the terms of Sections@w{ }1 and@w{ -}2 above on a medium customarily used for software interchange; or, - -@item -Accompany it with a written offer, valid for at least three years, to -give any third party, for a charge no more than your cost of physically -performing source distribution, a complete machine-readable copy of the -corresponding source code, to be distributed under the terms of -Sections@w{ }1 and@w{ }2 above on a medium customarily used for software -interchange; or, - -@item -Accompany it with the information you received as to the offer to -distribute corresponding source code. (This alternative is allowed only -for noncommercial distribution and only if you received the program in -object code or executable form with such an offer, in accord with -Subsection@w{ }b above.) -@end enumerate - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to control -compilation and installation of the executable. However, as a special -exception, the source code distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies the -executable. - -If distribution of executable or object code is made by offering access -to copy from a designated place, then offering equivalent access to copy -the source code from the same place counts as distribution of the source -code, even though third parties are not compelled to copy the source -along with the object code. - -@item -You may not copy, modify, sublicense, or distribute the Program except -as expressly provided under this License. Any attempt otherwise to -copy, modify, sublicense or distribute the Program is void, and will -automatically terminate your rights under this License. However, -parties who have received copies, or rights, from you under this License -will not have their licenses terminated so long as such parties remain -in full compliance. - -@item -You are not required to accept this License, since you have not signed -it. However, nothing else grants you permission to modify or distribute -the Program or its derivative works. These actions are prohibited by -law if you do not accept this License. Therefore, by modifying or -distributing the Program (or any work based on the Program), you -indicate your acceptance of this License to do so, and all its terms and -conditions for copying, distributing or modifying the Program or works -based on it. - -@item -Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further restrictions -on the recipients' exercise of the rights granted herein. You are not -responsible for enforcing compliance by third parties to this License. - -@item -If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent license -would not permit royalty-free redistribution of the Program by all those -who receive copies directly or indirectly through you, then the only way -you could satisfy both it and this License would be to refrain entirely -from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is implemented -by public license practices. Many people have made generous -contributions to the wide range of software distributed through that -system in reliance on consistent application of that system; it is up to -the author/donor to decide if he or she is willing to distribute -software through any other system and a licensee cannot impose that -choice. - -This section is intended to make thoroughly clear what is believed to be -a consequence of the rest of this License. - -@item -If the distribution and/or use of the Program is restricted in certain -countries either by patents or by copyrighted interfaces, the original -copyright holder who places the Program under this License may add an -explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - -@item -The Free Software Foundation may publish revised and/or new versions of -the General Public License from time to time. Such new versions will be -similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and ``any -later version'', you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Program does not specify a version -number of this License, you may choose any version ever published by the -Free Software Foundation. - -@item -If you wish to incorporate parts of the Program into other free programs -whose distribution conditions are different, write to the author to ask -for permission. For software which is copyrighted by the Free Software -Foundation, write to the Free Software Foundation; we sometimes make -exceptions for this. Our decision will be guided by the two goals of -preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - -@iftex -@heading NO WARRANTY -@end iftex -@ifinfo -@center NO WARRANTY -@end ifinfo - -@item -BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR -THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER -EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. -THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH -YOU@. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL -NECESSARY SERVICING, REPAIR OR CORRECTION. - -@item -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR -DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL -DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM -(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED -INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF -THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR -OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. -@end enumerate - -@iftex -@heading END OF TERMS AND CONDITIONS -@end iftex -@ifinfo -@center END OF TERMS AND CONDITIONS -@end ifinfo - - -@page -@unnumberedsec How to Apply These Terms to Your New Programs - -If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these -terms. - -To do so, attach the following notices to the program. It is safest to -attach them to the start of each source file to most effectively convey -the exclusion of warranty; and each file should have at least the -``copyright'' line and a pointer to where the full notice is found. - -@smallexample -@var{one line to give the program's name and an idea of what it does.} -Copyright (C) 19@var{yy} @var{name of author} - -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or (at -your option) any later version. - -This program is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. -@end smallexample - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - -@smallexample -Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author} -Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type -`show w'. This is free software, and you are welcome to redistribute -it under certain conditions; type `show c' for details. -@end smallexample - -The hypothetical commands @samp{show@w{ }w} and @samp{show@w{ }c} should -show the appropriate parts of the General Public License. Of course, -the commands you use may be called something other than @samp{show@w{ -}w} and @samp{show@w{ }c}; they could even be mouse-clicks or menu items --- whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a ``copyright disclaimer'' for the program, if -necessary. Here is a sample; alter the names: - -@smallexample -@group -Yoyodyne, Inc., hereby disclaims all copyright interest -in the program `Gnomovision' (which makes passes at compilers) -written by James Hacker. - -@var{signature of Ty Coon}, 1 April 1989 -Ty Coon, President of Vice -@end group -@end smallexample - -This General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications -with the library. If this is what you want to do, use the GNU Library -General Public License instead of this License. - - - @c ===================================================================== @c ===================================================================== -@node Introduction, Invoking groff, Copying, Top +@node Introduction, Invoking groff, Top, Top @chapter Introduction @cindex introduction @@ -811,8 +511,8 @@ impossible to accomplish complex actions.'' --Doug Gwyn (22/Jun/91 in @section History @cindex history -@cindex @code{runoff} -@cindex @code{rf} +@cindex @code{runoff}, the program +@cindex @code{rf}, the program @code{troff} can trace its origins back to a formatting program called @code{runoff}, written by J.@w{ }E.@w{ }Saltzer, which ran on MIT's CTSS operating system in the mid-sixties. This name came from the common @@ -823,16 +523,16 @@ of @code{runoff}). It was rewritten as @code{rf} for the @w{PDP-7} McIllroy rewrote an extended and simplified version of @code{roff} in the @acronym{BCPL} programming language. -@cindex @code{roff} +@cindex @code{roff}, the program The first version of @acronym{UNIX} was developed on a @w{PDP-7} which was sitting around Bell Labs. In 1971 the developers wanted to get a @w{PDP-11} for further work on the operating system. In order to justify the cost for this system, they proposed that they would -implement a document formatting system for the AT&T patents division. -This first formatting program was a reimplementation of McIllroy's -@code{roff}, written by J.@w{ }F.@w{ }Ossanna. +implement a document formatting system for the @acronym{AT&T} patents +division. This first formatting program was a reimplementation of +McIllroy's @code{roff}, written by J.@w{ }F.@w{ }Ossanna. -@cindex @code{nroff} +@cindex @code{nroff}, the program When they needed a more flexible language, a new version of @code{roff} called @code{nroff} (``Newer @code{roff}'') was written. It had a much more complicated syntax, but provided the basis for all future versions. @@ -866,12 +566,12 @@ He rewrote it in C, although it was now 7000@w{ }lines of uncommented code and still dependent on the CAT. As the CAT became less common, and was no longer supported by the manufacturer, the need to make it support other devices became a priority. However, before this could be done, -Ossanna was killed in an auto accident. +Ossanna was killed in a car accident. @pindex ditroff -@cindex @code{ditroff} +@cindex @code{ditroff}, the program So, Brian Kernighan took on the task of rewriting @code{troff}. The -newly rewritten version produced a device independent code which was +newly rewritten version produced device independent code which was very easy for postprocessors to read and translate to the appropriate printer codes. Also, this new version of @code{troff} (called @code{ditroff} for ``device independent @code{troff}'') had several @@ -897,7 +597,7 @@ The @code{soelim}, @code{pic}, @code{tbl}, and @code{eqn} preprocessors. @item Postprocessors for character devices, @sc{PostScript}, @TeX{} DVI, and -X@w{ }windows. GNU @code{troff} also eliminated the need for a +X@w{ }Windows. GNU @code{troff} also eliminated the need for a separate @code{nroff} program with a postprocessor which would produce @acronym{ASCII} output. @@ -947,10 +647,10 @@ hyphenation page control @item -font and character size control +font and glyph size control @item -vertical spacing (i.e.@: double spacing) +vertical spacing (e.g.@: double-spacing) @item line length and indenting @@ -1020,15 +720,15 @@ common (and the ones described in this manual) are @file{man}, Although @code{groff} provides most functions needed to format a document, some operations would be unwieldy (e.g.@: to draw pictures). -Therefore, programs called preprocessors were written which understand -their own language and produce the necessary @code{groff} operations. -These preprocessors are able to differentiate their own input from the -rest of the document via markers. +Therefore, programs called @dfn{preprocessors} were written which +understand their own language and produce the necessary @code{groff} +operations. These preprocessors are able to differentiate their own +input from the rest of the document via markers. To use a preprocessor, @acronym{UNIX} pipes are used to feed the output from the preprocessor into @code{groff}. Any number of preprocessors may be used on a given document; in this case, the preprocessors are -linked together into one pipeline. However, in @code{groff}, the user +linked together into one pipeline. However, with @code{groff}, the user does not need to construct the pipe, but only tell @code{groff} what preprocessors to use. @@ -1078,6 +778,7 @@ The section on the @file{man} macro package is partly based on Susan@w{ }G.@: Kleinmann's @file{groff_man} manual page written for the Debian GNU/Linux system. +Larry Kollar contributed the section in the @file{ms} macro package. @@ -1096,15 +797,24 @@ the preprocessors, @code{gtroff} and the postprocessor. It has become a tradition that GNU programs get the prefix @samp{g} to distinguish it from its original counterparts provided by the host (see @ref{Environment}, for more details). Thus, for example, @code{geqn} is -GNU @code{eqn}. On operating systems like Linux or the Hurd, which -don't contain proprietary software, and on MS-DOS/MS-Windows, where -@code{troff} and associated programs are not available at all, this -prefix is omitted since GNU @code{troff} is the only used incarnation of -@code{troff}. Exception: @code{groff} is never replaced by @code{roff}. +GNU @code{eqn}. On operating systems like GNU/Linux or the Hurd, which +don't contain proprietary versions of @code{troff}, and on +MS-DOS/MS-Windows, where @code{troff} and associated programs are not +available at all, this prefix is omitted since GNU @code{troff} is the +only used incarnation of @code{troff}. Exception: @samp{groff} is never +replaced by @samp{roff}. + +In this document, we consequently say @samp{gtroff} when talking about +the GNU @code{troff} program. All other implementations of @code{troff} +are called @acronym{AT&T} @code{troff} which is the common origin of +all @code{troff} derivates (with more or less compatible changes). +Similarly, we say @samp{gpic}, @samp{geqn}, etc. @menu * Groff Options:: * Environment:: +* Macro Directories:: +* Font Directories:: * Invocation Examples:: @end menu @@ -1142,7 +852,7 @@ grolbp}, and @ref{Invoking gxditview}. The command line format for @code{groff} is: @Example -groff [ -abeghilpstvzCEGNRSUVXZ ] [ -F@var{dir} ] [ -m@var{name} ] +groff [ -abceghilpstvzCEGNRSUVXZ ] [ -F@var{dir} ] [ -m@var{name} ] [ -T@var{def} ] [ -f@var{fam} ] [ -w@var{name} ] [ -W@var{name} ] [ -M@var{dir} ] [ -d@var{cs} ] [ -r@var{cn} ] [ -n@var{num} ] [ -o@var{list} ] [ -P@var{arg} ] [ -L@var{arg} ] [ -I@var{dir} ] @@ -1152,7 +862,7 @@ groff [ -abeghilpstvzCEGNRSUVXZ ] [ -F@var{dir} ] [ -m@var{name} ] The command line format for @code{gtroff} is as follows. @Example -gtroff [ -abivzCERU ] [ -w@var{name} ] [ -W@var{name} ] [ -d@var{cs} ] +gtroff [ -abcivzCERU ] [ -w@var{name} ] [ -W@var{name} ] [ -d@var{cs} ] [ -f@var{fam} ] [ -m@var{name} ] [ -n@var{num} ] [ -o@var{list} ] [ -r@var{cn} ] [ -T@var{name} ] [ -F@var{dir} ] [ -M@var{dir} ] [ @var{files}@dots{} ] @@ -1162,8 +872,8 @@ gtroff [ -abivzCERU ] [ -w@var{name} ] [ -W@var{name} ] [ -d@var{cs} ] Obviously, many of the options to @code{groff} are actually passed on to @code{gtroff}. -Options without an argument can be grouped behind a single @option{-}. -A filename of @file{-} denotes the standard input. It is possible to +Options without an argument can be grouped behind a single@w{ }@option{-}. +A filename of@w{ }@file{-} denotes the standard input. It is possible to have whitespace between an option and its parameter. The @code{grog} command can be used to guess the correct @code{groff} @@ -1194,6 +904,9 @@ Preprocess with @code{gpic}. @item -s Preprocess with @code{gsoelim}. +@item -c +Suppress color output. + @item -R Preprocess with @code{grefer}. No mechanism is provided for passing arguments to @code{grefer} because most @code{grefer} options have @@ -1232,9 +945,9 @@ ignored. @item -L@var{arg} Pass @var{arg} to the spooler. Each argument should be passed with a -separate @option{-L} option. Note that @code{groff} does not prepend a -@samp{-} to @var{arg} before passing it to the postprocessor. If the -@code{print} keyword in the device description file is missing, +separate @option{-L} option. Note that @code{groff} does not prepend +a @samp{-} to @var{arg} before passing it to the postprocessor. +If the @code{print} keyword in the device description file is missing, @option{-L} is ignored. @item -T@var{dev} @@ -1252,29 +965,46 @@ For @TeX{} DVI format. @item X75 For a 75@dmn{dpi} X11 previewer. +@item X75-12 +For a 75@dmn{dpi} X11 previewer with a 12@dmn{pt} base font in the +document. + @item X100 For a 100@dmn{dpi} X11 previewer. +@item X100-12 +For a 100@dmn{dpi} X11 previewer with a 12@dmn{pt} base font in the +document. + @item ascii -For typewriter-like devices. +@cindex encoding, @acronym{ASCII} +@cindex @acronym{ASCII}, encoding +For typewriter-like devices using the (7-bit) @acronym{ASCII} +character set. @item latin1 +@cindex encoding, latin-1 +@cindex latin-1, encoding For typewriter-like devices that support the @w{Latin-1} (@w{ISO 8859-1}) character set. @item utf8 +@cindex encoding, utf-8 +@cindex utf-8, encoding For typewriter-like devices which use the Unicode (@w{ISO 10646}) character set with @w{UTF-8} encoding. @item cp1047 @cindex @acronym{EBCDIC} encoding +@cindex encoding, @acronym{EBCDIC} +@cindex encoding, cp1047 @cindex cp1047 @cindex IBM cp1047 For typewriter-like devices which use the @acronym{EBCDIC} encoding IBM cp1047. @item lj4 -For an HP LaserJet4-compatible (or other PCL5-compatible) printer. +For HP LaserJet4-compatible (or other PCL5-compatible) printers. @item lbp For Canon @acronym{CAPSL} printers (@w{LBP-4} and @w{LBP-8} series laser @@ -1282,15 +1012,15 @@ printers). @pindex pre-grohtml @pindex post-grohtml -@cindex @code{grohtml} +@cindex @code{grohtml}, the program @item html To produce @acronym{HTML} output. Note that the @acronym{HTML} driver consists of two parts, a preprocessor (@code{pre-grohtml}) and a postprocessor (@code{post-grohtml}). @end table -@vindex .T -@stindex .T +@cindex output device name string register (@code{.T}) +@cindex output device usage number register (@code{.T}) The predefined @code{gtroff} string register @code{.T} contains the current output device; the read-only number register @code{.T} is set to@w{ }1 if this option is used (which is always true if @code{groff} is @@ -1315,15 +1045,25 @@ Don't allow newlines with @code{eqn} delimiters. This is the same as the @option{-N} option in @code{geqn}. @item -S +@cindex @code{open} request, and safer mode +@cindex @code{opena} request, and safer mode +@cindex @code{pso} request, and safer mode +@cindex @code{sy} request, and safer mode +@cindex @code{pi} request, and safer mode +@cindex safer mode +@cindex mode, safer Safer mode. Pass the @option{-S} option to @code{gpic} and disable the @code{open}, @code{opena}, @code{pso}, @code{sy}, and @code{pi} requests. For security reasons, this is enabled by default. @item -U -Unsafe mode. Reverts to the old unsafe behaviour. +@cindex mode, unsafe +@cindex unsafe mode +Unsafe mode. This enables the @code{open}, @code{opena}, @code{pso}, +@code{sy}, and @code{pi} requests. @item -a -@vindex .A +@cindex @acronym{ASCII} approximation output register (@code{.A}) Generate an @acronym{ASCII} approximation of the typeset output. The read-only register @code{.A} is then set to@w{ }1. @xref{Built-in Registers}. A typical example is @@ -1359,13 +1099,13 @@ Inhibit all error messages. @item -C Enable compatibility mode. @xref{Implementation Differences}, for the -list of incompatibilities between @code{groff} and traditional Unix +list of incompatibilities between @code{groff} and @acronym{AT&T} @code{troff}. -@item -d@var{cs} -@itemx -d@var{name}=s -Define @var{c} or @var{name} to be a string @var{s}. @var{c} must be a -one-letter name; @var{name} can be of arbitrary length. All string +@item -d@var{c}@var{s} +@itemx -d@var{name}=@var{s} +Define @var{c} or @var{name} to be a string@w{ }@var{s}. @var{c}@w{ }must +be a one-letter name; @var{name} can be of arbitrary length. All string assignments happen before loading any macro file (including the start-up file). @@ -1375,20 +1115,18 @@ Use @var{fam} as the default font family. @xref{Font Families}. @item -m@var{name} Read in the file @file{@var{name}.tmac}. Normally @code{groff} searches for this in its macro directories. If it isn't found, it tries -@file{tmac.@var{name}} (and searches in the same directories). - -@c XXX document local and system macro dirs +@file{tmac.@var{name}} (searching in the same directories). @item -n@var{num} Number the first page @var{num}. @item -o@var{list} -@vindex .P +@cindex print current page register (@code{.P}) Output only pages in @var{list}, which is a comma-separated list of page -ranges; @samp{@var{n}} means print page @var{n}, @samp{@var{m}-@var{n}} -means print every page between @var{m} and @var{n}, @samp{-@var{n}} -means print every page up to @var{n}, @samp{@var{n}-} means print every -page beginning with @var{n}. @code{gtroff} exits after printing the +ranges; @samp{@var{n}} means print page@w{ }@var{n}, @samp{@var{m}-@var{n}} +means print every page between @var{m} and@w{ }@var{n}, @samp{-@var{n}} +means print every page up to@w{ }@var{n}, @samp{@var{n}-} means print every +page beginning with@w{ }@var{n}. @code{gtroff} exits after printing the last page in the list. All the ranges are inclusive on both ends. Within @code{gtroff}, this information can be extracted with the @@ -1398,22 +1136,24 @@ If your document restarts page numbering at the beginning of each chapter, then @code{gtroff} prints the specified page range for each chapter. -@item -r@var{cn} +@item -r@var{c}@var{n} @itemx -r@var{name}=@var{n} -Set number register @var{c} or @var{name} to the value @var{n}. @var{c} -must be a one-letter name; @var{name} can be of arbitrary length. -@var{n} can be any @code{gtroff} numeric expression. All register -assignments happen before loading any macro file (including the start-up -file). +Set number register@w{ }@var{c} or @var{name} to the value@w{ }@var{n}. +@var{c}@w{ }must be a one-letter name; @var{name} can be of arbitrary +length. @var{n}@w{ }can be any @code{gtroff} numeric expression. All +register assignments happen before loading any macro file (including +the start-up file). @item -F@var{dir} Search @file{@var{dir}} for subdirectories @file{dev@var{name}} (@var{name} is the name of the device), for the @file{DESC} file, and -for font files before looking in the standard directories. +for font files before looking in the standard directories (@pxref{Font +Directories}). This option is passed to all pre- and postprocessors +using the @env{GROFF_FONT_PATH} environment variable. @item -M@var{dir} Search directory @file{@var{dir}} for macro files before the standard -directories. +directories (@pxref{Macro Directories}). @item -I@var{dir} This option is as described in @ref{gsoelim}. It implies the @@ -1423,7 +1163,7 @@ This option is as described in @ref{gsoelim}. It implies the @c ===================================================================== -@node Environment, Invocation Examples, Groff Options, Invoking groff +@node Environment, Macro Directories, Groff Options, Invoking groff @section Environment @cindex environment variables @cindex variables in environment @@ -1433,40 +1173,42 @@ not within @code{gtroff}) which can modify the behavior of @code{groff}. @table @code @item GROFF_COMMAND_PREFIX -@tindex GROFF_COMMAND_PREFIX, environment variable -If this is set to @var{X}, then @code{groff} runs @code{@var{X}troff} +@tindex GROFF_COMMAND_PREFIX@r{, environment variable} +@cindex command prefix +@cindex prefix, for commands +If this is set to@w{ }@var{X}, then @code{groff} runs @code{@var{X}troff} instead of @code{gtroff}. This also applies to @code{tbl}, @code{pic}, @code{eqn}, @code{grn}, @code{refer}, and @code{soelim}. It does not apply to @code{grops}, @code{grodvi}, @code{grotty}, @code{pre-grohtml}, @code{post-grohtml}, @code{grolj4}, and @code{gxditview}. -@c XXX document default values +The default command prefix is determined during the installation process. +If a non-GNU troff system is found, prefix @samp{g} is used, none +otherwise. @item GROFF_TMAC_PATH -@tindex GROFF_TMAC_PATH, environment variable +@tindex GROFF_TMAC_PATH@r{, environment variable} A colon-separated list of directories in which to search for macro files -(before the default directories are tried). - -@c XXX document local and system macro dirs +(before the default directories are tried). @xref{Macro Directories}. @item GROFF_TYPESETTER -@tindex GROFF_TYPESETTER, environment variable +@tindex GROFF_TYPESETTER@r{, environment variable} The default output device. @item GROFF_FONT_PATH -@tindex GROFF_FONT_PATH, environment variable +@tindex GROFF_FONT_PATH@r{, environment variable} A colon-separated list of directories in which to search for the @code{dev}@var{name} directory (before the default directories are -tried). +tried). @xref{Font Directories}. @item GROFF_BIN_PATH -@tindex GROFF_BIN_PATH, environment variable +@tindex GROFF_BIN_PATH@r{, environment variable} This search path, followed by @code{PATH}, is used for commands executed by @code{groff}. @item GROFF_TMPDIR -@tindex GROFF_TMPDIR, environment variable -@tindex TMPDIR, environment variable +@tindex GROFF_TMPDIR@r{, environment variable} +@tindex TMPDIR@r{, environment variable} The directory in which @code{groff} creates temporary files. If this is not set and @env{TMPDIR} is set, temporary files are created in that directory. Otherwise temporary files are created in a system-dependent @@ -1482,7 +1224,137 @@ above. @c ===================================================================== -@node Invocation Examples, , Environment, Invoking groff +@node Macro Directories, Font Directories, Environment, Invoking groff +@section Macro Directories +@cindex macro directories +@cindex directories for macros +@cindex searching macros +@cindex macros, searching + +All macro file names must be named @code{@var{name}.tmac} or +@code{tmac.@var{name}} to make the @option{-m@var{name}} command line +option work. The @code{mso} request doesn't have this restriction; any +file name can be used, and @code{gtroff} won't try to append or prepend +the @samp{tmac} string. + +@cindex tmac, directory +@cindex directory, for tmac files +@cindex tmac, path +@cindex path, for tmac files +@cindex searching macro files +@cindex macro files, searching +@cindex files, macro, searching +Macro files are kept in the @dfn{tmac directories}, all of which +constitute the @dfn{tmac path}. The elements of the search path for +macro files are (in that order): + +@itemize @bullet +@item +The directories specified with @code{gtroff}'s or @code{groff}'s +@option{-M} command line option. + +@item +@tindex GROFF_TMAC_PATH@r{, environment variable} +The directories given in the @env{GROFF_TMAC_PATH} environment +variable. + +@item +@cindex safer mode +@cindex mode, safer +@cindex unsafe mode +@cindex mode, unsafe +@cindex current directory +@cindex directory, current +The current directory (only if in unsafe mode using the @option{-U} +command line switch). + +@item +@cindex home directory +@cindex directory, home +The home directory. + +@item +@cindex site-specific directory +@cindex directory, site-specific +@cindex platform-specific directory +@cindex directory, platform-specific +A platform-dependent directory, a site-specific (platform-independent) +directory, and the main tmac directory; the default locations are + +@Example +/usr/local/lib/groff/site-tmac +/usr/local/share/groff/site-tmac +/usr/local/share/groff/1.18/tmac +@endExample + +@noindent +assuming that the version of @code{groff} is 1.18, and the installation +prefix was @file{/usr/local}. It is possible to fine-tune those +directories during the installation process. +@end itemize + + +@c ===================================================================== + +@node Font Directories, Invocation Examples, Macro Directories, Invoking groff +@section Font Directories +@cindex font directories +@cindex directories for fonts +@cindex searching fonts +@cindex fonts, searching + +Basically, there is no restriction how font files for @code{groff} are +named and how long font names are; however, to make the font family +mechanism work (@pxref{Font Families}), fonts within a family should +start with the family name, followed by the shape. For example, the +Times family uses @samp{T} for the family name and @samp{R}, @samp{B}, +@samp{I}, and @samp{BI} to indicate the shapes `roman', `bold', +`italic', and `bold italic', respectively. Thus the final font names +are @samp{TR}, @samp{TB}, @samp{TI}, and @samp{TBI}. + +@cindex font path +@cindex path, for font files +All font files are kept in the @dfn{font directories} which constitute +the @dfn{font path}. The file search functions will always append the +directory @code{dev}@var{name}, where @var{name} is the name of the +output device. Assuming, say, DVI output, and @file{/foo/bar} as a +font directory, the font files for @code{grodvi} must be in +@file{/foo/bar/devdvi}. + +The elements of the search path for font files are (in that order): + +@itemize @bullet +@item +The directories specified with @code{gtroff}'s or @code{groff}'s +@option{-F} command line option. All device drivers and some +preprocessors also have this option. + +@item +@tindex GROFF_FONT_PATH@r{, environment variable} +The directories given in the @env{GROFF_FONT_PATH} environment +variable. + +@item +@cindex site-specific directory +@cindex directory, site-specific +A site-specific directory and the main font directory; the default +locations are + +@Example +/usr/local/share/groff/site-font +/usr/local/share/groff/1.18/font +@endExample + +@noindent +assuming that the version of @code{groff} is 1.18, and the installation +prefix was @file{/usr/local}. It is possible to fine-tune those +directories during the installation process. +@end itemize + + +@c ===================================================================== + +@node Invocation Examples, , Font Directories, Invoking groff @section Invocation Examples @cindex invocation examples @cindex examples of invocation @@ -1548,16 +1420,16 @@ double-sided printing -- don't produce any output. and/or macro packages are required for formatting them, and prints the @code{groff} command including those options on the standard output. It generates one or more of the options @option{-e}, @option{-man}, -@option{-me}, @option{-mm}, @option{-ms}, @option{-mdoc}, +@option{-me}, @option{-mm}, @option{-mom}, @option{-ms}, @option{-mdoc}, @option{-mdoc-old}, @option{-p}, @option{-R}, @option{-g}, @option{-G}, @option{-s}, and @option{-t}. -A special file name @file{-} refers to the standard input. Specifying +A special file name@w{ }@file{-} refers to the standard input. Specifying no files also means to read the standard input. Any specified options are included in the printed command. No space is allowed between options and their arguments. The only options recognized are @option{-C} (which is also passed on) to enable compatibility mode, and -@option{-v} (if it is the only parameter) to print the version number. +@option{-v} to print the version number and exit. For example, @@ -1654,7 +1526,7 @@ for all good men to come to the aid of their party. Four score and seven -years ago,... +years ago, etc. @endExample @noindent @@ -1662,7 +1534,7 @@ is read, packed onto output lines, and justified to produce: @quotation Now is the time for all good men to come to the aid of their party. -Four score and seven years ago,... +Four score and seven years ago, etc. @end quotation @cindex break @@ -1707,24 +1579,25 @@ hyphens out and join a word back together. Also, words such as can occur where not wanted, such as ``@w{mother- in}-law''. @end itemize -@rqindex ls -@cindex double spacing +@cindex double-spacing (@code{ls}) @cindex spacing -@code{gtroff} double spaces output text automatically if you use the -request @w{@samp{.ls 2}}. Reactivate single spaced mode by typing -@w{@samp{.ls 1}}. +@code{gtroff} double-spaces output text automatically if you use the +request @w{@samp{.ls 2}}. Reactivate single-spaced mode by typing +@w{@samp{.ls 1}}.@footnote{If you need finer granularity of the +vertical space, use the @code{pvs} request (@pxref{Changing Type +Sizes}).} A number of requests allow to change the way the output looks, sometimes called the @dfn{layout} of the output page. Most of these -requests adjust the placing of @dfn{white space} (blank lines or +requests adjust the placing of @dfn{whitespace} (blank lines or spaces). -@cindex new page -The @samp{.bp} request starts a new page, causing a line break. +@cindex new page (@code{bp}) +The @code{bp} request starts a new page, causing a line break. -@cindex blank line -@cindex empty line -@cindex line, empty +@cindex blank line (@code{sp}) +@cindex empty line (@code{sp}) +@cindex line, empty (@code{sp}) The request @w{@samp{.sp @var{N}}} leaves @var{N}@w{ }lines of blank space. @var{N}@w{ }can be omitted (meaning skip a single line) or can be of the form @var{N}i (for @var{N}@w{ }inches) or @var{N}c (for @@ -1741,9 +1614,8 @@ leaves one and a half inches of space, followed by the line ``My thoughts on the subject'', followed by a single blank line (more measurement units are available, see @ref{Measurements}). -@rqindex ce -@cindex centering lines -@cindex lines, centering +@cindex centering lines (@code{ce}) +@cindex lines, centering (@code{ce}) Text lines can be centered by using the @code{ce} request. The line after @code{ce} is centered (horizontally) on the page. To center more than one line, use @w{@samp{.ce @var{N}}} (where @var{N} is the number @@ -1760,9 +1632,8 @@ lines to center The @w{@samp{.ce 0}} request tells @code{groff} to center zero more lines, in other words, stop centering. -@rqindex br -@cindex line break -@cindex break +@cindex line break (@code{br}) +@cindex break (@code{br}) All of these requests cause a break; that is, they always start a new line. To start a new line without performing any other action, use @code{br}. @@ -1823,24 +1694,28 @@ sacred to be touched. And there are also indented paragraphs which begin with a tag or label at the margin and the remaining text indented. -@example -@group +@Example one This is the first paragraph. Notice how the first line of the resulting paragraph lines up with the other lines in the paragraph. -@end group -@group +@endExample +@Example longlabel This paragraph had a long label. The first character of text on the first line does not line up with the text on second and subsequent lines, although they line up with each other. -@end group -@end example +@endExample A variation of this is a bulleted list. -@c XXX description +@Example +. Bulleted lists start with a bullet. It is possible + to use other glyphs instead of the bullet. In nroff + mode using the ASCII character set for output, a dot + is used instead of a real bullet. +@endExample + @c --------------------------------------------------------------------- @@ -1858,11 +1733,15 @@ supply macros for starting chapters and appendices. @node Headers and Footers, Page Layout Adjustment, Sections and Chapters, Common Features @subsection Headers and Footers -Every macro package gives some way to manipulate the headers and footers -(or @dfn{titles}) on each page. Some packages allow for different ones -on the even and odd pages (for material printed in a book form). +Every macro package gives some way to manipulate the @dfn{headers} and +@dfn{footers} (also called @dfn{titles}) on each page. This is text +put at the top and bottom of each page, respectively, which contain +data like the current page number, the current chapter title, and so +on. Its appearance is not affected by the running text. Some packages +allow for different ones on the even and odd pages (for material printed +in a book form). -The titles are called three-part titles, that is, there is a +The titles are called @dfn{three-part titles}, that is, there is a left-justified part, a centered part, and a right-justified part. An automatically generated page number may be put in any of these fields with the @samp{%} character (see @ref{Page Layout}, for more details). @@ -1881,9 +1760,9 @@ other details about the appearance of the printed pages. @subsection Displays @cindex displays -Displays are sections of text to be set off from the body of the paper. -Major quotes, tables, and figures are types of displays, as are all the -examples used in this document. +@dfn{Displays} are sections of text to be set off from the body of +the paper. Major quotes, tables, and figures are types of displays, as +are all the examples used in this document. @cindex quotes, major @cindex major quotes @@ -1891,7 +1770,7 @@ examples used in this document. are set in from the rest of the text without quote marks around them. @cindex list -A @dfn{list} is an indented, single spaced, unfilled display. Lists +A @dfn{list} is an indented, single-spaced, unfilled display. Lists should be used when the material to be printed should not be filled and justified like normal text, such as columns of figures or the examples used in this paper. @@ -1904,7 +1783,7 @@ not. @cindex keep, floating @cindex floating keep -Floating keeps move relative to the text. Hence, they are good for +@dfn{Floating keeps} move relative to the text. Hence, they are good for things which are referred to by name, such as ``See figure@w{ }3''. A floating keep appears at the bottom of the current page if it fits; otherwise, it appears at the top of the next page. Meanwhile, the @@ -1954,6 +1833,10 @@ While some macro packages use the term @dfn{index}, none actually provide that functionality. The facilities they call indices are actually more appropriate for tables of contents. +@pindex makeindex +To produce a real index in a document, external tools like the +@code{makeindex} program are necessary. + @c --------------------------------------------------------------------- @node Paper Formats, Multiple Columns, Indices, Common Features @@ -1995,12 +1878,12 @@ various special characters. @node Preprocessor Support, Configuration and Customization, Predefined Strings, Common Features @subsection Preprocessor Support -All macro packages provide support for the various preprocessors and may +All macro packages provide support for various preprocessors and may extend their functionality. For example, all macro packages mark tables (which are processed with -@code{gtbl}) by placing them between @code{.TS} and @code{.TE} macros. -The @file{ms} macro package has an option, @code{.TS@w{}H}, that prints +@code{gtbl}) by placing them between @code{TS} and @code{TE} macros. +The @file{ms} macro package has an option, @samp{.TS@w{ }H}, that prints a caption at the top of a new page (when the table is too long to fit on a single page). @@ -2039,8 +1922,8 @@ This chapter documents the main macro packages that come with @node man, mdoc, Macro Packages, Macro Packages @section @file{man} -@cindex @file{man} @cindex manual pages +@cindex man pages @pindex an.tmac @pindex man.tmac @pindex man-old.tmac @@ -2067,7 +1950,8 @@ The command line format for using the @file{man} macros with @code{groff} is: @Example -groff -m man [ -rcR=1 ] [ -rC1 ] [ -rD1 ] [ -rP@var{nnn} ] +groff -m man [ -rLL=@var{length} ] [ -rLT=@var{length} ] + [ -rcR=1 ] [ -rC1 ] [ -rD1 ] [ -rP@var{nnn} ] [ -rS@var{xx} ] [ -rX@var{nnn} ] [ @var{files}@dots{} ] @endExample @@ -2075,8 +1959,18 @@ groff -m man [ -rcR=1 ] [ -rC1 ] [ -rD1 ] [ -rP@var{nnn} ] It is possible to use @samp{-man} instead of @w{@samp{-m man}}. @table @code +@item -rLL=@var{length} +Set line length to @var{length}. If not specified, the line length +defaults to 78@w{ }en in nroff mode (this is 78@w{ }characters per +line) and 6.5@w{ }inch otherwise. + +@item -rLT=@var{length} +Set title length to @var{length}. If not specified, the title length +defaults to 78@w{ }en in nroff mode (this is 78@w{ }characters per +line) and 6.5@w{ }inch otherwise. + @item -rcR=1 -This option (the default if a tty output device is used) creates a +This option (the default if a TTY output device is used) creates a single, very long page instead of multiple pages. Use @code{-rcR=0} to disable it. @@ -2106,7 +2000,7 @@ following page numbers: 1, 2, 2a, 2b, 2c, etc. @node Man usage, Man font macros, Man options, man @subsection Usage @cindex @code{man} macros -@cindex macros for manual pages +@cindex macros for manual pages [@code{man}] @pindex man.local This section describes the available macros for manual pages. For @@ -2114,7 +2008,7 @@ further customization, put additional macros and requests into the file @file{man.local} which is loaded immediately after the @file{man} package. -@Defmac {TH, title section [@Var{extra1}] [@Var{extra2}] [@Var{extra3}]} +@Defmac {TH, title section [@Var{extra1} [@Var{extra2} [@Var{extra3}]]], man} Set the title of the man page to @var{title} and the section to @var{section}, which must have a value between 1 and@w{ }8. The value of @var{section} may also have a string appended, e.g.@: @samp{.pm}, @@ -2137,7 +2031,7 @@ single man page should contain exactly one @code{TH} macro at the beginning of the file. @endDefmac -@Defmac {SH, [@Var{heading}]} +@Defmac {SH, [@Var{heading}], man} Set up an unnumbered section heading sticking out to the left. Prints out all the text following @code{SH} up to the end of the line (or the text in the next line if there is no argument to @code{SH}) in bold @@ -2145,7 +2039,7 @@ face, one size larger than the base document size. Additionally, the left margin for the following text is reset to its default value. @endDefmac -@Defmac {SS, [@Var{heading}]} +@Defmac {SS, [@Var{heading}], man} Set up an unnumbered (sub)section heading. Prints out all the text following @code{SS} up to the end of the line (or the text in the next line if there is no argument to @code{SS}) in bold face, at the same @@ -2153,7 +2047,7 @@ size as the base document size. Additionally, the left margin for the following text is reset to its default value. @endDefmac -@Defmac {TP, [@Var{nnn}]} +@Defmac {TP, [@Var{nnn}], man} Set up an indented paragraph with label. The indentation is set to @var{nnn} if that argument is supplied (the default unit is @samp{n} if omitted), otherwise it is set to the default indentation value. @@ -2171,17 +2065,18 @@ set to a default value; on the other hand, the rest of the text has default font settings. @endDefmac -@Defmac {LP} -@Defmacx {PP} -@Defmacx {P} +@DefmacList {LP, , man} +@DefmacItem {PP, , man} +@DefmacListEnd {P, , man} These macros are mutual aliases. Any of them causes a line break at the current position, followed by a vertical space downwards by the amount specified by the @code{PD} macro. The font size and shape are -reset to the default value (10@dmn{pt} roman). Finally, the current -left margin is restored. +reset to the default value (10@dmn{pt} roman if no @option{-rS} option +is given on the command line). Finally, the current left margin is +restored. @endDefmac -@Defmac {IP, [@Var{designator}] [@Var{nnn}]} +@Defmac {IP, [@Var{designator} [@Var{nnn}]], man} Set up an indented paragraph, using @var{designator} as a tag to mark its beginning. The indentation is set to @var{nnn} if that argument is supplied (default unit is @samp{n}), otherwise the default @@ -2192,74 +2087,79 @@ designator, use @samp{""} (two double quotes) as the first argument of @code{IP}. For example, to start a paragraph with bullets as the designator and -4@dmn{en} indentation, write +4@w{ }en indentation, write @Example .IP \(bu 4 @endExample @endDefmac -@cindex hanging indentation, in manual pages -@Defmac {HP, [@Var{nnn}]} +@Defmac {HP, [@Var{nnn}], man} +@cindex hanging indentation [@code{man}] +@cindex @code{man} macros, hanging indentation Set up a paragraph with hanging left indentation. The indentation is set to @var{nnn} if that argument is supplied (default unit is @samp{n}), otherwise the default indentation value is used. Font size and face are reset to their default values. @endDefmac -@cindex left margin, how to move, in manual pages -@Defmac {RS, [@Var{nnn}]} +@Defmac {RS, [@Var{nnn}], man} +@cindex left margin, how to move [@code{man}] +@cindex @code{man} macros, moving left margin Move the left margin to the right by the value @var{nnn} if specified -(default unit is @samp{n}); otherwise the default indentation value is -used. Calls to the @code{RS} macro can be nested. +(default unit is @samp{n}); otherwise the default indentation value +is used. Calls to the @code{RS} macro can be nested. @endDefmac -@Defmac {RE, [@Var{nnn}]} +@Defmac {RE, [@Var{nnn}], man} Move the left margin back to level @var{nnn}; if no argument is given, it moves one level back. The first level (i.e., no call to @code{RS} yet) has number@w{ }1, and each call to @code{RS} increases the level by@w{ }1. @endDefmac -@maindex SH -@maindex SS -@maindex TP -@maindex LP -@maindex PP -@maindex P -@maindex IP -@maindex HP +@cindex line breaks, with vertical space [@code{man}] +@cindex @code{man} macros, line breaks with vertical space To summarize, the following macros cause a line break with the insertion of vertical space (which amount can be changed with the @code{PD} macro): @code{SH}, @code{SS}, @code{TP}, @code{LP} (@code{PP}, @code{P}), @code{IP}, and @code{HP}. -@maindex RS -@maindex RE +@cindex line breaks, without vertical space [@code{man}] +@cindex @code{man} macros, line breaks without vertical space The macros @code{RS} and @code{RE} also cause a break but do not insert vertical space. +@cindex default indentation, resetting [@code{man}] +@cindex indentaion, resetting to default [@code{man}] +@cindex @code{man} macros, resetting default indentation +Finally, the macros @code{SH}, @code{SS}, @code{LP} (@code{PP}, @code{P}), +and @code{RS} reset the indentation to its default value. + @c --------------------------------------------------------------------- @node Man font macros, Miscellaneous man macros, Man usage, man @subsection Macros to set fonts -@cindex fonts in manual pages -@cindex @code{man}, how to set fonts +@cindex font selection [@code{man}] +@cindex @code{man} macros, how to set fonts The standard font is roman; the default text size is 10@w{ }point. +If command line option @option{-rS=@var{n}} is given, use +@var{n}@dmn{pt} as the default text size. -@Defmac {SM, [@Var{text}]} +@Defmac {SM, [@Var{text}], man} Set the text on the same line or the text on the next line in a font that is one point size smaller than the default font. @endDefmac -@cindex boldface, in manual pages -@Defmac {SB, [@Var{text}]} -Set the text on the same line or the text on the next line in boldface +@Defmac {SB, [@Var{text}], man} +@cindex bold face [@code{man}] +@cindex @code{man} macros, bold face +Set the text on the same line or the text on the next line in bold face font, one point size smaller than the default font. @endDefmac -@Defmac {BI, text} +@Defmac {BI, text, man} Set its arguments alternately in bold face and italic. Thus, @Example @@ -2271,41 +2171,35 @@ would set ``this'' and ``that'' in bold face, and ``word and'' in italics. @endDefmac -@Defmac {IB, text} +@Defmac {IB, text, man} Set its arguments alternately in italic and bold face. @endDefmac -@Defmac {RI, text} +@Defmac {RI, text, man} Set its arguments alternately in roman and italic. @endDefmac -@Defmac {IR, text} +@Defmac {IR, text, man} Set its arguments alternately in italic and roman. @endDefmac -@Defmac {BR, text} +@Defmac {BR, text, man} Set its arguments alternately in bold face and roman. @endDefmac -@Defmac {RB, text} +@Defmac {RB, text, man} Set its arguments alternately in roman and bold face. @endDefmac -@Defmac {R, [@Var{text}]} -Set @var{text} in roman font. If no text is present on the line where -the macro is called, then the text of the next line appears in roman. -This is the default font to which text is returned at the end of -processing of the other macros. -@endDefmac - -@Defmac {B, [@Var{text}]} +@Defmac {B, [@Var{text}], man} Set @var{text} in bold face. If no text is present on the line where the macro is called, then the text of the next line appears in bold face. @endDefmac -@cindex italic, in manual pages -@Defmac {I, [@Var{text}]} +@Defmac {I, [@Var{text}], man} +@cindex italic fonts [@code{man}] +@cindex @code{man} macros, italic fonts Set @var{text} in italic. If no text is present on the line where the macro is called, then the text of the next line appears in italic. @endDefmac @@ -2316,35 +2210,28 @@ macro is called, then the text of the next line appears in italic. @subsection Miscellaneous macros @pindex grohtml -@cindex @file{man}, default indentation -@cindex default indentation, @file{man} -The default indentation is 7.2@dmn{n} for all output devices except for +@cindex @code{man} macros, default indentation +@cindex default indentation [@code{man}] +The default indentation is 7.2@w{ }en for all output devices except for @code{grohtml} which ignores indentation. -@maindex TH -@cindex tab stops, in manual pages -@Defmac {DT} -Set tabs every 0.5@w{ }inches. Since this macro is always called -during a @code{TH} request, it makes sense to call it only if the tab -positions have been changed. +@Defmac {DT, , man} +@cindex tab stops [@code{man}] +@cindex @code{man} macros, tab stops +Set tabs every 0.5@w{ }inches. Since this macro is always executed +during a call to the @code{TH} macro, it makes sense to call it only if +the tab positions have been changed. @endDefmac -@cindex empty space before a paragraph, in manual pages -@Defmac {PD, [@Var{nnn}]} +@Defmac {PD, [@Var{nnn}], man} +@cindex empty space before a paragraph [@code{man}] +@cindex @code{man} macros, empty space before a paragraph Adjust the empty space before a new paragraph (or section). The optional argument gives the amount of space (default unit is @samp{v}); without parameter, the value is reset to its default value -(1@w{ }line for tty devices, 0.4@dmn{v}@w{ }otherwise). +(1@w{ }line for TTY devices, 0.4@dmn{v}@w{ }otherwise). @endDefmac -@maindex SH -@maindex SS -@maindex TP -@maindex LP -@maindex PP -@maindex P -@maindex IP -@maindex HP This affects the macros @code{SH}, @code{SS}, @code{TP}, @code{LP} (as well as @code{PP} and @code{P}), @code{IP}, and @code{HP}. @@ -2355,22 +2242,22 @@ well as @code{PP} and @code{P}), @code{IP}, and @code{HP}. The following strings are defined: -@Defstr {*S} +@Defstr {S, man} Switch back to the default font size. @endDefstr -@Defstr {*R} +@Defstr {R, man} The `registered' sign. @endDefstr -@Defstr {Tm} +@Defstr {Tm, man} The `trademark' sign. @endDefstr -@glindex lq -@glindex rq -@Defstr {lq} -@Defstrx {rq} +@DefstrList {lq, man} +@DefstrListEnd {rq, man} +@cindex @code{lq} glyph, and @code{lq} string [@code{man}] +@cindex @code{rq} glyph, and @code{rq} string [@code{man}] Left and right quote. This is equal to @code{\(lq} and @code{\(rq}, respectively. @endDefstr @@ -2387,7 +2274,7 @@ become common usage to make the first line of the man page look like this: @Example -.\" @var{word} +'\" @var{word} @endExample @pindex geqn@r{, invocation in manual pages} @@ -2406,37 +2293,1536 @@ and automatically call the right preprocessor(s). @node mdoc, ms, man, Macro Packages @section @file{mdoc} -@cindex @file{mdoc} +@cindex @code{mdoc} macros @c XXX documentation +@c XXX this is a placeholder until we get stuff knocked into shape +See the @cite{groff_mdoc(7)} man page (type @command{man groff_mdoc} +at the command line). @c ===================================================================== @node ms, me, mdoc, Macro Packages @section @file{ms} -@cindex @file{ms} +@cindex @code{ms} macros -@c XXX documentation +The @file{-ms} +macros are suitable for reports, letters, books, +user manuals, and so forth. +The package provides macros for cover pages, section headings, +paragraphs, lists, footnotes, pagination, +and a table of contents. + +@menu +* ms Intro:: +* General ms Structure:: +* ms Document Control Registers:: +* ms Cover Page Macros:: +* ms Body Text:: +* ms Page Layout:: +* Differences from AT&T ms:: +@end menu + +@c --------------------------------------------------------------------- + +@node ms Intro, General ms Structure, ms, ms +@subsection Introduction to @file{ms} + +The original @file{-ms} macros were included with +@acronym{AT&T} @code{troff} as well as the +@file{man} macros. +While the @file{man} package is intended for brief documents +that can be read on-line as well as printed, the @file{ms} +macros are suitable for longer documents that are meant to be +printed rather than read on-line. + +The @file{ms} macro package included with @code{groff} +is a complete, bottom-up re-implementation. +Several macros (specific to @acronym{AT&T} +or Berkeley) are not included, while several new commands are. +@xref{Differences from AT&T ms}, for more information. + +@c --------------------------------------------------------------------- + +@node General ms Structure, ms Document Control Registers, ms Intro, ms +@subsection General structure of an @file{ms} document +@cindex @code{ms} macros, general structure + +The @file{ms} macro package expects a certain amount of structure, +but not as much as packages such as @file{man} or @file{mdoc}. + +The simplest documents can begin with a paragraph macro +(such as @code{LP} or @code{PP}), +and consist of text separated by paragraph macros +or even blank lines. +Longer documents have a structure as follows: + +@table @strong +@item Document type +If you invoke the @code{RP} +(report) macro on the first line of the document, +@code{groff} prints the cover page information on its own page; +otherwise it prints the information on the +first page with your document text immediately following. +Other document formats found in @acronym{AT&T} @code{troff} +are specific to @acronym{AT&T} or Berkeley, and are not supported in +@code{groff}. + +@item Format and layout +By setting number registers, +you can change your document's type (font and size), +margins, spacing, headers and footers, and footnotes. +@xref{ms Document Control Registers}, for more details. + +@item Cover page +A cover page consists of a title, the author's name and institution, +an abstract, and the date. +@footnote{Actually, only the title is required.} +@xref{ms Cover Page Macros}, for more details. + +@item Body +Following the cover page is your document. +You can use the @file{ms} +macros to write reports, letters, books, and so forth. +The package is designed for structured documents, +consisting of paragraphs interspersed with headings +and augmented by lists, footnotes, tables, and other +common constructs. +@xref{ms Body Text}, for more details. + +@item Table of contents +Longer documents usually include a table of contents, +which you can invoke by placing the +@code{TC} +macro at the end of your document. +The @file{ms} +macros have minimal indexing facilities, consisting of the +@code{IX} macro, which prints an entry on standard error. +Printing the table of contents at the end is necessary since +@code{groff} is a single-pass text formatter, +thus it cannot determine the page number of each section +until that section has actually been set and printed. +Since @file{ms} output is intended for hardcopy, +you can manually relocate the pages containing +the table of contents between the cover page and the +body text after printing. +@end table + +@c --------------------------------------------------------------------- + +@node ms Document Control Registers, ms Cover Page Macros, General ms Structure, ms +@subsection Document control registers +@cindex @code{ms} macros, document control registers + +The following is a list of document control number registers. +For the sake of consistency, +set registers related to margins at the beginning of your document, +or just after the @code{RP} macro. +You can set other registers later in your document, +but you should keep them together at the beginning +to make them easy to find and edit as necessary. + +@unnumberedsubsubsec Margin Settings + +@Defmpreg {PO, ms} +Defines the page offset (i.e.@: the left margin). +There is no explicit right margin setting; the combination of +the @code{PO} and @code{LL} registers implicitly define the +right margin width. + +Effective: next page. + +Default value: 1@dmn{i}. +@endDefmpreg + +@Defmpreg {LL, ms} +Defines the line length (i.e.@: the width of the body text). + +Effective: next paragraph. + +Default: 6@dmn{i}. +@endDefmpreg + +@Defmpreg {LT, ms} +Defines the title length (i.e.@: the header and footer width). +This is usually the same as @code{LL}, but not necessarily. + +Effective: next paragraph. + +Default: 6@dmn{i}. +@endDefmpreg + +@Defmpreg {HM, ms} +Defines the header margin height at the top of the page. + +Effective: next page. + +Default: 1@dmn{i}. +@endDefmpreg + +@Defmpreg {FM, ms} +Defines the footer margin height at the bottom of the page. + +Effective: next page. + +Default: 1@dmn{i}. +@endDefmpreg + +@unnumberedsubsubsec Text Settings + +@Defmpreg {PS, ms} +Defines the point size of the body text. + +Effective: next paragraph. + +Default: 10@dmn{p}. +@endDefmpreg + +@Defmpreg {VS, ms} +Defines the space between lines (line height plus leading). + +Effective: next paragraph. + +Default: 12@dmn{p}. +@endDefmpreg + +@unnumberedsubsubsec Paragraph Settings + +@Defmpreg {PI, ms} +Defines the initial indent of a @code{.PP} paragraph. + +Effective: next paragraph. + +Default: 5@dmn{n}. +@endDefmpreg + +@Defmpreg {PD, ms} +Defines the space between paragraphs. + +Effective: next paragraph. + +Default: 0.3@dmn{v}. +@endDefmpreg + +@Defmpreg {QI, ms} +Defines the indent on both sides of a quoted (@code{.QP}) paragraph. + +Effective: next paragraph. + +Default: 5@dmn{n}. +@endDefmpreg + +@unnumberedsubsubsec Footnote Settings + +@Defmpreg {FL, ms} +Defines the length of a footnote. + +Effective: next footnote. + +Default: @math{@code{@\n[LL]} * 5 / 6}. +@endDefmpreg + +@Defmpreg {FI, ms} +Defines the footnote indent. + +Effective: next footnote. + +Default: 2@dmn{n}. +@endDefmpreg + +@Defmpreg {FF, ms} +The footnote format: +@table @code +@item 0 +Prints the footnote number as a superscript; indents the footnote (default). + +@item 1 +Prints the number followed by a period (like 1.) +and indents the footnote. + +@item 2 +Like 1, without an indent. + +@item 3 +Like 1, but prints the footnote number as a hanging paragraph. +@end table + +Effective: next footnote. + +Default: 0. +@endDefmpreg + +@unnumberedsubsubsec Miscellaneous Number Registers + +@Defmpreg {MINGW, ms} +Defines the minimum width between columns in a multi-column document. + +Effective: next page. + +Default: 2@dmn{n}. +@endDefmpreg + +@c --------------------------------------------------------------------- + +@node ms Cover Page Macros, ms Body Text, ms Document Control Registers, ms +@subsection Cover page macros +@cindex @code{ms} macros, cover page +@cindex cover page macros, [@code{ms}] + +Use the following macros to create a cover page for your document +in the order shown. + +@Defmac {RP, [@code{no}], ms} +Specifies the report format for your document. +The report format creates a separate cover page. +The default action (no @code{.RP} +macro) is to print a subset of the +cover page on page 1 of your document. + +If you use the word @code{no} as an optional argument, +@code{groff} prints a title page but +does not repeat any of the title page information +(title, author, abstract, etc.) +on page 1 of the document. +@endDefmac + +@Defmac {DA, [@dots{}], ms} +(optional) Print the current date, or the arguments to the macro if any, +on the title page (if specified) and in the footers. +This is the default for @code{nroff}. +@endDefmac + +@Defmac {ND, [@dots{}], ms} +(optional) Print the current date, or the arguments to the macro if any, +on the title page (if specified) but not in the footers. +This is the default for @code{troff}. +@endDefmac + +@Defmac {TL, , ms} +Specifies the document title. +@code{groff} collects text following the @code{.TL} +macro into the title, until reaching the author name or abstract. +@endDefmac + +@Defmac {AU, , ms} +Specifies the author's name, which appears on the +line (or lines) immediately following. +You can specify multiple authors as follows: + +@Example +.AU +John Doe +.AI +University of West Bumblefuzz +.AU +Martha Buck +.AI +Monolithic Corporation + +... +@endExample +@endDefmac + +@Defmac {AI, , ms} +Specifies the author's institution. +You can specify multiple institutions in the same way +that you specify multiple authors. +@endDefmac + +@Defmac {AB, [@code{no}], ms} +Begins the abstract. +The default is to print the word @acronym{ABSTRACT}, +centered and in italics, above the text of the abstract. +The word @code{no} as an optional argument suppresses this heading. +@endDefmac + +@Defmac {AE, , ms} +End the abstract. +@endDefmac + +The following is example mark-up for a title page. +@cindex title page, example markup +@cindex example markup, title page + +@Example +@cartouche +.RP +.TL +The Inevitability of Code Bloat +in Commercial and Free Software +.AU +J. Random Luser +.AI +University of West Bumblefuzz +.AB +This report examines the long-term growth +of the code bases in two large, popular software +packages; the free Emacs and the commercial +Microsoft Word. +While differences appear in the type or order +of features added, due to the different +methodologies used, the results are the same +in the end. +.PP +The free software approach is shown to be +superior in that while free software can +become as bloated as commercial offerings, +free software tends to have fewer serious +bugs and the added features are in line with +user demand. +.AE + +... the rest of the paper follows ... +@end cartouche +@endExample + +@c --------------------------------------------------------------------- + +@node ms Body Text, ms Page Layout, ms Cover Page Macros, ms +@subsection Body text +@cindex @code{ms} macros, body text + +This section describes macros used to mark up the body of your document. +Examples include paragraphs, sections, and other groups. + +@menu +* Paragraphs in ms:: +* Headings in ms:: +* Highlighting in ms:: +* Lists in ms:: +* Indents in ms:: +* Tabstops in ms:: +* ms Displays and Keeps:: +* ms Insertions:: +* Example multi-page table:: +* ms Footnotes:: +@end menu + +@c --------------------------------------------------------------------- + +@node Paragraphs in ms, Headings in ms, ms Body Text, ms Body Text +@subsubsection Paragraphs +@cindex @code{ms} macros, paragraph handling + +The following paragraph types are available. + +@Defmac {PP, , ms} +Sets a paragraph with an initial indent. +@endDefmac + +@Defmac {LP, , ms} +Sets a paragraph with no initial indent. +@endDefmac + +@Defmac {QP, , ms} +Sets a paragraph that is indented at both left and right margins. +The effect is identical to the @acronym{HTML} @code{<BLOCKQUOTE>} element. +The next paragraph or heading returns margins to normal. +@endDefmac + +@Defmac {XP, , ms} +Sets a paragraph whose lines are indented, +except for the first line. +This is a Berkeley extension. +@endDefmac + +The following markup uses all four paragraph macros. + +@Example +@cartouche +.NH 2 +Cases used in the study +.LP +The following software and versions were +considered for this report. +.PP +For commercial software, we chose +.B "Microsoft Word for Windows" , +starting with version 1.0 through the +current version (Word 2000). +.PP +For free software, we chose +.B Emacs , +from its first appearance as a standalone +editor through the current version (v20). +See [Bloggs 2002] for details. +.QP +Franklin's Law applied to software: +software expands to outgrow both +RAM and disk space over time. +.LP +Bibliography: +.XP +Bloggs, Joseph R., +.I "Everyone's a Critic" , +Underground Press, March 2002. +A definitive work that answers all questions +and criticisms about the quality and usability of +free software. + +@end cartouche +@endExample + +@c --------------------------------------------------------------------- + +@node Headings in ms, Highlighting in ms, Paragraphs in ms, ms Body Text +@subsubsection Headings +@cindex @code{ms} macros, headings + +Use headings to create a hierarchical structure for your document. +The @file{ms} macros print headings in @strong{bold}, +using the same font family and point size as the body text. + +The following describes the heading macros: + +@DefmacList {NH, @Var{curr-level}, ms} +@DefmacListEnd {NH, @t{S} @Var{level0} @dots{}, ms} +Numbered heading. +The argument is either a numeric argument to indicate the +level of the heading, or the letter@w{ }@code{S} followed by numeric +arguments to set the heading level explicitly. + +If you specify heading levels out of sequence, such as invoking +@samp{.NH 3} after @samp{.NH 1}, @code{groff} +prints a warning on standard error. +@endDefmac + +@Defmac {SH, , ms} +Unnumbered subheading. +@endDefmac + +@c --------------------------------------------------------------------- + +@node Highlighting in ms, Lists in ms, Headings in ms, ms Body Text +@subsubsection Highlighting +@cindex @code{ms} macros, highlighting + +The @file{ms} macros provide a variety of methods to highlight +or emphasize text: + +@Defmac {B, [@Var{txt} [@Var{post} [@Var{pre}]]], ms} +Sets its first argument in @strong{bold type}. +If you specify a second argument, @code{groff} prints it in the +previous font after the bold text, with no intervening space +(this allows you to set punctuation after the highlighted text +without highlighting the punctuation). +Similarly, it prints the third argument (if any) in the previous +font @strong{before} the first argument. +For example, + +@Example +.B foo ) ( +@endExample + +prints (@strong{foo}). + +If you give this macro no arguments, @code{groff} +prints all text following in bold until +the next highlighting, paragraph, or heading macro. +@endDefmac + +@Defmac {R, [@Var{txt} [@Var{post} [@Var{pre}]]], ms} +Sets its first argument in roman (or regular) type. +It operates similarly to the @code{B}@w{ }macro otherwise. +@endDefmac + +@Defmac {I, [@Var{txt} [@Var{post} [@Var{pre}]]], ms} +Sets its first argument in @emph{italic type}. +It operates similarly to the @code{B}@w{ }macro otherwise. +@endDefmac + +@Defmac {CW, [@Var{txt} [@Var{post} [@Var{pre}]]], ms} +Sets its first argument in a @code{constant width face}. +It operates similarly to the @code{B}@w{ }macro otherwise. +@endDefmac + +@Defmac {BI, [@Var{txt} [@Var{post} [@Var{pre}]]], ms} +Sets its first argument in bold italic type. +It operates similarly to the @code{B}@w{ }macro otherwise. +@endDefmac + +@Defmac {BX, [@Var{txt}], ms} +Prints its argument and draws a box around it. +If you want to box a string that contains spaces, +use a digit-width space (@code{\0}). +@endDefmac + +@Defmac {UL, [@Var{txt} [@Var{post}]], ms} +Prints its first argument with an underline. +If you specify a second argument, @code{groff} +prints it in the previous font after +the underlined text, with no intervening space. +@endDefmac + +@Defmac {LG, , ms} +Prints all text following in larger type +(two points larger than the current point size) until +the next font size, highlighting, paragraph, or heading macro. +You can specify this macro multiple times +to enlarge the point size as needed. +@endDefmac + +@Defmac {SM, , ms} +Prints all text following in smaller type +(two points smaller than the current point size) until +the next type size, highlighting, paragraph, or heading macro. +You can specify this macro multiple times +to reduce the point size as needed. +@endDefmac + +@Defmac {NL, , ms} +Prints all text following in the normal point size +(that is, the value of the @code{PS} register). +@endDefmac + +@c --------------------------------------------------------------------- + +@node Lists in ms, Indents in ms, Highlighting in ms, ms Body Text +@subsubsection Lists +@cindex @code{ms} macros, lists + +The @code{.IP} macro handles duties for all lists. + +@Defmac {IP, [@Var{marker} [@Var{width}]], ms} +The @var{marker} is usually a bullet glyph (@code{\[bu]}) +for unordered lists, a number (or auto-incrementing number +register) for numbered lists, or a word or phrase for indented +(glossary-style) lists. + +The @var{width} specifies the indent for the body of each list item; +its default unit is @samp{n}. +Once specified, the indent remains the same for all +list items in the document until specified again. +@endDefmac + +The following is an example of a bulleted list. +@cindex example markup, bulleted list [@code{ms}] +@cindex bulleted list, example markup [@code{ms}] + +@Example +A bulleted list: +.IP \[bu] 2 +lawyers +.IP \[bu] +guns +.IP \[bu] +money +@endExample + +Produces: + +@Example +A bulleted list: + +o lawyers + +o guns + +o money +@endExample + +@sp 1 + +The following is an example of a numbered list. +@cindex example markup, numbered list [@code{ms}] +@cindex numbered list, example markup [@code{ms}] + +@Example +.nr step 1 1 +A numbered list: +.IP \n[step] 3 +lawyers +.IP \n+[step] +guns +.IP \n+[step] +money +@endExample + +Produces: + +@Example +A numbered list: + +1. lawyers + +2. guns + +3. money +@endExample + +Note the use of the auto-incrementing number +register in this example. + +@sp 1 +The following is an example of a glossary-style list. +@cindex example markup, glossary-style list [@code{ms}] +@cindex glossary-style list, example markup [@code{ms}] + +@Example +A glossary-style list: +.IP lawyers 0.4i +Two or more attorneys. +.IP guns +Firearms, preferably +large-caliber. +.IP money +Gotta pay for those +lawyers and guns! +@endExample + +Produces: + +@Example +A glossary-style list: + +lawyers + Two or more attorneys. + +guns Firearms, preferably large-caliber. + +money + Gotta pay for those lawyers and guns! +@endExample + +In the last example, the @code{IP} macro places the definition +on the same line as the term if it has enough space; otherwise, +it breaks to the next line and starts the definition below the +term. +This may or may not be the effect you want, especially if some +of the definitions break and some do not. +The following examples show two possible ways to force a break. + +The first workaround uses the @code{br} +request to force a break after printing the term or label. + +@Example +@cartouche +A glossary-style list: +.IP lawyers 0.4i +Two or more attorneys. +.IP guns +.br +Firearms, preferably large-caliber. +.IP money +Gotta pay for those lawyers and guns! +@end cartouche +@endExample + +@sp 1 +The second workaround uses the @code{\p} escape to force the break. +Note the space following the escape; this is important. +If you omit the space, @code{groff} prints the first word on +the same line as the term or label (if it fits) @strong{then} +breaks the line. + +@Example +@cartouche +A glossary-style list: +.IP lawyers 0.4i +Two or more attorneys. +.IP guns +\p Firearms, preferably large-caliber. +.IP money +Gotta pay for those lawyers and guns! +@end cartouche +@endExample + +@sp 1 +To set nested lists, use the @code{RS} and @code{RE} macros. +@xref{Indents in ms}, for more information. +@cindex @code{ms} macros, nested lists +@cindex nested lists [@code{ms}] + +For example: + +@Example +@cartouche +.IP \[bu] 2 +Lawyers: +.RS +.IP \[bu] +Dewey, +.IP \[bu] +Cheatham, +.IP \[bu] +and Howe. +.RE +.IP \[bu] +Guns +@end cartouche +@endExample + +Produces: + +@Example +o Lawyers: + + o Dewey, + + o Cheatham, + + o and Howe. + +o Guns +@endExample + +@c --------------------------------------------------------------------- + +@node Indents in ms, Tabstops in ms, Lists in ms, ms Body Text +@subsubsection Indents + +In many situations, +you may need to indent a section of text +while still wrapping and filling. +@xref{Lists in ms}, +for an example of nested lists. + +@DefmacList {RS, , ms} +@DefmacListEnd {RE, , ms} +These macros begin and end an indented section. +The @code{PI} register controls the amount of indent, +allowing the indented text to line up under hanging +and indented paragraphs. +@endDefmac + +@xref{ms Displays and Keeps}, +for macros to indent and turn off filling. + +@c --------------------------------------------------------------------- + +@node Tabstops in ms, ms Displays and Keeps, Indents in ms, ms Body Text +@subsubsection Tab Stops + +Use the @code{ta} request to define tab stops as needed. +@xref{Tabs and Fields}. + +@Defmac{TA, , ms} +Use this macro to reset the tab stops to the default for @file{ms} +(every 5n). +You can redefine the @code{TA} macro to create a different set +of default tab stops. +@endDefmac + +@c --------------------------------------------------------------------- + +@node ms Displays and Keeps, ms Insertions, Tabstops in ms, ms Body Text +@subsubsection Displays and keeps +@cindex @code{ms} macros, displays +@cindex @code{ms} macros, keeps +@cindex keeps [@code{ms}] +@cindex displays [@code{ms}] + +Use displays to show text-based examples or figures +(such as code listings). + +Displays turn off filling, so lines of code are displayed +as-is without inserting @code{br} requests in between each line. +Displays can be @dfn{kept} on a single page, or allowed +to break across pages. + +@DefmacList {DS, @t{L}, ms} +@DefmacItem {LD, , ms} +@DefmacListEnd {DE, , ms} +Left-justified display. +The @samp{.DS L} call generates a page break, if necessary, +to keep the entire display on one page. +The @code{LD} macro allows the display to break across pages. +The @code{DE} macro ends the display. +@endDefmac + +@DefmacList {DS, @t{I}, ms} +@DefmacItem {ID, , ms} +@DefmacListEnd {DE, , ms} +Indents the display as defined by the @code{DI} register. +The @samp{.DS I} call generates a page break, if necessary, +to keep the entire display on one page. +The @code{ID} macro allows the display to break across pages. +The @code{DE} macro ends the display. +@endDefmac + +@DefmacList {DS, @t{B}, ms} +@DefmacItem {BD, , ms} +@DefmacListEnd {DE, , ms} +Sets a block-centered display: the entire display is left-justified, +but indented so that the longest line in the display is centered +on the page. +The @samp{.DS B} call generates a page break, if necessary, +to keep the entire display on one page. +The @code{BD} macro allows the display to break across pages. +The @code{DE} macro ends the display. +@endDefmac + +@DefmacList {DS, @t{C}, ms} +@DefmacItem {CD, , ms} +@DefmacListEnd {DE, , ms} +Sets a centered display: each line in the display is centered. +The @samp{.DS C} call generates a page break, if necessary, +to keep the entire display on one page. +The @code{CD} macro allows the display to break across pages. +The @code{DE} macro ends the display. +@endDefmac + +@DefmacList {DS, @t{R}, ms} +@DefmacItem {RD, , ms} +@DefmacListEnd {DE, , ms} +Right-justifies each line in the display. +The @samp{.DS R} call generates a page break, if necessary, +to keep the entire display on one page. +The @code{RD} macro allows the display to break across pages. +The @code{DE} macro ends the display. +@endDefmac + +@sp 1 +On occasion, you may want to @dfn{keep} other text together on a page. +For example, you may want to keep two paragraphs together, or +a paragraph that refers to a table (or list, or other item) +immediately following. +The @file{ms} macros provide the @code{KS} and @code{KE} +macros for this purpose. + +@DefmacList {KS, , ms} +@DefmacListEnd {KE, , ms} +The @code{KS} macro begins a block of text to be kept on a +single page, and the @code{KE} macro ends the block. +@endDefmac + +@DefmacList {KF, , ms} +@DefmacListEnd {KE, , ms} +Specifies a @dfn{floating keep}; +if the keep cannot fit on the current page, @code{groff} +holds the contents of the keep and allows text following +the keep (in the source file) to fill in the remainder of +the current page. +When the page breaks, whether by an explicit @code{bp} +request or by reaching the end of the page, @code{groff} +prints the floating keep at the top of the new page. +This is useful for printing large graphics or tables +that do not need to appear exactly where specified. +@endDefmac + +You can also use the @code{ne} request to force a page break if +there is not enough vertical space remaining on the page. + +@sp 1 +Use the following macros to draw a box around a section of +text (such as a display). + +@DefmacList {B1, , ms} +@DefmacListEnd {B2, , ms} +Marks the beginning and ending of text that is to have a +box drawn around it. +The @code{B1} macro begins the box; the @code{B2} macro ends it. +Text in the box is automatically placed in a diversion (keep). +@endDefmac + +@c --------------------------------------------------------------------- + +@node ms Insertions, Example multi-page table, ms Displays and Keeps, ms Body Text +@subsubsection Tables, figures, equations, and references +@cindex @code{ms} macros, tables +@cindex @code{ms} macros, figures +@cindex @code{ms} macros, equations +@cindex @code{ms} macros, references +@cindex tables [@code{ms}] +@cindex figures [@code{ms}] +@cindex equations [@code{ms}] +@cindex references [@code{ms}] + +The @file{ms} macros support the standard +@code{groff} preprocessors: +@code{tbl}, @code{pic}, @code{eqn}, and @code{refer}. +@pindex tbl +@pindex pic +@pindex eqn +@pindex refer +You mark text meant for preprocessors by enclosing it +in pairs of tags as follows. + +@DefmacList {TS, [@code{H}], ms} +@DefmacListEnd {TE, , ms} +Denotes a table, to be processed by the @code{tbl} preprocessor. +The optional argument@w{ }@code{H} to @code{TS} instructs @code{groff} +to create a running header with the information +up to the @code{TH} macro. +@code{groff} prints the header at the beginning of the +table; if the table runs onto another page, @code{groff} +prints the header on the next page as well. +@endDefmac + +@DefmacList {PS, , ms} +@DefmacListEnd {PE, , ms} +Denotes a graphic, to be processed by the @code{pic} preprocessor. +You can create a @code{pic} file by hand, using the @acronym{AT&T} +@code{pic} manual available on the Web as a reference, or by using +a graphics program such as @code{xfig}. +@endDefmac + +@DefmacList {EQ, [@Var{align}], ms} +@DefmacListEnd {EN, , ms} +Denotes an equation, to be processed by the @code{eqn} preprocessor. +The optional @var{align} argument can be @code{C}, @code{L}, or@w{ +}@code{I} to center (the default), left-justify, or indent the equation. +@endDefmac + +@DefmacList {[, , ms} +@DefmacListEnd {], , ms} +Denotes a reference, to be processed by the @code{refer} preprocessor. +The @acronym{GNU} @cite{refer(1)} man page provides a comprehensive +reference to the preprocessor and the format of the bibliographic +database. +@endDefmac + +@menu +* Example multi-page table:: +@end menu + +@c --------------------------------------------------------------------- + +@node Example multi-page table, ms Footnotes, ms Insertions, ms Body Text +@subsubsection An example multi-page table +@cindex example markup, multi-page table [@code{ms}] +@cindex multi-page table, example markup [@code{ms}] + +The following is an example of how to set up a +table that may print across two or more pages. + +@Example +@cartouche +.TS H +allbox expand; +cb | cb . +Text ...of heading... +_ +.TH +.T& +l | l . +... the rest of the table follows... +.CW +.TE +@end cartouche +@endExample + +@c --------------------------------------------------------------------- + +@node ms Footnotes, , Example multi-page table, ms Body Text +@subsubsection Footnotes +@cindex @code{ms} macros, footnotes +@cindex footnotes [@code{ms}] + +The @file{ms} macro package has a flexible footnote system. +You can specify either numbered footnotes or symbolic footnotes +(that is, using a marker such as a dagger symbol). + +@Defstr {*, ms} +Specifies the location of a numbered footnote marker in the text. +@endDefesc + +@DefmacList {FS, , ms} +@DefmacListEnd {FE, , ms} +Specifies the text of the footnote. +The default action is to create a numbered footnote; +you can create a symbolic footnote by specifying +a @dfn{mark} glyph +(such as @code{\[dg]} for the dagger glyph) +in the body text and as an argument to the @code{FS} macro, +followed by the text of the footnote +and the @code{FE} macro. +@endDefmac + +You can control how @code{groff} +prints footnote numbers by changing the value of the +@code{FF} register. @xref{ms Document Control Registers}. + +@c --------------------------------------------------------------------- + +@node ms Page Layout, Differences from AT&T ms, ms Body Text, ms +@subsection Page layout +@cindex @code{ms} macros, page layout +@cindex page layout [@code{ms}] + +The default output from the @file{ms} +macros provides a minimalist page layout: +it prints a single column, with the page number centered at the top +of each page. +It prints no footers. + +You can change the layout by setting +the proper number registers and strings. + +@menu +* ms Headers and Footers:: +* ms Margins:: +* ms Multiple Columns:: +* ms TOC:: +* ms Strings and Special Characters:: +@end menu + +@c --------------------------------------------------------------------- + +@node ms Headers and Footers, ms Margins, ms Page Layout, ms Page Layout +@subsubsection Headers and footers +@cindex @code{ms} macros, headers +@cindex @code{ms} macros, footers +@cindex headers [@code{ms}] +@cindex footers [@code{ms}] + +For documents that do not distinguish between odd and even pages, +set the following strings: + +@DefstrList {LH, ms} +@DefstrItem {CH, ms} +@DefstrListEnd {RH, ms} +Sets the left, center, and right headers. +@endDefstr + +@DefstrList {LF, ms} +@DefstrItem {CF, ms} +@DefstrListEnd {RF, ms} +Sets the left, center, and right footers. +@endDefstr + +@sp 1 +For documents that need different information printed in the +even and odd pages, use the following macros: + +@DefmacList {OH, @t{'}@Var{left}@t{'}@Var{center}@t{'}@Var{right}@t{'}, ms} +@DefmacItem {EH, @t{'}@Var{left}@t{'}@Var{center}@t{'}@Var{right}@t{'}, ms} +@DefmacItem {OF, @t{'}@Var{left}@t{'}@Var{center}@t{'}@Var{right}@t{'}, ms} +@DefmacListEnd {EF, @t{'}@Var{left}@t{'}@Var{center}@t{'}@Var{right}@t{'}, ms} +The @code{OH} and @code{EH} macros define headers for the odd and even pages; +the @code{OF} and @code{EF} macros define footers for the odd and even pages. +This is more flexible than defining the individual strings. + +You can replace the quote (@code{'}) marks with any character not +appearing in the header or footer text. +@endDefmac + +@c --------------------------------------------------------------------- + +@node ms Margins, ms Multiple Columns, ms Headers and Footers, ms Page Layout +@subsubsection Margins +@cindex @code{ms} macros, margins + +You control margins using a set of number registers. +@xref{ms Document Control Registers}, for details. + +@c --------------------------------------------------------------------- + +@node ms Multiple Columns, ms TOC, ms Margins, ms Page Layout +@subsubsection Multiple columns +@cindex @code{ms} macros, multiple columns +@cindex multiple columns [@code{ms}] + +The @file{ms} macros can set text in as many columns as will +reasonably fit on the page. +The following macros are available; +all of them force a page break if a multi-column mode is already set. +However, if the current mode is single-column, starting a multi-column +mode does @strong{not} force a page break. + +@Defmac {1C, , ms} +Single-column mode. +@endDefmac + +@Defmac {2C, , ms} +Two-column mode. +@endDefmac + +@Defmac {MC, [@Var{width} [@Var{gutter}]], ms} +Multi-column mode. +If you specify no arguments, it is equivalent to the +@code{2C} macro. +Otherwise, @var{width} is the width of each column and +@var{gutter} is the space between columns. +The @code{MINGW} number register controls the default gutter width. +@endDefmac + +@c --------------------------------------------------------------------- + +@node ms TOC, ms Strings and Special Characters, ms Multiple Columns, ms Page Layout +@subsubsection Creating a table of contents +@cindex @code{ms} macros, creating table of contents +@cindex table of contents, creating [@code{ms}] + +The facilities in the @file{ms} macro package for creating +a table of contents are semi-automated at best. +Assuming that you want the table of contents to consist of +the document's headings, you need to repeat those headings +wrapped in @code{XS} and @code{XE} macros. + +@DefmacList {XS, [@Var{page}], ms} +@DefmacItem {XA, [@Var{page}], ms} +@DefmacListEnd {XE, , ms} +These macros define a table of contents +or an individual entry in the table of contents, +depending on their use. +The macros are very simple; they cannot indent a heading based on its level. +The easiest way to work around this is to add tabs +to the table of contents string. +The following is an example: + +@Example +@cartouche +.NH 1 +Introduction +.XS +Introduction +.XE +.LP +... +.CW +.NH 2 +Methodology +.XS + Methodology +.XE +.LP +... +@end cartouche +@endExample + +You can manually create a table of contents +by beginning with the @code{XS} macro for the first entry, +specifying the page number for that entry as the argument to @code{XS}. +Add subsequent entries using the @code{XA} macro, +specifying the page number for that entry as the argument to @code{XA}. +The following is an example: + +@Example +@cartouche +.XS 1 +Introduction +.XA 2 +A Brief History of the Universe +.XA 729 +Details of Galactic Formation +... +.XE +@end cartouche +@endExample +@endDefmac + +@Defmac {TC, [@code{no}], ms} +Prints the table of contents on a new page, +setting the page number to@w{ }@strong{i} (Roman numeral one). +You should usually place this macro at the end of the +file, since @code{groff} is a single-pass formatter and +can only print what has been collected up to the point +that the @code{TC} macro appears. + +The optional argument @code{no} suppresses printing +the title specified by the string register @code{TOC}. +@endDefmac + +@Defmac{PX, [@code{no}], ms} +Prints the table of contents on a new page, +using the current page numbering sequence. +Use this macro to print a manually-generated table of contents +at the beginning of your document. + +The optional argument @code{no} suppresses printing +the title specified by the string register @code{TOC}. +@endDefmac + +The @cite{Groff and Friends HOWTO} +includes a @code{sed} script that automatically inserts +@code{XS} and @code{XE} macro entries after each heading in a document. + +Altering the @code{NH} macro to automatically build the table +of contents is perhaps initially more difficult, but would save +a great deal of time in the long run if you use @file{ms} regularly. + +@c --------------------------------------------------------------------- + +@node ms Strings and Special Characters, , ms TOC, ms Page Layout +@subsubsection Strings and Special Characters +@cindex @code{ms} macros, strings +@cindex @code{ms} macros, special characters +@cindex @code{ms} macros, accent marks +@cindex accent marks [@code{ms}] +@cindex special characters [@code{ms}] +@cindex strings [@code{ms}] + +The @file{ms} macros provide the following predefined strings. +You can change the string definitions to help in creating +documents in languages other than English. + +@Defstr {REFERENCES, ms} +Contains the string printed at the beginning of the +references (bibliography) page. +The default is @samp{References}. +@endDefstr + +@Defstr {ABSTRACT, ms} +Contains the string printed at the beginning of the abstract. +The default is @samp{ABSTRACT}. +@endDefstr + +@Defstr {TOC, ms} +Contains the string printed at the beginning of the table of contents. +@endDefstr + +@DefstrList {MONTH1, ms} +@DefstrItem {MONTH2, ms} +@DefstrItem {MONTH3, ms} +@DefstrItem {MONTH4, ms} +@DefstrItem {MONTH5, ms} +@DefstrItem {MONTH6, ms} +@DefstrItem {MONTH7, ms} +@DefstrItem {MONTH8, ms} +@DefstrItem {MONTH9, ms} +@DefstrItem {MONTH10, ms} +@DefstrItem {MONTH11, ms} +@DefstrListEnd {MONTH12, ms} +Prints the full name of the month in dates. +The default is @samp{January}, @samp{February}, etc. +@endDefstr + +The following special characters are available@footnote{For an +explanation what special characters are see @ref{Special Characters}.}: + +@Defstr {-, ms} +Prints an em dash. +@endDefstr + +@DefstrList {*Q, ms} +@DefstrListEnd {*U, ms} +Prints typographer's quotes in troff, +plain quotes in nroff. +@code{*Q} is the left quote and @code{*U} is the right quote. +@endDefstr + +Improved accent marks are available in the @file{ms} macros. + +@Defmac {AM, , ms} +Specify this macro at the beginning of your document +to enable extended accent marks and special characters. +This is a Berkeley extension. + +To use the accent marks, place them @strong{after} +the character being accented. +@endDefmac + +The following accent marks are available +after invoking the @code{AM} macro: + +@Defstr {\', ms} +Acute accent. +@endDefstr + +@Defstr {\`, ms} +Grave accent. +@endDefstr + +@Defstr {^, ms} +Circumflex. +@endDefstr + +@Defstr {\,, ms} +Cedilla. +@endDefstr + +@Defstr {~, ms} +Tilde. +@endDefstr + +@deffn String @t{\*[:]} +@ifnotinfo +@stindex : @r{[}ms@r{]} +@end ifnotinfo +@ifinfo +@stindex @r{<colon>} @r{[}ms@r{]} +@end ifinfo +Umlaut. +@end deffn + +@Defstr {v, ms} +Hacek. +@endDefstr + +@Defstr {_, ms} +Macron (overbar). +@endDefstr + +@Defstr {., ms} +Underdot. +@endDefstr + +@Defstr {o, ms} +Ring above. +@endDefstr + +The following are standalone characters +available after invoking the @code{AM} macro: + +@Defstr {?, ms} +Upside-down question mark. +@endDefstr + +@Defstr {!, ms} +Upside-down exclamation point. +@endDefstr + +@Defstr {8, ms} +German @ss{} ligature. +@endDefstr + +@Defstr {3, ms} +Yogh. +@endDefstr + +@Defstr {Th, ms} +Uppercase thorn. +@endDefstr + +@Defstr {th, ms} +Lowercase thorn. +@endDefstr + +@Defstr {D-, ms} +Uppercase eth. +@endDefstr + +@Defstr {d-, ms} +Lowercase eth. +@endDefstr + +@Defstr {q, ms} +Hooked o. +@endDefstr + +@Defstr {ae, ms} +Lowercase @ae{} ligature. +@endDefstr + +@Defstr {Ae, ms} +Uppercase @AE{} ligature. +@endDefstr + +@c --------------------------------------------------------------------- + +@node Differences from AT&T ms, , ms Page Layout, ms +@subsection Differences from @acronym{AT&T} @file{ms} +@cindex @code{ms} macros, differences from @acronym{AT&T} +@cindex @acronym{AT&T} @code{troff}, @code{ms} macro package differences + +This section lists the (minor) differences between the +@code{groff -ms} macros and @acronym{AT&T} +@code{troff -ms} macros. + +@menu +* Missing ms Macros:: +* Additional ms Macros:: +@end menu + +@c --------------------------------------------------------------------- + +@node Missing ms Macros, Additional ms Macros, Differences from AT&T ms, Differences from AT&T ms +@subsubsection @code{troff} macros not appearing in @code{groff} + +Macros missing from @code{groff -ms} +are cover page macros specific to Bell Labs. +The macros known to be missing are: + +@table @code +@item .TM +Technical memorandum; a cover sheet style + +@item .IM +Internal memorandum; a cover sheet style + +@item .MR +Memo for record; a cover sheet style + +@item .MF +Memo for file; a cover sheet style + +@item .EG +Engineer's notes; a cover sheet style + +@item .TR +Computing Science Tech Report; a cover sheet style + +@item .OK +Other keywords + +@item .CS +Cover sheet information + +@item .MH +A cover sheet macro +@end table + +@c --------------------------------------------------------------------- + +@node Additional ms Macros, , Missing ms Macros, Differences from AT&T ms +@subsubsection @code{groff} macros not appearing in @acronym{AT&T} @code{troff} + +The @code{groff -ms} macros have a few minor extensions +compared to the @acronym{AT&T} @code{troff -ms} macros. + +@Defmac {AM, , ms} +Improved accent marks. +@xref{ms Strings and Special Characters}, for details. +@endDefmac + +@Defmac {DS, @t{I}, ms} +Indented display. +The default behavior of @acronym{AT&T} @code{troff -ms} +was to indent; the @code{groff} default prints displays +flush left with the body text. +@endDefmac + +@Defmac {CW, , ms} +Print text in @code{constant width} (Courier) font. +@endDefmac + +@Defmac {IX, , ms} +Indexing term (printed on standard error). +You can write a script to capture and process an index +generated in this manner. +@endDefmac + +@sp 1 +The following additional number registers +appear in @code{groff -ms}: + +@Defmpreg {MINGW, ms} +Specifies a minimum space +between columns (for multi-column output); this takes the +place of the @code{GW} register that was documented but apparently +not implemented in @acronym{AT&T} @code{troff}. +@endDefmpreg + +@sp 1 +Several new string registers are available as well. +You can change these to handle (for example) the local language. +@xref{ms Strings and Special Characters}, for details. @c ===================================================================== @node me, mm, ms, Macro Packages @section @file{me} -@cindex @file{me} +@cindex @code{me} macro package @c XXX documentation +@c XXX this is a placeholder until we get stuff knocked into shape +See the @file{meintro.me} and @file{meref.me} documents in +groff's @file{doc} directory. @c ===================================================================== @node mm, , me, Macro Packages @section @file{mm} -@cindex @file{mm} +@cindex @code{mm} macro package @c XXX documentation - +@c XXX this is a placeholder until we get stuff knocked into shape +See the @cite{groff_mm(7)} man page (type @command{man groff_mm} at +the command line). @c ===================================================================== @@ -2445,7 +3831,7 @@ and automatically call the right preprocessor(s). @node gtroff Reference, Preprocessors, Macro Packages, Top @chapter @code{gtroff} Reference @cindex reference, @code{gtroff} -@cindex @code{gtroff} reference +@cindex @code{gtroff}, reference This chapter covers @strong{all} of the facilities of @code{gtroff}. Users of macro packages may skip it if not interested in details. @@ -2466,6 +3852,7 @@ Users of macro packages may skip it if not interested in details. * Character Translations:: * Troff and Nroff Mode:: * Line Layout:: +* Line Control:: * Page Layout:: * Page Control:: * Fonts:: @@ -2479,13 +3866,13 @@ Users of macro packages may skip it if not interested in details. * Diversions:: * Environments:: * Suppressing output:: +* Colors:: * I/O:: * Postprocessor Access:: * Miscellaneous:: * Gtroff Internals:: * Debugging:: * Implementation Differences:: -* Summary:: @end menu @@ -2541,7 +3928,7 @@ it. This means it widens the spacing between words until the text reaches the right margin (in the default adjustment mode). Extra spaces between words are preserved, but spaces at the end of lines are ignored. Spaces at the front of a line cause a @dfn{break} (breaks are -explained in @ref{Implicit Line Breaks}) +explained in @ref{Implicit Line Breaks}). @xref{Manipulating Filling and Adjusting}. @@ -2582,7 +3969,7 @@ a comma or a period as part of an abbreviation. @cindex space between sentences @cindex french-spacing @code{gtroff} does this by flagging certain characters (normally -@samp{!}, @samp{?}, and @samp{.}) as @dfn{end of sentence} characters. +@samp{!}, @samp{?}, and @samp{.}) as @dfn{end-of-sentence} characters. When @code{gtroff} encounters one of these characters at the end of a line, it appends a normal space followed by a @dfn{sentence space} in the formatted output. (This justifies one of the conventions mentioned @@ -2590,21 +3977,21 @@ in @ref{Input Conventions}.) @cindex transparent characters @cindex character, transparent -@glindex dg -@glindex rq -@cindex " -@cindex ' -@cindex ) -@cindex ] -@cindex * -In addition, the following characters or glyphs are treated -transparently while handling end of sentence characters: @samp{"}, -@samp{'}, @samp{)}, @samp{]}, @samp{*}, @code{dg}, and @code{rq}. +@cindex @code{dg} glyph, at end of sentence +@cindex @code{rq} glyph, at end of sentence +@cindex @code{"}, at end of sentence +@cindex @code{'}, at end of sentence +@cindex @code{)}, at end of sentence +@cindex @code{]}, at end of sentence +@cindex @code{*}, at end of sentence +In addition, the following characters and symbols are treated +transparently while handling end-of-sentence characters: @samp{"}, +@samp{'}, @samp{)}, @samp{]}, @samp{*}, @code{\[dg]}, and @code{\[rq]}. See the @code{cflags} request in @ref{Using Symbols}, for more details. -@esindex \& -To prevent the insertion of extra space after an end of sentence +@cindex @code{\&}, at end of sentence +To prevent the insertion of extra space after an end-of-sentence character (at the end of a line), append @code{\&}. @c --------------------------------------------------------------------- @@ -2617,6 +4004,7 @@ character (at the end of a line), append @code{\&}. @cindex character, tabulator @cindex @acronym{EBCDIC} encoding +@cindex encoding, @acronym{EBCDIC} @code{gtroff} translates @dfn{tabulator characters}, also called @dfn{tabs} (normally code point @acronym{ASCII} @code{0x09} or @acronym{EBCDIC} @code{0x05}), in the input into movements to the next @@ -2664,14 +4052,12 @@ line. @cindex blank line @cindex empty line @cindex line, blank -@cindex blank line macro -@rqindex blm +@cindex blank line macro (@code{blm}) There are several ways to cause a break in @code{gtroff}. A blank -line not only causes a break, but it also outputs a one line vertical +line not only causes a break, but it also outputs a one-line vertical space (effectively a blank line). Note that this behaviour can be modified with the blank line macro request @code{blm}. - -@c XXX xref for blm +@xref{Blank Line Traps}. @cindex fill mode @cindex mode, fill @@ -2721,9 +4107,9 @@ don't try using spaces to get proper indentation). @cindex measurements @cindex units of measurement -@cindex basic units -@cindex machine units -@cindex measurement units +@cindex basic unit (@code{u}) +@cindex machine unit (@code{u}) +@cindex measurement unit @cindex @code{u} unit @cindex unit, @code{u} @code{gtroff} (like many other programs) requires numeric parameters to @@ -2744,7 +4130,7 @@ current settings (e.g.@: type size) of @code{gtroff}. @table @code @item i -@cindex inch +@cindex inch unit (@code{i}) @cindex @code{i} unit @cindex unit, @code{i} Inches. An antiquated measurement unit still in use in certain @@ -2752,20 +4138,20 @@ backwards countries with incredibly low-cost computer equipment. One inch is equal to@w{ }2.54@dmn{cm}. @item c -@cindex centimeter +@cindex centimeter unit (@code{c}) @cindex @code{c} unit @cindex unit, @code{c} Centimeters. One centimeter is equal to@w{ }0.3937@dmn{in}. @item p -@cindex points +@cindex point unit (@code{p}) @cindex @code{p} unit @cindex unit, @code{p} Points. This is a typesetter's measurement used for measure type size. It is 72@w{ }points to an inch. @item P -@cindex pica +@cindex pica unit (@code{P}) @cindex @code{P} unit @cindex unit, @code{P} Pica. Another typesetting measurement. 6@w{ }Picas to an inch (and @@ -2778,6 +4164,12 @@ Pica. Another typesetting measurement. 6@w{ }Picas to an inch (and @cindex @code{z} unit @cindex unit, @code{z} @xref{Fractional Type Sizes}, for a discussion of these units. + +@item f +@cindex @code{f} unit +@cindex unit, @code{f} +Fractions. Value is 65536. +@xref{Colors}, for usage. @end table The other measurements understood by @code{gtroff} depend on @@ -2787,7 +4179,7 @@ text. @table @code @item m -@cindex em unit +@cindex em unit (@code{m}) @cindex @code{m} unit @cindex unit, @code{m} Ems. This unit is equal to the current font size in points. So called @@ -2795,14 +4187,14 @@ because it is @emph{approximately} the width of the letter@w{ }@samp{m} in the current font. @item n -@cindex en unit +@cindex en unit (@code{n}) @cindex @code{n} unit @cindex unit, @code{n} -Ens. This is half of an em. +Ens. In @code{groff}, this is half of an em. @item v -@cindex vertical space -@cindex space, vertical +@cindex vertical space unit (@code{v}) +@cindex space, vertical, unit (@code{v}) @cindex @code{v} unit @cindex unit, @code{v} Vertical space. This is equivalent to the current line spacing. @@ -2834,6 +4226,7 @@ line length of 3.5@w{ }inches and their results: 3.5i @result{} 3.5i 7/2 @result{} 0i 7/2i @result{} 0i +(7 / 2)u @result{} 0i 7i/2 @result{} 0.1i 7i/2u @result{} 3.5i @endExample @@ -2844,7 +4237,8 @@ is assumed that 1@dmn{i} equals@w{ }240@dmn{u}, and 1@dmn{m} equals@w{ }10@dmn{p} (thus 1@dmn{m} equals@w{ }33@dmn{u}). The value 7@dmn{i}/2 is first handled as 7@dmn{i}/2@dmn{m}, then converted to 1680@dmn{u}/66@dmn{u} which is 25@dmn{u}, and this is approximately -0.1@dmn{i}. +0.1@dmn{i}. As can be seen, a scaling indicator after a closing +parenthesis is simply ignored. @cindex measurements, specifying safely Thus, the safest way to specify measurements is to always @@ -2860,8 +4254,6 @@ certain scalar value, use @samp{u} as the unit for that value. @code{gtroff} has most arithmetic operators common to other languages: -@c XXX more details; examples - @itemize @bullet @item @cindex arithmetic operators @@ -2895,7 +4287,12 @@ Comparison: @samp{<} (less than), @samp{>} (greater than), @samp{<=} @cindex logical operators @cindex operators, logical @opindex & +@ifnotinfo @opindex : +@end ifnotinfo +@ifinfo +@opindex @r{<colon>} +@end ifinfo Logical: @samp{&} (logical and), @samp{:} (logical or). @item @@ -2904,31 +4301,37 @@ Logical: @samp{&} (logical and), @samp{:} (logical or). @opindex - @opindex + @opindex ! -@rqindex if -@rqindex while -@cindex @code{if}, and the @samp{!} operator -@cindex @code{while}, and the @samp{!} operator +@cindex @code{if} request, and the @samp{!} operator +@cindex @code{while} request, and the @samp{!} operator Unary operators: @samp{-} (negating, i.e.@: changing the sign), @samp{+} (just for completeness; does nothing in expressions), @samp{!} (logical not; this works only within @code{if} and @code{while} requests). See below for the use of unary operators in motion requests. @item -@cindex extremum operators -@cindex operators, extremum +@cindex extremum operators (@code{>?}, @code{<?}) +@cindex operators, extremum (@code{>?}, @code{<?}) @opindex >? @opindex <? -Extrema: @samp{>?} (maximum), @samp{<?} (minimum). For example, -@samp{5>?3} yields@w{ }@samp{5}. +Extrema: @samp{>?} (maximum), @samp{<?} (minimum). + +Example: -@c XXX add examples +@Example +.nr x 5 +.nr y 3 +.nr z (\n[x] >? \n[y]) +@endExample + +@noindent +The register@w{ }@code{z} now contains@w{ }5. @item @cindex scaling operator @cindex operator, scaling -Scaling: @code{(@var{c};@var{e})}. Evaluate @var{e} using @var{c} as -the default scaling indicator. If @var{c} is missing, ignore scaling -indicators in the evaluation of @var{e}. +Scaling: @code{(@var{c};@var{e})}. Evaluate@w{ }@var{e} using@w{ }@var{c} +as the default scaling indicator. If @var{c} is missing, ignore scaling +indicators in the evaluation of@w{ }@var{e}. @end itemize @cindex parentheses @@ -2943,28 +4346,56 @@ to right. This means that @code{gtroff} evaluates @samp{3+5*4} as if it were parenthesized like @samp{(3+5)*4}, not as @samp{3+(5*4)}, as might be expected. -@opindex +@r{, and page motion} -@opindex -@r{, and page motion} -@opindex |@r{, and page motion} +@cindex @code{+}, and page motion +@cindex @code{-}, and page motion @cindex motion operators @cindex operators, motion For many requests which cause a motion on the page, the unary operators -work differently. The @samp{+} and @samp{-} operators then indicate a -motion relative to the current position (down or up, respectively), and -the @samp{|} operator indicates an absolute position on the page or -input line. -@c XXX xref +@samp{+} and @samp{-} work differently if leading an expression. They +then indicate a motion relative to the current position (down or up, +respectively). + +@cindex @code{|}, and page motion +@cindex absolute position operator (@code{|}) +@cindex position, absolute, operator (@code{|}) +Similarly, a leading @samp{|} operator indicates an absolute position. +For vertical movements, it specifies the distance from the top of the +page; for horizontal movements, it gives the distance from the beginning +of the @emph{input} line. + +@cindex @code{bp} request, using @code{+} and@w{ }@code{-} +@cindex @code{in} request, using @code{+} and@w{ }@code{-} +@cindex @code{ll} request, using @code{+} and@w{ }@code{-} +@cindex @code{lt} request, using @code{+} and@w{ }@code{-} +@cindex @code{nm} request, using @code{+} and@w{ }@code{-} +@cindex @code{nr} request, using @code{+} and@w{ }@code{-} +@cindex @code{pl} request, using @code{+} and@w{ }@code{-} +@cindex @code{pn} request, using @code{+} and@w{ }@code{-} +@cindex @code{po} request, using @code{+} and@w{ }@code{-} +@cindex @code{ps} request, using @code{+} and@w{ }@code{-} +@cindex @code{pvs} request, using @code{+} and@w{ }@code{-} +@cindex @code{rt} request, using @code{+} and@w{ }@code{-} +@cindex @code{ti} request, using @code{+} and@w{ }@code{-} +@cindex @code{\H}, using @code{+} and@w{ }@code{-} +@cindex @code{\R}, using @code{+} and@w{ }@code{-} +@cindex @code{\s}, using @code{+} and@w{ }@code{-} @samp{+} and @samp{-} are also treated differently by the following requests and escapes: @code{bp}, @code{in}, @code{ll}, @code{lt}, @code{nm}, @code{nr}, @code{pl}, @code{pn}, @code{po}, @code{ps}, -@code{rt}, @code{ti}, @code{\R}, and @code{\s}. Here the plus and minus -signs indicate increments and decrements. +@code{pvs}, @code{rt}, @code{ti}, @code{\H}, @code{\R}, and @code{\s}. +Here, leading plus and minus signs indicate increments and decrements. -@c XXX add more xref -@xref{Setting Registers}. +@xref{Setting Registers}, for some examples. -@cindex space characters in expressions -@cindex expressions and space characters +@Defesc {\\B, ', anything, '} +@cindex numeric expression, valid +@cindex valid numeric expression +Return@w{ }1 if @var{anything} is a valid numeric expression; +or@w{ }0 if @var{anything} is empty or not a valid numeric expression. +@endDefesc + +@cindex space characters, in expressions +@cindex expressions, and space characters Due to the way arguments are parsed, spaces are not allowed in expressions, unless the entire expression is surrounded by parentheses. @@ -3000,7 +4431,7 @@ Backspace (@acronym{ASCII}@w{ }@code{0x08} or @acronym{EBCDIC}@w{ @cindex invalid input characters @cindex input characters, invalid @cindex characters, invalid input -@cindex unicode +@cindex Unicode The following input characters are invalid and are ignored if @code{groff} runs on a machine based on @acronym{ASCII}, causing a warning message of type @samp{input} (see @ref{Debugging}, for more @@ -3031,7 +4462,7 @@ end-list @@_ @endExample -@rqindex ] +@cindex @code{]}, as part of an identifier @noindent Note that identifiers longer than two characters with a closing bracket (@samp{]}) in its name can't be accessed with escape sequences which @@ -3039,7 +4470,15 @@ expect an identifier as a parameter. For example, @samp{\[foo]]} accesses the glyph @samp{foo}, followed by @samp{]}, whereas @samp{\C'foo]'} really asks for glyph @samp{foo]}. -@c XXX xref +@cindex @code{refer}, and macro names starting with @code{[} or @code{]} +@cindex @code{[}, macro names starting with, and @code{refer} +@cindex @code{]}, macro names starting with, and @code{refer} +@cindex macro names, starting with @code{[} or @code{]}, and @code{refer} +To avoid problems with the @code{refer} preprocessor, macro names +should not start with @samp{[} or @samp{]}. Due to backwards +compatibility, everything after @samp{.[} and @samp{.]} is handled as +a special argument to @code{refer}. For example, @samp{.[foo} makes +@code{refer} to start a reference, using @samp{foo} as a parameter. @Defesc {\\A, ', ident, '} Test whether an identifier @var{ident} is valid in @code{gtroff}. It @@ -3057,22 +4496,20 @@ looking up user input in some sort of associative table. @xref{Escapes}, for details on parameter delimiting characters. -@c XXX add xrefs above - Identifiers in @code{gtroff} can be any length, but, in some contexts, @code{gtroff} needs to be told where identifiers end and text begins (and in different ways depending on their length): -@rqindex ( -@rqindex [ -@rqindex ] @itemize @bullet @item Single character. +@cindex @code{(}, starting a two-character identifier @item Two characters. Must be prefixed with @samp{(} in some situations. +@cindex @code{[}, starting an identifier +@cindex @code{]}, ending an identifier @item Arbitrary length (@code{gtroff} only). Must be bracketed with @samp{[} and@w{ }@samp{]} in some situations. Any length identifier can be put @@ -3080,11 +4517,11 @@ in brackets. @end itemize @cindex undefined identifiers -@cindex indentifiers, undefined +@cindex identifiers, undefined Unlike many other programming languages, undefined identifiers are silently ignored or expanded to nothing. When @code{gtroff} finds an undefined identifier, it emits a -warning then: +warning, doing the following: @itemize @bullet @item @@ -3096,9 +4533,29 @@ If the identifier is a number register, @code{gtroff} defines it with a value of@w{ }0. @end itemize -@xref{Warnings}. +@xref{Warnings}., @ref{Interpolating Registers}, and @ref{Strings}. + +Note that macros, strings, and diversions share the same name space. + +@Example +.de xxx +. nop foo +.. +. +.di xxx +bar +.br +.di +. +.xxx + @result{} bar +@endExample -@c XXX info about common identifier pool for strings and macros. +@noindent +As can be seen in the previous example, @code{gtroff} reuses the +identifier @samp{xxx}, changing it from a macro to a diversion. +No warning is emitted! The contents of the first macro definition is +lost. @xref{Interpolating Registers}, and @ref{Strings}. @@ -3117,9 +4574,8 @@ implicit line breaking. In order to gain further functionality, The first is a @dfn{request} which takes up an entire line, and does some large-scale operation (e.g.@: break lines, start new pages). -The other is an @dfn{escape} which can be embedded anywhere in the text, -or even as an argument to a request. -@c XXX (Not always?) +The other is an @dfn{escape} which can be usually embedded anywhere +in the text; most requests can accept it even as an argument. Escapes generally do more minor operations like sub- and superscripts, print a symbol, etc. @@ -3135,13 +4591,11 @@ print a symbol, etc. @subsection Requests @cindex requests -@cindex control character -@cindex character, control -@cindex no-break control character -@cindex character, no-break control -@cindex control character, no-break -@rqindex ' -@rqindex . +@cindex control character (@code{.}) +@cindex character, control (@code{.}) +@cindex no-break control character (@code{'}) +@cindex character, no-break control (@code{'}) +@cindex control character, no-break (@code{'}) A request line begins with a control character, which is either a single quote (@samp{'}, the @dfn{no-break control character}) or a period (@samp{.}, the normal @dfn{control character}). These can be changed; @@ -3152,7 +4606,7 @@ arguments (@emph{no} tabs here). @cindex structuring source code of documents or macro packages @cindex documents, structuring the source code -@cindex macro packages, strucuring the source code +@cindex macro packages, structuring the source code Since a control character followed by whitespace only is ignored, it is common practice to use this feature for structuring the source code of documents or macro packages. @@ -3169,8 +4623,7 @@ of documents or macro packages. @endExample @cindex blank line -@cindex blank line macro -@rqindex blm +@cindex blank line macro (@code{blm}) Another possibility is to use the blank line macro request @code{blm} by assigning an empty macro to it. @@ -3191,12 +4644,11 @@ by assigning an empty macro to it. .blm \" deactivate blank line macro @endExample -@c XXX xref to blm +@xref{Blank Line Traps}. -@cindex zero width space character -@cindex character, zero width space -@cindex space character, zero width -@esindex \& +@cindex zero width space character (@code{\&}) +@cindex character, zero width space (@code{\&}) +@cindex space character, zero width (@code{\&}) @cindex @code{\&}, escaping control characters To begin a line with a control character without it being interpreted, precede it with @code{\&}. This represents a zero width space, which @@ -3216,9 +4668,12 @@ character prevents this. @cindex arguments to requests Arguments to requests (and macros) are processed much like the shell: -The line is split into arguments according to spaces. An argument -which is intended to contain spaces can either be enclosed in double -quotes, or have the spaces @dfn{escaped} with backslashes. +The line is split into arguments according to +spaces.@footnote{Plan@w{ }9's @code{troff} implementation also allows +tabs for argument separation -- @code{gtroff} intentionally doesn't +support this.} An argument which is intended to contain spaces can +either be enclosed in double quotes, or have the spaces @dfn{escaped} +with backslashes. Here are a few examples: @@ -3228,8 +4683,8 @@ Here are a few examples: .uh The\ Mouse\ Problem @endExample -@esindex \~ -@esindex \@key{SP} +@cindex @code{\~}, difference to @code{\@key{SP}} +@cindex @code{\@key{SP}}, difference to @code{\~} @noindent The first line is the @code{uh} macro being called with 3 arguments, @samp{The}, @samp{Mouse}, and @samp{Problem}. The latter two have the @@ -3241,8 +4696,8 @@ documents. Nevertheless, it is not optimal in all situations, since can't stretch. @code{gtroff} provides a different command @code{\~} to insert a stretchable, non-breaking space.} -@cindex @code{"}, as a macro argument -@cindex double quote, as a macro argument +@cindex @code{"}, in a macro argument +@cindex double quote, in a macro argument A double quote which isn't preceded by a space doesn't start a macro argument. If not closing a string, it is printed literally. @@ -3254,9 +4709,53 @@ For example, @noindent has the arguments @samp{a"}, @w{@samp{b c}}, @samp{de}, and @samp{fg"}. +Don't rely on this obscure behaviour! -@rqindex ds -Duoble quotes in the @code{ds} request are handled differently. +There are two possibilities to get a double quote reliably. + +@itemize @bullet +@item +Enclose the whole argument with double quotes and use two consecutive double +quotes to represent a single one. This traditional solution has the +disadvantage that double quotes don't survive argument expansion again if +called in compatibility mode (using the @option{-C} option of @code{groff}): + +@Example +.de xx +. tm xx: `\\$1' `\\$2' `\\$3' +. +. yy "\\$1" "\\$2" "\\$3" +.. +.de yy +. tm yy: `\\$1' `\\$2' `\\$3' +.. +.xx A "test with ""quotes""" . + @result{} xx: `A' `test with "quotes"' `.' + @result{} yy: `A' `test with ' `quotes""' +@endExample + +@noindent +If not in compatibility mode, you get the expected result + +@Example +xx: `A' `test with "quotes"' `.' +yy: `A' `test with "quotes"' `.' +@endExample + +@noindent +since @code{gtroff} preserves the input level. + +@item +Use the double quote glyph @code{\(dq}. This works with and without +compatibility mode enabled since @code{gtroff} doesn't convert @code{\(dq} +back to a double quote input character. + +Not that this method won't work with @acronym{UNIX} @code{troff} in general +since the glyph `dq' isn't defined normally. +@end itemize + +@cindex @code{ds} request, and double quotes +Double quotes in the @code{ds} request are handled differently. @xref{Strings}, for more details. @c --------------------------------------------------------------------- @@ -3282,9 +4781,6 @@ begin with a backslash and are followed by a single character which indicates the function to be performed. The escape character can be changed; see @ref{Character Translations}. -@rqindex ( -@rqindex [ -@rqindex ] Escape sequences which require an identifier as a parameter accept three possible syntax forms. @@ -3292,11 +4788,14 @@ possible syntax forms. @item The next single character is the identifier. +@cindex @code{(}, starting a two-character identifier @item If this single character is an opening parenthesis, take the following two characters as the identifier. Note that there is no closing parenthesis after the identifier. +@cindex @code{[}, starting an identifier +@cindex @code{]}, ending an identifier @item If this single character is an opening bracket, take all characters until a closing bracket as the identifier. @@ -3311,7 +4810,7 @@ Examples: \*[TeX] @endExample -@rqindex ' +@cindex @code{'}, delimiting arguments @cindex argument delimiting characters @cindex characters, argument delimiting @cindex delimiting characters for arguments @@ -3325,9 +4824,9 @@ escape expects. Example: \l'1.5i\(bu' @endExample -@esindex \o -@esindex \b -@esindex \X +@cindex @code{\o}, possible quote characters +@cindex @code{\b}, possible quote characters +@cindex @code{\X}, possible quote characters Note that the quote character can be replaced with any other character which does not occur in the argument (even a newline or a space character) in the following escapes: @code{\o}, @code{\b}, and @@ -3346,86 +4845,98 @@ in Paris @noindent possible, but it is better not to use this feature to avoid confusion. -@esindex \% -@esindex \@key{SP} -@esindex \| -@esindex \^ -@esindex \@{ -@esindex \@} -@esindex \' -@esindex \` -@esindex \- -@esindex \_ -@esindex \! -@esindex \? -@esindex \@@ -@esindex \) -@esindex \/ -@esindex \, -@esindex \& -@esindex \~ -@esindex \0 -@esindex \a -@esindex \c -@esindex \d -@esindex \e -@esindex \E -@esindex \p -@esindex \r -@esindex \t -@esindex \u +@cindex @code{\%}, used as delimiter +@cindex @code{\@key{SP}}, used as delimiter +@cindex @code{\|}, used as delimiter +@cindex @code{\^}, used as delimiter +@cindex @code{\@{}, used as delimiter +@cindex @code{\@}}, used as delimiter +@cindex @code{\'}, used as delimiter +@cindex @code{\`}, used as delimiter +@cindex @code{\-}, used as delimiter +@cindex @code{\_}, used as delimiter +@cindex @code{\!}, used as delimiter +@cindex @code{\?}, used as delimiter +@cindex @code{\@@}, used as delimiter +@cindex @code{\)}, used as delimiter +@cindex @code{\/}, used as delimiter +@cindex @code{\,}, used as delimiter +@cindex @code{\&}, used as delimiter +@ifnotinfo +@cindex @code{\:}, used as delimiter +@end ifnotinfo +@ifinfo +@cindex @code{\@r{<colon>}}, used as delimiter +@end ifinfo +@cindex @code{\~}, used as delimiter +@cindex @code{\0}, used as delimiter +@cindex @code{\a}, used as delimiter +@cindex @code{\c}, used as delimiter +@cindex @code{\d}, used as delimiter +@cindex @code{\e}, used as delimiter +@cindex @code{\E}, used as delimiter +@cindex @code{\p}, used as delimiter +@cindex @code{\r}, used as delimiter +@cindex @code{\t}, used as delimiter +@cindex @code{\u}, used as delimiter The following escapes sequences (which are handled similarly to characters since they don't take a parameter) are also allowed as delimiters: @code{\%}, @w{@samp{\ }}, @code{\|}, @code{\^}, @code{\@{}, @code{\@}}, @code{\'}, @code{\`}, @code{\-}, @code{\_}, @code{\!}, @code{\?}, @code{\@@}, @code{\)}, @code{\/}, @code{\,}, @code{\&}, -@code{\~}, @code{\0}, @code{\a}, @code{\c}, @code{\d}, @code{\e}, -@code{\E}, @code{\p}, @code{\r}, @code{\t}, and @code{\u}. Again, don't -use these if possible. - -@esindex \A -@esindex \Z -@esindex \C -@esindex \w +@code{\:}, @code{\~}, @code{\0}, @code{\a}, @code{\c}, @code{\d}, +@code{\e}, @code{\E}, @code{\p}, @code{\r}, @code{\t}, and @code{\u}. +Again, don't use these if possible. + +@cindex @code{\A}, allowed delimiters +@cindex @code{\B}, allowed delimiters +@cindex @code{\Z}, allowed delimiters +@cindex @code{\C}, allowed delimiters +@cindex @code{\w}, allowed delimiters No newline characters as delimiters are allowed in the following -escapes: @code{\A}, @code{\Z}, @code{\C}, and @code{\w}. - -@esindex \D -@esindex \h -@esindex \H -@esindex \l -@esindex \L -@esindex \N -@esindex \R -@esindex \s -@esindex \S -@esindex \v -@esindex \x +escapes: @code{\A}, @code{\B}, @code{\Z}, @code{\C}, and @code{\w}. + +@cindex @code{\D}, allowed delimiters +@cindex @code{\h}, allowed delimiters +@cindex @code{\H}, allowed delimiters +@cindex @code{\l}, allowed delimiters +@cindex @code{\L}, allowed delimiters +@cindex @code{\N}, allowed delimiters +@cindex @code{\R}, allowed delimiters +@cindex @code{\s}, allowed delimiters +@cindex @code{\S}, allowed delimiters +@cindex @code{\v}, allowed delimiters +@cindex @code{\x}, allowed delimiters Finally, the escapes @code{\D}, @code{\h}, @code{\H}, @code{\l}, -@code{\L}, @code{\N}, @code{\R}, @code{\s}, @code{\S}, @code{\v}, and -@code{\x} can't use the following characters as delimiters: +@code{\L}, @code{\N}, @code{\R}, @code{\s}, @code{\S}, @code{\v}, +and @code{\x} can't use the following characters as delimiters: @itemize @bullet @item -@cindex numbers -@cindex digits +@cindex numbers, and delimiters +@cindex digits, and delimiters The digits @code{0}-@code{9}. @item -@cindex operators -@opindex + -@opindex - -@opindex / -@opindex * -@opindex % -@opindex < -@opindex > -@opindex = -@opindex & -@opindex : -@opindex ( -@opindex ) -@opindex . +@cindex operators, as delimiters +@cindex @code{+}, as delimiter +@cindex @code{-}, as delimiter +@cindex @code{/}, as delimiter +@cindex @code{*}, as delimiter +@cindex @code{%}, as delimiter +@cindex @code{<}, as delimiter +@cindex @code{>}, as delimiter +@cindex @code{=}, as delimiter +@cindex @code{&}, as delimiter +@ifnotinfo +@cindex @code{:}, as delimiter +@end ifnotinfo +@ifinfo +@cindex <colon>, as delimiter +@end ifinfo +@cindex @code{(}, as delimiter +@cindex @code{)}, as delimiter +@cindex @code{.}, as delimiter The (single-character) operators @samp{+-/*%<>=&:().}. @item @@ -3438,36 +4949,40 @@ The (single-character) operators @samp{+-/*%<>=&:().}. The space, tab, and newline characters. @item -@esindex \% -@esindex \@{ -@esindex \@} -@esindex \' -@esindex \` -@esindex \- -@esindex \_ -@esindex \! -@esindex \@@ -@esindex \/ -@esindex \c -@esindex \e -@esindex \p -All escape sequences except @code{\%}, @code{\@{}, @code{\@}}, +@cindex @code{\%}, used as delimiter +@ifnotinfo +@cindex @code{\:}, used as delimiter +@end ifnotinfo +@ifinfo +@cindex @code{\@r{<colon>}}, used as delimiter +@end ifinfo +@cindex @code{\@{}, used as delimiter +@cindex @code{\@}}, used as delimiter +@cindex @code{\'}, used as delimiter +@cindex @code{\`}, used as delimiter +@cindex @code{\-}, used as delimiter +@cindex @code{\_}, used as delimiter +@cindex @code{\!}, used as delimiter +@cindex @code{\@@}, used as delimiter +@cindex @code{\/}, used as delimiter +@cindex @code{\c}, used as delimiter +@cindex @code{\e}, used as delimiter +@cindex @code{\p}, used as delimiter +All escape sequences except @code{\%}, @code{\:}, @code{\@{}, @code{\@}}, @code{\'}, @code{\`}, @code{\-}, @code{\_}, @code{\!}, @code{\@@}, @code{\/}, @code{\c}, @code{\e}, and @code{\p}. @end itemize -@esindex \\ -@esindex \e -@esindex \E +@cindex printing backslash (@code{\\}, @code{\e}, @code{\E}, @code{\[rs]}) +@cindex backslash, printing (@code{\\}, @code{\e}, @code{\E}, @code{\[rs]}) To have a backslash (actually, the current escape character) appear in the output several escapes are defined: @code{\\}, @code{\e} or @code{\E}. These are very similar, and only differ with respect to being used in -macros or diversions. @xref{Copy-in Mode}, and @ref{Diversions}, for -more information. - -@c XXX explanation of \E +macros or diversions. @xref{Character Translations}, for an exact +description of those escapes. -@xref{Identifiers}, and @ref{Character Translations}. +@xref{Implementation Differences}, @ref{Copy-in Mode}, and @ref{Diversions}, +@ref{Identifiers}, for more information. @menu * Comments:: @@ -3487,17 +5002,17 @@ Start a comment. Everything to the end of the input line is ignored. This may sound simple, but it can be tricky to keep the comments from interfering with the appearance of the final output. -@rqindex ds -@rqindex as +@cindex @code{ds}, @code{ds1} requests, and comments +@cindex @code{as}, @code{as1} requests, and comments If the escape is to the right of some text or a request, that portion of the line is ignored, but the space leading up to it is noticed by -@code{gtroff}. This only affects the @code{.ds} and @code{.as} -request. +@code{gtroff}. This only affects the @code{ds} and @code{as} +request and its variants. -@cindex tabs before comments +@cindex tabs, before comments @cindex comments, lining up with tabs One possibly irritating idiosyncracy is that tabs must not be used to -line up comments. Tabs are not treated as white space between the +line up comments. Tabs are not treated as whitespace between the request and macro arguments. @cindex undefined request @@ -3524,7 +5039,7 @@ To avoid this, it is common to start the line with @code{.\"} which causes the line to be treated as an undefined request and thus ignored completely. -@rqindex ' +@cindex @code{'}, as a comment Another commenting scheme seen sometimes is three consecutive single quotes (@code{'''}) at the beginning of a line. This works, but @code{gtroff} gives a warning about an undefined macro (namely @@ -3612,35 +5127,40 @@ details of formatting parameters. @node Setting Registers, Interpolating Registers, Registers, Registers @subsection Setting Registers -@cindex setting registers -@cindex registers, setting +@cindex setting registers (@code{nr}, @code{\R}) +@cindex registers, setting (@code{nr}, @code{\R}) Define or set registers using the @code{nr} request or the @code{\R} escape. -@Defreq {nr, ident value} -@Defescx {\\R, ', ident value, '} +@DefreqList {nr, ident value} +@DefescListEnd {\\R, ', ident value, '} Set number register @var{ident} to @var{value}. If @var{ident} doesn't exist, @code{gtroff} creates it. The argument to @code{\R} usually has to be enclosed in quotes. @xref{Escapes}, for details on parameter delimiting characters. + +The @code{\R} escape doesn't produce an input token in @code{gtroff}; +with other words, it vanishes completely after @code{gtroff} has +processed it. @endDefreq For example, the following two lines are equivalent: @Example -.nr a 1 -\R'a 1' +.nr a (((17 + (3 * 4))) % 4) +\R'a (((17 + (3 * 4))) % 4)' + @result{} 1 @endExample Both @code{nr} and @code{\R} have two additional special forms to increment or decrement a register. -@Defreq {nr, ident @t{+}@Var{value}} -@Defreqx {nr, ident @t{-}@Var{value}} -@Defescx {\\R, ', ident @t{+}@Var{value}, '} -@Defescx {\\R, ', ident @t{-}@Var{value}, '} +@DefreqList {nr, ident @t{+}@Var{value}} +@DefreqItem {nr, ident @t{-}@Var{value}} +@DefescItem {\\R, ', ident @t{+}@Var{value}, '} +@DefescListEnd {\\R, ', ident @t{-}@Var{value}, '} Increment (decrement) register @var{ident} by @var{value}. @Example @@ -3683,16 +5203,26 @@ with a @samp{0}: @endDefreq @Defreq {rr, ident} +@cindex removing number register (@code{rr}) +@cindex number register, removing (@code{rr}) +@cindex register, removing (@code{rr}) Remove number register @var{ident}. If @var{ident} doesn't exist, the request is ignored. @endDefreq @Defreq {rnn, ident1 ident2} +@cindex renaming number register (@code{rnn}) +@cindex number register, renaming (@code{rnn}) +@cindex register, renaming (@code{rnn}) Rename number register @var{ident1} to @var{ident2}. If either @var{ident1} or @var{ident2} doesn't exist, the request is ignored. @endDefreq @Defreq {aln, ident1 ident2} +@cindex alias, number register, creating (@code{aln}) +@cindex creating alias, for number register (@code{aln}) +@cindex number register, creating alias (@code{aln}) +@cindex register, creating alias (@code{aln}) Create an alias @var{ident1} for a number register @var{ident2}. The new name and the old name are exactly equivalent. If @var{ident1} is undefined, a warning of type @samp{reg} is generated, and the request @@ -3703,23 +5233,22 @@ is ignored. @xref{Debugging}, for information about warnings. @node Interpolating Registers, Auto-increment, Setting Registers, Registers @subsection Interpolating Registers -@cindex interpolating registers -@cindex registers, interpolating +@cindex interpolating registers (@code{\n}) +@cindex registers, interpolating (@code{\n}) Numeric registers can be accessed via the @code{\n} escape. +@DefescList {\\n, , i, } +@DefescItem {\\n, @lparen{}, id, } +@DefescListEnd {\\n, @lbrack{}, ident, @rbrack} @cindex nested assignments @cindex assignments, nested @cindex indirect assignments @cindex assignments, indirect -@Defesc {\\n, , i, } -@Defescx {\\n, @lparen{}, id, } -@Defescx {\\n, @lbrack{}, ident, @rbrack} -Interpolate number register with name @var{ident} (one-character name -@var{i}, two-character name @var{id}). This means that the value of -the register is expanded in-place while @code{gtroff} is parsing the -input line. Nested assignments (also called indirect assignments) are -possible. +Interpolate number register with name @var{ident} (one-character name@w{ +}@var{i}, two-character name @var{id}). This means that the value of the +register is expanded in-place while @code{gtroff} is parsing the input line. +Nested assignments (also called indirect assignments) are possible. @Example .nr a 5 @@ -3751,8 +5280,8 @@ Number registers can also be auto-incremented and auto-decremented. The increment or decrement value can be specified with a third argument to the @code{nr} request or @code{\R} escape. -@esindex \R @Defreq {nr, ident value incr} +@cindex @code{\R}, difference to @code{nr} Set number register @var{ident} to @var{value}; the increment for auto-incrementing is set to @var{incr}. Note that the @code{\R} escape doesn't support this notation. @@ -3761,18 +5290,18 @@ escape doesn't support this notation. To activate auto-incrementing, the escape @code{\n} has a special syntax form. -@Defesc {\\n, +, i, } -@Defescx {\\n, -, i, } -@Defescx {\\n, @lparen{}+, id, } -@Defescx {\\n, @lparen{}-, id, } -@Defescx {\\n, +@lparen{}, id, } -@Defescx {\\n, -@lparen{}, id, } -@Defescx {\\n, @lbrack{}+, ident, @rbrack{}} -@Defescx {\\n, @lbrack{}-, ident, @rbrack{}} -@Defescx {\\n, +@lbrack{}, ident, @rbrack{}} -@Defescx {\\n, -@lbrack{}, ident, @rbrack{}} +@DefescList {\\n, +, i, } +@DefescItem {\\n, -, i, } +@DefescItem {\\n, @lparen{}+, id, } +@DefescItem {\\n, @lparen{}-, id, } +@DefescItem {\\n, +@lparen{}, id, } +@DefescItem {\\n, -@lparen{}, id, } +@DefescItem {\\n, @lbrack{}+, ident, @rbrack{}} +@DefescItem {\\n, @lbrack{}-, ident, @rbrack{}} +@DefescItem {\\n, +@lbrack{}, ident, @rbrack{}} +@DefescListEnd {\\n, -@lbrack{}, ident, @rbrack{}} Before interpolating, increment or decrement @var{ident} -(one-character name @var{i}, two-character name @var{id}) by the +(one-character name@w{ }@var{i}, two-character name @var{id}) by the auto-increment value as specified with the @code{nr} request (or the @code{\R} escape). If no auto-increment value has been specified, these syntax forms are identical to @code{\n}. @@ -3801,6 +5330,7 @@ produces @endExample @cindex increment value without changing the register +@cindex value, incrementing without changing the register To change the increment value without changing the value of a register (@var{a} in the example), the following can be used: @@ -3812,8 +5342,8 @@ To change the increment value without changing the value of a register @node Assigning Formats, Built-in Registers, Auto-increment, Registers @subsection Assigning Formats -@cindex assigning formats -@cindex formats, assigning +@cindex assigning formats (@code{af}) +@cindex formats, assigning (@code{af}) When a register is used in the text of an input file (as opposed to part of an expression), it is textually replaced (or interpolated) @@ -3887,19 +5417,19 @@ thousand and Roman numeral ten thousand (Unicode code points If @var{ident} doesn't exist, it is created. @cindex read-only register, changing format -@cindex changing format, read-only register +@cindex changing format, and read-only registers Changing the output format of a read-only register causes an error. It is necessary to first copy the register's value to a writeable register, then apply the @code{af} request to this other register. @endDefreq -@cindex format of register -@cindex register, format -@Defesc {\\g, , i, } -@Defescx {\\g, @lparen{}, id, } -@Defescx {\\g, @lbrack{}, ident, @rbrack{}} +@DefescList {\\g, , i, } +@DefescItem {\\g, @lparen{}, id, } +@DefescListEnd {\\g, @lbrack{}, ident, @rbrack{}} +@cindex format of register (@code{\g}) +@cindex register, format (@code{\g}) Return the current format of the specified register @var{ident} -(one-character name @var{i}, two-character name @var{id}). For +(one-character name@w{ }@var{i}, two-character name @var{id}). For example, @samp{\ga} after the previous example would produce the string @samp{000}. If the register hasn't been defined yet, nothing is returned. @@ -3915,42 +5445,73 @@ is returned. The following lists some built-in registers which are not described elsewhere in this manual. Any register which begins with a @samp{.} is read-only. A complete listing of all built-in registers can be found in -@ref{Register Index}. +appendix@w{ }@ref{Register Index}. @table @code +@item .F +@cindex current input file name register (@code{.F}) +@cindex input file name, current, register (@code{.F}) +@vindex .F +This string-valued register returns the current input file name. + @item .H -@cindex horizontal resolution register -@cindex resolution, horizontal, register +@cindex horizontal resolution register (@code{.H}) +@cindex resolution, horizontal, register (@code{.H}) @vindex .H Horizontal resolution in basic units. @item .V -@cindex vertical resolution register -@cindex resolution, vertical, register +@cindex vertical resolution register (@code{.V}) +@cindex resolution, vertical, register (@code{.V}) @vindex .V Vertical resolution in basic units. +@item seconds +@cindex seconds, current time (@code{seconds}) +@cindex time, current, seconds (@code{seconds}) +@cindex current time, seconds (@code{seconds}) +@vindex seconds +The number of seconds after the minute, normally in the range@w{ }0 +to@w{ }59, but can be up to@w{ }61 to allow for leap seconds. Initialized +at start-up of @code{gtroff}. + +@item minutes +@cindex minutes, current time (@code{minutes}) +@cindex time, current, minutes (@code{minutes}) +@cindex current time, minutes (@code{minutes}) +@vindex minutes +The number of minutes after the hour, in the range@w{ }0 to@w{ }59. +Initialized at start-up of @code{gtroff}. + +@item hours +@cindex hours, current time (@code{hours}) +@cindex time, current, hours (@code{hours}) +@cindex current time, hours (@code{hours}) +@vindex hours +The number of hours past midnight, in the range@w{ }0 to@w{ }23. +Initialized at start-up of @code{gtroff}. + @item dw -@cindex day of the week register -@cindex date, day of the week register +@cindex day of the week register (@code{dw}) +@cindex date, day of the week register (@code{dw}) @vindex dw Day of the week (1-7). @item dy -@cindex day of the month register -@cindex date, day of the month register +@cindex day of the month register (@code{dy}) +@cindex date, day of the month register (@code{dy}) @vindex dy Day of the month (1-31). @item mo -@cindex month of the year register -@cindex date, month of the year register +@cindex month of the year register (@code{mo}) +@cindex date, month of the year register (@code{mo}) @vindex mo Current month (1-12). @item year -@cindex date, year register -@cindex year, current, register +@cindex date, year register (@code{year}, @code{yr}) +@cindex year, current, register (@code{year}, @code{yr}) @vindex year The current year. @@ -3959,8 +5520,9 @@ The current year. The current year minus@w{ }1900. Unfortunately, the documentation of @acronym{UNIX} Version@w{ }7's @code{troff} had a year@w{ }2000 bug: It incorrectly claimed that @code{yr} contains the last two digits of the -year. That claim has never been true of either traditional @code{troff} -or GNU @code{troff}. Old @code{troff} input that looks like this: +year. That claim has never been true of either @acronym{AT&T} +@code{troff} or GNU @code{troff}. Old @code{troff} input that looks +like this: @Example '\" The following line stopped working after 1999 @@ -3986,17 +5548,16 @@ This document was formatted in \n(y4. @vindex .c @itemx c. @vindex c. -@cindex input line number register -@cindex line number, input, register +@cindex input line number register (@code{.c}, @code{c.}) +@cindex line number, input, register (@code{.c}, @code{c.}) The current @emph{input} line number. Register @samp{.c} is read-only, whereas @samp{c.} (a @code{gtroff} extension) is writable also, affecting both @samp{.c} and @samp{c.}. @item ln @vindex ln -@rqindex nm -@cindex output line number register -@cindex line number, output, register +@cindex output line number register (@code{ln}) +@cindex line number, output, register (@code{ln}) The current @emph{output} line number after a call to the @code{nm} request to activate line numbering. @@ -4004,33 +5565,39 @@ request to activate line numbering. @item .x @vindex .x -@cindex major version number register -@cindex version number, major, register +@cindex major version number register (@code{.x}) +@cindex version number, major, register (@code{.x}) The major version number. For example, if the version number is@w{ }1.03 then @code{.x} contains@w{ }@samp{1}. @item .y @vindex .y -@cindex minor version number register -@cindex version number, minor, register +@cindex minor version number register (@code{.y}) +@cindex version number, minor, register (@code{.y}) The minor version number. For example, if the version number is@w{ }1.03 then @code{.y} contains@w{ }@samp{03}. @item .Y @vindex .Y -@cindex revision number register +@cindex revision number register (@code{.Y}) The revision number of @code{groff}. +@item $$ +@vindex $$ +@cindex process ID of @code{gtroff} register (@code{$$}) +@cindex @code{gtroff}, process ID register (@code{$$}) +The process ID of @code{gtroff}. + @item .g @vindex .g -@cindex @code{gtroff} identification register -@cindex GNU-specific register +@cindex @code{gtroff}, identification register (@code{.g}) +@cindex GNU-specific register (@code{.g}) Always@w{ }1. Macros should use this to determine whether they are running under GNU @code{troff}. @item .A @vindex .A -@cindex @acronym{ASCII} approximation output register +@cindex @acronym{ASCII} approximation output register (@code{.A}) If the command line option @option{-a} is used to produce an @acronym{ASCII} approximation of the output, this is set to@w{ }1, zero otherwise. @xref{Groff Options}. @@ -4049,7 +5616,7 @@ number register @code{.T} is set to@w{ }1, and zero otherwise. @xref{Groff Options}. @stindex .T -@cindex output device register +@cindex output device name string register (@code{.T}) Additionally, @code{gtroff} predefines a single read-write string register @code{.T} which contains the current output device (for example, @samp{latin1} or @samp{ps}). @@ -4068,17 +5635,17 @@ example, @samp{latin1} or @samp{ps}). @cindex break @cindex line break -@rqindex bp -@rqindex ce -@rqindex cf -@rqindex fi -@rqindex fl -@rqindex in -@rqindex nf -@rqindex rj -@rqindex sp -@rqindex ti -@rqindex trf +@cindex @code{bp} request, causing implicit linebreak +@cindex @code{ce} request, causing implicit linebreak +@cindex @code{cf} request, causing implicit linebreak +@cindex @code{fi} request, causing implicit linebreak +@cindex @code{fl} request, causing implicit linebreak +@cindex @code{in} request, causing implicit linebreak +@cindex @code{nf} request, causing implicit linebreak +@cindex @code{rj} request, causing implicit linebreak +@cindex @code{sp} request, causing implicit linebreak +@cindex @code{ti} request, causing implicit linebreak +@cindex @code{trf} request, causing implicit linebreak Various ways of causing @dfn{breaks} were given in @ref{Implicit Line Breaks}. The @code{br} request likewise causes a break. Several other requests also cause breaks, but implicitly. These are @@ -4104,21 +5671,23 @@ Initially, @code{gtroff} fills and adjusts text to both margins. Filling can be disabled via the @code{nf} request and re-enabled with the @code{fi} request. -@cindex fill mode -@cindex mode, fill -@Defreq {fi, } -@Defregx {.u} +@DefreqList {fi, } +@DefregListEnd {.u} +@cindex fill mode (@code{fi}) +@cindex mode, fill (@code{fi}) Activate fill mode (which is the default). This request implicitly enables adjusting; it also inserts a break in the text currently being filled. The read-only number register @code{.u} is set to@w{ }1. The fill mode status is associated with the current environment (@pxref{Environments}). + +See @ref{Line Control}, for interaction with the @code{\c} escape. @endDefreq -@cindex no-fill mode -@cindex mode, no-fill @Defreq {nf, } +@cindex no-fill mode (@code{nf}) +@cindex mode, no-fill (@code{nf}) Activate no-fill mode. Input lines are output as-is, retaining line breaks and ignoring the current line length. This command implicitly disables adjusting; it also causes a break. The number register @@ -4126,10 +5695,12 @@ disables adjusting; it also causes a break. The number register The fill mode status is associated with the current environment (@pxref{Environments}). + +See @ref{Line Control}, for interaction with the @code{\c} escape. @endDefreq -@Defreq {ad, [@Var{mode}]} -@Defregx {.j} +@DefreqList {ad, [@Var{mode}]} +@DefregListEnd {.j} Set adjusting mode. Activation and deactivation of adjusting is done implicitly with @@ -4149,7 +5720,7 @@ Adjust text to the right margin, producing ragged-left text. @item c @cindex centered text -@rqindex ce +@cindex @code{ce} request, difference to @samp{.ad@w{ }c} Center filled text. This is different to the @code{ce} request which only centers text without filling. @@ -4174,7 +5745,7 @@ text text @endExample -@cindex current adjustment mode register +@cindex adjustment mode register (@code{.j}) The current adjustment mode is available in the read-only number register @code{.j}; it can be stored and subsequently used to set adjustment. @@ -4192,10 +5763,11 @@ The adjustment mode status is associated with the current environment (@pxref{Environments}). @endDefreq -@Defesc {\\p, , , } +@DefreqList {brp, } +@DefescListEnd {\\p, , , } Adjust the current line and cause a break. -In most cases this produces very ugly results, since @code{gtroff} +In most cases this produces very ugly results since @code{gtroff} doesn't have a sophisticated paragraph building algorithm (as @TeX{} have, for example); instead, @code{gtroff} fills and adjusts a paragraph line by line: @@ -4214,17 +5786,17 @@ is formatted as uninteresting sentence. This is an uninteresting sentence. @endExample -@endDefesc +@endDefreq -@cindex word space size -@cindex size of word space -@cindex space between words -@cindex sentence space size -@cindex size of sentence space -@cindex space between sentences -@Defreq {ss, word_space_size [@Var{sentence_space_size}]} -@Defregx {.ss} -@Defregx {.sss} +@DefreqList {ss, word_space_size [@Var{sentence_space_size}]} +@DefregItem {.ss} +@DefregListEnd {.sss} +@cindex word space size register (@code{.ss}) +@cindex size of word space register (@code{.ss}) +@cindex space between words register (@code{.ss}) +@cindex sentence space size register (@code{.sss}) +@cindex size of sentence space register (@code{.sss}) +@cindex space between sentences register (@code{.sss}) Change the minimum size of a space between filled words. It takes its units as one twelfth of the space width parameter for the current font. Initially both the @var{word_space_size} and @@ -4252,22 +5824,22 @@ values of the parameters set by the first and second arguments of the The word space and sentence space values are associated with the current environment (@pxref{Environments}). -Contrary to traditional Unix @code{troff}, this request is @emph{not} -ignored if a tty output device is used; the given values are then -rounded down to a multiple of@w{ }12. - -@c XXX xref implementation differences +Contrary to @acronym{AT&T} @code{troff}, this request is @emph{not} +ignored if a TTY output device is used; the given values are then +rounded down to a multiple of@w{ }12 (@pxref{Implementation Differences}). The request is ignored if there is no parameter. @endDefreq -@cindex centering lines -@cindex lines, centering -@Defreq {ce, [@Var{nnn}]} -@Defregx {.ce} +@DefreqList {ce, [@Var{nnn}]} +@DefregListEnd {.ce} +@cindex centering lines (@code{ce}) +@cindex lines, centering (@code{ce}) Center text. While the @w{@samp{.ad c}} request also centers text, it fills the text as well. @code{ce} does not fill the -text it affects. This request causes a break. +text it affects. This request causes a break. The number of lines +still to be centered is associated with the current environment +(@pxref{Environments}). The following example demonstrates the differences. Here the input: @@ -4301,9 +5873,6 @@ With no arguments, @code{ce} centers the next line of text. @var{nnn} specifies the number of lines to be centered. If the argument is zero or negative, centering is disabled. -@rqindex ll -@rqindex in -@rqindex ti The basic length for centering text is the line length (as set with the @code{ll} request) minus the indentation (as set with the @code{in} request). Temporary indentation is ignored. @@ -4317,15 +5886,17 @@ The @code{.ce} read-only number register contains the number of lines remaining to be centered, as set by the @code{ce} request. @endDefreq -@cindex justifying text -@cindex text, justifying -@cindex right-justifying -@Defreq {rj, [@Var{nnn}]} -@Defregx {.rj} +@DefreqList {rj, [@Var{nnn}]} +@DefregListEnd {.rj} +@cindex justifying text (@code{rj}) +@cindex text, justifying (@code{rj}) +@cindex right-justifying (@code{rj}) Justify unfilled text to the right margin. Arguments are identical to the @code{ce} request. The @code{.rj} read-only number register is the number of lines to be right-justified as set by the @code{rj} -request. This request causes a break. +request. This request causes a break. The number of lines still to be +right-justified is associated with the current environment +(@pxref{Environments}). @endDefreq @@ -4339,8 +5910,8 @@ request. This request causes a break. As discussed in @ref{Hyphenation}, @code{gtroff} hyphenates words. There are a number of ways to influence hyphenation. -@Defreq {hy, [@Var{mode}]} -@Defregx {.hy} +@DefreqList {hy, [@Var{mode}]} +@DefregListEnd {.hy} Enable hyphenation. The request has an optional numeric argument, @var{mode}, to restrict hyphenation if necessary: @@ -4363,7 +5934,7 @@ Values in the previous table are additive. For example, the value@w{ }12 causes @code{gtroff} to neither hyphenate the last two nor the first two characters of a word. -@cindex hyphenation restrictions register +@cindex hyphenation restrictions register (@code{.hy}) The current hyphenation restrictions can be found in the read-only number register @samp{.hy}. @@ -4380,15 +5951,14 @@ The hyphenation mode is associated with the current environment (@pxref{Environments}). @endDefreq -@esindex \% -@cindex explicit hyphens -@cindex hyphen, explicit -@cindex consecutive hyphenated lines -@cindex lines, consecutive hyphenated -@cindex hyphenated lines, consecutive -@Defreq {hlm, [@Var{nnn}]} -@Defregx {.hlm} -@Defregx {.hlc} +@DefreqList {hlm, [@Var{nnn}]} +@DefregItem {.hlm} +@DefregListEnd {.hlc} +@cindex explicit hyphen (@code{\%}) +@cindex hyphen, explicit (@code{\%}) +@cindex consecutive hyphenated lines (@code{hlm}) +@cindex lines, consecutive hyphenated (@code{hlm}) +@cindex hyphenated lines, consecutive (@code{hlm}) Set the maximum number of consecutive hyphenated lines to @var{nnn}. If this number is negative, there is no maximum. The default value is@w{ }@minus{}1 if @var{nnn} is omitted. This value is associated @@ -4429,11 +5999,18 @@ store such information; fortunately, with @code{gtroff}, this is no longer a restriction. @endDefreq -@cindex hyphenation character -@cindex character, hyphenation -@cindex disabling hyphenation -@cindex hyphenation, disabling -@Defesc {\\%, , , } +@DefescList {\\%, , , } +@deffnx Escape @t{\:} +@ifnotinfo +@esindex \: +@end ifnotinfo +@ifinfo +@esindex @r{<colon>} +@end ifinfo +@cindex hyphenation character (@code{\%}) +@cindex character, hyphenation (@code{\%}) +@cindex disabling hyphenation (@code{\%}) +@cindex hyphenation, disabling (@code{\%}) To tell @code{gtroff} how to hyphenate words on the fly, use the @code{\%} escape, also known as the @dfn{hyphenation character}. Preceding a word with this character prevents it from being @@ -4442,6 +6019,22 @@ the word may be hyphenated at that point. Note that this mechanism only affects that one occurrence of the word; to change the hyphenation of a word for the entire document, use the @code{hw} request. + +The @code{\:} escape inserts a zero-width break point +(that is, the word breaks but without adding a hyphen). + +@Example +... check the /var/log/\:httpd/\:access_log file ... +@endExample + +@cindex @code{\X}, followed by @code{\%} +@cindex @code{\Y}, followed by @code{\%} +@cindex @code{\%}, following @code{\X} or @code{\Y} +Note that @code{\X} and @code{\Y} start a word, that is, the @code{\%} +escape in (say) @w{@samp{ \X'...'\%foobar}} and +@w{@samp{ \Y'...'\%foobar}} no longer prevents hyphenation but inserts +a hyphenation point at the beginning of @samp{foobar}; most likely +this isn't what you want to do. @endDefesc @Defreq {hc, [@Var{char}]} @@ -4454,23 +6047,66 @@ The hyphenation character is associated with the current environment (@pxref{Environments}). @endDefreq -@cindex hyphenation patterns -@cindex patterns for hyphenation -@Defreq {hpf, pattern_file} +@DefreqList {hpf, pattern_file} +@DefreqItem {hpfa, pattern_file} +@DefreqListEnd {hpfcode, a b [c d @dots{}]} +@cindex hyphenation patterns (@code{hpf}) +@cindex patterns for hyphenation (@code{hpf}) Read in a file of hyphenation patterns. This file is searched for in the same way as @file{@var{name}.tmac} (or @file{tmac.@var{name}}) is searched for if the @option{-m@var{name}} option is specified. -It should have the same format as the argument to the @code{\patterns} -primitive in @TeX{} (without using @TeX{}'s macro expansion); the -letters appearing in this file are interpreted as hyphenation codes. A -@samp{%} character in the patterns file introduces a comment that -continues to the end of the line. +It should have the same format as (simple) @TeX{} patterns files. +More specifically, the following scanning rules are implemented. + +@itemize @bullet +@item +A percent sign starts a comment (up to the end of the line) +even if preceded by a backslash. + +@item +No support for `digraphs' like @code{\$}. + +@item +@code{^^@var{xx}} (@var{x} is 0-9 or a-f) and @code{^^@var{x}} (character +code of @var{x} in the range 0-127) are recognized; other use of @code{^} +causes an error. + +@item +No macro expansion. + +@item +@code{hpf} checks for the expression @code{\patterns@{@dots{}@}} +(possibly with whitespace before and after the braces). +Everything between the braces is taken as hyphenation patterns. +Consequently, @code{@{} and @code{@}} are not allowed in patterns. + +@item +Similarly, @code{\hyphenation@{@dots{}@}} gives a list of hyphenation +exceptions. + +@item +@code{\endinput} is recognized also. + +@item +For backwards compatibility, if @code{\patterns} is missing, +the whole file is treated as a list of hyphenation patterns +(only recognizing the @code{%} character as the start of a comment). +@end itemize If no @code{hpf} request is specified (either in the document or in a macro package), @code{gtroff} won't hyphenate at all. -@rqindex hla +The @code{hpfa} request appends a file of patterns to the current list. + +The @code{hpfcode} request defines mapping values for character codes in +hyphenation patterns. @code{hpf} or @code{hpfa} then apply the mapping +(after reading the patterns) before replacing or appending them to +the current list of patterns. Its arguments are pairs of character codes +-- integers from 0 to@w{ }255. The request maps character code@w{ }@var{a} +to code@w{ }@var{b}, code@w{ }@var{c} to code@w{ }@var{d}, and so on. You +can use character codes which would be invalid otherwise. + @pindex troffrc @pindex troffrc-end @pindex hyphen.us @@ -4480,76 +6116,81 @@ invoked by the @file{troffrc} or @file{troffrc-end} file; by default, @file{troffrc} loads hyphenation patterns for American English (in file @file{hyphen.us}). +A second call to @code{hpf} (for the same language) will replace the +hyphenation patterns with the new ones. + Invoking @code{hpf} causes an error if there is no current hyphenation language. @endDefreq -@cindex hyphenation code -@cindex code, hyphenation @Defreq {hcode, c1 code1 c2 code2 @dots{}} +@cindex hyphenation code (@code{hcode}) +@cindex code, hyphenation (@code{hcode}) Set the hyphenation code of character @var{c1} to @var{code1}, that of @var{c2} to @var{code2}, etc. A hyphenation code must be a single input character (not a special character) other than a digit or a space. Initially each lower-case letter (@samp{a}-@samp{z}) has its -hyphenation set to itself, and each upper-case letter +hyphenation code set to itself, and each upper-case letter (@samp{A}-@samp{Z}) has a hyphenation code which is the lower-case version of itself. This request is ignored if it has no parameter. @endDefreq -@cindex hyphenation margin -@cindex margin for hyphenation -@rqindex ad -@Defreq {hym, [@Var{length}]} -@Defregx {.hym} +@DefreqList {hym, [@Var{length}]} +@DefregListEnd {.hym} +@cindex hyphenation margin (@code{hym}) +@cindex margin for hyphenation (@code{hym}) +@cindex @code{ad} request, and hyphenation margin Set the (right) hyphenation margin to @var{length}. If the current -adjustment mode is not @samp{b} or@w{ }@samp{n}, the line is not +adjustment mode is not @samp{b} or @samp{n}, the line is not hyphenated if it is shorter than @var{length}. Without an argument, the hyphenation margin is reset to its default value, which is@w{ }0. -The default scaling indicator for this request is@w{ }@code{m}. The +The default scaling indicator for this request is @samp{m}. The hyphenation margin is associated with the current environment (@pxref{Environments}). A negative argument resets the hyphenation margin to zero, emitting a warning of type @samp{range}. -@cindex current hyphenation margin register +@cindex hyphenation margin register (@code{.hym}) The current hyphenation margin is available in the @code{.hym} read-only number register. @endDefreq -@cindex hyphenation space -@rqindex ad -@Defreq {hys, [@Var{hyphenation_space}]} -@Defregx {.hys} +@DefreqList {hys, [@Var{hyphenation_space}]} +@DefregListEnd {.hys} +@cindex hyphenation space (@code{hys}) +@cindex @code{ad} request, and hyphenation space Set the hyphenation space to @var{hyphenation_space}. If the current -adjustment mode is @samp{b} or@w{ }@samp{n}, don't hyphenate the line +adjustment mode is @samp{b} or @samp{n}, don't hyphenate the line if it can be justified by adding no more than @var{hyphenation_space} extra space to each word space. Without argument, the hyphenation space is set to its default value, which is@w{ }0. The default -scaling indicator for this request is@w{ }@code{m}. The hyphenation +scaling indicator for this request is @samp{m}. The hyphenation space is associated with the current environment (@pxref{Environments}). A negative argument resets the hyphenation space to zero, emitting a warning of type @samp{range}. -@cindex current hyphenation space register +@cindex hyphenation space register (@code{.hys}) The current hyphenation space is available in the @code{.hys} read-only number register. @endDefreq -@cindex soft hyphen character -@cindex character, soft hyphen -@glindex hy -@rqindex char -@rqindex tr -@Defreq {shc, [@Var{char}]} -Set the soft hyphen character to @var{char}. If the argument is -omitted, the soft hyphen character is set to the default character -@code{\(hy} (this is the start-up value of @code{gtroff} also). The -soft hyphen character is the character that is inserted when a word is +@Defreq {shc, [@Var{glyph}]} +@cindex soft hyphen character, setting (@code{shc}) +@cindex character, soft hyphen, setting (@code{shc}) +@cindex glyph, soft hyphen (@code{hy}) +@cindex soft hyphen glyph (@code{hy}) +@cindex @code{char} request, and soft hyphen character +@cindex @code{tr} request, and soft hyphen character +Set the @dfn{soft hyphen character} to @var{glyph}.@footnote{@dfn{Soft +hyphen character} is a misnomer since it is an output glyph.} If the +argument is omitted, the soft hyphen character is set to the default +glyph @code{\(hy} (this is the start-up value of @code{gtroff} also). +The soft hyphen character is the glyph that is inserted when a word is hyphenated at a line break. If the soft hyphen character does not exist in the font of the character immediately preceding a potential break point, then the line is not broken at that point. Neither @@ -4558,21 +6199,21 @@ definitions (specified with the @code{char} request) nor translations soft hyphen character. @endDefreq -@rqindex hpf -@rqindex hw +@DefreqList {hla, language} +@DefregListEnd {.hla} +@cindex @code{hpf} request, and hyphenation language +@cindex @code{hw} request, and hyphenation language @pindex troffrc @pindex troffrc-end -@Defreq {hla, language} -@Defregx {.hla} Set the current hyphenation language to the string @var{language}. Hyphenation exceptions specified with the @code{hw} request and -hyphenation patterns specified with the @code{hpf} request are both -associated with the current hyphenation language. The @code{hla} -request is usually invoked by the @file{troffrc} or the +hyphenation patterns specified with the @code{hpf} and @code{hpfa} +requests are both associated with the current hyphenation language. +The @code{hla} request is usually invoked by the @file{troffrc} or the @file{troffrc-end} files; @file{troffrc} sets the default language to @samp{us}. -@cindex current hyphenation language register +@cindex hyphenation language register (@code{.hla}) The current hyphenation language is available as a string in the read-only number register @samp{.hla}. @@ -4596,13 +6237,12 @@ Space downwards @var{distance}. With no argument it advances 1@w{ }line. A negative argument causes @code{gtroff} to move up the page the specified distance. If the argument is preceded by a @samp{|} then @code{gtroff} moves that distance from the top of the page. This -request causes a line break. The default scaling indicator is@w{ -}@code{v}. +request causes a line break. The default scaling indicator is @samp{v}. @endDefreq -@cindex double-spacing -@Defreq {ls, [@Var{nnn}]} -@Defregx {.L} +@DefreqList {ls, [@Var{nnn}]} +@DefregListEnd {.L} +@cindex double-spacing (@code{ls}) Output @w{@var{nnn}@minus{}1} blank lines after each line of text. With no argument, @code{gtroff} uses the previous value before the last @code{ls} call. @@ -4610,70 +6250,86 @@ last @code{ls} call. @Example .ls 2 \" This causes double-spaced output .ls 3 \" This causes triple-spaced output -.ls \" Again double spaced +.ls \" Again double-spaced @endExample The line spacing is associated with the current environment (@pxref{Environments}). -@cindex current line spacing register +@cindex line spacing register (@code{.L}) The read-only number register @code{.L} contains the current line spacing setting. @endDefreq -@c XXX document \n[nl] -@c XXX document \n[nl] == -1 if vertical position is zero +@xref{Changing Type Sizes}, for the requests @code{vs} and @code{pvs} +as alternatives to @code{ls}. -@Defesc {\\x, ', spacing, '} -@Defregx {.a} +@DefescList {\\x, ', spacing, '} +@DefregListEnd {.a} Sometimes, extra vertical spacing is only needed occasionally, e.g.@: to allow space for a tall construct (like an equation). The @code{\x} escape does this. The escape is given a numerical argument, usually enclosed in quotes (like @samp{\x'3p'}); the default scaling indicator -is@w{ }@code{v}. If this number is positive extra vertical space is +is @samp{v}. If this number is positive extra vertical space is inserted below the current line. A negative number adds space above. If this escape is used multiple times on the same line, the maximum of the values is used. @xref{Escapes}, for details on parameter delimiting characters. -@cindex extra vertical line space register +@cindex extra post-vertical line space register (@code{.a}) The @code{.a} read-only number register contains the most recent (nonnegative) extra vertical line space. -@c XXX -@ignore +Using @code{\x} can be necessary in combination with the @code{\b} +escape, as the following example shows. + @Example -... example of inline equation ... +This is a test with the \[rs]b escape. +.br +This is a test with the \[rs]b escape. +.br +This is a test with \b'xyz'\x'-1m'\x'1m'. +.br +This is a test with the \[rs]b escape. +.br +This is a test with the \[rs]b escape. +@endExample + +@noindent +produces + +@Example +This is a test with the \b escape. +This is a test with the \b escape. + x +This is a test with y. + z +This is a test with the \b escape. +This is a test with the \b escape. @endExample -@end ignore @endDefesc -@rqindex sp -@cindex no-space mode -@cindex mode, no-space +@DefreqList {ns, } +@DefreqItem {rs, } +@DefregListEnd {.ns} +@cindex @code{sp} request, and no-space mode +@cindex no-space mode (@code{ns}) +@cindex mode, no-space (@code{ns}) @cindex blank lines, disabling @cindex lines, blank, disabling -@Defreq {ns, } -@Defregx {.ns} Enable @dfn{no-space mode}. In this mode, spacing (either via @code{sp} or via blank lines) is disabled. The @code{bp} request to advance to the next page is also disabled, except if it is accompanied by a page number (see @ref{Page Control}, for more information). This mode ends when actual text is output or the @code{rs} request is -encountered. The read-only number register @code{.ns} is set to@w{ }1. - -This request is useful for macros which want to avoid that subsequent -macros inadvertently insert some vertical space before the text starts -(for example, to set up the first paragraph after a section header). - -@c XXX xref -@endDefreq - -@Defreq {rs, } -Disable no-space mode. +encountered which ends no-space mode. The read-only number register +@code{.ns} is set to@w{ }1 as long as no-space mode is active. -@c XXX xref +This request is useful for macros that conditionally +insert vertical space before the text starts +(for example, a paragraph macro could insert some space +except when it is the first paragraph after a section header). @endDefreq @@ -4681,8 +6337,8 @@ Disable no-space mode. @node Tabs and Fields, Character Translations, Manipulating Spacing, gtroff Reference @section Tabs and Fields -@cindex tabs and fields -@cindex fields and tabs +@cindex tabs, and fields +@cindex fields, and tabs @cindex @acronym{EBCDIC} encoding of a tab A tab character (@acronym{ASCII} char@w{ }9, @acronym{EBCDIC} char@w{ @@ -4690,12 +6346,14 @@ A tab character (@acronym{ASCII} char@w{ }9, @acronym{EBCDIC} char@w{ like it did on a typewriter). @Defesc {\\t, , , } +@cindex tab character, non-interpreted (@code{\t}) +@cindex character, tab, non-interpreted (@code{\t}) This escape is a non-interpreted tab character. In copy mode (@pxref{Copy-in Mode}), @code{\t} is the same as a real tab character. @endDefesc -@Defreq {ta, [@Var{n1} @Var{n2} @dots{} @Var{nn} @t{T} @Var{r1} @Var{r2} @dots{} @Var{rn}]} -@Defregx {.tabs} +@DefreqList {ta, [@Var{n1} @Var{n2} @dots{} @Var{nn} @t{T} @Var{r1} @Var{r2} @dots{} @Var{rn}]} +@DefregListEnd {.tabs} Change tab stop positions. This request takes a series of tab specifiers as arguments (optionally divided into two groups with the letter @samp{T}) which indicate where each tab stop is to be @@ -4743,7 +6401,7 @@ is specified by appending @samp{R}, @samp{L}, or @samp{C} to the tab specifier. The default justification is @samp{L}. Example: @Example -.ta 1i 2iC 2iR +.ta 1i 2iC 3iR @endExample Some notes: @@ -4821,15 +6479,13 @@ Tab stops are associated with the current environment Calling @code{ta} without an argument removes all tab stops. @item -@cindex tab stops, for tty output devices -The start-up value of @code{gtroff} is @w{@samp{T 0.5i}}. This value -is used even for tty output devices (contrary to @acronym{UNIX} -@code{nroff} which has tab stops preset every 0.8@dmn{i}). - -@c XXX xref implementation differences +@cindex tab stops, for TTY output devices +The start-up value of @code{gtroff} is @w{@samp{T 0.5i}} in troff mode +and @w{@samp{T 0.8i}} in nroff mode (the latter is done with an +explicit call to the @code{ta} request in the file @file{tty.tmac}. @end itemize -@cindex current tab settings register +@cindex tab settings register (@code{.tabs}) The read-only number register @code{.tabs} contains a string representation of the current tab settings suitable for use as an argument to the @code{ta} request. @@ -4839,16 +6495,65 @@ argument to the @code{ta} request. \*[tab-string] @result{} T120u @endExample + +@cindex @code{.S} register, Plan@w{ }9 alias for @code{.tabs} +@cindex @code{.tabs} register, Plan@w{ }9 alias (@code{.S}) +The @code{troff} version of the Plan@w{ }9 operating system uses +register @code{.S} for the same purpose. @endDefreq -@cindex tab repetition character -@cindex character, tab repetition -@Defreq {tc, [@Var{fill-char}]} +@Defreq {tc, [@Var{fill-glyph}]} +@cindex tab repetition character (@code{tc}) +@cindex character, tab repetition (@code{tc}) +@cindex glyph, tab repetition (@code{tc}) Normally @code{gtroff} fills the space to the next tab stop with whitespace. This can be changed with the @code{tc} request. With no argument @code{gtroff} reverts to using whitespace, which is the -default. The value of this @dfn{tab repetition} character is -associated with the current environment (@pxref{Environments}). +default. The value of this @dfn{tab repetition character} is +associated with the current environment +(@pxref{Environments}).@footnote{@dfn{Tab repetition character} is a +misnomer since it is an output glyph.} +@endDefreq + +@DefreqList {linetabs, n} +@DefregListEnd {.linetabs} +@cindex tab, line-tabs mode +@cindex line-tabs mode +@cindex mode, line-tabs +If @var{n} is missing or not zero, enable @dfn{line-tabs} mode, +or disable it otherwise (the default). +In line-tabs mode, @code{gtroff} computes tab distances +relative to the (current) output line instead of the input line. + +For example, the following code: + +@Example +.ds x a\t\c +.ds y b\t\c +.ds z c +.ta 1i 3i +\*x +\*y +\*z +@endExample + +@noindent +in normal mode, results in the output + +@Example +a b c +@endExample + +@noindent +in line-tabs mode, the same code outputs + +@Example +a b c +@endExample + +Line-tabs mode is associated with the current environment. +The read-only register @code{.linetabs} is set to@w{ }1 if in line-tabs +mode, and 0 in normal mode. @endDefreq @menu @@ -4863,7 +6568,7 @@ associated with the current environment (@pxref{Environments}). @cindex leaders Sometimes it may may be desirable to use the @code{tc} request to fill a -particular tab stop with a given character (for example dots in a table +particular tab stop with a given glyph (for example dots in a table of contents), but also normal tab stops on the rest of the line. For this @code{gtroff} provides an alternate tab mechanism, called @dfn{leaders} which does just that. @@ -4871,23 +6576,27 @@ this @code{gtroff} provides an alternate tab mechanism, called @cindex leader character A leader character (character code@w{ }1) behaves similarly to a tab character: It moves to the next tab stop. The only difference is that -for this movement, the fill character defaults to a period character and +for this movement, the fill glyph defaults to a period character and not to space. @Defesc {\\a, , , } +@cindex leader character, non-interpreted (@code{\a}) +@cindex character, leader, non-interpreted (@code{\a}) This escape is a non-interpreted leader character. In copy mode (@pxref{Copy-in Mode}), @code{\a} is the same as a real leader character. @endDefesc -@cindex leader repetition character -@cindex character, leader repetition -@Defreq {lc, [@Var{fill-char}]} -Declare the leader character. Without an argument, leaders act the -same as tabs (i.e., using whitespace for filling). @code{gtroff}'s -start-up value is @samp{.}. The value of this @dfn{leader repetition} -character is associated with the current environment -(@pxref{Environments}). +@Defreq {lc, [@Var{fill-glyph}]} +@cindex leader repetition character (@code{lc}) +@cindex character, leader repetition (@code{lc}) +@cindex glyph, leader repetition (@code{lc}) +Declare the @dfn{leader repetition character}.@footnote{@dfn{Leader +repetition character} is a misnomer since it is an output glyph.} +Without an argument, leaders act the same as tabs (i.e., using +whitespace for filling). @code{gtroff}'s start-up value is a dot +(@samp{.}). The value of the leader repetition character is +associated with the current environment (@pxref{Environments}). @endDefreq @cindex table of contents @@ -4917,12 +6626,12 @@ This produces @subsection Fields @cindex fields -@cindex field delimiting character -@cindex delimiting character for fields -@cindex character, field delimiting -@cindex field padding character -@cindex padding character for fields -@cindex character, field padding +@cindex field delimiting character (@code{fc}) +@cindex delimiting character, for fields (@code{fc}) +@cindex character, field delimiting (@code{fc}) +@cindex field padding character (@code{fc}) +@cindex padding character, for fields (@code{fc}) +@cindex character, field padding (@code{fc}) @dfn{Fields} are a more general way of laying out tabular data. A field is defined as the data between a pair of @dfn{delimiting characters}. It contains substrings which are separated by @dfn{padding characters}. @@ -4939,8 +6648,8 @@ Define a delimiting and a padding character for fields. If the latter is missing, the padding character defaults to a space character. If there is no argument at all, the field mechanism is disabled (which is the default). Note that contrary to e.g.@: the tab repetition -character, delimiting and padding characters are not associated to the -current environment (@pxref{Environments}). +character, delimiting and padding characters are @emph{not} associated +to the current environment (@pxref{Environments}). Example: @@ -4969,33 +6678,32 @@ foo bar smurf @cindex character translations @cindex translations of characters -@rqindex . -@rqindex ' -@cindex control character -@cindex character, control -@cindex no-break control character -@cindex character, no-break control -@cindex control character, no-break +@cindex control character, changing (@code{cc}) +@cindex character, control, changing (@code{cc}) +@cindex no-break control character, changing (@code{c2}) +@cindex character, no-break control, changing (@code{c2}) +@cindex control character, no-break, changing (@code{c2}) The control character (@samp{.}) and the no-break control character (@samp{'}) can be changed with the @code{cc} and @code{c2} requests, respectively. @Defreq {cc, [@Var{c}]} -Set the control character to @var{c}. With no argument the default +Set the control character to@w{ }@var{c}. With no argument the default control character @samp{.} is restored. The value of the control character is associated with the current environment (@pxref{Environments}). @endDefreq @Defreq {c2, [@Var{c}]} -Set the no-break control character to @var{c}. With no argument the +Set the no-break control character to@w{ }@var{c}. With no argument the default control character @samp{'} is restored. The value of the no-break control character is associated with the current environment (@pxref{Environments}). @endDefreq -@esindex \\ @Defreq {eo, } +@cindex disabling @code{\} (@code{eo}) +@cindex @code{\}, disabling (@code{eo}) Disable the escape mechanism completely. After executing this request, the backslash character @samp{\} no longer starts an escape sequence. @@ -5021,92 +6729,191 @@ necessary then to double the escape character. Here an example: @endExample @endDefreq -@cindex escape character -@cindex character, escape @Defreq {ec, [@Var{c}]} -Set the escape character to @var{c}. With no argument the default +@cindex escape character, changing (@code{ec}) +@cindex character, escape, changing (@code{ec}) +Set the escape character to@w{ }@var{c}. With no argument the default escape character @samp{\} is restored. It can be also used to re-enable the escape mechanism after an @code{eo} request. Note that changing the escape character globally will likely break -macro packages since @code{gtroff} has no mechanism (like @TeX{}) to -`intern' macros, i.e., to convert a macro definition into an internal -form which is independent of its representation. If a macro is -called, it is executed literally. +macro packages since @code{gtroff} has no mechanism to `intern' macros, +i.e., to convert a macro definition into an internal form which is +independent of its representation (@TeX{} has this mechanism). +If a macro is called, it is executed literally. +@endDefreq + +@DefreqList {ecs, } +@DefreqListEnd {ecr, } +The @code{ecs} request saves the current escape character +in an internal register. +Use this request in combination with the @code{ec} request to +temporarily change the escape character. + +The @code{ecr} request restores the escape character +saved with @code{ecs}. +Without a previous call to @code{ecs}, this request +sets the escape character to @code{\}. @endDefreq -@Defesc {\\e, , , } -This escape sequence prints the current escape character (which is the -backslash character @samp{\} by default). +@DefescList {\\\\, , , } +@DefescItem {\\e, , , } +@DefescListEnd {\\E, , , } +Print the current escape character (which is the backslash character +@samp{\} by default). + +@code{\\} is a `delayed' backslash; more precisely, it is the default +escape character followed by a backslash, which no longer has special +meaning due to the leading escape character. It is @emph{not} an escape +sequence in the usual sense! In any unknown escape sequence +@code{\@var{X}} the escape character is ignored and @var{X} is printed. +But if @var{X} is equal to the current escape character, no warning is +emitted. + +As a consequence, only at top-level or in a diversion a backslash glyph is +printed; in copy-in mode, it expands to a single backslash which then +combines with the following character to an escape sequence. + +The @code{\E} escape differs from @code{\e} by printing an escape +character that is not interpreted in copy mode. +Use this to define strings with escapes that work +when used in copy mode (for example, as a macro argument). +The following example defines strings to begin and end +a superscript: + +@Example +.ds @{ \v'-.3m'\s'\Es[.s]*60/100' +.ds @} \s0\v'.3m' +@endExample + +Another example to demonstrate the differences between the various escape +sequences, using a strange escape character, @samp{-}. + +@Example +.ec - +.de xxx +--A'123' +.. +.xxx + @result{} -A'foo' +@endExample + +@noindent +The result is surprising for most users, expecting @samp{1} since +@samp{foo} is a valid identifier. What has happened? As mentioned +above, the leading escape character makes the following character +ordinary. Written with the default escape character the sequence +@samp{--} becomes @samp{\-} -- this is the minus sign. + +If the escape character followed by itself is a valid escape sequence, +only @code{\E} yields the expected result: + +@Example +.ec - +.de xxx +-EA'123' +.. +.xxx + @result{} 1 +@endExample @endDefesc -A @dfn{translation} is a mapping of an input character to an output -character. The default mappings are given in the font definition files -for the specific output device (@pxref{Font Files}); all mappings (both -with @code{tr} and in the font definition files) occur at output time, -i.e., the input character gets assigned the metric information of the -mapped output character. +@Defesc {\\., , , } +Similar to @code{\\}, the sequence @code{\.} isn't a real escape sequence. +As before, a warning message is suppressed if the escape character is +followed by a dot, and the dot itself is printed. -@Defreq {tr, @Var{a}@Var{b}@Var{c}@Var{d}@dots{}} -Translate character @var{a} to @var{b}, character @var{c} to @var{d}, -etc. If there is an odd number of arguments, the last one is -translated to the space character. +@Example +.de foo +. nop foo +. +. de bar +. nop bar +\\.. +. +.. +.foo +.bar + @result{} foo bar +@endExample + +@noindent +The first backslash is consumed while the macro is read, and the second +is swallowed while exexuting macro @code{foo}. +@endDefesc + +A @dfn{translation} is a mapping of an input character to an output +glyph. The mapping occurs at output time, i.e., the input character +gets assigned the metric information of the mapped output character +right before input tokens are converted to nodes (@pxref{Gtroff +Internals}, for more on this process). + +@DefreqList {tr, @Var{a}@Var{b}@Var{c}@Var{d}@dots{}} +@DefreqListEnd {trin, @Var{a}@Var{b}@Var{c}@Var{d}@dots{}} +Translate character @var{a} to glyph@w{ }@var{b}, character @var{c} to +glyph@w{ }@var{d}, etc. If there is an odd number of arguments, the +last one is translated to an unstretchable space (@w{@samp{\ }}). + +The @code{trin} request is identical to @code{tr}, +but when you unformat a diversion with @code{asciify} +it ignores the translation. +@xref{Diversions}, for details about the @code{asciify} request. Some notes: @itemize @bullet @item -@esindex \( -@esindex \[ -@esindex \' -@esindex \` -@esindex \- -@esindex \_ -@esindex \C -@esindex \N -@rqindex char -@cindex special character +@cindex @code{\(}, and translations +@cindex @code{\[}, and translations +@cindex @code{\'}, and translations +@cindex @code{\`}, and translations +@cindex @code{\-}, and translations +@cindex @code{\_}, and translations +@cindex @code{\C}, and translations +@cindex @code{\N}, and translations +@cindex @code{char} request, and translations +@cindex special characters @cindex character, special -@cindex numbered character -@cindex character, numbered +@cindex numbered glyph (@code{\N}) +@cindex glyph, numbered (@code{\N}) Special characters (@code{\(@var{xx}}, @code{\[@var{xxx}]}, @code{\C'@var{xxx}'}, @code{\'}, @code{\`}, @code{\-}, @code{\_}), -characters defined with the @code{char} request, and numbered characters +glyphs defined with the @code{char} request, and numbered glyphs (@code{\N'@var{xxx}'}) can be translated also. @item -@esindex \e +@cindex @code{\e}, and translations The @code{\e} escape can be translated also. @item -@esindex \% -@esindex \~ +@cindex @code{\%}, and translations +@cindex @code{\~}, and translations Characters can be mapped onto the @code{\%} and @code{\~} escapes (but -@code{\%} and @code{\~} can't be mapped onto another character). +@code{\%} and @code{\~} can't be mapped onto another glyph). @item -@cindex backspace character -@cindex character, backspace -@cindex leader character -@cindex character, leader -@cindex newline character -@cindex character, newline -@cindex tab character -@cindex character, tab -@esindex \a -@esindex \t +@cindex backspace character, and translations +@cindex character, backspace, and translations +@cindex leader character, and translations +@cindex character, leader, and translations +@cindex newline character, and translations +@cindex character, newline, and translations +@cindex tab character, and translations +@cindex character, tab, and translations +@cindex @code{\a}, and translations +@cindex @code{\t}, and translations The following characters can't be translated: space (with one exception, see below), backspace, newline, leader (and @code{\a}), tab (and @code{\t}). @item -@rqindex shc +@cindex @code{shc} request, and translations Translations are not considered for finding the soft hyphen character set with the @code{shc} request. @item -@esindex \& -The character pair @samp{@var{c}\&} (this is an arbitrary character@w{ +@cindex @code{\&}, and translations +The pair @samp{@var{c}\&} (this is an arbitrary character@w{ }@var{c} followed by the zero width space character) maps this character to nothing. @@ -5127,8 +6934,8 @@ foo bar @noindent As shown in the example, the space character can't be the first -character pair as an argument of @code{tr}. Additionally, it is not -possible to map the space character to any other character; requests +character/glyph pair as an argument of @code{tr}. Additionally, it is +not possible to map the space character to any other glyph; requests like @w{@samp{.tr aa x}} undo @w{@samp{.tr aa \&}} instead. If justification is active, lines are justified in spite of the @@ -5136,21 +6943,55 @@ If justification is active, lines are justified in spite of the space character, between words). @item -After an output character has been constructed (this happens at the -moment immediately before the character is appended to an output -character list, either by direct output, in a macro, diversion, or +After an output glyph has been constructed (this happens at the +moment immediately before the glyph is appended to an output +glyph list, either by direct output, in a macro, diversion, or string), it is no longer affected by @code{tr}. -@c XXX xref +@item +Translating character to glyphs where one of them or both are +undefined is possible also; @code{tr} does not check whether the +entities in its argument do exist. + +@xref{Gtroff Internals}. + +@item +@code{troff} no longer has a hard-coded dependency on @w{Latin-1}; +all @code{char@var{XXX}} entities have been removed from the font +description files. This has a notable consequence which shows up in +warnings like @code{can't find character with input code @var{XXX}} +if the @code{tr} request isn't handled properly. + +Consider the following translation: + +@Example +.tr @'e@'E +@endExample + +@noindent +This maps input character @code{@'e} onto glyph @code{@'E}, which is +identical to glyph @code{char201}. But this glyph intentionally +doesn't exist! Instead, @code{\[char201]} is treated as an input +character entity and is by default mapped onto @code{\['E]}, and +@code{gtroff} doesn't handle translations of translations. + +The right way to write the above translation is + +@Example +.tr @'e\['E] +@endExample + +@noindent +With other words, the first argument of @code{tr} should be an input +character or entity, and the second one a glyph entity. @item Without an argument, the @code{tr} request is ignored. @end itemize @endDefreq -@esindex \! -@cindex @code{\!}, and @code{trnt} @Defreq {trnt, @Var{a}@Var{b}@Var{c}@Var{d}@dots{}} +@cindex @code{\!}, and @code{trnt} @code{trnt} is the same as the @code{tr} request except that the translations do not apply to text that is transparently throughput into a diversion with @code{\!}. @xref{Diversions}, for more @@ -5182,41 +7023,41 @@ instead of @code{tr} it prints @samp{a}. @cindex mode, nroff Originally, @code{nroff} and @code{troff} were two separate programs, -the former for tty output, the latter for everything else. With GNU +the former for TTY output, the latter for everything else. With GNU @code{troff}, both programs are merged into one executable, sending -its output to a device driver (@code{grotty} for tty devices, +its output to a device driver (@code{grotty} for TTY devices, @code{grops} for @sc{PostScript}, etc.) which interprets the intermediate output of @code{gtroff}. For @acronym{UNIX} @code{troff} it makes sense to talk about @dfn{Nroff mode} and @dfn{Troff mode} since the differences are hardcoded. For GNU @code{troff}, this distinction is not appropriate because @code{gtroff} simply takes the information given in the font files for a particular device without -handling requests specially if a tty output device is used. +handling requests specially if a TTY output device is used. Usually, a macro package can be used with all output devices. Nevertheless, it is sometimes necessary to make a distinction between -tty and non-tty devices: @code{gtroff} provides two built-in +TTY and non-TTY devices: @code{gtroff} provides two built-in conditions @samp{n} and @samp{t} for the @code{if}, @code{ie}, and @code{while} requests to decide whether @code{gtroff} shall behave like @code{nroff} or like @code{troff}. +@Defreq {troff, } @pindex troffrc @pindex troffrc-end -@Defreq {troff, } Make the @samp{t} built-in condition true (and the @samp{n} built-in condition false) for @code{if}, @code{ie}, and @code{while} conditional requests. This is the default if @code{gtroff} (@emph{not} @code{groff}) is started with the @option{-R} switch to avoid loading of the start-up files @file{troffrc} and @file{troffrc-end}. Without @option{-R}, @code{gtroff} stays in troff -mode if the output device is not a tty (e.g.@: `ps'). +mode if the output device is not a TTY (e.g.@: `ps'). @endDefreq -@pindex tty.tmac @Defreq {nroff, } +@pindex tty.tmac Make the @samp{n} built-in condition true (and the @samp{t} built-in condition false) for @code{if}, @code{ie}, and @code{while} -conditional requests. This is the default if @code{gtroff} uses a tty +conditional requests. This is the default if @code{gtroff} uses a TTY output device; the code for switching to nroff mode is in the file @file{tty.tmac} which is loaded by the start-up file @code{troffrc}. @endDefreq @@ -5224,26 +7065,10 @@ output device; the code for switching to nroff mode is in the file @xref{Conditionals and Loops}, for more details on built-in conditions. -@c XXX move the following to grotty section - -@pindex less -@cindex Teletype -@cindex ISO 6249 SGR -@cindex terminal control sequences -@cindex control sequences, for terminals -For tty output devices, underlining is done by emitting sequences of -@samp{_} and @samp{\b} (the backspace character) before the actual -character. Literally, this is printing an underline character, then -moving back one character position, and printing the actual character -at the same position as the underline character (similar to a -typewriter). Usually, a modern terminal can't interpret this (and the -original Teletype machines for which this sequence was appropriate are -no longer in use). You need a pager program like @code{less} which -translates this into ISO 6429 SGR sequences to control terminals. @c ===================================================================== -@node Line Layout, Page Layout, Troff and Nroff Mode, gtroff Reference +@node Line Layout, Line Control, Troff and Nroff Mode, gtroff Reference @section Line Layout @cindex line layout @cindex layout, line @@ -5269,50 +7094,67 @@ These dimensions are: @ftable @code @item po -@cindex left margin -@cindex margin, left -@cindex page offset -@cindex offset, page +@cindex left margin (@code{po}) +@cindex margin, left (@code{po}) +@cindex page offset (@code{po}) +@cindex offset, page (@code{po}) @dfn{Page offset} -- this is the leftmost position of text on the final output, defining the @dfn{left margin}. @item in -@cindex indentation -@cindex line indentation +@cindex indentation (@code{in}) +@cindex line indentation (@code{in}) @dfn{Indentation} -- this is the distance from the left margin where text is printed. @item ll -@cindex line length -@cindex length of line +@cindex line length (@code{ll}) +@cindex length of line (@code{ll}) @dfn{Line length} -- this is the distance from the left margin to right margin. @end ftable -@c XXX improve example +A simple demonstration: @Example +.ll 3i +This is text without indentation. +The line length has been set to 3\~inch. .in +.5i .ll -.5i -A bunch of really boring text which should -be indented from both margins. -Replace me with a better (and more) example! -.in -.5i -.ll +.5i +Now the left and right margins are both increased. +.in +.ll +Calling .in and .ll without parameters restore +the previous values. @endExample +Result: + +@Example +This is text without indenta- +tion. The line length has +been set to 3 inch. + Now the left and + right margins are + both increased. +Calling .in and .ll without +parameters restore the previ- +ous values. +@endExample + +@DefreqList {po, [@Var{offset}]} +@DefreqItem {po, @t{+}@Var{offset}} +@DefreqItem {po, @t{-}@Var{offset}} +@DefregListEnd {.o} @pindex troffrc -@Defreq {po, [@Var{offset}]} -@Defreqx {po, @t{+}@Var{offset}} -@Defreqx {po, @t{-}@Var{offset}} -@Defregx {.o} Set horizontal page offset to @var{offset} (or increment or decrement the current value by @var{offset}). Note that this request does not cause a break, so changing the page offset in the middle of text being filled may not yield the expected result. The initial value is -1@dmn{i}. For tty output devices, it is set to 0 in the startup file -@file{troffrc}; the default scaling indicator is@w{ }@code{m} (and -not@w{ }@code{v} as incorrectly documented in the original +1@dmn{i}. For TTY output devices, it is set to 0 in the startup file +@file{troffrc}; the default scaling indicator is @samp{m} (and +not @samp{v} as incorrectly documented in the original @acronym{UNIX} troff manual). The current page offset can be found in the read-only number register @@ -5334,19 +7176,20 @@ the previous value before the last call to @code{po}. @endExample @endDefreq -@Defreq {in, [@Var{indent}]} -@Defreqx {in, @t{+}@Var{indent}} -@Defreqx {in, @t{-}@Var{indent}} -@Defregx {.i} +@DefreqList {in, [@Var{indent}]} +@DefreqItem {in, @t{+}@Var{indent}} +@DefreqItem {in, @t{-}@Var{indent}} +@DefregListEnd {.i} Set indentation to @var{indent} (or increment or decrement the current value by @var{indent}). This request causes a break. Initially, there is no indentation. If @code{in} is called without an argument, the indentation is reset to the previous value before the last call to @code{in}. The default -scaling indicator is@w{ }@code{m}. +scaling indicator is @samp{m}. -The indentation is associated with the current environment. +The indentation is associated with the current environment +(@pxref{Environments}). If a negative indentation value is specified (which is not allowed), @code{gtroff} emits a warning of type @samp{range} and sets the @@ -5359,17 +7202,17 @@ The current indentation (as set by @code{in}) can be found in the read-only number register @samp{.i}. @endDefreq -@Defreq {ti, offset} -@Defreqx {ti, @t{+}@Var{offset}} -@Defreqx {ti, @t{-}@Var{offset}} -@Defregx {.in} +@DefreqList {ti, offset} +@DefreqItem {ti, @t{+}@Var{offset}} +@DefreqItem {ti, @t{-}@Var{offset}} +@DefregListEnd {.in} Temporarily indent the next output line by @var{offset}. If an increment or decrement value is specified, adjust the temporary indentation relative to the value set by the @code{in} request. This request causes a break; its value is associated with the current -environment. The default scaling indicator is@w{ }@code{m}. A call -of @code{ti} without an argument is ignored. +environment (@pxref{Environments}). The default scaling indicator +is @samp{m}. A call of @code{ti} without an argument is ignored. If the total indentation value is negative (which is not allowed), @code{gtroff} emits a warning of type @samp{range} and sets the @@ -5388,25 +7231,26 @@ into account whether a partially collected line still uses the old indentation value or a temporary indentation value is active. @endDefreq -@Defreq {ll, [@Var{length}]} -@Defreqx {ll, @t{+}@Var{length}} -@Defreqx {ll, @t{-}@Var{length}} -@Defregx {.l} -@Defregx {.ll} +@DefreqList {ll, [@Var{length}]} +@DefreqItem {ll, @t{+}@Var{length}} +@DefreqItem {ll, @t{-}@Var{length}} +@DefregItem {.l} +@DefregListEnd {.ll} Set the line length to @var{length} (or increment or decrement the current value by @var{length}). Initially, the line length is set to 6.5@dmn{i}. The effect of @code{ll} is delayed until a partially collected line (if it exists) is output. The default scaling -indicator is@w{ }@code{m}. +indicator is @samp{m}. If @code{ll} is called without an argument, the line length is reset to the previous value before the last call to @code{ll}. If a negative line length is specified (which is not allowed), @code{gtroff} emits a warning of type @samp{range} and sets the line length to zero. -The line length is associated with the current environment. +The line length is associated with the current environment +(@pxref{Environments}). -@cindex current line length register +@cindex line length register (@code{.l}) The current line length (as set by @code{ll}) can be found in the read-only number register @samp{.l}. The read-only number register @code{.ll} is the line length that applies to the current output line. @@ -5419,7 +7263,128 @@ collected line still uses the old line length value. @c ===================================================================== -@node Page Layout, Page Control, Line Layout, gtroff Reference +@node Line Control, Page Layout, Line Layout, gtroff Reference +@section Line Control +@cindex line control +@cindex control, line + +It is important to understand how @code{gtroff} handles input and output +lines. + +Many escapes use positioning relative to the input line. For example, +this + +@Example +This is a \h'|1.2i'test. + +This is a +\h'|1.2i'test. +@endExample + +@noindent +produces + +@Example +This is a test. + +This is a test. +@endExample + +The main usage of this feature is to define macros which act exactly +at the place where called. + +@Example +.\" A simple macro to underline a word +.de underline +. nop \\$1\l'|0\[ul]' +.. +@endExample + +@noindent +In the above example, @samp{|0} specifies a negative distance from the +current position (at the end of the just emitted argument @code{\$1}) back +to the beginning of the input line. Thus, the @samp{\l} escape draws a +line from right to left. + +@cindex input line continuation (@code{\}) +@cindex line, input, continuation (@code{\}) +@cindex continuation, input line (@code{\}) +@cindex output line, continuation (@code{\c}) +@cindex line, output, continuation (@code{\c}) +@cindex continuation, output line (@code{\c}) +@cindex interrupted line +@cindex line, interrupted +@code{gtroff} makes a difference between input and output line +continuation; the latter is also called @dfn{interrupting} a line. + +@DefescList {\\@key{RET}, , ,} +@DefescItem {\\c, , ,} +@DefregListEnd{.int} +Continue a line. @code{\@key{RET}} (this is a backslash at the end +of a line immediately followed by a newline) works on the input level, +suppressing the effects of the following newline in the input. + +@Example +This is a \ +.test + @result{} This is a .test +@endExample + +The @samp{|} operator is also affected. + +@cindex @code{\R}, after @code{\c} +@code{\c} works on the output level. Anything after this escape on the +same line is ignored, except @code{\R} which works as usual. Anything +before @code{\c} on the same line will be appended to the current partial +output line. The next non-command line after an interrupted line counts +as a new input line. + +The visual results depend on whether no-fill mode is active. + +@itemize @bullet +@item +@cindex @code{\c}, and no-fill mode +@cindex no-fill mode, and @code{\c} +@cindex mode, no-fill, and @code{\c} +If no-fill mode is active (using the @code{nf} request), the next input +text line after @code{\c} will be handled as a continuation of the same +input text line. + +@Example +.nf +This is a \c +test. + @result{} This is a test. +@endExample + +@item +@cindex @code{\c}, and fill mode +@cindex fill mode, and @code{\c} +@cindex mode, fill, and @code{\c} +If fill mode is active (using the @code{fi} request), a word interrupted +with @code{\c} will be continued with the text on the next input text line, +without an intervening space. + +@Example +This is a te\c +st. + @result{} This is a test. +@endExample +@end itemize + +Note that an intervening control line which causes a break is stronger +than @code{\c}, flushing out the current partial line in the usual way. + +@cindex interrupted line register (@code{.int}) +The @code{.int} register contains a positive value +if the last output line was interrupted with @code{\c}; this is +associated with the current environment (@pxref{Environments}). + +@endDefesc + +@c ===================================================================== + +@node Page Layout, Page Control, Line Control, gtroff Reference @section Page Layout @cindex page layout @cindex layout, page @@ -5427,17 +7392,17 @@ collected line still uses the old line length value. @code{gtroff} provides some very primitive operations for controlling page layout. -@cindex page length -@cindex length of page -@Defreq {pl, [@Var{length}]} -@Defreqx {pl, @t{+}@Var{length}} -@Defreqx {pl, @t{-}@Var{length}} -@Defregx {.p} +@DefreqList {pl, [@Var{length}]} +@DefreqItem {pl, @t{+}@Var{length}} +@DefreqItem {pl, @t{-}@Var{length}} +@DefregListEnd {.p} +@cindex page length (@code{pl}) +@cindex length of page (@code{pl}) Set the @dfn{page length} to @var{length} (or increment or decrement the current value by @var{length}). This is the length of the -physical output page. The default scaling indicator is@w{ }@code{v}. +physical output page. The default scaling indicator is @samp{v}. -@cindex current page length register +@cindex page length register (@code{.p}) The current setting can be found in the read-only number register @samp{.p}. @@ -5463,10 +7428,10 @@ length to 11@dmn{i}. @code{gtroff} provides several operations which help in setting up top and bottom titles (or headers and footers). -@cindex title line -@cindex three-part title -@cindex page number character @Defreq {tl, @t{'}@Var{left}@t{'}@Var{center}@t{'}@Var{right}@t{'}} +@cindex title line (@code{tl}) +@cindex three-part title (@code{tl}) +@cindex page number character (@code{%}) Print a @dfn{title line}. It consists of three parts: a left justified portion, a centered portion, and a right justified portion. The argument separator @samp{'} can be replaced with any character not @@ -5493,28 +7458,24 @@ title line with the left justified word @samp{foo}; the centered and right justfied parts are empty. @item -Any modifications to the current environment within @code{tl} (e.g.@: -changing the font or font size) are undone after processing @code{tl}. - -@item @code{tl} accepts the same parameter delimiting characters as the @code{\A} escape; see @ref{Escapes}. @end itemize @endDefreq -@cindex length of title line -@cindex title line, length -@cindex current title line length register -@Defreq {lt, [@Var{length}]} -@Defreqx {lt, @t{+}@Var{length}} -@Defreqx {lt, @t{-}@Var{length}} -@Defregx {.lt} +@DefreqList {lt, [@Var{length}]} +@DefreqItem {lt, @t{+}@Var{length}} +@DefreqItem {lt, @t{-}@Var{length}} +@DefregListEnd {.lt} +@cindex length of title line (@code{lt}) +@cindex title line, length (@code{lt}) +@cindex title line length register (@code{.lt}) The title line is printed using its own line length, which is specified (or incremented or decremented) with the @code{lt} request. Initially, the title line length is set to 6.5@dmn{i}. If a negative line length is specified (which is not allowed), @code{gtroff} emits a warning of type @samp{range} and sets the title line length to zero. -The default scaling indicator is@w{ }@code{m}. If @code{lt} is called +The default scaling indicator is @samp{m}. If @code{lt} is called without an argument, the title length is reset to the previous value before the last call to @code{lt}. @@ -5524,12 +7485,12 @@ number register; it is associated with the current environment @endDefreq -@cindex page number -@cindex number, page -@Defreq {pn, page} -@Defreqx {pn, @t{+}@Var{page}} -@Defreqx {pn, @t{-}@Var{page}} -@Defregx {.pn} +@DefreqList {pn, page} +@DefreqItem {pn, @t{+}@Var{page}} +@DefreqItem {pn, @t{-}@Var{page}} +@DefregListEnd {.pn} +@cindex page number (@code{pn}) +@cindex number, page (@code{pn}) Change (increase or decrease) the page number of the @emph{next} page. The only argument is the page number; the request is ignored without a parameter. @@ -5539,18 +7500,18 @@ page: either the value set by a @code{pn} request, or the number of the current page plus@w{ }1. @endDefreq -@cindex current page number register @Defreg {%} +@cindex page number register (@code{%}) A read-write register holding the current page number. @endDefreg -@cindex changing the page number character -@cindex page number character, changing -@vindex % @Defreq {pc, [@Var{char}]} +@cindex changing the page number character (@code{pc}) +@cindex page number character, changing (@code{pc}) +@vindex % Change the page number character (used by the @code{tl} request) to a different character. With no argument, this mechanism is disabled. -Note that this doesn't affect the number register @code{%}. +Note that this doesn't affect the number register@w{ }@code{%}. @endDefreq @xref{Traps}. @@ -5563,11 +7524,11 @@ Note that this doesn't affect the number register @code{%}. @cindex page control @cindex control, page -@rqindex pn -@cindex new page -@Defreq {bp, [@Var{page}]} -@Defreqx {bp, @t{+}@Var{page}} -@Defreqx {bp, @t{-}@Var{page}} +@DefreqList {bp, [@Var{page}]} +@DefreqItem {bp, @t{+}@Var{page}} +@DefreqListEnd {bp, @t{-}@Var{page}} +@cindex new page (@code{bp}) +@cindex page, new (@code{bp}) Stop processing the current page and move to the next page. This request causes a break. It can also take an argument to set (increase, decrease) the page number of the next page. The only @@ -5583,22 +7544,25 @@ cause a break or actually eject a page. .. \" end macro @endExample -@cindex top-level diversion -@cindex diversion, top-level +@cindex @code{bp} request, and top-level diversion +@cindex top-level diversion, and @code{bp} +@cindex diversion, top-level, and @code{bp} @code{bp} has no effect if not called within the top-level diversion (@pxref{Diversions}). @endDefreq -@cindex orphan line @Defreq {ne, [@Var{space}]} +@cindex orphan lines, preventing with @code{ne} +@cindex conditional page break (@code{ne}) +@cindex page break, conditional (@code{ne}) It is often necessary to force a certain amount of space before a new page occurs. This is most useful to make sure that there is not a single @dfn{orphan} line left at the bottom of a page. The @code{ne} request ensures that there is a certain distance, specified by the first argument, before the next page is triggered (see @ref{Traps}, -for further information). The default unit for @code{ne} is @samp{v}; -the default value of @var{space} is@w{ }1@dmn{v} if no argument is -given. +for further information). The default scaling indicator for @code{ne} +is @samp{v}; the default value of @var{space} is@w{ }1@dmn{v} if no +argument is given. For example, to make sure that no fewer than 2@w{ }lines get orphaned, do the following before each paragraph: @@ -5607,20 +7571,76 @@ do the following before each paragraph: .ne 2 text text text @endExample + +@code{ne} will then automatically cause a page break if there is space +for one line only. @endDefreq -@rqindex os -@rqindex ne -@Defreq {sv, [@Var{space}]} +@DefreqList {sv, [@Var{space}]} +@DefreqListEnd {os, } +@cindex @code{ne} request, comparison with @code{sv} @code{sv} is similar to the @code{ne} request; it reserves the specified amount of vertical space. If the desired amount of space -exists before the next trap (bottom page boundary), the space is -output immediately (ignoring a partial filled line which stays -untouched). If there is not enough space, it is stored for later -output via the @code{os} request. The default value is@w{ }1@dmn{v} -if no argument is given; the default unit is @samp{v}. +exists before the next trap (or the bottom page boundary if no trap is +set), the space is output immediately (ignoring a partially filled line +which stays untouched). If there is not enough space, it is stored for +later output via the @code{os} request. The default value is@w{ }1@dmn{v} +if no argument is given; the default scaling indicator is @samp{v}. + +@cindex @code{sv} request, and no-space mode +@cindex @code{os} request, and no-space mode +Both @code{sv} and @code{os} ignore no-space mode. While the @code{sv} +request allows negative values for @var{space}, @code{os} will ignore +them. @endDefreq +@Defreg {nl} +This register contains the current vertical position. If the vertical +position is zero and the top of page transition hasn't happened yet, +@code{nl} is set to negative value. @code{gtroff} itself does this at +the very beginning of a document before anything has been printed, but +the main usage is to plant a header trap on a page if this page has +already started. + +Consider the following: + +@Example +.de xxx +. sp +. tl ''Header'' +. sp +.. +. +First page. +.bp +.wh 0 xxx +.nr nl (-1) +Second page. +@endExample + +@noindent +Result: + +@Example +First page. + +... + + Header + +Second page. + +... +@endExample + +@noindent +Without resetting @code{nl} to a negative value, the just planted trap +would be active beginning with the @emph{next} page, not the current +one. + +@xref{Diversions}, for a comparison with the @code{.h} and @code{.d} +registers. +@endDefreg @c ===================================================================== @@ -5631,7 +7651,7 @@ if no argument is given; the default unit is @samp{v}. @code{gtroff} can switch fonts at any point in the text. The basic set of fonts is @samp{R}, @samp{I}, @samp{B}, and @samp{BI}. -These are Times Roman, Italic, Bold, and Bold Italic. For non-tty +These are Times Roman, Italic, Bold, and Bold Italic. For non-TTY devices, there is also at least one symbol font which contains various special symbols (Greek, mathematics). @@ -5649,32 +7669,34 @@ special symbols (Greek, mathematics). @node Changing Fonts, Font Families, Fonts, Fonts @subsection Changing Fonts -@cindex changing fonts -@cindex fonts, changing +@cindex fonts -@rqindex sty -@rqindex fam +@DefreqList {ft, [@Var{font}]} +@DefescItem {\\f, , f, } +@DefescItem {\\f, @lparen{}, fn, } +@DefescListEnd {\\f, @lbrack{}, font, @rbrack} +@cindex changing fonts (@code{ft}, @code{\f}) +@cindex fonts, changing (@code{ft}, @code{\f}) +@cindex @code{sty} request, and changing fonts +@cindex @code{fam} request, and changing fonts +@cindex @code{\F}, and changing fonts @kindex styles @kindex family @pindex DESC -@Defreq {ft, [@Var{font}]} -@Defescx {\\f, , f, } -@Defescx {\\f, @lparen{}, fn, } -@Defescx {\\f, @lbrack{}, font, @rbrack} The @code{ft} request and the @code{\f} escape change the current font -to @var{font} (one-character name @var{f}, two-character name +to @var{font} (one-character name@w{ }@var{f}, two-character name @var{fn}). If @var{font} is a style name (as set with the @code{sty} request or with the @code{styles} command in the @file{DESC} file), use it within -the current font family (as set with the @code{fam} request or with -the @code{family} command in the @file{DESC} file). +the current font family (as set with the @code{fam} request, @code{\F} +escape, or with the @code{family} command in the @file{DESC} file). -@cindex previous font -@cindex font, previous +@cindex previous font (@code{ft}, @code{\f[]}, @code{\fP}) +@cindex font, previous (@code{ft}, @code{\f[]}, @code{\fP}) With no argument or using @samp{P} as an argument, @code{.ft} switches -to the previous font. Use @code{\fP} or @code{\f[P]} to do this with -the escape. +to the previous font. Use @code{\f[]} to do this with the escape. The +old syntax forms @code{\fP} or @code{\f[P]} are also supported. Fonts are generally specified as upper-case strings, which are usually 1@w{ }to 4 characters representing an abbreviation or acronym of the @@ -5692,25 +7714,34 @@ and sausage. eggs, bacon, \fBspam\fP and sausage. @endExample +Note that @code{\f} doesn't produce an input token in @code{gtroff}. +As a consequence, it can be used in requests like @code{mc} (which +expects a single character as an argument) to change the font on +the fly: + +@Example +.mc \f[I]x\f[] +@endExample + @xref{Font Positions}, for an alternative syntax. @endDefreq -@rqindex ft -@rqindex ul -@rqindex bd -@esindex \f -@rqindex cs -@rqindex tkf -@rqindex special -@rqindex fspecial -@rqindex fp -@rqindex code @Defreq {ftr, f [@Var{g}]} -Translate font@w{ }@var{f} to font@w{ }@var{g}. Whenever a font named -@var{f} is referred to in a @code{\f} escape sequence, or in the +@cindex @code{ft} request, and font translations +@cindex @code{ul} request, and font translations +@cindex @code{bd} request, and font translations +@cindex @code{\f}, and font translations +@cindex @code{cs} request, and font translations +@cindex @code{tkf} request, and font translations +@cindex @code{special} request, and font translations +@cindex @code{fspecial} request, and font translations +@cindex @code{fp} request, and font translations +@cindex @code{sty} request, and font translations +Translate font@w{ }@var{f} to font@w{ }@var{g}. Whenever a font named@w{ +}@var{f} is referred to in a @code{\f} escape sequence, or in the @code{ft}, @code{ul}, @code{bd}, @code{cs}, @code{tkf}, -@code{special}, @code{fspecial}, @code{fp}, or @code{code} requests, -font@w{ }@var{g} is used. If @var{g} is missing or equal to @var{f} +@code{special}, @code{fspecial}, @code{fp}, or @code{sty} requests, +font@w{ }@var{g} is used. If @var{g} is missing or equal to@w{ }@var{f} the translation is undone. @endDefreq @@ -5729,21 +7760,34 @@ specified as the concatenation of the font family and style. Specifying a font without the family part causes @code{gtroff} to use that style of the current family. -@cindex postscript fonts -@cindex fonts, postscript -Currently, only @sc{PostScript} fonts are set up to this mechanism. +@cindex PostScript fonts +@cindex fonts, PostScript +Currently, fonts for the devices @option{-Tps}, @option{-Tdvi}, and +@option{-Tlbp} are set up to this mechanism. By default, @code{gtroff} uses the Times family with the four styles @samp{R}, @samp{I}, @samp{B}, and @samp{BI}. This way, it is possible to use the basic four fonts and to select a different font family on the command line (@pxref{Groff Options}). -@Defreq {fam, [@Var{family}]} -@Defregx {.fam} -Switch font family to @var{family}. If no argument is given, switch -back to the previous font family. The current font family is available -in the read-only number register @samp{.fam} (this is a string-valued -register); it is associated with the current environment. +@DefreqList {fam, [@Var{family}]} +@DefregItem {.fam} +@DefescItem {\\F, , f, } +@DefescItem {\\F, @lparen{}, fm, } +@DefescItem {\\F, @lbrack{}, family, @rbrack} +@DefregListEnd {.fn} +@cindex changing font family (@code{fam}, @code{\F}) +@cindex font family, changing (@code{fam}, @code{\F}) +Switch font family to @var{family} (one-character name@w{ }@var{f}, +two-character name @var{fm}). If no argument is given, switch +back to the previous font family. Use @code{\F[]} to do this with the +escape. Note that @code{\FP} doesn't work; it selects font family +@samp{P} instead. + +The value at start-up is @samp{T}. +The current font family is available in the read-only number register +@samp{.fam} (this is a string-valued register); it is associated with +the current environment. @Example spam, @@ -5758,29 +7802,46 @@ baked beans, .ft R \" family T + style R = font TR and spam. @endExample + +Note that @code{\F} doesn't produce an input token in @code{gtroff}. +As a consequence, it can be used in requests like @code{mc} (which +expects a single character as an argument) to change the font family on +the fly: + +@Example +.mc \F[P]x\F[] +@endExample + +The @samp{.fn} register contains the current @dfn{real font name} +of the current font. +This is a string-valued register. +If the current font is a style, the value of @code{\n[.fn]} +is the proper concatenation of family and style name. @endDefreq -@rqindex cs -@rqindex bd -@rqindex tkf -@rqindex uf -@rqindex fspecial @Defreq {sty, n style} +@cindex changing font style (@code{sty}) +@cindex font style, changing (@code{sty}) +@cindex @code{cs} request, and font styles +@cindex @code{bd} request, and font styles +@cindex @code{tkf} request, and font styles +@cindex @code{uf} request, and font styles +@cindex @code{fspecial} request, and font styles Associate @var{style} with font position@w{ }@var{n}. A font position can be associated either with a font or with a style. The current font is the index of a font position and so is also either a font or a -style. When it is a style, the font that is actually used is the font -the name of which is the concatenation of the name of the current +style. If it is a style, the font that is actually used is the font +which name is the concatenation of the name of the current family and the name of the current style. For example, if the current -font is@w{ }1 and font position@w{ }1 is associated with style@w{ -}@samp{R} and the current font family is@w{ }@samp{T}, then font +font is@w{ }1 and font position@w{ }1 is associated with style +@samp{R} and the current font family is @samp{T}, then font @samp{TR} will be used. If the current font is not a style, then the -current family is ignored. When the requests @code{cs}, @code{bd}, -@code{tkf}, @code{uf}, or @code{fspecial} are applied to a style, then +current family is ignored. If the requests @code{cs}, @code{bd}, +@code{tkf}, @code{uf}, or @code{fspecial} are applied to a style, they will instead be applied to the member of the current family corresponding to that style. -@var{n} must be a non-negative integer value. +@var{n}@w{ }must be a non-negative integer value. @pindex DESC @kindex styles @@ -5804,8 +7865,8 @@ is equivalent to .sty 4 BI @endExample -@code{.fam} always checks whether the current font position is valid; -this can give surprising results if the current font position is +@code{fam} and @code{\F} always check whether the current font position +is valid; this can give surprising results if the current font position is associated with a style. In the following example, we want to access the @sc{PostScript} font @@ -5846,16 +7907,18 @@ For the sake of old phototypesetters and compatibility with old versions of @code{troff}, @code{gtroff} has the concept of font @dfn{positions}, on which various fonts are mounted. -@Defreq {fp, pos font [@Var{external-name}]} -@Defregx {.f} -@Defregx {.fp} +@DefreqList {fp, pos font [@Var{external-name}]} +@DefregItem {.f} +@DefregListEnd {.fp} +@cindex mounting font (@code{fp}) +@cindex font, mounting (@code{fp}) Mount font @var{font} at position @var{pos} (which must be a non-negative integer). This numeric position can then be referred to with font changing commands. When @code{gtroff} starts it is using font position@w{ }1 (which must exist; position@w{ }0 is unused usually at start-up). -@cindex current font position register +@cindex font position register (@code{.f}) The current font in use, as a font position, is available in the read-only number register @samp{.f}. This can be useful to remember the current font for later recall. It is associated with the current @@ -5868,7 +7931,7 @@ environment (@pxref{Environments}). .ft \n[save-font] @endExample -@cindex next free font position register +@cindex next free font position register (@code{.fp}) The number of the next free font position is available in the read-only number register @samp{.fp}. This is useful when mounting a new font, like so: @@ -5899,23 +7962,27 @@ fonts with long names in compatibility mode. Both the @code{ft} request and the @code{\f} escape have alternative syntax forms to access font positions. -@rqindex sty -@rqindex fam +@DefreqList {ft, nnn} +@DefescItem {\\f, , n, } +@DefescItem {\\f, @lparen{}, nn, } +@DefescListEnd {\\f, @lbrack{}, nnn, @rbrack} +@cindex changing font position (@code{\f}) +@cindex font position, changing (@code{\f}) +@cindex @code{sty} request, and font positions +@cindex @code{fam} request, and font positions +@cindex @code{\F}, and font positions @kindex styles @kindex family @pindex DESC -@Defreq {ft, nnn} -@Defescx {\\f, , n, } -@Defescx {\\f, @lparen{}, nn, } -@Defescx {\\f, @lbrack{}, nnn, @rbrack} -Change the current font position to @var{nnn} (one-digit position -@var{n}, two-digit position @var{nn}), which must be a non-negative +Change the current font position to @var{nnn} (one-digit position@w{ +}@var{n}, two-digit position @var{nn}), which must be a non-negative integer. If @var{nnn} is associated with a style (as set with the @code{sty} request or with the @code{styles} command in the @file{DESC} file), use -it within the current font family (as set with the @code{fam} request or -with the @code{family} command in the @file{DESC} file). +it within the current font family (as set with the @code{fam} request, +the @code{\F} escape, or with the @code{family} command in the @file{DESC} +file). @Example this is font 1 @@ -5950,17 +8017,10 @@ written in a roman or an italic font, yielding two different glyphs); sometimes more than one character maps to a single glyph (this is a @dfn{ligature} -- the most common is `fi'). -@c XXX - -Please note that currently the distinction between glyphs and -characters in this reference is not clearly carried out. This will be -improved eventually in the next revision. - @cindex symbol @cindex special fonts @kindex fonts @pindex DESC -@rqindex fspecial A @dfn{symbol} is simply a named glyph. Within @code{gtroff}, all glyph names of a particular font are defined in its font file. If the user requests a glyph not available in this font, @code{gtroff} looks @@ -5973,42 +8033,100 @@ special fonts. Fonts mounted with the @code{fonts} keyword in the special fonts locally (i.e.@: for a particular font), use the @code{fspecial} request. +In summary, @code{gtroff} tries the following to find a given symbol: + +@itemize @bullet +@item +If the symbol has been defined with the @code{char} request, use it. +This hides a symbol with the same name in the current font. + +@item +Check the current font. + +@item +If the symbol has been defined with the @code{fchar} request, use it. + +@item +Check all fonts given with the @code{fspecial} request, in the order +of appearance in @code{fspecial} calls. + +@item +Check all fonts given with the @code{special} request, in the order +of appearance in @code{special} calls (inclusively the special fonts +defined in the @file{DESC} file, which come first). + +@item +As a last resort, consult all fonts loaded up to now (in the order they +have been called the first time) for special fonts and check them. +@end itemize + @xref{Font Files}, and @ref{Special Fonts}, for more details. -@Defesc {\\, @lparen{}, nm, } -@Defescx {\\, @lbrack{}, name, @rbrack} +@DefescList {\\, @lparen{}, nm, } +@DefescListEnd {\\, @lbrack{}, name, @rbrack} Insert a symbol @var{name} (two-character name @var{nm}). There is no special syntax for one-character names -- the natural form -@samp{\@var{n}} would collide with escapes. +@samp{\@var{n}} would collide with escapes.@footnote{Note that a +one-character symbol is not the same as an input character, i.e., the +character @code{a} is not the same as @code{\[a]}. By default, +@code{groff} defines only a single one-character symbol, @code{\[-]}; +it is usually accessed as @code{\-}. On the other hand, @code{gtroff} +has the special feature that @code{\[char@var{XXX}]} is the same as the +input character with character code @var{XXX}. For example, +@code{\[char97]} is identical to the letter @code{a} if @acronym{ASCII} +encoding is active.} If @var{name} is undefined, a warning of type @samp{char} is generated, and the escape is ignored. @xref{Debugging}, for information about warnings. -The list of available symbols is device dependent; see @ref{Glyph Name -Index} for some of them discussed in this reference. +@cindex list of available glyphs (@cite{groff_char(7)} man page) +@cindex available glyphs, list (@cite{groff_char(7)} man page) +@cindex glyphs, available, list (@cite{groff_char(7)} man page) +The list of available symbols is device dependent; see the +@cite{groff_char(7)} man page for a complete list for the given output +device. For example, say + +@Example +man -Tdvi groff_char > groff_char.dvi +@endExample + +@noindent +for a list using the default DVI fonts (not all versions of the +@code{man} program support the @option{-T} option). If you want to +use an additional macro package to change the used fonts, @code{groff} +must be called directly: + +@Example +groff -Tdvi -mec -man groff_char.7 > groff_char.dvi +@endExample @c XXX list of common symbols @endDefesc @Defesc {\\C, ', xxx, '} -Typeset the character named @var{xxx}. Normally it is more convenient -to use @code{\[@var{xxx}]}, but @code{\C} has the advantage that it is -compatible with newer versions of @code{ditroff} and is available in -compatibility mode. +@cindex named character (@code{\C}) +@cindex character, named (@code{\C}) +Typeset the glyph named @var{xxx}.@footnote{@code{\C} is actually a +misnomer since it accesses an output glyph.} Normally it is more +convenient to use @code{\[@var{xxx}]}, but @code{\C} has the advantage +that it is compatible with newer versions of @acronym{AT&T} +@code{troff} and is available in compatibility mode. @endDefesc -@rqindex char -@cindex unicode @Defesc {\\N, ', n, '} -Typeset the character with code@w{ }@var{n} in the current font (this -is @strong{not} the input character code). @var{n} can be any -integer. Most devices only have characters with codes between 0 -and@w{ }255; the Unicode output device uses codes in the range -0--65535. If the current font does not contain a character with that -code, special fonts are @emph{not} searched. The @code{\N} escape -sequence can be conveniently used in conjunction with the @code{char} -request: +@cindex numbered glyph (@code{\N}) +@cindex glyph, numbered (@code{\N}) +@cindex @code{char} request, used with @code{\N} +@cindex Unicode +Typeset the glyph with code@w{ }@var{n} in the current font +(@code{n}@w{ }is @strong{not} the input character code). The +number @var{n}@w{ }can be any non-negative decimal integer. Most devices +only have glyphs with codes between 0 and@w{ }255; the Unicode +output device uses codes in the range 0--65535. If the current +font does not contain a glyph with that code, special fonts are +@emph{not} searched. The @code{\N} escape sequence can be +conveniently used in conjunction with the @code{char} request: @Example .char \[phone] \f[ZD]\N'37' @@ -6016,117 +8134,171 @@ request: @noindent @pindex DESC -@cindex unnamed characters -@cindex characters, unnamed -The code of each character is given in the fourth column in the font +@cindex unnamed glyphs +@cindex glyphs, unnamed +The code of each glyph is given in the fourth column in the font description file after the @code{charset} command. It is possible to -include unnamed characters in the font description file by using a +include unnamed glyphs in the font description file by using a name of @samp{---}; the @code{\N} escape sequence is the only way to use these. @endDefesc -@c XXX should be `glyph', not `character' +Some escape sequences directly map onto special glyphs. + +@Defesc {\\', , , } +This is a backslash followed by the apostrophe character, @acronym{ASCII} +character @code{0x27} (@acronym{EBCDIC} character @code{0x7D}). The same +as @code{\[aa]}, the acute accent. +@endDefesc + +@Defesc {\\`, , , } +This is a backslash followed by @acronym{ASCII} character @code{0x60} +(@acronym{EBCDIC} character @code{0x79} usually). The same as +@code{\[ga]}, the grave accent. +@endDefesc + +@Defesc {\\-, , , } +This is the same as @code{\[-]}, the minus sign in the current font. +@endDefesc -@cindex character properties -@cindex properties of characters @Defreq {cflags, n c1 c2 @dots{}} -Each character has certain properties associated with it. These -properties can be modified with the @code{cflags} request. The first -argument is the the sum of the desired flags and the remaining -arguments are the characters to have those properties. It is possible -to omit the spaces between the characters. +@cindex glyph properties (@code{cflags}) +@cindex character properties (@code{cflags}) +@cindex properties of glyphs (@code{cflags}) +@cindex properties of characters (@code{cflags}) +Input characters and symbols have certain properties associated +with it.@footnote{Note that the output glyphs themselves don't have +such properties. For @code{gtroff}, a glyph is a numbered box with +a given width, depth, and height, nothing else. All manipulations +with the @code{cflags} request work on the input level.} These +properties can be modified with the @code{cflags} request. The +first argument is the sum of the desired flags and the remaining +arguments are the characters or symbols to have those properties. +It is possible to omit the spaces between the characters or symbols. @table @code @item 1 -@cindex end of sentence characters -@cindex characters, end of sentence -the character ends sentences (initially characters @samp{.?!} have this -property) +@cindex end-of-sentence characters +@cindex characters, end-of-sentence +The character ends sentences (initially characters @samp{.?!} have this +property). @item 2 @cindex hyphenating characters @cindex characters, hyphenation -lines can be broken before the character (initially no characters have -this property) +Lines can be broken before the character (initially no characters have +this property). @item 4 -@glindex hy -@glindex em -lines can be broken after the character (initially the characters -@samp{-\(hy\(em} have this property) +@cindex @code{hy} glyph, and @code{cflags} +@cindex @code{em} glyph, and @code{cflags} +Lines can be broken after the character (initially the character +@samp{-} and the symbols @samp{\(hy} and @samp{\(em} have this property). @item 8 @cindex overlapping characters @cindex characters, overlapping -@glindex ul -@glindex rn -@glindex ru -the character overlaps horizontally (initially the characters -@samp{\(ul\(rn\(ru} have this property) +@cindex @code{ul} glyph, and @code{cflags} +@cindex @code{rn} glyph, and @code{cflags} +@cindex @code{ru} glyph, and @code{cflags} +The character overlaps horizontally (initially the symbols +@samp{\(ul\(rn\(ru} have this property). @item 16 -@glindex br -the character overlaps vertically (initially character @samp{\(br} has -this property) +@cindex @code{br} glyph, and @code{cflags} +The character overlaps vertically (initially symbol @samp{\(br} has +this property). @item 32 @cindex transparent characters @cindex character, transparent -@cindex ' -@cindex " -@cindex ] -@cindex ) -@cindex * -@glindex dg -@glindex rq -an end of sentence character followed by any number of characters with +@cindex @code{"}, at end of sentence +@cindex @code{'}, at end of sentence +@cindex @code{)}, at end of sentence +@cindex @code{]}, at end of sentence +@cindex @code{*}, at end of sentence +@cindex @code{dg} glyph, at end of sentence +@cindex @code{rq} glyph, at end of sentence +An end-of-sentence character followed by any number of characters with this property is treated as the end of a sentence if followed by a newline or two spaces; in other words the character is -@dfn{transparent} for the purposes of end of sentence recognition -- +@dfn{transparent} for the purposes of end-of-sentence recognition -- this is the same as having a zero space factor in @TeX{} (initially -characters @samp{"')]*\(dg\(rq} have this property). +characters @samp{"')]*} and the symbols @samp{\(dg\(rq} have this +property). @end table @endDefreq -@cindex defining characters -@cindex characters, defining -@cindex creating new characters -@cindex escape character -@cindex character, escape -@rqindex tr -@rqindex cp -@rqindex rc -@rqindex lc -@esindex \l -@esindex \L -@esindex \& -@esindex \e -@rqindex hcode -@Defreq {char, c [@Var{string}]} -Define a new character@w{ }@var{c} to be @var{string} (which can be -empty). Every time character@w{ }@var{c} needs to be printed, +@DefreqList {char, g [@Var{string}]} +@DefreqListEnd {fchar, g [@Var{string}]} +@cindex defining character (@code{char}) +@cindex character, defining (@code{char}) +@cindex creating new characters (@code{char}) +@cindex defining symbol (@code{char}) +@cindex symbol, defining (@code{char}) +@cindex defining glyph (@code{char}) +@cindex glyph, defining (@code{char}) +@cindex escape character, while defining glyph +@cindex character, escape, while defining glyph +@cindex @code{tr} request, and glyph definitions +@cindex @code{cp} request, and glyph definitions +@cindex @code{rc} request, and glyph definitions +@cindex @code{lc} request, and glyph definitions +@cindex @code{\l}, and glyph definitions +@cindex @code{\L}, and glyph definitions +@cindex @code{\&}, and glyph definitions +@cindex @code{\e}, and glyph definitions +@cindex @code{hcode} request, and glyph definitions +Define a new glyph@w{ }@var{g} to be @var{string} (which can be +empty).@footnote{@code{char} is a misnomer since an output glyph is +defined.} Every time glyph@w{ }@var{g} needs to be printed, @var{string} is processed in a temporary environment and the result is wrapped up into a single object. Compatibility mode is turned off and the escape character is set to @samp{\} while @var{string} is being processed. Any emboldening, constant spacing or track kerning is applied to this object rather than to individual characters in -@var{string}. A character defined by this request can be used just -like a normal character provided by the output device. In particular, -other characters can be translated to it with the @code{tr} request; -it can be made the leader character by the @code{lc} request; repeated -patterns can be drawn with the character using the @code{\l} and -@code{\L} escape sequences; words containing the character can be -hyphenated correctly, if the @code{hcode} request is used to give the -character a hyphenation code. There is a special anti-recursion -feature: Use of character within the character's definition is handled -like normal characters not defined with @code{char}. -@endDefreq - -@cindex removing character definition -@cindex character, removing definition +@var{string}. + +A glyph defined by this request can be used just +like a normal glyph provided by the output device. In particular, +other characters can be translated to it with the @code{tr} or +@code{trin} requests; it can be made the leader character by the +@code{lc} request; repeated patterns can be drawn with the glyph +using the @code{\l} and @code{\L} escape sequences; words containing +the glyph can be hyphenated correctly if the @code{hcode} request +is used to give the glyph's symbol a hyphenation code. + +There is a special anti-recursion feature: Use of @code{g} within +the glyph's definition is handled like normal characters and symbols +not defined with @code{char}. + +Note that the @code{tr} and @code{trin} requests take precedence if +@code{char} accesses the same symbol. + +@Example +.tr XY +X + @result{} Y +.char X Z +X + @result{} Y +.tr XX +X + @result{} Z +@endExample + +The @code{fchar} request defines a fallback glyph: +@code{gtroff} only checks for glyphs defined with @code{fchar} +if it cannot find the glyph in the current font. +@code{gtroff} carries out this test before checking special fonts. +@endDefreq + @Defreq {rchar, c1 c2 @dots{}} -Remove the definitions of characters @var{c1}, @var{c2},@w{ -}@enddots{} This undoes the effect of a @code{char} request. +@cindex removing glyph definition (@code{rchar}) +@cindex glyph, removing definition (@code{rchar}) +Remove the definitions of glyphs @var{c1}, @var{c2},@w{ +}@enddots{} This undoes the effect of a @code{char} or @code{fchar} +request. It is possible to omit the whitespace between arguments. @endDefreq @@ -6140,9 +8312,31 @@ It is possible to omit the whitespace between arguments. @cindex special fonts @cindex fonts, special -@c XXX +Special fonts are those that @code{gtroff} searches +when it cannot find the requested glyph in the current font. +The Symbol font is usually a special font. + +@code{gtroff} provides the following two requests to add more special +fonts. @xref{Using Symbols}, for a detailed description of the glyph +searching mechanism in @code{gtroff}. -To be written. +Usually, only non-TTY devices have special fonts. + +@DefreqList {special, s1 s2 @dots{}} +@DefreqListEnd {fspecial, f s1 s2 @dots{}} +@kindex fonts +@pindex DESC +Use the @code{special} request to define special fonts. They are +appended to the list of global special fonts in the given order. +The first entries in this list are the fonts defined with the +@code{fonts} command in the @file{DESC} file which are marked as +special in the corresponding font description files. + +Use the @code{fspecial} request to designate special fonts +only when font@w{ }@var{f} font is active. They are appended to the +list of special fonts for @var{f} in the given order. Initially, this +list is empty. +@endDefreq @c --------------------------------------------------------------------- @@ -6151,15 +8345,73 @@ To be written. @cindex artificial fonts @cindex fonts, artificial -There are a number of requests for artificially creating fonts. These -are largely vestiges of the days when output devices did not have a -wide variety of fonts, and when @code{nroff} and @code{troff} were -separate programs. These are no longer necessary in GNU -@code{troff}. Nevertheless, they are supported. +There are a number of requests and escapes for artificially creating +fonts. These are largely vestiges of the days when output devices +did not have a wide variety of fonts, and when @code{nroff} and +@code{troff} were separate programs. Most of them are no longer +necessary in GNU @code{troff}. Nevertheless, they are supported. + +@DefescList {\\H, ', height, '} +@DefescItem {\\H, ', @t{+}@Var{height}, '} +@DefescListEnd {\\H, ', @t{-}@Var{height}, '} +@cindex changing the font height (@code{\H}) +@cindex font height, changing (@code{\H}) +@cindex height, font, changing (@code{\H}) +Change (increment, decrement) the height of the current font, but not +the width. If @var{height} is zero, restore the original height. +Default scaling indicator is @samp{z}. + +Currently, only the @option{-Tps} device supports this feature. + +Note that @code{\H} doesn't produce an input token in @code{gtroff}. +As a consequence, it can be used in requests like @code{mc} (which +expects a single character as an argument) to change the font on +the fly: + +@Example +.mc \H'+5z'x\H'0' +@endExample + +In compatibility mode, @code{gtroff} behaves differently: If an +increment or decrement is used, it is always taken relative to the +current point size and not relative to the previously selected font +height. Thus, + +@Example +.cp 1 +\H'+5'test \H'+5'test +@endExample + +@noindent +prints the word @samp{test} twice with the same font height (five +points larger than the current font size). +@endDefesc + +@DefescList {\\S, ', slant, '} +@cindex changing the font slant (@code{\S}) +@cindex font slant, changing (@code{\S}) +@cindex slant, font, changing (@code{\S}) +Slant the current font by @var{slant} degrees. Positive values slant +to the right. + +Currently, only the @option{-Tps} device supports this feature. + +Note that @code{\S} doesn't produce an input token in @code{gtroff}. +As a consequence, it can be used in requests like @code{mc} (which +expects a single character as an argument) to change the font on +the fly: + +@Example +.mc \S'20'x\S'0' +@endExample + +This request is incorrectly documented in the original @acronym{UNIX} +troff manual; the slant is always set to an absolute value. +@endDefesc -@cindex underlining @Defreq {ul, [@Var{lines}]} -The @code{ul} request normally underlines subsequent lines if a tty +@cindex underlining (@code{ul}) +The @code{ul} request normally underlines subsequent lines if a TTY output device is used. Otherwise, the lines are printed in italics (only the term `underlined' is used in the following). The single argument is the number of input lines to be underlined; with no @@ -6174,43 +8426,39 @@ underline font is activated. Within the span of a @code{ul} request, it is possible to change fonts, but after the last line affected by @code{ul} the saved font is restored. -@cindex underline font -@cindex font, for underlining -@rqindex uf -This command is associated with the current environment. The -underline font can be changed with the @code{uf} request. +This number of lines still to be underlined is associated with the +current environment (@pxref{Environments}). The underline font can be +changed with the @code{uf} request. @c XXX @xref should be changed to grotty -@xref{Troff and Nroff Mode}, for a discussion how underlining is -implemented in for tty output devices, and which problems can arise. +@c @xref{Troff and Nroff Mode}, for a discussion how underlining is +@c implemented in for TTY output devices, and which problems can arise. The @code{ul} request does not underline spaces. @endDefreq -@cindex continuous underlining -@cindex underlining, continuous @Defreq {cu, [@Var{lines}]} +@cindex continuous underlining (@code{cu}) +@cindex underlining, continuous (@code{cu}) The @code{cu} request is similar to @code{ul} but underlines spaces as -well (if a tty output device is used). +well (if a TTY output device is used). @endDefreq -@cindex underline font -@cindex font for underlining -@rqindex ul -@rqindex cu @Defreq {uf, font} +@cindex underline font (@code{uf}) +@cindex font for underlining (@code{uf}) Set the underline font (globally) used by @code{ul} and @code{cu}. By default, this is the font at position@w{ }2. @var{font} can be either a non-negative font position or the name of a font. @endDefreq -@cindex imitating bold face -@cindex bold face, imitating -@Defreq {bd, font [@Var{offset}]} -@Defreqx {bd, font1 font2 [@Var{offset}]} -@Defregx {.b} -Artificially create a bold font by printing each character twice, +@DefreqList {bd, font [@Var{offset}]} +@DefreqItem {bd, font1 font2 [@Var{offset}]} +@DefregListEnd {.b} +@cindex imitating bold face (@code{bd}) +@cindex bold face, imitating (@code{bd}) +Artificially create a bold font by printing each glyph twice, slightly offset. Two syntax forms are available. @@ -6219,7 +8467,7 @@ Two syntax forms are available. @item Imitate a bold font unconditionally. The first argument specifies the font to embolden, and the second is the number of basic units, minus -one, by which the two characters is offset. If the second argument is +one, by which the two glyphs are offset. If the second argument is missing, emboldening is turned off. @var{font} can be either a non-negative font position or the name of a @@ -6229,7 +8477,7 @@ font. special font is active; in the @code{bd} request, its default unit is @samp{u}. -@rqindex fspecial +@cindex @code{fspecial} request, and imitating bold @kindex special @cindex embolding of special fonts @cindex special fonts, emboldening @@ -6245,19 +8493,20 @@ command in font files or with the @code{fspecial} request). @end itemize @endDefreq -@cindex constant character space mode -@cindex mode for constant character space -@cindex character, constant space -@rqindex ps @Defreq {cs, font [@Var{width} [@Var{em-size}]]} -Switch to and from constant character space mode. If activated, the -width of every character is @math{@var{width}/36} ems. The em size is +@cindex constant glyph space mode (@code{cs}) +@cindex mode for constant glyph space (@code{cs}) +@cindex glyph, constant space +@cindex @code{ps} request, and constant glyph space mode +Switch to and from @dfn{constant glyph space mode}. If activated, the +width of every glyph is @math{@var{width}/36} ems. The em size is given absolutely by @var{em-size}; if this argument is missing, the em value is taken from the current font size (as set with the @code{ps} request) when the font is effectively in use. Without second and -third argument, constant character space mode is deactivated. +third argument, constant glyph space mode is deactivated. -Default unit for @var{em-size} is @samp{z}; @var{width} is an integer. +Default scaling indicator for @var{em-size} is @samp{z}; @var{width} is +an integer. @endDefreq @c --------------------------------------------------------------------- @@ -6267,26 +8516,27 @@ Default unit for @var{em-size} is @samp{z}; @var{width} is an integer. @cindex ligatures and kerning @cindex kerning and ligatures -Ligatures are groups of characters that are run together. For -example, the letters `f' and `i' can form a ligature `fi' as in the -word `file'. This produces a cleaner look (albeit subtle) to the -printed output. Usually, ligatures are not available in fonts for tty -output devices. +Ligatures are groups of characters that are run together, i.e, producing +a single glyph. For example, the letters `f' and `i' can form a +ligature `fi' as in the word `file'. This produces a cleaner look +(albeit subtle) to the printed output. Usually, ligatures are not +available in fonts for TTY output devices. Most @sc{PostScript} fonts support the fi and fl ligatures. The C/A/T -typesetter that was the target of AT&T @code{troff} also supported -`ff', `ffi', and `ffl' ligatures. Advanced typesetters or `expert' -fonts may include ligatures for `ft' and `ct', although GNU +typesetter that was the target of @acronym{AT&T} @code{troff} also +supported `ff', `ffi', and `ffl' ligatures. Advanced typesetters or +`expert' fonts may include ligatures for `ft' and `ct', although GNU @code{troff} does not support these (yet). -@cindex ligatures enabled register -@Defreq {lg, [@Var{flag}]} -@Defregx {.lg} -The ligature mechanism can be switched on or off with the @code{lg} -request; if the parameter is non-zero or missing, ligatures are -enabled, otherwise disabled. Default is on. The current ligature -mode can be found in the read-only number register @code{.lg} (set to -1 or@w{ }2 if ligatures are enabled, 0@w{ }otherwise). +@DefreqList {lg, [@Var{flag}]} +@DefregListEnd {.lg} +@cindex activating ligatures (@code{lg}) +@cindex ligatures, activating (@code{lg}) +@cindex ligatures enabled register (@code{.lg}) +Switch the ligature mechanism on or off; if the parameter is non-zero +or missing, ligatures are enabled, otherwise disabled. Default is on. +The current ligature mode can be found in the read-only number register +@code{.lg} (set to 1 or@w{ }2 if ligatures are enabled, 0@w{ }otherwise). Setting the ligature mode to@w{ }2 enables the two-character ligatures (fi, fl, and ff) and disables the three-character ligatures (ffi and @@ -6294,28 +8544,30 @@ ffl). @endDefreq @dfn{Pairwise kerning} is another subtle typesetting mechanism that -modifies the distance between a character pair to improve readability. +modifies the distance between a glyph pair to improve readability. In most cases (but not always) the distance is decreased. @ifnotinfo For example, compare the combination of the letters `V' and `A'. With kerning, `VA' is printed. Without kerning it appears as `V@w{}A'. @end ifnotinfo -Typewriter-like fonts and fonts for terminals where all characters +Typewriter-like fonts and fonts for terminals where all glyphs have the same width don't use kerning. -@cindex kerning enabled register -@Defreq {kern, [@Var{flag}]} -@Defregx {.kern} -Kerning can be activated with the @code{kern} request. If the -parameter is non-zero or missing, enable pairwise kerning, otherwise -disable it. The read-only number register @code{.kern} is set to@w{ -}1 if pairwise kerning is enabled, 0@w{ }otherwise. - -@cindex zero width space character -@cindex character, zero width space -@cindex space character, zero width +@DefreqList {kern, [@Var{flag}]} +@DefregListEnd {.kern} +@cindex activating kerning (@code{kern}) +@cindex kerning, activating (@code{kern}) +@cindex kerning enabled register (@code{.kern}) +Switch kerning on or off. If the parameter is non-zero or missing, +enable pairwise kerning, otherwise disable it. The read-only number +register @code{.kern} is set to@w{ }1 if pairwise kerning is enabled, +0@w{ }otherwise. + +@cindex zero width space character (@code{\&}) +@cindex character, zero width space (@code{\&}) +@cindex space character, zero width (@code{\&}) If the font description file contains pairwise kerning information, -characters from that font are kerned. Kerning between two characters +glyphs from that font are kerned. Kerning between two glyphs can be inhibited by placing @code{\&} between them: @samp{V\&A}. @xref{Font File Format}. @@ -6323,15 +8575,17 @@ can be inhibited by placing @code{\&} between them: @samp{V\&A}. @cindex track kerning @cindex kerning, track -@dfn{Track kerning} expands or reduces the space between characters. +@dfn{Track kerning} expands or reduces the space between glyphs. This can be handy, for example, if you need to squeeze a long word onto a single line or spread some text to fill a narrow column. It must be used with great care since it is usually considered bad typography if the reader notices the effect. @Defreq {tkf, f s1 n1 s2 n2} +@cindex activating track kerning (@code{tkf}) +@cindex track kerning, activating (@code{tkf}) Enable track kerning for font@w{ }@var{f}. If the current font is@w{ -}@var{f} the width of every character is increased by an amount +}@var{f} the width of every glyph is increased by an amount between @var{n1} and @var{n2} (@var{n1}, @var{n2} can be negative); if the current point size is less than or equal to @var{s1} the width is increased by @var{n1}; if it is greater than or equal to @var{s2} the @@ -6339,28 +8593,33 @@ width is increased by @var{n2}; if the point size is greater than or equal to @var{s1} and less than or equal to @var{s2} the increase in width is a linear function of the point size. -The default unit is @samp{z} for @var{s1} and @var{s2}, @samp{p} for -@var{n1} and @var{n2}. +The default scaling indicator is @samp{z} for @var{s1} and @var{s2}, +@samp{p} for @var{n1} and @var{n2}. + +Note that the track kerning amount is added even to the rightmost glyph +in a line; for large values it is thus recommended to increase the line +length by the same amount to compensate it. @endDefreq Sometimes, when typesetting letters of different fonts, more or less space at such boundaries are needed. There are two escapes to help with this. -@cindex italic correction -@cindex correction, italic -@cindex correction between italic and roman character -@cindex roman character, correction after italic character -@cindex italic character, correction before roman character @Defesc {\\/, , , } -Increase the width of the preceding character so that the spacing -between that character and the following character is correct if the -following character is a roman character. For example, if an +@cindex italic correction (@code{\/}) +@cindex correction, italic (@code{\/}) +@cindex correction between italic and roman glyph (@code{\/}, @code{\,}) +@cindex roman glyph, correction after italic glyph (@code{\/}) +@cindex italic glyph, correction before roman glyph (@code{\/}) +@cindex glyph, italic correction (@code{\/}) +Increase the width of the preceding glyph so that the spacing +between that glyph and the following glyph is correct if the +following glyph is a roman glyph. For example, if an italic@w{ }@code{f} is immediately followed by a roman right -parenthesis, then in many fonts the top right portion of the @code{f} +parenthesis, then in many fonts the top right portion of the@w{ }@code{f} overlaps the top left of the right parenthesis. Use this escape -sequence whenever an italic character is immediately followed by a -roman character without any intervening space. This small amount of +sequence whenever an italic glyph is immediately followed by a +roman glyph without any intervening space. This small amount of space is also called @dfn{italic correction}. @iftex @@ -6375,16 +8634,17 @@ space is also called @dfn{italic correction}. @end iftex @endDefesc -@cindex left italic correction -@cindex correction, left italic -@cindex roman character, correction before italic character -@cindex italic character, correction after roman character @Defesc {\\\,, , , } -Modify the spacing of the following character so that the spacing -between that character and the preceding character is correct if the -preceding character is a roman character. Use this escape sequence -whenever a roman character is immediately followed by an italic -character without any intervening space. In analogy to above, this +@cindex left italic correction (@code{\,}) +@cindex correction, left italic (@code{\,}) +@cindex glyph, left italic correction (@code{\,}) +@cindex roman glyph, correction before italic glyph (@code{\,}) +@cindex italic glyph, correction after roman glyph (@code{\,}) +Modify the spacing of the following glyph so that the spacing +between that glyph and the preceding glyph is correct if the +preceding glyph is a roman glyph. Use this escape sequence +whenever a roman glyph is immediately followed by an italic +glyph without any intervening space. In analogy to above, this space could be called @dfn{left italic correction}, but this term isn't used widely. @@ -6406,7 +8666,7 @@ is to stop interaction of a character with its surrounding. @itemize @bullet @item -It prevents the insertion of extra space after an end of sentence +It prevents the insertion of extra space after an end-of-sentence character. @Example @@ -6430,7 +8690,7 @@ an input line. @endExample @item -It prevents kerning between two characters. +It prevents kerning between two glyphs. @ifnotinfo @example @@ -6449,6 +8709,32 @@ request (@pxref{Character Translations}). @end itemize @endDefesc +@Defesc {\\), , , } +This escape is similar to @code{\&} except that it behaves like a +character declared with the @code{cflags} request to be transparent +for the purposes of an end-of-sentence character. + +Its main usage is in macro definitions to protect against arguments +starting with a control character. + +@Example +.de xxx +\)\\$1 +.. +.de yyy +\&\\$1 +.. +This is a test.\c +.xxx ' +This is a test. + @result{}This is a test.' This is a test. +This is a test.\c +.yyy ' +This is a test. + @result{}This is a test.' This is a test. +@endExample +@endDefesc + @c ===================================================================== @@ -6463,7 +8749,7 @@ request (@pxref{Character Translations}). @cindex spacing, vertical @code{gtroff} uses two dimensions with each line of text, type size and vertical spacing. The @dfn{type size} is approximately the height -of the tallest character.@footnote{This is usually the parenthesis. +of the tallest glyph.@footnote{This is usually the parenthesis. Note that in most cases the real dimensions of the glyphs in a font are @emph{not} related to its type size! For example, the standard @sc{PostScript} font families `Times Roman', `Helvetica', and @@ -6479,7 +8765,7 @@ term papers). By default, @code{gtroff} uses 10@w{ }point type on @cindex leading The difference between type size and vertical spacing is known, by -typesetters, as @dfn{leading}. +typesetters, as @dfn{leading} (this is pronounced `ledding'). @menu * Changing Type Sizes:: @@ -6490,22 +8776,25 @@ typesetters, as @dfn{leading}. @node Changing Type Sizes, Fractional Type Sizes, Sizes, Sizes @subsection Changing Type Sizes -@cindex changing type sizes -@cindex type sizes, changing - -@Defreq {ps, [@Var{size}]} -@Defreqx {ps, @t{+}@Var{size}} -@Defreqx {ps, @t{-}@Var{size}} -@Defescx {\\s, , size, } -@Defregx {.s} + +@DefreqList {ps, [@Var{size}]} +@DefreqItem {ps, @t{+}@Var{size}} +@DefreqItem {ps, @t{-}@Var{size}} +@DefescItem {\\s, , size, } +@DefregListEnd {.s} +@cindex changing type sizes (@code{ps}, @code{\s}) +@cindex type sizes, changing (@code{ps}, @code{\s}) +@cindex point sizes, changing (@code{ps}, @code{\s}) Use the @code{ps} request or the @code{\s} escape to change (increase, decrease) the type size (in points). Specify @var{size} as either an absolute point size, or as a relative change from the current size. The size@w{ }0, or no argument, goes back to the previous size. -Default unit of @code{size} is @samp{z}. If @code{size} is zero or -negative, it is set to 1@dmn{u}. +Default scaling indicator of @code{size} is @samp{z}. If @code{size} +is zero or negative, it is set to 1@dmn{u}. +@cindex type size registers (@code{.s}, @code{.ps}) +@cindex point size registers (@code{.s}, @code{.ps}) The read-only number register @code{.s} returns the point size in points as a decimal fraction. This is a string. To get the point size in scaled points, use the @code{.ps} register instead. @@ -6548,26 +8837,52 @@ Increase or decrease the point size by @var{nn}@w{ }points. @var{nn} must be exactly two digits. @end table +Note that @code{\s} doesn't produce an input token in @code{gtroff}. +As a consequence, it can be used in requests like @code{mc} (which +expects a single character as an argument) to change the font on +the fly: + +@Example +.mc \s[20]x\s[0] +@endExample + @xref{Fractional Type Sizes}, for yet another syntactical form of using the @code{\s} escape. +@endDefreq +@Defreq {sizes, s1 s2 @dots{} sn [0]} Some devices may only have certain permissible sizes, in which case @code{gtroff} rounds to the nearest permissible size. +The @file{DESC} file specifies which sizes are permissible for the device. + +Use the @code{sizes} request to change the permissible sizes +for the current output device. +Arguments are in scaled points; +the @code{sizescale} line in the +@file{DESC} file for the output device +provides the scaling factor. +For example, if the scaling factor is 1000, +then the value 12000 is 12@w{ }points. + +Each argument can be a single point size (such as @samp{12000}), +or a range of sizes (such as @samp{4000-72000}). +You can optionally end the list with a zero. @endDefreq -@cindex current type size register -@cindex current vertical spacing register -@Defreq {vs, [@Var{space}]} -@Defreqx {vs, @t{+}@Var{space}} -@Defreqx {vs, @t{-}@Var{space}} -@Defregx {.v} +@DefreqList {vs, [@Var{space}]} +@DefreqItem {vs, @t{+}@Var{space}} +@DefreqItem {vs, @t{-}@Var{space}} +@DefregListEnd {.v} +@cindex changing vertical line spacing (@code{vs}) +@cindex vertical line spacing, changing (@code{vs}) +@cindex vertical line spacing register (@code{.v}) Change (increase, decrease) the vertical spacing by @var{space}. The -default unit is @samp{p}. +default scaling indicator is @samp{p}. If @code{vs} is called without an argument, the vertical spacing is reset to the previous value before the last call to @code{vs}. -@vindex .V +@cindex @code{.V} register, and @code{vs} @code{gtroff} creates a warning of type @samp{range} if @var{space} is zero or negative; the vertical spacing is then set to the vertical resolution (as given in the @code{.V} register). @@ -6577,30 +8892,85 @@ spacing; it is associated with the current environment (@pxref{Environments}). @endDefreq -@c XXX example +@cindex vertical line spacing, effective value +The effective vertical line spacing consists of four components. + +@itemize @bullet +@item +The vertical line spacing as set with the @code{vs} request. + +@cindex post-vertical line spacing +@cindex line spacing, post-vertical (@code{pvs}) +@item +The @dfn{post-vertical line spacing} as set with the @code{pvs} request. +This is vertical space which will be added after a line has been +output. + +@cindex extra pre-vertical line space (@code{\x}) +@cindex line space, extra pre-vertical (@code{\x}) +@item +The @dfn{extra pre-vertical line space} as set with the @code{\x} request, +using a negative value. This is vertical space which will be added once +before the current line has been output. + +@cindex extra post-vertical line space (@code{\x}) +@cindex line space, extra post-vertical (@code{\x}) +@item +The @dfn{extra post-vertical line space} as set with the @code{\x} request, +using a positive value. This is vertical space which will be added once +after the current line has been output. +@end itemize + +@cindex double-spacing (@code{vs}, @code{pvs}) +It is usually better to use @code{vs} or @code{pvs} instead of @code{ls} +to produce double-spaced documents: @code{vs} and @code{pvs} have a finer +granularity for the inserted vertical space compared to @code{ls}; +furthermore, certain preprocessors assume single-spacing. + +@xref{Manipulating Spacing}, for more details on the @code{\x} escape +and the @code{ls} request. + +@DefreqList {pvs, [@Var{space}]} +@DefreqItem {pvs, @t{+}@Var{space}} +@DefreqItem {pvs, @t{-}@Var{space}} +@DefregListEnd {.pvs} +@cindex @code{ls} request, alternative to (@code{pvs}) +@cindex post-vertical line spacing, changing (@code{pvs}) +@cindex post-vertical line spacing register (@code{.pvs}) +Change (increase, decrease) the post-vertical spacing by +@var{space}. The default scaling indicator is @samp{p}. + +If @code{pvs} is called without an argument, the post-vertical spacing is +reset to the previous value before the last call to @code{pvs}. + +@code{gtroff} creates a warning of type @samp{range} if @var{space} is +zero or negative; the vertical spacing is then set to zero. + +The read-only number register @code{.pvs} contains the current +post-vertical spacing; it is associated with the current environment +(@pxref{Environments}). +@endDefreq -@ignore -@Example -... .sz macro example?? ... -@endExample -@end ignore @c --------------------------------------------------------------------- @node Fractional Type Sizes, , Changing Type Sizes, Sizes @subsection Fractional Type Sizes @cindex fractional type sizes +@cindex fractional point sizes @cindex type sizes, fractional +@cindex point sizes, fractional +@cindex sizes, fractional @cindex @code{s} unit @cindex unit, @code{s} @cindex @code{z} unit @cindex unit, @code{z} -@rqindex ps -@rqindex cs -@rqindex tkf -@esindex \H -@esindex \s +@cindex @code{ps} request, with fractional type sizes +@cindex @code{cs} request, with fractional type sizes +@cindex @code{tkf} request, with fractional type sizes +@cindex @code{\H}, with fractional type sizes +@cindex @code{\s}, with fractional type sizes A @dfn{scaled point} is equal to @math{1/@var{sizescale}} points, where @var{sizescale} is specified in the @file{DESC} file (1@w{ }by default). There is a new scale indicator @samp{z} which has the @@ -6632,7 +9002,6 @@ number of units in a scaled point. So, for example, @samp{\n[.ps]s} is equal to @samp{1m}. Be sure not to confuse the @samp{s} and @samp{z} scale indicators. -@vindex .s @Defreg {.ps} A read-only number register returning the point size in scaled points. @@ -6640,12 +9009,12 @@ A read-only number register returning the point size in scaled points. (@pxref{Environments}). @endDefreg -@cindex last-requested point size register -@cindex point size, last-requested -@vindex .ps -@vindex .s -@Defreg {.psr} -@Defregx {.sr} +@DefregList {.psr} +@DefregListEnd {.sr} +@cindex last-requested point size registers (@code{.psr}, @code{.sr}) +@cindex point size registers, last-requested (@code{.psr}, @code{.sr}) +@cindex @code{.ps} register, in comparison with @code{.psr} +@cindex @code{.s} register, in comparison with @code{.sr} The last-requested point size in scaled points is contained in the @code{.psr} read-only number register. The last requested point size in points as a decimal fraction can be found in @code{.sr}. This is a @@ -6653,9 +9022,9 @@ string-valued read-only number register. Note that the requested point sizes are device-independent, whereas the values returned by the @code{.ps} and @code{.s} registers are not. -For example, if a point size of 11@dmn{pt} is requested for a DVI -device, 10.95@dmn{pt} are actually used (as specified in the -@file{DESC} file). +For example, if a point size of 11@dmn{pt} is requested, and a +@code{sizes} request (or a @code{sizescale} line in a @file{DESC} file) +specifies 10.95@dmn{pt} instead, this value is actually used. Both registers are associated with the current environment (@pxref{Environments}). @@ -6667,7 +9036,7 @@ fractional type sizes: @table @code @item \s[@var{n}] @itemx \s'@var{n}' -Set the point size to @var{n} scaled points; @var{n}@w{ }is a numeric +Set the point size to @var{n}@w{ }scaled points; @var{n}@w{ }is a numeric expression with a default scale indicator of @samp{z}. @item \s[+@var{n}] @@ -6678,8 +9047,8 @@ expression with a default scale indicator of @samp{z}. @itemx \s'-@var{n}' @itemx \s+'@var{n}' @itemx \s-'@var{n}' -Increase or or decrease the point size by @var{n} scaled points; -@var{n} is a numeric expression with a default scale indicator of +Increase or or decrease the point size by @var{n}@w{ }scaled points; +@var{n}@w{ }is a numeric expression with a default scale indicator of @samp{z}. @end table @@ -6696,38 +9065,46 @@ Increase or or decrease the point size by @var{n} scaled points; convenience (i.e.@: there are no built-in strings exept @code{.T}, but even this is a read-write string variable). -@cindex string interpolation -@cindex string expansion -@cindex interpolation of strings -@cindex expansion of strings -@Defreq {ds, name [@Var{string}]} -@Defescx {\\*, , n, } -@Defescx {\\*, @lparen{}, nm, } -@Defescx {\\*, @lbrack{}, name, @rbrack{}} -Define and access a string variable @var{name} (one-character name -@var{n}, two-character name @var{nm}). If @var{name} already exists, -@code{ds} overwrites the previous definition. +@DefreqList {ds, name [@Var{string}]} +@DefreqItem {ds1, name [@Var{string}]} +@DefescItem {\\*, , n, } +@DefescItem {\\*, @lparen{}, nm, } +@DefescListEnd {\\*, @lbrack{}, name arg1 arg2 @dots{}, @rbrack{}} +@cindex string interpolation (@code{\*}) +@cindex string expansion (@code{\*}) +@cindex interpolation of strings (@code{\*}) +@cindex expansion of strings (@code{\*}) +@cindex string arguments +@cindex arguments, of strings +Define and access a string variable @var{name} (one-character name@w{ +}@var{n}, two-character name @var{nm}). If @var{name} already exists, +@code{ds} overwrites the previous definition. Only the syntax form +using brackets can take arguments which are handled identically to +macro arguments; the single exception is that a closing bracket as an +argument must be enclosed in double quotes. @xref{Request Arguments}, +and @ref{Parameters}. Example: @Example -.ds UX \s-1UNIX\s0\u\s-3tm\s0\d +.ds foo a \\$1 test . -The \*(UX Operating System +This is \*[foo nice]. + @result{} This is a nice test. @endExample The @code{\*} escape @dfn{interpolates} (expands in-place) a previously-defined string variable. To be more precise, the stored string is pushed onto the input stack which is then parsed by @code{gtroff}. Similar to number registers, it is possible to nest -strings, i.e. a string variables can be called within string -variables. +strings, i.e. string variables can be called within string variables. -If the string named by the @code{\*} does not exist, it is defined as -empty, and a warning of type @samp{mac} is emitted (see +If the string named by the @code{\*} escape does not exist, it is +defined as empty, and a warning of type @samp{mac} is emitted (see @ref{Debugging}, for more details). @cindex comments, with @code{ds} +@cindex @code{ds} request, and comments @strong{Caution:} Unlike other requests, the second argument to the @code{ds} request takes up the entire line including trailing spaces. This means that comments on a line with such a request can introduce @@ -6749,6 +9126,7 @@ escape adjacent with the end of the string. @cindex quotes, trailing @cindex leading spaces with @code{ds} @cindex spaces with @code{ds} +@cindex @code{ds} request, and leading spaces To produce leading space the string can be started with a double quote. No trailing quote is needed; in fact, any trailing quote is included in your string. @@ -6757,11 +9135,10 @@ included in your string. .ds sign " Yours in a white wine sauce, @endExample -@esindex \@key{RET} @cindex multi-line strings @cindex strings, multi-line -@cindex newline character in strings, escaping -@cindex escaping newline characters in strings +@cindex newline character, in strings, escaping +@cindex escaping newline characters, in strings Strings are not limited to a single line of text. A string can span several lines by escaping the newlines with a backslash. The resulting string is stored @emph{without} the newlines. @@ -6772,11 +9149,34 @@ of text are on these \ next several lines @endExample -It is not possible to have real newlines in a string. +It is not possible to have real newlines in a string. To put a single +double quote character into a string, use two consecutive double quote +characters. -@cindex name space of macros and strings -@cindex macros, shared name space with strings -@cindex strings, shared name space with macros +The @code{ds1} request turns off compatibility mode +while interpreting a string. To be more precise, a @dfn{compatibility +save} input token is inserted at the beginning of the string, and a +@dfn{compatibility restore} input token at the end. + +@Example +.nr xxx 12345 +.ds aa The value of xxx is \\n[xxx]. +.ds1 bb The value of xxx ix \\n[xxx]. +. +.cp 1 +. +\*(aa + @result{} warning: number register `[' not defined + @result{} The value of xxx is 0xxx]. +\*(bb + @result{} The value of xxx ix 12345. +@endExample + +@cindex name space, common, of macros, diversions, and strings +@cindex common name space of macros, diversions, and strings +@cindex macros, shared name space with strings and diversions +@cindex strings, shared name space with macros and diversions +@cindex diversions, shared name space with macros and strings Strings, macros, and diversions (and boxes) share the same name space. Internally, even the same mechanism is used to store them. This has some interesting consequences. For example, it is possible to call a @@ -6795,8 +9195,7 @@ This is @result{} This is a funny test. @endExample -Diversions and boxes can be also called with string syntax. It is not -possible to pass arguments to a macro if called with @code{\*}. +Diversions and boxes can be also called with string syntax. Another consequence is that you can copy one-line diversions or boxes to a string. @@ -6838,8 +9237,13 @@ final newline from a diversion. Another disadvantage is that the spaces in the copied string are already formatted, making them unstretchable. This can cause ugly results. -@rqindex chop -@rqindex unformat +@cindex stripping final newline in diversions +@cindex diversion, stripping final newline +@cindex final newline, stripping in diversions +@cindex newline, final, stripping in diversions +@cindex horizontal space, unformatting +@cindex space, horizontal, unformatting +@cindex unformatting horizontal space A clean solution to this problem is available in GNU @code{troff}, using the requests @code{chop} to remove the final newline of a diversion, and @code{unformat} to make the horizontal spaces @@ -6861,9 +9265,10 @@ This is \*[xxx]. @xref{Gtroff Internals}, for more information. @endDefreq -@cindex appending to strings -@cindex strings, appending -@Defreq {as, name [@Var{string}]} +@DefreqList {as, name [@Var{string}]} +@DefreqListEnd {as1, name [@Var{string}]} +@cindex appending to a string (@code{as}) +@cindex string, appending (@code{as}) The @code{as} request is similar to @code{ds} but appends @var{string} to the string stored as @var{name} instead of redefining it. If @var{name} doesn't exist yet, it is created. @@ -6871,60 +9276,85 @@ to the string stored as @var{name} instead of redefining it. If @Example .as sign " with shallots, onions and garlic, @endExample + +The @code{as1} request is similar to @code{as}, but compatibility mode +is switched off while the appended string is interpreted. To be more +precise, a @dfn{compatibility save} input token is inserted at the +beginning of the appended string, and a @dfn{compatibility restore} +input token at the end. @endDefreq Rudimentary string manipulation routines are given with the next two requests. -@cindex substring @Defreq {substring, str n1 [@Var{n2}]} -Replace the string in register@w{ }@var{str} with the substring +@cindex substring (@code{substring}) +Replace the string named @var{str} with the substring defined by the indices @var{n1} and@w{ }@var{n2}. The first character -in the string has index one. If @var{n2} is omitted, it is taken to +in the string has index@w{ }0. If @var{n2} is omitted, it is taken to be equal to the string's length. If the index value @var{n1} or -@var{n2} is negative or zero, it is counted from the end of the -string, going backwards: The last character has index@w{ }0, the -character before the last character has index@w{ }@minus{}1, etc. +@var{n2} is negative, it is counted from the end of the +string, going backwards: The last character has index@w{ }@minus{}1, the +character before the last character has index@w{ }@minus{}2, etc. @Example .ds xxx abcdefgh -.substring xxx 2 -3 +.substring xxx 1 -4 \*[xxx] @result{} bcde @endExample @endDefreq -@cindex length of a string -@cindex string, length of @Defreq {length, reg str} -Compute the length of @var{str} and returns it in the number -register@w{ }@var{reg}. If @var{reg} doesn't exist, it is created. +@cindex length of a string (@code{length}) +@cindex string, length of (@code{length}) +Compute the number of characters of @var{str} and return it in the +number register @var{reg}. If @var{reg} doesn't exist, it is created. +@code{str} is read in copy mode. @Example -.ds xxx abcdefgh -.length yyy xxx +.ds xxx abcd\h'3i'efgh +.length yyy \n[xxx] \n[yyy] - @result{} 8 + @result{} 14 @endExample @endDefreq -@cindex rename request -@cindex rename macro -@cindex rename string @Defreq {rn, xx yy} -Rename the request, macro, or string @var{xx} to @var{yy}. +@cindex renaming request (@code{rn}) +@cindex request, renaming (@code{rn}) +@cindex renaming macro (@code{rn}) +@cindex macro, renaming (@code{rn}) +@cindex renaming string (@code{rn}) +@cindex string, renaming (@code{rn}) +@cindex renaming diversion (@code{rn}) +@cindex diversion, renaming (@code{rn}) +Rename the request, macro, diversion, or string @var{xx} to @var{yy}. @endDefreq -@cindex remove request -@cindex remove macro -@cindex remove string @Defreq {rm, xx} -Remove the request, macro, or string @var{xx}. @code{gtroff} treats -subsequent invocations as if the object had never been defined. +@cindex removing request (@code{rm}) +@cindex request, removing (@code{rm}) +@cindex removing macro (@code{rm}) +@cindex macro, removing (@code{rm}) +@cindex removing string (@code{rm}) +@cindex string, removing (@code{rm}) +@cindex removing diversion (@code{rm}) +@cindex diversion, removing (@code{rm}) +Remove the request, macro, diversion, or string @var{xx}. @code{gtroff} +treats subsequent invocations as if the object had never been defined. @endDefreq -@cindex alias @Defreq {als, new old} +@cindex alias, string, creating (@code{als}) +@cindex alias, macro, creating (@code{als}) +@cindex alias, diversion, creating (@code{als}) +@cindex creating alias, for string (@code{als}) +@cindex creating alias, for macro (@code{als}) +@cindex creating alias, for diversion (@code{als}) +@cindex string, creating alias (@code{als}) +@cindex macro, creating alias (@code{als}) +@cindex diversion, creating alias (@code{als}) Create an alias named @var{new} for the request, string, macro, or diversion object named @var{old}. The new name and the old name are exactly equivalent (it is similar to a hard rather than a soft @@ -6934,10 +9364,10 @@ type @samp{mac} and ignores the request. @Defreq {chop, xx} Remove (chop) the last character from the macro, string, or diversion -named @var{xx}. This is useful for removing the newline from the end +named @var{xx}. This is useful for removing the newline from the end of diversions that are to be interpolated as strings. This command can be used repeatedly; see @ref{Gtroff Internals}, for details on -nodes inserted by @code{gtroff} automatically. +nodes inserted additionally by @code{gtroff}. @endDefreq @xref{Identifiers}, and @ref{Comments}. @@ -6961,10 +9391,8 @@ nodes inserted by @code{gtroff} automatically. @node Operators in Conditionals, if-else, Conditionals and Loops, Conditionals and Loops @subsection Operators in Conditionals -@rqindex if -@rqindex while -@cindex @code{if}, operators to use with it -@cindex @code{while}, operators to use with it +@cindex @code{if} request, operators to use with +@cindex @code{while} request, operators to use with In @code{if} and @code{while} requests, there are several more operators available: @@ -6974,17 +9402,16 @@ operators available: True if the current page is even or odd numbered (respectively). @item n -@rqindex nroff True if the document is being processed in nroff mode (i.e., the @code{.nroff} command has been issued). @item t -@rqindex troff True if the document is being processed in troff mode (i.e., the @code{.troff} command has been issued). @item v -Always false. +Always false. This condition is for compatibility with other +@code{troff} versions only. @item '@var{xxx}'@var{yyy}' True if the string @var{xxx} is equal to the string @var{yyy}. Other @@ -7001,11 +9428,11 @@ false @endExample @noindent -The resulting motions, character sizes, and fonts have to +The resulting motions, glyph sizes, and fonts have to match,@footnote{The created output nodes must be identical. @xref{Gtroff Internals}.} and not the individual motion, size, and font requests. In the previous example, @samp{|} and @samp{\fR|\fP} -both result in a roman @samp{|} character with the same point size and +both result in a roman @samp{|} glyph with the same point size and at the same location on the page, so the strings are equal. If @samp{.ft@w{ }I} had been added before the @samp{.ie}, the result would be ``false'' because (the first) @samp{|} produces an italic @@ -7017,12 +9444,15 @@ True if there is a number register named @var{xxx}. @item d @var{xxx} True if there is a string, macro, diversion, or request named @var{xxx}. -@item c @var{ch} -@rqindex char -True if there is a character @var{ch} available; @var{ch} is either an -@acronym{ASCII} character or a special character (@code{\(@var{ch}} or -@code{\[@var{ch}]}); the condition is also true if @var{ch} has been -defined by the @code{char} request. +@item m @var{xxx} +True if there is a color named @var{xxx}. + +@item c @var{g} +True if there is a glyph @var{g} available@footnote{The name of this +conditional operator is a misnomer since it tests names of output +glyphs.}; @var{g} is either an @acronym{ASCII} character or a special +character (@code{\(@var{gg}} or @code{\[@var{ggg}]}); the condition +is also true if @var{g} has been defined by the @code{char} request. @end table Note that these operators can't be combined with other operators like @@ -7080,26 +9510,39 @@ more info. @endExample @endDefreq -@c XXX .nop request +@Defreq{nop, anything} +Executes @var{anything}. +This is similar to @code{.if@w{ }1}. +@endDefreq -@Defreq {ie, expr anything} -@Defreqx {el, anything} +@DefreqList {ie, expr anything} +@DefreqListEnd {el, anything} Use the @code{ie} and @code{el} requests to write an if-then-else. The first request is the `if' part and the latter is the `else' part. @Example -.ie n .ls 2 \" double spacing in nroff -.el .ls 1 \" single spacing in troff +.ie n .ls 2 \" double-spacing in nroff +.el .ls 1 \" single-spacing in troff @endExample @endDefreq -@c this is a bug in makeinfo: you can't have `@{' as an argument -@c to deffn +@c there is a bug in makeinfo <= 4.1a: you can't have `@{' as an argument +@c to @deffn +@c +@c and in 4.2 you still can't use @{ in macros. +@c @DefescList {\@{, , , } +@c @DefescListEnd {\@}, , , } +@deffn Escape @t{\@{} +@deffnx Escape @t{\@}} @esindex \@{ @esindex \@} -@c @Defesc {\\@@@{, , , } -@c @Defescx {\\@@@}, , , } +@cindex begin of conditional block (@code{\@{}) +@cindex end of conditional block (@code{\@}}) +@cindex conditional block, begin (@code{\@{}) +@cindex conditional block, end (@code{\@}}) +@cindex block, conditional, begin (@code{\@{}) +@cindex block, condititional, end (@code{\@}}) In many cases, an if (or if-else) construct needs to execute more than one request. This can be done using the @code{\@{} and @code{\@}} escapes. The following example shows the possible ways to use these @@ -7116,6 +9559,7 @@ escapes (note the position of the opening and closing braces). . ds rq "\@} @endExample @c @endDefesc +@end deffn @xref{Expressions}. @@ -7144,7 +9588,7 @@ to@w{ }0. Some remarks. -@rqindex de +@cindex @code{de} request, and @code{while} @itemize @bullet @item The body of a @code{while} request is treated like the body of a @@ -7204,16 +9648,16 @@ The closing brace of a @code{while} body must end a line. @end itemize @endDefreq -@rqindex while -@cindex @code{break}, in a @code{while} loop -@cindex @code{continue}, in a @code{while} loop @Defreq {break, } +@cindex @code{while} request, confusing with @code{br} +@cindex @code{break} request, in a @code{while} loop +@cindex @code{continue} request, in a @code{while} loop Break out of a @code{while} loop. Be sure not to confuse this with the @code{br} request (causing a line break). @endDefreq @Defreq {continue, } -Finishes the current iteration of a @code{while} loop, immediately +Finish the current iteration of a @code{while} loop, immediately restarting the next iteration. @endDefreq @@ -7230,14 +9674,16 @@ restarting the next iteration. A @dfn{macro} is a collection of text and embedded commands which can be invoked multiple times. Use macros to define common operations. -@Defreq {de, name [@Var{end}]} +@DefreqList {de, name [@Var{end}]} +@DefreqItem {de1, name [@Var{end}]} +@DefreqListEnd {dei, name [@Var{end}]} Define a new macro named @var{name}. @code{gtroff} copies subsequent lines (starting with the next one) into an internal buffer until it encounters the line @samp{..} (two dots). The optional second argument to @code{de} changes this to a macro to @samp{.@var{end}}. -Note that no leading whitespace is allowed in the line containing the -ending token (either @samp{..} or the macro @samp{.@var{end}}). +There can be whitespace after the first dot in the line containing the +ending token (either @samp{.} or macro @samp{@var{end}}). Here a small example macro called @samp{P} which causes a break and inserts some vertical space. It could be used to separate paragraphs. @@ -7249,25 +9695,85 @@ inserts some vertical space. It could be used to separate paragraphs. .. @endExample -@c XXX add info about macro definitions in macros. +The following example defines a macro within another. Remember that +expansion must be protected twice; once for reading the macro and +once for executing. + +@Example +\# a dummy macro to avoid a warning +.de end +.. +. +.de foo +. de bar end +. nop \f[B]Hallo \\\\$1!\f[] +. end +.. +. +.foo +.bar Joe + @result{} @b{Hallo Joe!} +@endExample + +@noindent +Since @code{\f} has no expansion, it isn't necessary to protect its +backslash. Had we defined another macro within @code{bar} which takes +a parameter, eight backslashes would be necessary before @samp{$1}. -@c XXX give example for end macro. +The @code{de1} request turns off compatibility mode +while executing the macro. On entry, the current compatibility mode +is saved and restored at exit. -@c XXX add info about indirect macro calls: -@c -@c .de xxx -@c from yyy\c -@c .. -@c -@c test \*[xxx] test -@c => test from yyy test +@Example +.nr xxx 12345 +. +.de aa +The value of xxx is \\n[xxx]. +.. +.de1 bb +The value of xxx ix \\n[xxx]. +.. +. +.cp 1 +. +.aa + @result{} warning: number register ' not defined + @result{} The value of xxx is 0xxx]. +.bb + @result{} The value of xxx ix 12345. +@endExample -@c XXX info about common identifier pool for strings, macros, and -@c diversions. +The @code{dei} request defines a macro indirectly. +That is, it expands strings whose names +are @var{name} or @var{end} before performing the append. + +This: + +@Example +.ds xx aa +.ds yy bb +.dei xx yy +@endExample + +@noindent +is equivalent to: + +@Example +.de aa bb +@endExample + +@pindex trace.tmac +Using @file{trace.tmac}, you can trace calls to @code{de} and @code{de1}. + +Note that macro identifiers are shared with identifiers for strings and +diversions. @endDefreq -@cindex appending, to a macro -@Defreq {am, xx} +@DefreqList {am, xx} +@DefreqItem {am1, xx} +@DefreqListEnd {ami, xx yy} +@cindex appending to a macro (@code{am}) +@cindex macro, appending (@code{am}) Works similarly to @code{de} except it appends onto the macro named @var{xx}. So, to make the previously defined @samp{P} macro actually do indented instead of block paragraphs, add the necessary code to the @@ -7278,21 +9784,31 @@ existing macro like this: .ti +5n .. @endExample + +The @code{am1} request turns off compatibility mode +while executing the appended macro piece. To be more precise, a +@dfn{compatibility save} input token is inserted at the beginning of +the appended code, and a @dfn{compatibility restore} input token at +the end. + +The @code{ami} request appends indirectly, +meaning that @code{gtroff} expands strings whose names +are @var{xx} or @var{yy} before performing the append. + +@pindex trace.tmac +Using @file{trace.tmac}, you can trace calls to @code{am} and @code{am1}. @endDefreq -@cindex alias -@Defreq {als, new old} -Create an alias named @var{new} for the request, string, macro, or -diversion object named @var{old}. The new name and the old name are -exactly equivalent (it is similar to a hard rather than a soft -link). If @var{old} is undefined, @code{gtroff} generates a warning of -type @samp{mac} and ignores the request. +@xref{Strings}, for the @code{als} request to rename a macro. + +The @code{de}, @code{am}, @code{di}, @code{da}, @code{ds}, and +@code{as} requests (together with its variants) only create a new object +if the name of the macro, diversion or string diversion is currently +undefined or if it is defined to be a request; normally they modify the +value of an existing object. -The @code{de}, @code{am}, @code{di}, @code{da}, @code{ds}, -and @code{as} requests only create a new object if the name -of the macro, diversion or string diversion is currently -undefined or if it is defined to be a request; normally -they modify the value of an existing object. +@Defreq {return, } +Exit a macro, immediately returning to the caller. @endDefreq @menu @@ -7307,19 +9823,14 @@ they modify the value of an existing object. @cindex copy-in mode @cindex mode, copy-in -@esindex \n -@esindex \$ -@esindex \* -@esindex \\ -@esindex \@key{RET} @cindex @code{\n}, when reading text for a macro @cindex @code{\$}, when reading text for a macro @cindex @code{\*}, when reading text for a macro @cindex @code{\\}, when reading text for a macro @cindex \@key{RET}, when reading text for a macro -When @code{gtroff} reads in the text for a macro or diversion, it copies -the text (including request lines, but excluding escapes) into an -internal buffer. Escapes are converted into an internal form, +When @code{gtroff} reads in the text for a macro, string, or diversion, +it copies the text (including request lines, but excluding escapes) into +an internal buffer. Escapes are converted into an internal form, except for @code{\n}, @code{\$}, @code{\*}, @code{\\} and @code{\@key{RET}} which are evaluated and inserted into the text where the escape was located. This is known as @dfn{copy-in} mode or @@ -7348,62 +9859,69 @@ The following example prints the numbers 20 and@w{ }10: @subsection Parameters @cindex parameters -@vindex .$ -The arguments to a macro can be examined using a variety of escapes. -The number of arguments is available in the @code{.$} number register. +The arguments to a macro or string can be examined using a variety of +escapes. + +@Defreg {.$} +@cindex number of arguments register (@code{.$}) +The number of arguments passed to a macro or string. This is a read-only +number register. +@endDefreg + Any individual argument can be retrieved with one of the following escapes: +@DefescList {\\$, , n, } +@DefescItem {\\$, @lparen{}, nn, } +@DefescListEnd {\\$, @lbrack{}, nnn, @rbrack{}} @cindex copy-in mode, and macro arguments -@Defesc {\\$, n, , } -@Defescx {\\$, @lparen{}, nn, } -@Defescx {\\$, @lbrack{}, nnn, @rbrack{}} -The escapes @code{\$@var{n}}, @code{\$(@var{nn}} and -@code{\$[@var{nnn}]} retrieve the @var{n}@dmn{th}, @var{nn}@dmn{th} or -@var{nnn}@dmn{th} argument. As usual, the first form only accepts a -single number (larger than zero), the second a two-digit number (larger -or equal to@w{ }10), and the third any positive integer value (larger -than zero). Macros can have an unlimited number of arguments. Note -that due to copy-in mode, use two backslashes on these in actual use to -prevent interpolation until the macro is actually invoked. +@cindex macro, arguments (@code{\$}) +@cindex arguments, macro (@code{\$}) +Retrieve the @var{n}@dmn{th}, @var{nn}@dmn{th} or @var{nnn}@dmn{th} +argument. As usual, the first form only accepts a single number +(larger than zero), the second a two-digit number (larger or equal +to@w{ }10), and the third any positive integer value (larger +than zero). Macros and strings can have an unlimited number of arguments. +Note that due to copy-in mode, use two backslashes on these in actual use +to prevent interpolation until the macro is actually invoked. @endDefesc @Defreq {shift, [@Var{n}]} -Shifts the arguments 1@w{ }position, or as +Shift the arguments 1@w{ }position, or as many positions as specified by its argument. After executing this -request, argument@w{ }@var{i} becomes argument @var{i}-@var{n}; +request, argument@w{ }@var{i} becomes argument @math{@var{i}-@var{n}}; arguments 1 to@w{ }@var{n} are no longer available. Shifting by negative amounts is currently undefined. @endDefreq -@Defesc {\\$*, , , } -@Defescx {\\$@@, , , } +@DefescList {\\$*, , , } +@DefescListEnd {\\$@@, , , } In some cases it is convenient to use all of the arguments at once (for example, to pass the arguments along to another macro). The @code{\$*} escape concatenates all the arguments separated by spaces. A similar escape is @code{\$@@}, which concatenates all the arguments with each surrounded by double quotes, and separated by -spaces. +spaces. If not in compatibility mode, the input level of double quotes +is preserved (see @ref{Request Arguments}). @endDefesc -@rqindex als -@cindex @code{als}, use with @code{\$0} @Defesc {\\$0, , , } +@cindex macro name register (@code{\$0}) +@cindex @code{als} request, and @code{\$0} The name used to invoke the current macro. The @code{als} request can make a macro have more than one name. @Example -.de vl -.ie \\n(.$=1 .ds Vl Pre-Release Version -.el .ds Vl Version \\$3, \\$4. +.de generic-macro +. ... +. if \\n[error] \@{\ +. tm \\$0: Houston, we have a problem. +. return +. \@} .. -@endExample - -@noindent -This would be called as - -@Example -.vl $Id: groff.texinfo,v 1.77 2001/05/07 13:36:24 wlemb Exp $ +. +.als foo generic-macro +.als bar generic-macro @endExample @endDefesc @@ -7417,102 +9935,167 @@ This would be called as @cindex page motions @cindex motions, page -@cindex @code{sp}, as vertical page motion -@Defreq {sp, [@Var{len}]} -Motions up and down the page can be done with the @code{sp} request. -However, this causes a break so that the actual effect is to move to the -left margin and then to the specified location. -@endDefreq - -@Defreq {mk, [@Var{reg}]} -@Defreqx {rt, reg} +@xref{Manipulating Spacing}, for a discussion of the main request for +vertical motion, @code{sp}. + +@DefreqList {mk, [@Var{reg}]} +@DefreqListEnd {rt, [@Var{dist}]} +@cindex marking vertical page location (@code{mk}) +@cindex page location, vertical, marking (@code{mk}) +@cindex location, vertical, page, marking (@code{mk}) +@cindex vertical page location, marking (@code{mk}) +@cindex returning to marked vertical page location (@code{rt}) +@cindex page location, vertical, returning to marked (@code{rt}) +@cindex location, vertical, page, returning to marked (@code{rt}) +@cindex vertical page location, returning to marked (@code{rt}) The request @code{mk} can be used to mark a location on a page, for -movement to later. This request takes a register name as an argument in -which to store the current page location. With no argument it -stores the location in an internal register. The results of this can be -used later by the @code{rt} or the @code{sp} request. The @code{rt} -request returns @emph{upwards} to the location given in the register -name given as an argument; with no argument it returns to the -location marked with the @code{mk} request. - -@c XXX example -@ignore +movement to later. This request takes a register name as an argument +in which to store the current page location. With no argument it +stores the location in an internal register. The results of this can +be used later by the @code{rt} or the @code{sp} request (or the +@code{\v} escape). + +The @code{rt} request returns @emph{upwards} to the location marked +with the last @code{mk} request. If used with an argument, return to +a position which distance from the top of the page is @var{dist} (no +previous call to @code{mk} is necessary in this case). Default scaling +indicator is @samp{v}. + +Here a primitive solution for a two-column macro. + @Example -... dual column example ... +.nr column-length 1.5i +.nr column-gap 4m +.nr bottom-margin 1m +. +@endExample +@Example +.de 2c +. br +. mk +. ll \\n[column-length]u +. wh -\\n[bottom-margin]u 2c-trap +. nr right-side 0 +.. +. +@endExample +@Example +.de 2c-trap +. ie \\n[right-side] \@{\ +. nr right-side 0 +. po -(\\n[column-length]u + \\n[column-gap]u) +. \" remove trap +. wh -\\n[bottom-margin]u +. \@} +. el \@{\ +. \" switch to right side +. nr right-side 1 +. po +(\\n[column-length]u + \\n[column-gap]u) +. rt +. \@} +.. +. +@endExample +@Example +.pl 1.5i +.ll 4i +This is a small test which shows how the +rt request works in combination with mk. + +.2c +Starting here, text is typeset in two columns. +Note that this implementation isn't robust +and thus not suited for a real two-column +macro. +@endExample + +Result: + +@Example +This is a small test which shows how the +rt request works in combination with mk. + +Starting here, isn't robust +text is typeset and thus not +in two columns. suited for a +Note that this real two-column +implementation macro. @endExample -@end ignore @endDefreq The following escapes give fine control of movements about the page. -@cindex vertical motion -@cindex motion, vertical @Defesc {\\v, ', e, '} -The @code{\v'@var{e}'} escape enables arbitrary vertical motion from the -current location on the page. The argument@w{ }@var{e} specifies the -distance to move; positive is downwards and negative upwards. The -default unit for this escape @samp{v}. Beware, however, that -@code{gtroff} continues text processing at the point where the motion -ends, so you should always balance motions to avoid interference with -text processing. +@cindex vertical motion (@code{\v}) +@cindex motion, vertical (@code{\v}) +Move vertically, usually from the current location on the page (if no +absolute position operator @samp{|} is used). The +argument@w{ }@var{e} specifies the distance to move; positive is +downwards and negative upwards. The default scaling indicator for this +escape is @samp{v}. Beware, however, that @code{gtroff} continues text +processing at the point where the motion ends, so you should always +balance motions to avoid interference with text processing. + +@code{\v} doesn't trigger a trap. This can be quite useful; for example, +consider a page bottom trap macro which prints a marker in the margin to +indicate continuation of a footnote or something similar. @endDefesc -There are some special case escapes for vertical motion. +There are some special-case escapes for vertical motion. -@ftable @code -@item \r -move upwards@w{ }1@dmn{v}. +@Defesc {\\r, , , } +Move upwards@w{ }1@dmn{v}. +@endDefesc -@item \u -move upwards@w{ }.5@dmn{v}. +@Defesc {\\u, , , } +Move upwards@w{ }.5@dmn{v}. +@endDefesc -@item \d -move down@w{ }.5@dmn{v}. -@end ftable +@Defesc {\\d, , , } +Move down@w{ }.5@dmn{v}. +@endDefesc -@cindex inserting horizontal space -@cindex horizontal space -@cindex space, horizontal @Defesc {\\h, ', e, '} -The @code{\h'@var{e}'} escape provides horizontal motions. The -expression@w{ }@var{e} indicates how far to move: positive is rightwards -and negative leftwards. -@c XXX Is there a default unit for this? +@cindex inserting horizontal space (@code{\h}) +@cindex horizontal space (@code{\h}) +@cindex space, horizontal (@code{\h}) +@cindex horizontal motion (@code{\h}) +@cindex motion, horizontal (@code{\h}) +Move horizontally, usually from the current location (if no absolute +position operator @samp{|} is used). The expression@w{ }@var{e} +indicates how far to move: positive is rightwards and negative +leftwards. The default scaling indicator for this escape is @samp{m}. @endDefesc -There are a number of special case escapes for horizontal motion: +There are a number of special-case escapes for horizontal motion. -@ftable @code -@item \@key{SP} +@Defesc {\\@key{SP}, , , } +@cindex space, unbreakable +@cindex unbreakable space An unbreakable and unpaddable (i.e.@: not expanded during filling) space. (Note: This is a backslash followed by a space.) +@endDefesc -@item \~ +@Defesc {\\~, , , } An unbreakable space that stretches like a normal inter-word space when a line is adjusted. +@endDefesc -@item \| -A 1/6@dmn{th} em space. Ignored for tty output devices (rounded to +@Defesc {\\|, , , } +A 1/6@dmn{th} em space. Ignored for TTY output devices (rounded to zero). +@endDefesc -@item \^ -A 1/12@dmn{th} em space. Ignored for tty output devices (rounded to +@Defesc {\\^, , , } +A 1/12@dmn{th} em space. Ignored for TTY output devices (rounded to zero). +@endDefesc -@item \0 +@Defesc {\\0, , , } +@cindex space, width of a digit (@code{\0}) +@cindex digit width space (@code{\0}) A space the size of a digit. - -@item \& -@cindex zero width space character -@cindex character, zero width space -@cindex space character, zero width -A zero width space. - -@item \) -Like @code{\&} except that it behaves like a character declared with the -@code{cflags} request to be transparent for the purposes of end of -sentence recognition. -@end ftable +@endDefesc The following string sets the @TeX{} logo: @@ -7520,21 +10103,23 @@ The following string sets the @TeX{} logo: .ds TeX T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X @endExample -@cindex width escape -@cindex escape, width -@Defesc {\\w, ', text, '} -Used as @code{\w'@var{text}'}, -returns the width of the specified @var{text} in basic units. +@DefescList {\\w, ', text, '} +@DefregItem {st} +@DefregItem {sb} +@DefregItem {rst} +@DefregItem {rsb} +@DefregItem {ct} +@DefregItem {ssc} +@DefregListEnd {skw} +@cindex width escape (@code{\w}) +Return the width of the specified @var{text} in basic units. This allows horizontal movement based on the width of some arbitrary text (e.g.@: given as an argument to a macro). -@c XXX example - -@ignore @Example -... strlen example ... +The length of the string `abc' is \w'abc'u. + @result{} The length of the string `abc' is 72u. @endExample -@end ignore Font changes may occur in @var{text} which don't affect current settings. @@ -7544,60 +10129,107 @@ After use, @code{\w} sets several registers: @table @code @item st @itemx sb -@vindex st -@vindex sb -The highest and lowest point, respectively, in @var{text}. +The highest and lowest point of the baseline, respectively, in @var{text}. @item rst @itemx rsb -@vindex rst -@vindex rsb Like the @code{st} and @code{sb} registers, but takes account of the -heights and depths of characters. +heights and depths of glyphs. With other words, this gives the +highest and lowest point of @var{text}. @item ct -@vindex ct -Defines the kinds of characters occurring in @var{text}: +Defines the kinds of glyphs occurring in @var{text}: @table @asis @item 0 -only short characters, no descenders or tall characters. +only short glyphs, no descenders or tall glyphs. @item 1 at least one descender. @item 2 -at least one tall character. +at least one tall glyph. @item 3 -at least one each of a descender and a tall character. +at least one each of a descender and a tall glyph. @end table @item ssc -@vindex ssc The amount of horizontal space (possibly negative) that should be added -to the last character before a subscript. +to the last glyph before a subscript. @item skw -@vindex skw -How far to right of the center of the last character in the @code{\w} +How far to right of the center of the last glyph in the @code{\w} argument, the center of an accent from a roman font should be placed -over that character. +over that glyph. @end table @endDefesc -@Defesc {\\k, ', x, '} -Stores the current horizontal position in register @var{x}. -Use this, for example, to return to the beginning of a string -for highlighting or other decoration. +@DefescList {\\k, , p, } +@DefescItem {\\k, @lparen{}, ps, } +@DefescListEnd {\\k, @lbrack{}, position, @rbrack} +@cindex saving horizontal input line position (@code{\k}) +@cindex horizontal input line position, saving (@code{\k}) +@cindex input line position, horizontal, saving (@code{\k}) +@cindex position, horizontal input line, saving (@code{\k}) +@cindex line, input, horizontal position, saving (@code{\k}) +Store the current horizontal position in the @emph{input} line in +number register with name @var{position} (one-character name@w{ }@var{p}, +two-character name @var{ps}). Use this, for example, to return to the +beginning of a string for highlighting or other decoration. @endDefesc +@Defreg {hp} +@cindex horizontal input line position register (@code{hp}) +@cindex input line, horizontal position, register (@code{hp}) +@cindex position, horizontal, in input line, register (@code{hp}) +@cindex line, input, horizontal position, register (@code{hp}) +The current horizontal position at the input line. +@endDefreg + @Defreg {.k} +@cindex horizontal output line position register (@code{.k}) +@cindex output line, horizontal position, register (@code{.k}) +@cindex position, horizontal, in output line, register (@code{.k}) +@cindex line, output, horizontal position, register (@code{.k}) A read-only number register containing the current horizontal output position. @endDefreg -@c XXX documentation +@Defesc {\\o, ', @Var{a}@Var{b}@Var{c}, '} +@cindex overstriking glyphs (@code{\o}) +@cindex glyphs, overstriking (@code{\o}) +Overstrike glyphs @var{a}, @var{b}, @var{c}, @dots{}; the glyphs +are centered, and the resulting spacing is the largest width of the +affected glyphs. +@endDefesc + +@Defesc {\\z, , g, , } +@cindex zero-width printing (@code{\z}, @code{\Z}) +@cindex printing, zero-width (@code{\z}, @code{\Z}) +Print glyph @var{g} with zero width, i.e., without spacing. Use +this to overstrike glyphs left-aligned. +@endDefesc + +@Defesc {\\Z, ', anything, '} +@cindex zero-width printing (@code{\z}, @code{\Z}) +@cindex printing, zero-width (@code{\z}, @code{\Z}) +Print @var{anything}, then restore the horizontal and vertical position. +The argument may not contain tabs or leaders. + +The following is an example of a strike-through macro: + +@Example +.de ST +.nr ww \w'\\$1' +\Z@@\v'-.25m'\l'\\n[ww]u'@@\\$1 +.. +. +This is +.ST "a test" +an actual emergency! +@endExample +@endDefesc @c ===================================================================== @@ -7617,188 +10249,251 @@ information. All drawing is done via escapes. -@cindex drawing horizontal lines -@cindex horizontal line, drawing -@cindex line, horizontal, drawing -@Defesc {\\l, ', l c, '} -Draws a line rightwards from the current -location. The full syntax for this escape is: - -@Example -\l'@var{l}@var{c}' -@endExample - -@noindent -where @var{l} is the length of the line to be drawn, starting at the -current location; positive numbers draw to the right, and negative -numbers draw towards the left. This can also be specified absolutely -(i.e.@: with a leading @samp{|}) which draws back to the beginning -of the line. - -@cindex underscore character -@cindex character, underscore -@cindex line drawing character -@cindex character for line drawing -The optional second parameter @var{c} is a character to draw the line +@DefescList {\\l, ', @Var{l}, '} +@DefescListEnd {\\l, ', @Var{l}@Var{g}, '} +@cindex drawing horizontal lines (@code{\l}) +@cindex horizontal line, drawing (@code{\l}) +@cindex line, horizontal, drawing (@code{\l}) +Draw a line horizontally. @var{l} is the length of the line to be +drawn. If it is positive, start the line at the current location and +draw to the right; its end point is the new current location. Negative +values are handled differently: The line starts at the current location +and draws to the left, but the current location doesn't move. + +@var{l} can also be specified absolutely (i.e.@: with a leading +@samp{|}) which draws back to the beginning of the input line. +Default scaling indicator is @samp{m}. + +@cindex underscore glyph (@code{\[ru]}) +@cindex glyph, underscore (@code{\[ru]}) +@cindex line drawing glyph +@cindex glyph, for line drawing +The optional second parameter@w{ }@var{g} is a glyph to draw the line with. If this second argument is not specified, @code{gtroff} uses -the underscore character. +the underscore glyph, @code{\[ru]}. -@cindex zero width space character -@cindex character, zero width space -@cindex space character, zero width -@esindex \& +@cindex zero width space character (@code{\&}) +@cindex character, zero width space (@code{\&}) +@cindex space character, zero width (@code{\&}) To separate the two arguments (to prevent @code{gtroff} from -interpreting a drawing character as a scaling indicator) use @code{\&}. +interpreting a drawing glyph as a scaling indicator if the glyph is +represented by a single character) use @code{\&}. Here a small useful example: @Example .de box -\(br\\$*\(br\l'|0\(rn'\l'|0\(ul' +\[br]\\$*\[br]\l'|0\[rn]'\l'|0\[ul]' .. @endExample -@opindex | @noindent Note that this works by outputting a box rule (a vertical line), then -the text given as an argument and then another box rule. Then the line -drawing escapes both draw from the current location to the beginning of -the @emph{input} line. +the text given as an argument and then another box rule. Finally, the +line drawing escapes both draw from the current location to the +beginning of the @emph{input} line -- this works because the line +length is negative, not moving the current point. @endDefesc -@cindex drawing vertical lines -@cindex vertical line drawing -@cindex line, vertical, drawing -@cindex line drawing character -@cindex character for line drawing -@cindex box rule character -@cindex character, box rule -@Defesc {\\L, ', l c, '} -Draws vertical lines. Its parameters are -similar to the @code{\l} escape. The -movement is downwards for positive values, -and upwards for negative values. The -default character is the box rule character. As with the vertical -motion escapes, text processing blindly continues where the line -ends. - -@c XXX example +@DefescList {\\L, ', @Var{l}, '} +@DefescListEnd {\\L, ', @Var{l}@Var{g}, '} +@cindex drawing vertical lines (@code{\L}) +@cindex vertical line drawing (@code{\L}) +@cindex line, vertical, drawing (@code{\L}) +@cindex line drawing glyph +@cindex glyph for line drawing +@cindex box rule glyph (@code{\[br]}) +@cindex glyph, box rule (@code{\[br]}) +Draw vertical lines. Its parameters are +similar to the @code{\l} escape, except that the default scaling +indicator is @samp{v}. The movement is downwards for positive values, +and upwards for negative values. The default glyph is the box rule +glyph, @code{\[br]}. As with the vertical motion escapes, text +processing blindly continues where the line ends. -@ignore @Example -...box macro... +This is a \L'3v'test. +@endExample + +@noindent +Here the result, produced with @code{grotty}. + +@Example +This is a + | + | + |test. @endExample -@end ignore @endDefesc @Defesc {\\D, ', command arg @dots{}, '} The @code{\D} escape provides a variety of drawing functions. -While the previous escapes work on a character device, these -escapes do not. +Note that on character devices, only vertical and horizontal lines are +supported within @code{grotty}; other devices may only support a subset +of the available drawing functions. + +The default scaling indicator for all subcommands of @code{\D} is +@samp{m} for horizontal distances and @samp{v} for vertical ones. +Exceptions are @w{@code{\D'f @dots{}'}} and @w{@code{\D't @dots{}'}} +which use @code{u} as the default. @table @code @item \D'l @var{dx} @var{dy}' +@cindex line, drawing (@w{@code{\D'l @dots{}'}}) +@cindex drawing a line (@w{@code{\D'l @dots{}'}}) Draw a line from the current location to the relative point specified by (@var{dx},@var{dy}). -@c XXX example - -@ignore -@Example -...revised box macro... +The following example is a macro for creating a box around a text string; +for simplicity, the box margin is taken as a fixed value, 0.2@dmn{m}. + +@Example +.de BOX +. nr @@wd \w'\\$1' +\h'.2m'\ +\h'-.2m'\v'(.2m - \\n[rsb]u)'\ +\D'l 0 -(\\n[rst]u - \\n[rsb]u + .4m)'\ +\D'l (\\n[@@wd]u + .4m) 0'\ +\D'l 0 (\\n[rst]u - \\n[rsb]u + .4m)'\ +\D'l -(\\n[@@wd]u + .4m) 0'\ +\h'.2m'\v'-(.2m - \\n[rsb]u)'\ +\\$1\ +\h'.2m' +.. @endExample -@end ignore + +@noindent +First, the width of the string is stored in register @code{@@wd}. Then, +four lines are drawn to form a box, properly offset by the box margin. +The registers @code{rst} and @code{rsb} are set by the @code{\w} escape, +containing the largest height and depth of the whole string. @item \D'c @var{d}' -@cindex circle drawing -@cindex drawing a circle -Draw a circle with a diameter of @var{d} with the leftmost point at the +@cindex circle, drawing (@w{@code{\D'c @dots{}'}}) +@cindex drawing a circle (@w{@code{\D'c @dots{}'}}) +Draw a circle with a diameter of@w{ }@var{d} with the leftmost point at the current position. @item \D'C @var{d}' -Draw a solid circle with the same parameters as an outlined circle. - -@item \D'e @var{dx} @var{dy}' -@cindex drawing an ellipse -@cindex ellipse drawing -Draw an ellipse with a horizontal diameter of @var{dx} and a vertical -diameter of @var{dy} with the leftmost point at the current position. - -@item \D'E @var{dx} @var{dy}' +@cindex circle, solid, drawing (@w{@code{\D'C @dots{}'}}) +@cindex drawing a solid circle (@w{@code{\D'C @dots{}'}}) +@cindex solid circle, drawing (@w{@code{\D'C @dots{}'}}) +Draw a solid circle with the same parameters as an outlined circle. No +outline is drawn. + +@item \D'e @var{x} @var{y}' +@cindex drawing an ellipse (@w{@code{\D'e @dots{}'}}) +@cindex ellipse, drawing (@w{@code{\D'e @dots{}'}}) +Draw an ellipse with a horizontal diameter of @var{x} and a vertical +diameter of @var{y} with the leftmost point at the current position. + +@item \D'E @var{x} @var{y}' +@cindex ellipse, solid, drawing (@w{@code{\D'E @dots{}'}}) +@cindex drawing a solid ellipse (@w{@code{\D'E @dots{}'}}) +@cindex solid ellipse, drawing (@w{@code{\D'E @dots{}'}}) Draw a solid ellipse with the same parameters as an outlined ellipse. +No outline is drawn. @item \D'a @var{dx1} @var{dy1} @var{dx2} @var{dy2}' -@cindex arc drawing -@cindex drawing an arc +@cindex arc, drawing (@w{@code{\D'a @dots{}'}}) +@cindex drawing an arc (@w{@code{\D'a @dots{}'}}) Draw an arc clockwise from the current location through the two -specified locations (@var{dx1},@var{dy1}) and (@var{dx2},@var{dy2}). +specified relative locations (@var{dx1},@var{dy1}) and +(@var{dx2},@var{dy2}). The coordinates of the first point are relative +to the current position, and the coordinates of the second point are +relative to the first point. -@item \D'~ @var{dx1} @var{dy1} @var{dx2} @var{dy2} ...' -@cindex drawing a spline -@cindex spline drawing -Draw a spline from the current location to (@var{dx1},@var{dy1}) and -then to (@var{dx2},@var{dy2}), and so on. +@item \D'~ @var{dx1} @var{dy1} @var{dx2} @var{dy2} @dots{}' +@cindex drawing a spline (@w{@code{\D'~ @dots{}'}}) +@cindex spline, drawing (@w{@code{\D'~ @dots{}'}}) +Draw a spline from the current location to the relative point +(@var{dx1},@var{dy1}) and then to (@var{dx2},@var{dy2}), and so on. @item \D'f @var{n}' -@cindex gray shading -@cindex shading -@cindex shades for filling objects +@cindex gray shading (@w{@code{\D'f @dots{}'}}) +@cindex shading filled objects (@w{@code{\D'f @dots{}'}}) Set the shade of gray to be used for filling solid objects to@w{ }@var{n}; @var{n}@w{ }must be an integer between 0 and@w{ }1000, where 0 corresponds solid white and 1000 to solid black, and values in between correspond to intermediate shades of gray. This applies only to solid -circles, solid ellipses and solid polygons. By default, a level of@w{ -}1000 is used. - -@item \D'p @var{dx1} @var{dy1} @var{dx2} @var{dy2} ...' -@cindex drawing a polygon -@cindex polygon drawing -Draw a polygon from the current location to (@var{dx1},@var{dy1}) and -then to (@var{dx2},@var{dy2}) and so on. When the specified data points -are exhausted, a line is drawn back to the starting point. - -@c XXX example - -@ignore -@Example -... box example (yes, again)... -@endExample -@end ignore - -@item \D'P @var{dx1} @var{dy1} @var{dx2} @var{dy2} ...' +circles, solid ellipses, and solid polygons. By default, a level of +1000 is used. + +@item \D'p @var{dx1} @var{dy1} @var{dx2} @var{dy2} @dots{}' +@cindex drawing a polygon (@w{@code{\D'p @dots{}'}}) +@cindex polygon, drawing (@w{@code{\D'p @dots{}'}}) +Draw a polygon from the current location to the relative position +(@var{dx1},@var{dy1}) and then to (@var{dx2},@var{dy2}) and so on. +When the specified data points are exhausted, a line is drawn back +to the starting point. + +@item \D'P @var{dx1} @var{dy1} @var{dx2} @var{dy2} @dots{}' +@cindex polygon, solid, drawing (@w{@code{\D'P @dots{}'}}) +@cindex drawing a solid polygon (@w{@code{\D'P @dots{}'}}) +@cindex solid polygon, drawing (@w{@code{\D'P @dots{}'}}) Draw a solid polygon with the same parameters as an outlined polygon. - -@c XXX example - -@ignore -@Example -... shaded box example ... +No outline is drawn. + +Here a better variant of the box macro to fill the box with some color. +Note that the box must be drawn before the text since colors in +@code{gtroff} are not transparent; the filled polygon would hide the +text completely. + +@Example +.de BOX +. nr @@wd \w'\\$1' +\h'.2m'\ +\h'-.2m'\v'(.2m - \\n[rsb]u)'\ +\M[lightcyan]\ +\D'P 0 -(\\n[rst]u - \\n[rsb]u + .4m) \ + (\\n[@@wd]u + .4m) 0 \ + 0 (\\n[rst]u - \\n[rsb]u + .4m) \ + -(\\n[@@wd]u + .4m) 0'\ +\h'.2m'\v'-(.2m - \\n[rsb]u)'\ +\M[]\ +\\$1\ +\h'.2m' +.. @endExample -@end ignore @item \D't @var{n}' -@cindex line thickness -@cindex thickness of lines -Set the current line thickness to @var{n} machine units. A value of +@cindex line thickness (@w{@code{\D't @dots{}'}}) +@cindex thickness of lines (@w{@code{\D't @dots{}'}}) +Set the current line thickness to @var{n}@w{ }machine units. A value of zero selects the smallest available line thickness. A negative value makes the line thickness proportional to the current point size (this is -the default behaviour of @code{ditroff}). +the default behaviour of @acronym{AT&T} @code{troff}). @end table @endDefesc -@cindex pile, character -@cindex character pile +@xref{Graphics Commands}. + @Defesc {\\b, ', string, '} -@dfn{Piles} a sequence of characters -vertically, and centers it vertically on the current line. Use it -to build large brackets and braces. +@cindex pile, glyph (@code{\b}) +@cindex glyph pile (@code{\b}) +@cindex stacking glyphs (@code{\b}) +@dfn{Pile} a sequence of glyphs vertically, and center it vertically +on the current line. Use it to build large brackets and braces. + +Here an example how to create a large opening brace: @Example -\b'\(lt\(bv\(lk\(bv\(lb' +\b'\[lt]\[bv]\[lk]\[bv]\[lb]' @endExample -@endDefesc -@xref{Drawing Functions}. +@cindex @code{\b}, limitations +@cindex limitations of @code{\b} escape +The first glyph is on the top, the last glyph in @var{string} is +at the bottom. Note that @code{gtroff} separates the glyphs +vertically by 1@dmn{m}, and the whole object is centered 0.5@dmn{m} +above the current baseline; the largest glyph width is used as the +width for the whole object. This rather unflexible positioning +algorithm doesn't work with @option{-Tdvi} since the bracket pieces vary +in height for this device. Instead, use the @code{eqn} preprocessor. + +@xref{Manipulating Spacing}, how to adjust the vertical spacing with +the @code{\x} escape. +@endDefesc @c ===================================================================== @@ -7809,13 +10504,22 @@ to build large brackets and braces. @dfn{Traps} are locations, which, when reached, call a specified macro. These traps can occur at a given location on the page, at a -given location in the current diversion, after a certain number of input -lines or at the end of input. +given location in the current diversion, at a blank line, +after a certain number of input lines, or at the end of input. + +@cindex planting a trap +@cindex trap, planting +Setting a trap is also called @dfn{planting}. +@cindex trap, springing +@cindex springing a trap +It is also said that a trap is @dfn{sprung} if the associated macro +is executed. @menu * Page Location Traps:: * Diversion Traps:: * Input Line Traps:: +* Blank Line Traps:: * End-of-input Traps:: @end menu @@ -7827,8 +10531,8 @@ lines or at the end of input. @cindex traps, page location @dfn{Page location traps} perform an action when @code{gtroff} -reaches a certain vertical location on the page. Page location -traps have a variety of purposes, including: +reaches or passes a certain vertical location on the page. Page +location traps have a variety of purposes, including: @itemize @item @@ -7841,10 +10545,12 @@ setting body text in multiple columns setting footnotes @end itemize -@cindex vertical position trap enable register -@Defreq {vpt, flag} -@Defregx {.vpt} -Enables vertical position traps if @var{flag} is non-zero, or disables +@DefreqList {vpt, flag} +@DefregListEnd {.vpt} +@cindex enabling vertical position traps (@code{vpt}) +@cindex vertical position traps, enabling (@code{vpt}) +@cindex vertical position trap enable register (@code{.vpt}) +Enable vertical position traps if @var{flag} is non-zero, or disables them otherwise. Vertical position traps are traps set by the @code{wh} or @code{dt} requests. Traps set by the @code{it} request are not vertical position traps. The parameter that controls whether vertical @@ -7853,13 +10559,15 @@ are enabled. The current setting of this is available in the @code{.vpt} read-only number register. @endDefreq -@Defreq {wh, dist macro} -Sets a page location trap. Positive values for @var{dist} set +@Defreq {wh, dist [@Var{macro}]} +Set a page location trap. Positive values for @var{dist} set the trap relative to the top of the page; negative values set -the trap relative to the bottom of the page. +the trap relative to the bottom of the page. Default scaling +indicator is @samp{v}. @var{macro} is the name of the macro to execute when the -trap is sprung. +trap is sprung. If @var{macro} is missing, remove the first trap +(if any) at @var{dist}. @cindex page headers @cindex page footers @@ -7870,35 +10578,85 @@ set headers and footers. @Example .de hd \" Page header -'sp .5i -.tl 'Title''date' -'sp .3i +' sp .5i +. tl 'Title''date' +' sp .3i .. +. .de fo \" Page footer -'sp 1v -.tl ''%'' -'bp +' sp 1v +. tl ''%'' +' bp .. +. .wh 0 hd \" trap at top of the page .wh -1i fo \" trap one inch from bottom @endExample + +A trap at or below the bottom of the page is ignored; it can be made +active by either moving it up or increasing the page length so that the +trap is on the page. + +It is possible to have more than one trap at the same location; to do so, +the traps must be defined at different locations, then moved together with +the @code{ch} request; otherwise the second trap would replace the first +one. Earlier defined traps hide later defined traps if moved to the same +position (the many empty lines caused by the @code{bp} request are omitted): + +@Example +.de a +. nop a +.. +.de b +. nop b +.. +.de c +. nop c +.. +. +.wh 1i a +.wh 2i b +.wh 3i c +.bp + @result{} a b c +@endExample +@Example +.ch b 1i +.ch c 1i +.bp + @result{} a +@endExample +@Example +.ch a 0.5i +.bp + @result{} a b +@endExample @endDefreq -@cindex distance to next trap -@cindex trap, distance @Defreg {.t} +@cindex distance to next trap register (@code{.t}) +@cindex trap, distance, register (@code{.t}) A read-only number register holding the distance to the next trap. + +If there are no traps between the current position and the bottom of the +page, it contains the distance to the page bottom. In a diversion, the +distance to the page bottom is infinite (the returned value is the biggest +integer which can be represented in @code{groff}) if there are no diversion +traps. @endDefreg -@cindex changing trap location -@cindex trap, changing location -@Defreq {ch, dist macro} -Changes the location of a trap. +@Defreq {ch, macro dist} +@cindex changing trap location (@code{ch}) +@cindex trap, changing location (@code{ch}) +Change the location of a trap. The first argument is the name of the macro to be invoked at the trap, and the second argument is the new location for the trap -(note that the parameters are specified the opposite of the @code{.wh} request). -This is useful for building up footnotes in a diversion to allow more -space at the bottom of the page for them. +(note that the parameters are specified the opposite of the @code{wh} +request). This is useful for building up footnotes in a diversion to +allow more space at the bottom of the page for them. + +Default scaling indicator for @var{dist} is @samp{v}. If @var{dist} +is missing, the trap is removed. @c XXX @@ -7916,9 +10674,9 @@ sprung. Useful in conjunction with the @code{.trunc} register. @xref{Page Control}, for more information. @endDefreg -@rqindex ne -@cindex @code{ne}, and the @code{.trunc} register @Defreg {.trunc} +@cindex @code{ne} request, and the @code{.trunc} register +@cindex truncated vertical space register (@code{.trunc}) A read-only register containing the amount of vertical space truncated by the most recently sprung vertical position trap, or, if the trap was sprung by an @code{ne} request, minus the amount of vertical motion @@ -7935,28 +10693,34 @@ actually is. @cindex diversion traps @cindex traps, diversion -@vindex .t -@cindex @code{.t}, and diversions @Defreq {dt, dist macro} -Sets a trap @emph{within} a diversion. -@var{dist} is the first argument is the location of the trap -(identical to the @code{.wh} request) -and @var{macro} is the name of the macro to be invoked. The +@cindex @code{.t} register, and diversions +@cindex setting diversion trap (@code{dt}) +@cindex diversion trap, setting (@code{dt}) +@cindex trap, diversion, setting (@code{dt}) +Set a trap @emph{within} a diversion. +@var{dist} is the location of the trap +(identical to the @code{.wh} request; default scaling indicator is +@samp{v}) and @var{macro} is the name of the macro to be invoked. The number register @code{.t} still works within diversions. @xref{Diversions}, for more information. @endDefreq @c --------------------------------------------------------------------- -@node Input Line Traps, End-of-input Traps, Diversion Traps, Traps +@node Input Line Traps, Blank Line Traps, Diversion Traps, Traps @subsection Input Line Traps @cindex input line traps @cindex traps, input line -@Defreq {it, n macro} -Sets an input line trap. -@var{n} is the number of lines of input which may be read before -@dfn{springing} the trap, @var{macro} is the macro to be invoked. +@DefreqList {it, n macro} +@DefreqItem {itc, n macro} +@cindex setting input line trap (@code{it}) +@cindex input line trap, setting (@code{it}) +@cindex trap, input line, setting (@code{it}) +Set an input line trap. +@var{n}@w{ }is the number of lines of input which may be read before +springing the trap, @var{macro} is the macro to be invoked. Request lines are not counted as input lines. For example, one possible use is to have a macro which prints the @@ -7964,26 +10728,58 @@ next @var{n}@w{ }lines in a bold font. @Example .de B -.it \\$1 B-end -.ft B +. it \\$1 B-end +. ft B .. +. .de B-end -.ft R +. ft R .. @endExample + +@cindex input line traps and interrupted lines (@code{itc}) +@cindex interrupted lines and input line traps (@code{itc}) +@cindex traps, input line, and interrupted lines (@code{itc}) +@cindex lines, interrupted, and input line traps (@code{itc}) +The @code{itc} request is identical, +except that a line interrupted with @code{\c} +counts as one input line. + +Both requests are associated with the current environment +(@pxref{Environments}); switching to another environment disables the +current input trap, and going back reactivates it, restoring the number +of already processed lines. @endDefreq @c --------------------------------------------------------------------- -@node End-of-input Traps, , Input Line Traps, Traps +@node Blank Line Traps, End-of-input Traps, Input Line Traps, Traps +@subsection Blank Line Traps +@cindex blank line traps +@cindex traps, blank line + +@Defreq {blm, macro} +@cindex blank line macro (@code{blm}) +Set a blank line trap. +@code{gtroff} executes @var{macro} when it encounters a blank line in +the input file. +@endDefreq + +@c --------------------------------------------------------------------- + +@node End-of-input Traps, , Blank Line Traps, Traps @subsection End-of-input Traps @cindex end-of-input traps @cindex traps, end-of-input @Defreq {em, macro} -Sets a trap at the end of input. The @var{macro} -specified is executed after the last line of the -input file has been processed. +@cindex setting end-of-input trap (@code{em}) +@cindex end-of-input trap, setting (@code{em}) +@cindex trap, end-of-input, setting (@code{em}) +@cindex end-of-input macro (@code{em}) +@cindex macro, end-of-input (@code{em}) +Set a trap at the end of input. @var{macro} is executed after the +last line of the input file has been processed. For example, if the document had to have a section at the bottom of the last page for someone to approve it, the @code{em} request could be @@ -7991,15 +10787,16 @@ used. @Example .de approval -.ne 5v -.sp |(\\n(.t-6v) -.in +4i -.lc _ -.br +. ne 5v +. sp |(\\n[.t] - 6v) +. in +4i +. lc _ +. br Approved:\t\a -.sp +. sp Date:\t\t\a .. +. .em approval @endExample @endDefreq @@ -8015,34 +10812,79 @@ In @code{gtroff} it is possible to @dfn{divert} text into a named storage area. Due to the similarity to defining macros it is sometimes said to be stored in a macro. This is used for saving text for output at a later time, which is useful for keeping blocks of text on the same -page, footnotes, tables of contents and indices. - -@c XXX describe top-level diversion -@c XXX index entry for top-level diversion +page, footnotes, tables of contents, and indices. -@Defreq {di, macro} -@Defreqx {da, macro} -Begins a diversion. Like the @code{de} +@cindex top-level diversion +@cindex diversion, top-level +For orthogonality it is said that @code{gtroff} is in the @dfn{top-level +diversion} if no diversion is active (i.e., the data is diverted to the +output device). + +@DefreqList {di, macro} +@DefreqListEnd {da, macro} +@cindex beginning diversion (@code{di}) +@cindex diversion, beginning (@code{di}) +@cindex ending diversion (@code{di}) +@cindex diversion, ending (@code{di}) +@cindex appending to a diversion (@code{da}) +@cindex diversion, appending (@code{da}) +Begin a diversion. Like the @code{de} request, it takes an argument of a macro name to divert subsequent text into. The @code{da} macro appends to an existing diversion. @code{di} or @code{da} without an argument ends the diversion. +@endDefreq -@c XXX example +@DefreqList {box, macro} +@DefreqListEnd {boxa, macro} +Begin (or appends to) a diversion like the +@code{di} and @code{da} requests. +The difference is that @code{box} and @code{boxa} +do not include a partially-filled line in the diversion. + +Compare this: -@ignore @Example -... end-note example ... +Before the box. +.box xxx +In the box. +.br +.box +After the box. +.br + @result{} Before the box. After the box. +.xxx + @result{} In the box. @endExample -@end ignore + +@noindent +with this: + +@Example +Before the diversion. +.di yyy +In the diversion. +.br +.di +After the diversion. +.br + @result{} After the diversion. +.yyy + @result{} Before the diversion. In the diversion. +@endExample + +@code{box} or @code{boxa} without an argument ends the diversion. @endDefreq -@vindex nl -@vindex .h +@DefregList {.z} +@DefregListEnd {.d} +@cindex @code{nl} register, and @code{.d} @cindex nested diversions @cindex diversion, nested -@Defreg {.z} -@Defregx {.d} +@cindex diversion name register (@code{.z}) +@cindex vertical position in diversion register (@code{.d}) +@cindex position, vertical, in diversion, register (@code{.d}) +@cindex diversion, vertical position in, register (@code{.d}) Diversions may be nested. The read-only number register @code{.z} contains the name of the current diversion (this is a string-valued register). The read-only number register @code{.d} contains the current @@ -8050,60 +10892,86 @@ vertical place in the diversion. If not in a diversion it is the same as the register @code{nl}. @endDefreg -@c XXX more info - @Defreg {.h} +@cindex high-water mark register (@code{.h}) +@cindex mark, high-water, register (@code{.h}) +@cindex position of lowest text line (@code{.h}) +@cindex text line, position of lowest (@code{.h}) The @dfn{high-water mark} on the current page. It corresponds to the text baseline of the lowest line on the page. This is a read-only register. + +@Example +.tm .h==\n[.h], nl==\n[nl] + @result{} .h==0, nl==-1 +This is a test. +.br +.sp 2 +.tm .h==\n[.h], nl==\n[nl] + @result{} .h==40, nl==120 +@endExample + +@cindex @code{.h} register, difference to @code{nl} +@cindex @code{nl} register, difference to @code{.h} +@noindent +As can be seen in the previous example, empty lines are not considered +in the return value of the @code{.h} register. @endDefreg -@Defreg {dn} -@Defregx {dl} +@DefregList {dn} +@DefregListEnd {dl} After completing a diversion, the read-write number registers @code{dn} and @code{dl} contain the vertical and horizontal size of the diversion. -@example -@group +@Example .\" Center text both horizontally & vertically +. +.\" Enclose macro definitions in .eo and .ec +.\" to avoid the doubling of the backslash +.eo +.\" macro .(c starts centering mode .de (c -.br -.nf -.di @@c +. br +. ev (c +. evc 0 +. in 0 +. nf +. di @@c .. -@end group -@group +@endExample +@Example +.\" macro .)c terminates centering mode .de )c -.br -.di -.nr @@s (((\\n(.tu-\\n(dnu)/2u)-1v) -.sp \\n(@@su -.ce 1000 -.nf -.@c -.br -.ce 0 -.sp \\n(@@su -.br -.fi -.rr @@s +. br +. ev +. di +. nr @@s (((\n[.t]u - \n[dn]u) / 2u) - 1v) +. sp \n[@@s]u +. ce 1000 +. @@c +. ce 0 +. sp \n[@@s]u +. br +. fi +. rr @@s +. rm @@s +. rm @@c .. -@end group -@end example +.\" End of macro definitions, restore escape mechanism +.ec +@endExample @endDefreg -@cindex transparent output -@cindex output, transparent -@Defesc {\\!, , , } -@Defescx {\\?, , @Var{anything}, \\?} -Prevents requests, macros and escapes from being +@DefescList {\\!, , , } +@DefescListEnd {\\?, , @Var{anything}, \\?} +@cindex transparent output (@code{\!}, @code{\?}) +@cindex output, transparent (@code{\!}, @code{\?}) +Prevent requests, macros, and escapes from being interpreted when read into a diversion. This takes the given text and @dfn{transparently} embeds it into the diversion. This is useful for macros which shouldn't be invoked until the diverted text is actually output. -@c XXX anything is read in copy mode. (what about \! ??) - The @code{\!} escape transparently embeds text up to and including the end of the line. The @code{\?} escape transparently embeds text until the next @@ -8117,7 +10985,7 @@ occurrence of the @code{\?} escape. For example: @var{anything} may not contain newlines; use @code{\!} to embed newlines in a diversion. The escape sequence @code{\?} is also recognized in copy mode and turned into a single internal code; it is -this code that terminates anything. Thus the following example +this code that terminates @var{anything}. Thus the following example prints@w{ }4. @Example @@ -8137,16 +11005,52 @@ prints@w{ }4. .nr x 4 .f @endExample + +Both escapes read the data in copy mode. + +@cindex @code{\!}, in top-level diversion +@cindex top-level diversion, and @code{\!} +@cindex diversion, top-level, and @code{\!} +If @code{\!} is used in the top-level diversion, its argument is +directly embedded into the @code{gtroff} intermediate output. This can +be used for example to control a postprocessor which processes the data +before it is sent to the device driver. + +@cindex @code{\?}, in top-level diversion +@cindex top-level diversion, and @code{\?} +@cindex diversion, top-level, and @code{\?} +The @code{\?} escape used in the top-level diversion produces no output +at all; its argument is simply ignored. @endDefesc -@cindex unformatting diversions -@cindex diversion, unformatting +@cindex @code{\!}, and @code{output} +@cindex @code{output} request, and @code{\!} +@Defreq {output, string} +Emit @var{string} directly to the @code{gtroff} intermediate output +(subject to copy-mode interpretation); this is similar to @code{\!} used +at the top level. An initial double quote in @var{string} is stripped off +to allow initial blanks. + +This request can't be used before the first page has started -- if you get +an error, simply insert @code{.br} before the @code{output} request. + +Without argument, @code{output} is ignored. + +Use with caution! It is normally only needed for mark-up used by a +postprocessor which does something with the output before sending it to +the output device, filtering out @code{string} again. +@endDefreq + @Defreq {asciify, div} -@dfn{Unformats} the diversion specified by @var{div} -in such a way that @acronym{ASCII} and space characters that +@cindex unformatting diversions (@code{asciify}) +@cindex diversion, unformatting (@code{asciify}) +@cindex @code{trin} request, and @code{asciify} +@dfn{Unformat} the diversion specified by @var{div} +in such a way that @acronym{ASCII} characters, characters translated with +the @code{trin} request, space characters, and some escape sequences that were formatted and diverted are treated like ordinary input characters when the diversion is reread. It can be also used for gross -hacks; for example, the following sets register @code{n} to@w{ }1. +hacks; for example, the following sets register@w{ }@code{n} to@w{ }1. @Example .tr @@. @@ -8162,6 +11066,17 @@ hacks; for example, the following sets register @code{n} to@w{ }1. @xref{Copy-in Mode}. @endDefreq +@Defreq {unformat, div} +Like @code{asciify}, unformat the specified diversion. +However, @code{unformat} only unformats spaces and tabs +between words. +Unformatted tabs are treated as input tokens, +and spaces are stretchable again. + +The vertical size of lines is not preserved; glyph information (font, +font size, space width, etc.)@: is retained. +@endDefreq + @c ===================================================================== @@ -8180,33 +11095,41 @@ following is the information kept in an environment. @itemize @bullet @item -font parameters (size, family, style, character height and slant, space +font parameters (size, family, style, glyph height and slant, space and sentence space size) @item page parameters (line length, title length, vertical spacing, -line spacing, indentation, line numbering, hyphenation data) +line spacing, indentation, line numbering, centering, right-justifying, +underlining, hyphenation data) @item fill and adjust mode @item -tab stops, tab and leader characters, escape character, no-break and -hyphen indicators, margin character data +tab stops, tab and leader characters, escape character, +no-break and hyphen indicators, margin character data @item partially collected lines + +@item +input traps + +@item +drawing and fill colours @end itemize These environments may be given arbitrary names (see @ref{Identifiers}, for more info). Old versions of @code{troff} only had environments -named @samp{0}, @samp{1} and@w{ }@samp{2}. - -@cindex switch environments -@cindex current environment number/name register -@Defreq {ev, env} -@Defregx {.ev} -Switches to another environment. The argument @var{env} is the name of +named @samp{0}, @samp{1}, and @samp{2}. + +@DefreqList {ev, [@Var{env}]} +@DefregListEnd {.ev} +@cindex switching environments (@code{ev}) +@cindex environment, switching (@code{ev}) +@cindex environment number/name register (@code{.ev}) +Switch to another environment. The argument @var{env} is the name of the environment to switch to. With no argument, @code{gtroff} switches back to the previous environment. There is no limit on the number of named environments; they are created the first time that they are @@ -8220,14 +11143,6 @@ active environment onto a stack. If, say, environments @samp{foo}, @samp{bar} (which is popped off the stack), and a second call switches back to environment @samp{foo}. -@c XXX example - -@ignore -@Example -... page break macro, revised ... -@endExample -@end ignore - Here is an example: @Example @@ -8246,27 +11161,77 @@ Here is an example: @endExample @endDefreq -@cindex copy environment @Defreq {evc, env} -Copies the environment @var{env} into the current environment. +@cindex copying environment (@code{evc}) +@cindex environment, copying (@code{evc}) +Copy the environment @var{env} into the current environment. + +The following environment data is not copied: + +@itemize @bullet +@item +Partially filled lines. + +@item +The status whether the previous line was interrupted. + +@item +The number of lines still to center, or to right-justify, or to underline +(with or without underlined spaces); they are set to zero. + +@item +The status whether a temporary indent is active. + +@item +Input traps and its associated data. + +@item +Line numbering mode is disabled; it can be reactivated with +@w{@samp{.nm +0}}. + +@item +The number of consecutive hyphenated lines (set to zero). +@end itemize @endDefreq +@DefregList {.cht} +@DefregItem {.cdp} +@DefregListEnd {.csk} +@cindex environment, last glyph +The @code{\n[.cht]} register contains the +maximum extent (above the baseline) +of the last glyph added to the current environment. + +The @code{\n[.cdp]} register contains the +maximum extent (below the baseline) +of the last glyph added to the current environment. + +The @code{\n[.csk]} register contains the +@dfn{skew} (how far to the right of the glyph's center +that @code{gtroff} shold place an accent) +of the last glyph added to the current environment. +@endDefreg + @c ===================================================================== -@node Suppressing output, I/O, Environments, gtroff Reference +@node Suppressing output, Colors, Environments, gtroff Reference @section Suppressing output -@cindex suppressing output @Defesc {\\O, , num, } -Disables or enables output depending on the value of @var{num}: +@cindex suppressing output (@code{\O}) +@cindex output, suppressing (@code{\O}) +Disable or enable output depending on the value of @var{num}: @table @samp @item \O0 -Disable any ditroff glyphs from being emitted to the device driver. +Disable any glyphs from being emitted to the device driver, provided that +the escape occurs at the outer level (see @code{\O[3]} and @code{\O[4]}). +Motion is not suppressed so effectively @code{\O[0]} means @emph{pen up}. @item \O1 -Enable output of glyphs. +Enable output of glyphs, provided that the escape occurs at the outer +level. @end table @vindex opminx @@ -8278,25 +11243,148 @@ Enable output of glyphs. @xref{Register Index}. These four registers mark the top left and bottom right hand corners of a box which encompasses all written glyphs. -The following two forms of @code{\O} are specific to @code{grohtml}. +For example the input text: + +@Example +Hello \O[0]world \O[1]this is a test. +@endExample + +@noindent +produces the following output: + +@Example +Hello this is a test. +@endExample @table @samp @item \O2 -Disable any ditroff glyphs from being emitted to the device driver. Also -write out to @code{stderr} the page number and four registers encompassing -the glyphs previously written since the last call to @code{\O}. +Provided that the escape occurs at the outer level, enable output of +glyphs and also write out to @code{stderr} the page number and four +registers encompassing the glyphs previously written since the last call +to @code{\O}. @item \O3 -Enable output of glyphs (the default). Also write out to @code{stderr} -the page number and four registers encompassing the glyphs previously -written since the last call to @code{\O}. +Begin a nesting level. At start-up, @code{gtroff} is at outer level. + +@item \O4 +End a nesting level. + +@item \O[5@var{P}@var{filename}] +This escape is @code{grohtml} specific. Provided that this escape +occurs at the outer nesting level write the @code{filename} to +@code{stderr}. The position of the image, @var{P}, must be specified +and must be one of @code{l}, @code{r}, @code{c}, or@w{ }@code{i} (left, +right, centered, inline). @var{filename} will be associated with the +production of the next inline image. @end table @endDefesc +@c ===================================================================== + +@node Colors, I/O, Suppressing output, gtroff Reference +@section Colors +@cindex colors + +@DefreqList {color, [@Var{n}]} +@DefregListEnd {.color} +If @var{n} is missing or non-zero, activate colors (this is the default); +otherwise, turn it off. + +The read-only number register @code{.color} is@w{ }1 if colors are active, +0@w{ }otherwise. + +Internally, @code{color} sets a global flag; it does not produce a token. +Similar to the @code{cp} request, you should use it at the beginning of +your document to control color output. + +Colors can be also turned off with the @option{-c} command line option. +@endDefreq + +@Defreq {defcolor, ident scheme color_components} +Define color with name @var{ident}. @var{scheme} can be one of the +following values: @code{rgb} (three components), @code{cym} (three +components), @code{cmyk} (four components), and @code{gray} or +@code{grey} (one component). + +@cindex default color +@cindex color, default +Color components can be given either as a hexadecimal string or as +positive decimal integers in the range 0--65535. A hexadecimal string +contains all color components concatenated. It must start with either +@code{#} or @code{##}; the former specifies hex values in the range +0--255 (which are internally multiplied by@w{ }257), the latter in the +range 0--65535. Examples: @code{#FFC0CB} (pink), @code{##ffff0000ffff} +(magenta). The default color name @c{default} can't be redefined; its +value is device-specific (usually black). It is possible that the +default color for @code{\m} and @code{\M} is not identical. + +@cindex @code{f} unit, and colors +@cindex unit, @code{f}, and colors +A new scaling indicator@w{ }@code{f} has been introduced which multiplies +its value by 65536; this makes it convenient to specify color components +as fractions in the range 0 to@w{ }1 (1f equals 65536u). Example: + +@Example +.defcolor darkgreen rgb 0.1f 0.5f 0.2f +@endExample + +Note that @code{f} is the default scaling indicator for the +@code{defcolor} request, thus the above statement is equivalent to + +@Example +.defcolor darkgreen rgb 0.1 0.5 0.2 +@endExample +@endDefreq + +@DefescList {\\m, , c, } +@DefescItem {\\m, @lparen{}, co, } +@DefescListEnd {\\m, @lbrack{}, color, @rbrack} +Set drawing color. The following example shows how to turn the next four +words red. + +@Example +\m[red]these are in red\m[] and these words are in black. +@endExample + +The escape @code{\m[]} returns to the previous color. + +The drawing color is associated with the current environment +(@pxref{Environments}). + +Note that @code{\m} doesn't produce an input token in @code{gtroff}. +As a consequence, it can be used in requests like @code{mc} (which +expects a single character as an argument) to change the color on +the fly: + +@Example +.mc \m[red]x\m[] +@endExample +@endDefesc + +@DefescList {\\M, , c, } +@DefescItem {\\M, @lparen{}, co, } +@DefescListEnd {\\M, @lbrack{}, color, @rbrack} +Set background color for filled objects drawn with the +@code{\D'@dots{}'} commands. + +A red ellipse can be created with the following code: + +@Example +\M[red]\h'0.5i'\D'E 2i 1i'\M[] +@endExample + +The escape @code{\M[]} returns to the previous fill color. + +The fill color is associated with the current environment +(@pxref{Environments}). + +Note that @code{\M} doesn't produce an input token in @code{gtroff}. +@endDefesc + @c ===================================================================== -@node I/O, Postprocessor Access, Suppressing output, gtroff Reference +@node I/O, Postprocessor Access, Colors, gtroff Reference @section I/O @cindex i/o @cindex input and output requests @@ -8305,33 +11393,62 @@ written since the last call to @code{\O}. @code{gtroff} has several requests for including files: -@cindex including a file -@cindex file inclusion @Defreq {so, file} -Reads in the specified @var{file} and +@cindex including a file (@code{so}) +@cindex file, inclusion (@code{so}) +Read in the specified @var{file} and includes it in place of the @code{so} request. This is quite useful for large documents, e.g.@: keeping each chapter in a separate file. @xref{gsoelim}, for more information. + +Since @code{gtroff} replaces the @code{so} request with the contents +of @code{file}, it makes a difference whether the data is terminated with +a newline or not: Assuming that file @file{xxx} contains the word +@samp{foo} without a final newline, this + +@Example +This is +.so xxx +bar +@endExample + +@noindent +yields @samp{This is foobar}. +@endDefreq + +@Defreq {pso, command} +Read the standard output from the specified @var{command} +and includes it in place of the @code{pso} request. + +@cindex safer mode +@cindex mode, safer +@cindex unsafe mode +@cindex mode, unsafe +This request causes an error if used in safer mode (which is the default). +Use @code{groff}'s or @code{troff}'s @option{-U} option to activate unsafe +mode. + +The comment regarding a final newline for the @code{so} request is valid +for @code{pso} also. @endDefreq @Defreq {mso, file} -Identical to the @code{so} request except that @code{gtroff} -searches for the specified -@var{file} in the same directories as macro files for the +Identical to the @code{so} request except that @code{gtroff} searches for +the specified @var{file} in the same directories as macro files for the the @option{-m} command line option. If the file name to be included has the form @file{@var{name}.tmac} and it isn't found, @code{mso} tries to include @file{tmac.@var{name}} and vice versa. @endDefreq -@cindex transparent output -@cindex output, transparent -@Defreq {cf, file} -@Defreqx {trf, file} -Transparently outputs the contents of @var{file}. Each line is output -as it were preceded by @code{\!}; however, the lines are not subject to -copy mode interpretation. If the file does not end with a newline, then -a newline is added. For example, to define a macro@w{ }@code{x} -containing the contents of file@w{ }@file{f}, use +@DefreqList {trf, file} +@DefreqListEnd {cf, file} +@cindex transparent output (@code{cf}, @code{trf}) +@cindex output, transparent (@code{cf}, @code{trf}) +Transparently output the contents of @var{file}. Each line is output +as if it were preceded by @code{\!}; however, the lines are not subject +to copy mode interpretation. If the file does not end with a newline, +then a newline is added (@code{trf} only). For example, to define a +macro@w{ }@code{x} containing the contents of file@w{ }@file{f}, use @Example .di x @@ -8339,38 +11456,65 @@ containing the contents of file@w{ }@file{f}, use .di @endExample -The request @w{@code{.cf @var{filename}}}, when used in a diversion, +Both @code{trf} and @code{cf}, when used in a diversion, embeds an object in the diversion which, when reread, causes the -contents of @var{filename} to be transparently copied through to the -output. - -In @acronym{UNIX} @code{troff}, the contents of @var{filename} +contents of @var{file} to be transparently copied through to the +output. In @acronym{UNIX} @code{troff}, the contents of @var{file} is immediately copied through to the output regardless of whether there is a current diversion; this behaviour is so anomalous that it must be -considered a bug. This request causes a line break. +considered a bug. -@rqindex trf -With @code{trf}, unlike @code{cf}, the file cannot contain characters -such as NUL that are not valid @code{gtroff} input characters -(@pxref{Identifiers}). This request causes a line break. +@cindex @code{trf} request, and invalid characters +@cindex characters, invalid for @code{trf} request +@cindex invalid characters for @code{trf} request +While @code{cf} copies the contents of @var{file} completely unprocessed, +@code{trf} disallows characters such as NUL that are not valid +@code{gtroff} input characters (@pxref{Identifiers}). + +Both requests cause a line break. @endDefreq -@Defreq {nx, } -Forces @code{gtroff} to continue processing of -the file specified as an argument. +@Defreq {nx, [@Var{file}]} +@cindex processing next file (@code{nx}) +@cindex file, processing next (@code{nx}) +@cindex next file, processing (@code{nx}) +Force @code{gtroff} to continue processing of +the file specified as an argument. If no argument is given, immediately +jump to the end of file. @endDefreq -@Defreq {rd, } -The @code{rd} request reads from standard input, and includes what is -read as though it were part of the input file. Text is read until a -blank line is encountered. +@Defreq {rd, [@Var{prompt} [@Var{arg1} @Var{arg2} @dots{}]]} +@cindex reading from standard input (@code{rd}) +@cindex standard input, reading from (@code{rd}) +@cindex input, standard, reading from (@code{rd}) +Read from standard input, and include what is read as though it +were part of the input file. Text is read until a blank line +is encountered. + +If standard input is a TTY input device (keyboard), write @var{prompt} +to standard error, followed by a colon (or send BEL for a beep if no +argument is given). + +Arguments after @var{prompt} are available for the input. For example, +the line + +@Example +.rd data foo bar +@endExample + +with the input @w{@samp{This is \$2.}} prints + +@Example +This is bar. +@endExample @endDefreq @cindex form letters @cindex letters, form Using the @code{nx} and @code{rd} requests, it is easy to set up form letters. The form -letter template is constructed like this: +letter template is constructed like this, putting the following lines +into a file called @file{repeat.let}: @Example .ce @@ -8386,13 +11530,13 @@ Body of letter. .nx repeat.let @endExample -@rqindex ex +@cindex @code{ex} request, used with @code{nx} and @code{rd} @noindent -When this is run, the following file should be redirected in. Note that -requests included in this file are executed as though they were part of -the form letter. The last block of input is the @code{ex} requests -which tells groff to stop processing. If this was not there, groff -would not know when to stop. +When this is run, a file containing the following lines should be +redirected in. Note that requests included in this file are executed +as though they were part of the form letter. The last block of input +is the @code{ex} request which tells @code{groff} to stop processing. If +this was not there, @code{groff} would not know when to stop. @Example Trent A. Fisher @@ -8411,21 +11555,50 @@ Dear Mr. Adollar, @endExample @Defreq {pi, pipe} -Pipes the output of @code{gtroff} to the shell command(s) +Pipe the output of @code{gtroff} to the shell command(s) specified by @var{pipe}. This request must occur before @code{gtroff} has a chance to print anything. + +@cindex safer mode +@cindex mode, safer +@cindex unsafe mode +@cindex mode, unsafe +@code{pi} causes an error if used in safer mode (which is the default). +Use @code{groff}'s or @code{troff}'s @option{-U} option to activate unsafe +mode. + +Multiple calls to @code{pi} are allowed, acting as a chain. For example, + +@Example +.pi foo +.pi bar +... +@endExample + +is the same as @w{@samp{.pi foo | bar}}. + +@cindex @code{groff}, and @code{pi} request +@cindex @code{pi} request, and @code{groff} +Note that the intermediate output format of @code{gtroff} is piped to +the specified commands. Consequently, calling @code{groff} without the +@option{-Z} option normally causes a fatal error. @endDefreq -@Defreq {sy, cmds} -@Defregx {systat} -In @dfn{unsafe} mode, executes the shell command(s) specified by -@var{cmds}. The output is not saved anyplace, so it is up to the user -to do so. +@DefreqList {sy, cmds} +@DefregListEnd {systat} +Execute the shell command(s) specified by @var{cmds}. The output is not +saved anyplace, so it is up to the user to do so. -@c XXX add info about safer and unsafe mode +@cindex safer mode +@cindex mode, safer +@cindex unsafe mode +@cindex mode, unsafe +This request causes an error if used in safer mode (which is the default). +Use @code{groff}'s or @code{troff}'s @option{-U} option to activate unsafe +mode. -For example, the following example introduces the current time -into a document: +For example, the following code fragment introduces the current time into a +document: @cindex time, current @cindex current time @@ -8441,53 +11614,103 @@ into a document: @noindent Note that this works by having the @code{perl} script (run by @code{sy}) print out the @code{nr} requests which set the number registers -@samp{H}, @samp{M} and @samp{S}, and then reads those commands in with +@code{H}, @code{M}, and @code{S}, and then reads those commands in with the @code{so} request. -@cindex @code{system()} return value register +For most practical purposes, the number registers @code{seconds}, +@code{minutes}, and @code{hours} which are initialized at start-up of +@code{gtroff} should be sufficient. Use the @code{af} request to get a +formatted output: + +@Example +.af hours 00 +.af minutes 00 +.af seconds 00 +\n[hours]:\n[minutes]:\n[seconds] +@endExample + +@cindex @code{system()} return value register (@code{systat}) The @code{systat} read-write number register contains the return value of the @code{system()} function executed by the last @code{sy} request. @endDefreq -@Defreq {open, stream file} -@Defreqx {opena, stream file} -Opens the specified @var{file} for writing and +@DefreqList {open, stream file} +@DefreqListEnd {opena, stream file} +@cindex opening file (@code{open}) +@cindex file, opening (@code{open}) +@cindex appending to a file (@code{opena}) +@cindex file, appending to (@code{opena}) +Open the specified @var{file} for writing and associates the specified @var{stream} with it. -The @code{opena} is like @code{open}, but if the file exists, append to -it instead of truncating it. +The @code{opena} request is like @code{open}, but if the file exists, +append to it instead of truncating it. + +@cindex safer mode +@cindex mode, safer +@cindex unsafe mode +@cindex mode, unsafe +Both @code{open} and @code{opena} cause an error if used in safer mode +(which is the default). Use @code{groff}'s or @code{troff}'s @option{-U} +option to activate unsafe mode. @endDefreq +@DefreqList {write, stream data} +@DefreqListEnd {writec, stream data} @cindex copy-in mode, and @code{write} requests @cindex mode, copy-in, and @code{write} requests -@Defreq {write, stream data} -Writes to the file associated with the specified @var{stream}. +@cindex writing to file (@code{write}) +@cindex file, writing to (@code{write}) +Write to the file associated with the specified @var{stream}. The stream must previously have been the subject of an open request. The remainder of the line is interpreted as the @code{ds} request reads its second argument: A leading @samp{"} is stripped, and it is read in copy-in mode. + +The @code{writec} request is like @code{write}, but only +@code{write} appends a newline to the data. +@endDefreq + +@Defreq {writem, stream xx} +@cindex @code{asciify} request, and @code{writem} +Write the contents of the macro or string @var{xx} +to the file associated with the specified @var{stream}. + +@var{xx} is read in copy mode, i.e., already formatted elements are +ignored. Consequently, diversions must be unformatted with the +@code{asciify} request before calling @code{writem}. Usually, this +means a loss of information. @endDefreq @Defreq {close, stream} -Closes the specified @var{stream}; +@cindex closing file (@code{close}) +@cindex file, closing (@code{close}) +Close the specified @var{stream}; the stream is no longer an acceptable argument to the @code{write} request. -@c XXX example +Here a simple macro to write an index entry. -@ignore @Example -... example of open write &c... +.open idx test.idx +. +.de IX +. write idx \\n[%] \\$* +.. +. +.IX test entry +. +.close idx @endExample -@end ignore @endDefreq -@Defesc {\\V, ', xxx, '} -Interpolates the contents of the specified -environment variable, as returned by the function @code{getenv}. -Specify the argument to @code{\V} as an identifier, i.e.@: -@samp{\V@var{x}}, @samp{\V(@var{xx}} or @samp{\V[@var{xxx}]}. @code{\V} -is interpreted in copy-in mode. +@DefescList {\\V, , e, } +@DefescItem {\\V, @lparen{}, ev, } +@DefescListEnd {\\V, @lbrack{}, env, @rbrack} +Interpolate the contents of the specified environment variable +@var{env} (one-character name@w{ }@var{e}, two-character name @var{ev}) +as returned by the function @code{getenv}. @code{\V} is interpreted +in copy-in mode. @endDefesc @@ -8505,18 +11728,44 @@ postprocessor. This is particularly useful for embedding @Defesc {\\X, ', xxx, '} Embeds its argument into the @code{gtroff} output preceded with @w{@samp{x X}}. + +@cindex @code{\&}, in @code{\X} +@cindex @code{\)}, in @code{\X} +@cindex @code{\%}, in @code{\X} +@ifnotinfo +@cindex @code{\:}, in @code{\X} +@end ifnotinfo +@ifinfo +@cindex @code{\@r{<colon>}}, in @code{\X} +@end ifinfo +The escapes @code{\&}, @code{\)}, @code{\%}, and @code{\:} are ignored +within @code{\X}, @w{@samp{\ }} and @code{\~} are converted to single +space characters. All other escapes (except @code{\\} which produces a +backslash) cause an error. + +@kindex use_charnames_in_special +@pindex DESC@r{, and @code{use_charnames_in_special}} +@cindex @code{\X}, and special characters +If the @samp{use_charnames_in_special} keyword is set in the @file{DESC} +file, special characters no longer cause an error; the name @var{xx} is +represented as @samp{\(@var{xx})} in the @w{@samp{x X}} output command. +Additionally, the backslash is represented as @code{\\}. + +@samp{use_charnames_in_special} is currently used by @code{grohtml} only. @endDefesc -@Defesc {\\Y, ', xxx, '} -The @code{\Y} escape is called with an identifier (i.e.@: -@code{\Y@var{x}}, @code{\Y(@var{xx}} or @code{\Y[@var{xxx}]}). This is -approximately equivalent to @samp{\X'\*[@var{xxx}]'}. However, the -contents of the string or macro @var{xxx} are not interpreted; also it -is permitted for @var{xxx} to have been defined as a macro and thus -contain newlines (it is not permitted for the argument to @code{\X} to -contain newlines). The inclusion of newlines requires an extension to -the @acronym{UNIX} @code{troff} output format, and confuses drivers -that do not know about this extension. +@DefescList {\\Y, , n, } +@DefescItem {\\Y, @lparen{}, nm, } +@DefescListEnd {\\Y, @lbrack{}, name, @rbrack} +This is approximately equivalent to @samp{\X'\*[@var{name}]'} +(one-character name@w{ }@var{n}, two-character name @var{nm}). +However, the contents of the string or macro @var{name} are not +interpreted; also it is permitted for @var{name} to have been defined +as a macro and thus contain newlines (it is not permitted for the +argument to @code{\X} to contain newlines). The inclusion of +newlines requires an extension to the @acronym{UNIX} @code{troff} +output format, and confuses drivers that do not know about this +extension (@pxref{Device Control Commands}). @endDefesc @xref{Output Devices}. @@ -8526,50 +11775,105 @@ that do not know about this extension. @node Miscellaneous, Gtroff Internals, Postprocessor Access, gtroff Reference @section Miscellaneous -@cindex miscellaneous This section documents parts of @code{gtroff} which cannot (yet) be categorized elsewhere in this manual. -@cindex line numbers -@cindex numbers, line -@Defreq {nm, start inc space indent} -Prints line numbers in the left margin. +@Defreq {nm, [@Var{start} [@Var{inc} [@Var{space} [@Var{indent}]]]]} +@cindex printing line numbers (@code{nm}) +@cindex line numbers, printing (@code{nm}) +@cindex numbers, line, printing (@code{nm}) +Print line numbers. @var{start} is the line number of the @emph{next} -output line; this defaults to@w{ }1. @var{inc} indicates on -which lines numbers are printed, i.e.@: 5 means put line numbers on -every 5@w{ }lines; this defaults to@w{ }1. @var{space} is the -space to be left between the number and the text; this defaults to@w{ -}1. The fourth argument is the indentation of the line numbers. -Without arguments, line numbers are turned off. -@endDefreq - -@c XXX xref ln register - -@Defreq {nn, [@Var{skip}]} -Temporarily turns off line numbering. The -argument is the number of lines not to be numbered; this defaults -to@w{ }1. - -@c XXX (does this disable incrementing or display?) +output line. @var{inc} indicates which line numbers are printed. +For example, the value@w{ }5 means to emit only line numbers which +are multiples of@w{ }5; this defaults to@w{ }1. @var{space} is the +space to be left between the number and the text; this defaults to +one digit space. The fourth argument is the indentation of the line +numbers, defaulting to zero. Both @var{space} and @var{indent} are +given as multiples of digit spaces; they can be negative also. +Without any arguments, line numbers are turned off. + +@code{gtroff} reserves three digit spaces for the line number (which is +printed right-justified) plus the amount given by @var{indent}; the +output lines are concatenated to the line numbers, separated by +@var{space}, and @emph{without} reducing the line length. Depending +on the value of the horizontal page offset (as set with the +@code{po} request), line numbers which are longer than the reserved +space stick out to the left, or the whole line is moved to the right. + +Parameters corresponding to missing arguments are not changed; any +non-digit argument (to be more precise, any argument starting with a +character valid as a delimiter for identifiers) is also treated as +missing. + +If line numbering has been disabled with a call to @code{nm} without +an argument, it can be reactivated with @samp{.nm +0}, using the +previously active line numbering parameters. + +The parameters of @code{nm} are associated with the current environment +(@pxref{Environments}). The current output line number is available +in the number register @code{ln}. + +@Example +.po 1m +.ll 2i +This test shows how line numbering works with groff. +.nm 999 +This test shows how line numbering works with groff. +.br +.nm xxx 3 2 +.ll -\w'0'u +This test shows how line numbering works with groff. +.nn 2 +This test shows how line numbering works with groff. +@endExample -@c XXX example +@noindent +And here the result: -@ignore @Example -... line numbering example ... + This test shows how + line numbering works + 999 with groff. This +1000 test shows how line +1001 numbering works with +1002 groff. + This test shows how + line numbering + works with groff. + This test shows how +1005 line numbering + works with groff. @endExample -@end ignore @endDefreq -@cindex margin characters -@cindex characters for margins -@Defreq {mc, char dist} -Prints margin characters to the right of the text. -The first argument is the character to be -printed, and the second argument is the distance away from the main body -text. With no arguments the margin characters are turned off. If this -occurs before a break, no margin character is printed. +@Defreq {nn, [@Var{skip}]} +Temporarily turn off line numbering. The argument is the number +of lines not to be numbered; this defaults to@w{ }1. +@endDefreq + +@Defreq {mc, glyph [@Var{dist}]} +@cindex margin glyph (@code{mc}) +@cindex glyph, for margins (@code{mc}) +Print a @dfn{margin character} to the right of the +text.@footnote{@dfn{Margin character} is a misnomer since it is an +output glyph.} The first argument is the glyph to be +printed. The second argument is the distance away from the right +margin. If missing, the previously set value is used; default is +10@dmn{pt}). For text lines that are too long (that is, longer than +the text length plus @var{dist}), the margin character is directly +appended to the lines. + +With no arguments the margin character is turned off. +If this occurs before a break, no margin character is printed. + +@cindex @code{tl} request, and @code{mc} +For empty lines and lines produced by the @code{tl} request no margin +character is emitted. + +The margin character is associated with the current environment +(@pxref{Environments}). @pindex nrchbar @pindex changebar @@ -8578,33 +11882,49 @@ there are programs available for doing this (they are called @code{nrchbar} and @code{changebar} and can be found in any @samp{comp.sources.unix} archive. -@c XXX example - -@ignore @Example -... margin char example ... +.ll 3i +.mc | +This paragraph is highlighted with a margin +character. +.sp +Note that vertical space isn't marked. +.br +\& +.br +But we can fake it with `\&'. @endExample -@end ignore -@endDefreq -@pindex soelim -@cindex multi-file documents -@cindex documents, multi-file -@Defreq {lf, line filename} -A debugging aid for -documents which are split into many files, then put together -with @code{soelim} and other preprocessors. The second argument is the -name of the file and the first argument is the input line number in -that file. This way @code{gtroff} can produce error messages which are -intelligible to the user. - -@c XXX example +Result: -@ignore @Example -... example of soelim'ed doc ... +This paragraph is highlighted | +with a margin character. | + +Note that vertical space isn't | +marked. | + | +But we can fake it with `\&'. | @endExample -@end ignore +@endDefreq + +@DefreqList {psbb, filename} +@DefregItem {llx} +@DefregItem {lly} +@DefregItem {urx} +@DefregListEnd {ury} +@cindex PostScript, bounding box +@cindex bounding box +Retrieve the bounding box of the PostScript image +found in @var{filename}. +The file must conform to +Adobe's @dfn{Document Structuring Conventions} (DSC); +the command searches for a @code{%%BoundingBox} comment +and extracts the bounding box values into the number registers +@code{llx}, @code{lly}, @code{urx}, and @code{ury}. +If an error occurs (for example, @code{psbb} cannot find +the @code{%%BoundingBox} comment), +it sets the four number registers to zero. @endDefreq @@ -8618,20 +11938,29 @@ intelligible to the user. @cindex output node @cindex node, output @code{gtroff} processes input in three steps. One or more input -characters are converted to an @dfn{input token}. Then, one or more -input tokens are converted to an @dfn{output node}. Finally, output -nodes are converted to the intermediate output language understood by -all output devices. - -For example, the input string @samp{fi\[:u]} is converted in a +characters are converted to an @dfn{input token}.@footnote{Except the +escapes @code{\f}, @code{\F}, @code{\H}, @code{\m}, @code{\M}, @code{\R}, +@code{\s}, and @code{\S} which are processed immediately if not in +copy-in mode.} Then, one or more input tokens are converted to an +@dfn{output node}. Finally, output nodes are converted to the +intermediate output language understood by all output devices. + +Actually, before step one happens, @code{gtroff} converts certain +escape sequences into reserved input characters (not accessible by +the user); such reserved characters are used for other internal +processing also -- this is the very reason why not all characters +are valid input. @xref{Identifiers}, for more on this topic. + +For example, the input string @samp{fi\[:u]} is converted into a character token @samp{f}, a character token @samp{i}, and a special token @samp{:u} (representing u@w{ }umlaut). Later on, the character tokens @samp{f} and @samp{i} are merged to a single output node -representing the ligature glyph @samp{fi}; the same happens with -@samp{:u}. All output glyph nodes are `processed' which means that -they are invariably associated with a given font, font size, advance -width, etc. During the formatting process, @code{gtroff} itself adds -various nodes to control the data flow. +representing the ligature glyph @samp{fi} (provided the current font +has a glyph for this ligature); the same happens with @samp{:u}. All +output glyph nodes are `processed' which means that they are invariably +associated with a given font, font size, advance width, etc. During +the formatting process, @code{gtroff} itself adds various nodes to +control the data flow. Macros, diversions, and strings collect elements in two chained lists: a list of input tokens which have been passed unprocessed, and a list @@ -8663,12 +11992,11 @@ It contains these elements. @item --- @tab @code{\n} @tab 9 @end multitable -@esindex \v -@rqindex unformat +@cindex @code{\v}, internal representation @noindent Elements 1, 7, and@w{ }8 are inserted by @code{gtroff}; the latter two (which are always present) specify the vertical extent of the last -line, possibly modified by @code{\v}. The @code{br} request finishes +line, possibly modified by @code{\x}. The @code{br} request finishes the current partial line, inserting a newline input token which is subsequently converted to a space when the diversion is reread. Note that the word space node has a fixed width which isn't stretchable @@ -8678,6 +12006,39 @@ the @code{unformat} request. Macros only contain elements in the token list (and the node list is empty); diversions and strings can contain elements in both lists. +Note that the @code{chop} request simply reduces the number of elements in a +macro, string, or diversion by one. Exceptions are @dfn{compatibility save} +and @dfn{compatibility ignore} input tokens which are ignored. The +@code{substring} request also ignores those input tokens. + +Some requests like @code{tr} or @code{cflags} work on glyph +identifiers only; this means that the associated glyph can be changed +without destroying this association. This can be very helpful for +substituting glyphs. In the following example, we assume that +glyph @samp{foo} isn't available by default, so we provide a +substitution using the @code{fchar} request and map it to input +character @samp{x}. + +@Example +.fchar \[foo] foo +.tr x \[foo] +@endExample + +@noindent +Now let us assume that we install an additional special font +@samp{bar} which has glyph @samp{foo}. + +@Example +.special bar +.rchar \[foo] +@endExample + +@noindent +Since glyphs defined with @code{fchar} are searched before glyphs +in special fonts, we must call @code{rchar} to remove the definition +of the fallback glyph. Anyway, the translation is still active; +@samp{x} now maps to the real glyph @samp{foo}. + @c ===================================================================== @@ -8688,23 +12049,54 @@ empty); diversions and strings can contain elements in both lists. @code{gtroff} is not easy to debug, but there are some useful features and strategies for debugging. -@Defreq {tm, string} -Sends the @var{string} to the standard error stream; -this is very useful for printing debugging output among other things. +@Defreq {lf, line filename} +@pindex soelim +@cindex multi-file documents +@cindex documents, multi-file +@cindex setting input line number (@code{lf}) +@cindex input line number, setting (@code{lf}) +@cindex number, input line, setting (@code{lf}) +Change the line number and the file name @code{gtroff} shall use for +error and warning messages. @var{line} is the input line number of the +@emph{next} line. + +Without argument, the request is ignored. + +This is a debugging aid for documents which are split into many files, +then put together with @code{soelim} and other preprocessors. Usually, +it isn't invoked manually. +@endDefreq + +@DefreqList {tm, string} +@DefreqItem {tm1, string} +@DefreqListEnd {tmc, string} +@cindex printing to stderr (@code{tm}, @code{tm1}, @code{tmc}) +@cindex stderr, printing to (@code{tm}, @code{tm1}, @code{tmc}) +Send @var{string} to the standard error output; +this is very useful for printing debugging messages among other things. + +@var{string} is read in copy mode. + +The @code{tm} request ignores leading spaces of @var{string}; @code{tm1} +handles its argument similar to the @code{ds} request: a leading double +quote in @var{string} is stripped to allow initial blanks. + +The @code{tmc} request is similar to @code{tm1} but does +not append a newline (as is done in @code{tm} and @code{tm1}). @endDefreq -@cindex aborting @Defreq {ab, [@Var{string}]} +@cindex aborting (@code{ab}) Similar to the @code{tm} request, except that it causes @code{gtroff} to stop processing. With no argument it -prints @samp{User Abort}. +prints @samp{User Abort.} to standard error. @endDefreq -@cindex @code{ex}, use in debugging -@cindex exiting @Defreq {ex, } -The @code{ex} request also causes @code{gtroff} to stop processing -if encountered at the topmost level; see also @ref{I/O}. +@cindex @code{ex} request, use in debugging +@cindex exiting (@code{ex}) +The @code{ex} request also causes @code{gtroff} to stop processing; +see also @ref{I/O}. @endDefreq When doing something involved it is useful to leave the debugging @@ -8721,50 +12113,122 @@ To activate these statements say groff -rDB=1 file @endExample -@c XXX .tm1, .tmc requests - If it is known in advance that there will be many errors and no useful output, @code{gtroff} can be forced to suppress formatted output with the @option{-z} flag. -@cindex dumping symbol table -@cindex symbol table, dumping @Defreq {pm, } -The @code{pm} request prints out the entire symbol table on @code{stderr}. +@cindex dumping symbol table (@code{pm}) +@cindex symbol table, dumping (@code{pm}) +Print the entire symbol table on @code{stderr}. Names of all defined +macros, strings, and diversions are print together with their size in +bytes. Since @code{gtroff} sometimes adds nodes by itself, the +returned size can be larger than expected. + +This request differs from @acronym{UNIX} @code{troff}: @code{gtroff} +reports the sizes of diversions, ignores an additional argument to +print only the total of the sizes, and the size isn't returned in +blocks of 128 characters. @endDefreq -@cindex dumping number registers -@cindex number registers, dumping @Defreq {pnr, } -Prints the names and contents of all +@cindex dumping number registers (@code{pnr}) +@cindex number registers, dumping (@code{pnr}) +Print the names and contents of all currently defined number registers on @code{stderr}. @endDefreq -@cindex dumping traps -@cindex traps, dumping @Defreq {ptr, } -Prints the names and positions of all traps +@cindex dumping traps (@code{ptr}) +@cindex traps, dumping (@code{ptr}) +Print the names and positions of all traps (not including input line traps and diversion traps) on @code{stderr}. Empty slots in the page trap list are printed as well, because they can affect the priority of subsequently planted traps. @endDefreq -@cindex flush output -@cindex output, flush +@Defreq {fl, } +@cindex flush output (@code{fl}) +@cindex output, flush (@code{fl}) @cindex interactive use of @code{gtroff} @cindex @code{gtroff}, interactive use -@Defreq {fl, } -Instructs @code{gtroff} to flush its output -immediately. The intent is for interactive use. -@code{gtroff}; there is little other use for it. This -request causes a line break. +Instruct @code{gtroff} to flush its output immediately. The intent +is for interactive use, but this behaviour is currently not +implemented in @code{gtroff}. Contrary to @acronym{UNIX} @code{troff}, +TTY output is sent to a device driver also (@code{grotty}), making it +non-trivial to communicate interactively. + +This request causes a line break. @endDefreq -@cindex backtrace of input stack -@cindex input stack, backtrace @Defreq {backtrace, } -The @code{backtrace} request prints a backtrace of the input stack -to the standard error stream. +@cindex backtrace of input stack (@code{backtrace}) +@cindex input stack, backtrace (@code{backtrace}) +Print a backtrace of the input stack to the standard error stream. + +Consider the following in file @file{test}: + +@Example +.de xxx +. backtrace +.. +.de yyy +. xxx +.. +. +.yyy +@endExample + +@noindent +On execution, @code{gtroff} prints the following: + +@Example +test:2: backtrace: macro `xxx' +test:5: backtrace: macro `yyy' +test:8: backtrace: file `test' +@endExample + +The option @option{-b} of @code{gtroff} internally calls a variant of +this request on each error and warning. +@endDefreq + +@Defreg {slimit} +@cindex input stack, setting limit +Use the @code{slimit} number register +to set the maximum number of objects on the input stack. +If @code{slimit} is less than or equal to@w{ }0, +there is no limit set. +With no limit, a buggy recursive macro can exhaust virtual memory. + +The default value is 1000; this is a compile-time constant. +@endDefreg + +@Defreq {warnscale, si} +Set the scaling indicator used in warnings to @var{si}. Valid values for +@var{si} are @samp{u}, @samp{i}, @samp{c}, @samp{p}, and @samp{P}. At +startup, it is set to @samp{i}. +@endDefreq + +@Defreq {spreadwarn, [@Var{limit}]} +Make @code{gtroff} emit a warning if the additional space inserted for +each space between words in an output line is larger or equal to +@var{limit}. A negative value is changed to zero; no argument toggles the +warning on and off without changing @var{limit}. The default scaling +indicator is @samp{m}. At startup, @code{spreadwarn} is deactivated, and +@var{limit} is set to 3@dmn{m}. + +For example, + +@Example +.spreadwarn 0.2m +@endExample + +@noindent +will cause a warning if @code{gtroff} must add 0.2@dmn{m} or more for each +interword space in a line. + +This request is active only if text is justified to both margins (using +@w{@samp{.ad b}}). @endDefreq @cindex warnings @@ -8772,16 +12236,16 @@ to the standard error stream. (@option{-w}) and for printing backtraces (@option{-b}) when a warning or an error occurs. The most verbose level of warnings is @option{-ww}. -@cindex level of warnings -@cindex warnings, level -@Defreq {warn, [@Var{flags}]} -@Defregx {.warn} -Controls the level of warnings checked for. The @var{flags} are the sum +@DefreqList {warn, [@Var{flags}]} +@DefregListEnd {.warn} +@cindex level of warnings (@code{warn}) +@cindex warnings, level (@code{warn}) +Control the level of warnings checked for. The @var{flags} are the sum of the numbers associated with each warning that is to be enabled; all other warnings are disabled. The number associated with each warning is listed below. For example, @w{@code{.warn 0}} disables all warnings, and @w{@code{.warn 1}} disables all warnings except that about missing -characters. If an argument is not given, all warnings are enabled. +glyphs. If no argument is given, all warnings are enabled. The read-only number register @code{.warn} contains the current warning level. @@ -8805,7 +12269,9 @@ the @option{-w} and @option{-W} options; the number is used by the @table @samp @item char @itemx 1 -Non-existent characters. This is enabled by default. +Non-existent glyphs.@footnote{@code{char} is a misnomer since it reports +missing glyphs -- there aren't missing input characters, only invalid +ones.} This is enabled by default. @item number @itemx 2 @@ -8825,8 +12291,8 @@ Missing or mismatched closing delimiters. @item el @itemx 16 -@rqindex ie -@rqindex el +@cindex @code{ie} request, and warnings +@cindex @code{el} request, and warnings Use of the @code{el} request with no matching @code{ie} request. @xref{if-else}. @@ -8844,55 +12310,61 @@ Dubious syntax in numeric expressions. @item di @itemx 256 -@rqindex di -@rqindex da -@cindex @code{di}, debugging -@cindex @code{da}, debugging +@cindex @code{di} request, and warnings +@cindex @code{da} request, and warnings Use of @code{di} or @code{da} without an argument when there is no current diversion. @item mac @itemx 512 -@rqindex de -@c XXX more index entries +@cindex @code{de}, @code{de1}, @code{dei} requests, and warnings +@cindex @code{am}, @code{am1}, @code{ami} requests, and warnings +@cindex @code{ds}, @code{ds1} requests, and warnings +@cindex @code{as}, @code{as1} requests, and warnings +@cindex @code{di} request, and warnings +@cindex @code{da} request, and warnings +@cindex @code{box}, @code{boxa} requests, and warnings +@cindex @code{\*}, and warnings Use of undefined strings, macros and diversions. When an undefined -string, macro or diversion is used, that string is automatically defined -as empty. So, in most cases, at most one warning is given for each -name. +string, macro, or diversion is used, that string is automatically +defined as empty. So, in most cases, at most one warning is given +for each name. -@item reg +@item reg @itemx 1024 -@rqindex nr -@c XXX more index entries +@cindex @code{nr} request, and warnings +@cindex @code{\R}, and warnings +@cindex @code{\n}, and warnings Use of undefined number registers. When an undefined number register is used, that register is automatically defined to have a value of@w{ }0. -A definition is automatically made with a value of@w{ }0. So, in most -cases, at most one warning is given for use of a particular name. +So, in most cases, at most one warning is given for use of a particular +name. -@item tab +@item tab @itemx 2048 +@cindex @code{\t}, and warnings Use of a tab character where a number was expected. -@item right-brace +@item right-brace @itemx 4096 -@esindex \@} -@cindex @code{\@}}, debugging +@cindex @code{\@}}, and warnings Use of @code{\@}} where a number was expected. -@item missing +@item missing @itemx 8192 Requests that are missing non-optional arguments. -@item input +@item input @itemx 16384 -Illegal input characters. +Invalid input characters. -@item escape +@item escape @itemx 32768 -Unrecognized escape sequences. When an unrecognized escape sequence is -encountered, the escape character is ignored. +Unrecognized escape sequences. When an unrecognized escape sequence +@code{\@var{X}} is encountered, the escape character is ignored, and +@var{X} is printed. -@item space +@item space @itemx 65536 @cindex compatibility mode Missing space between a request or macro and its argument. This warning @@ -8902,10 +12374,19 @@ name. The request or macro is not invoked. When this warning is given, no macro is automatically defined. This is enabled by default. This warning never occurs in compatibility mode. -@item font +@item font @itemx 131072 Non-existent fonts. This is enabled by default. +@item ig +@itemx 262144 +Invalid escapes in text ignored with the @code{ig} request. These are +conditions that are errors when they do not occur in ignored text. + +@item color +@itemx 524288 +Color related warnings. + @item all All warnings except @samp{di}, @samp{mac} and @samp{reg}. It is intended that this covers all warnings that are useful with traditional @@ -8918,11 +12399,11 @@ All warnings. @c ===================================================================== -@node Implementation Differences, Summary, Debugging, gtroff Reference +@node Implementation Differences, , Debugging, gtroff Reference @section Implementation Differences @cindex implementation differences @cindex differences in implementation -@cindex incompatibilities with Unix @code{troff} +@cindex incompatibilities with @acronym{AT&T} @code{troff} @cindex compatibility mode @cindex mode, compatibility @@ -8938,12 +12419,8 @@ interprets .dsabcd @endExample -@esindex \* -@esindex \n -@cindex @code{\*}, incompatibilities with Unix @code{troff} -@cindex @code{\n}, incompatibilities with Unix @code{troff} -@rqindex cp -@vindex .C +@cindex @code{\*}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\n}, incompatibilities with @acronym{AT&T} @code{troff} @noindent as defining a string @samp{ab} with contents @samp{cd}. Normally, GNU @code{troff} interprets this as a call of a macro named @@ -8953,25 +12430,83 @@ called @samp{[}. In GNU @code{troff}, however, this is normally interpreted as the start of a long name. In compatibility mode GNU @code{troff} interprets long names in the traditional way (which means that they are not recognized as names). -Compatibility mode can be turned on with the @option{-C} command line -option, and turned on or off with the @code{cp} request. The number -register @code{.C} is@w{ }1 if compatibility mode is on, 0@w{ -}otherwise. - -@esindex \A -@esindex \| -@esindex \^ -@esindex \& -@esindex \@{ -@esindex \@} -@esindex \@key{SP} -@esindex \' -@esindex \` -@esindex \- -@esindex \_ -@esindex \! -@esindex \% -@esindex \c + +@DefreqList {cp, [@Var{n}]} +@DefreqItem {do, cmd} +@DefregListEnd {.C} +If @var{n} is missing or non-zero, turn on compatibility mode; +otherwise, turn it off. + +The read-only number register @code{.C} is@w{ }1 if compatibility mode is +on, 0@w{ }otherwise. + +Compatibility mode can be also turned on with the @option{-C} command line +option. + +The @code{do} request turns off compatibility mode +while executing its arguments as a @code{gtroff} command. + +@Example +.do fam T +@endExample + +@noindent +executes the @code{fam} request when compatibility mode +is enabled. + +@code{gtroff} restores the previous compatibility setting +before interpreting any files sourced by the @var{cmd}. +@endDefreq + +@cindex input level in delimited arguments +@cindex delimited arguments, incompatibilities with @acronym{AT&T} @code{troff} +Two other features are controlled by @option{-C}. If not in +compatibility mode, GNU @code{troff} preserves the input level in +delimited arguments: + +@Example +.ds xx ' +\w'abc\*(xxdef' +@endExample + +@noindent +In compatibility mode, the string @samp{72def'} is returned; without +@option{-C} the resulting string is @samp{168} (assuming a TTY output +device). + +@cindex @code{\f}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\H}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\s}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\S}, incompatibilities with @acronym{AT&T} @code{troff} +Finally, the escapes @code{\f}, @code{\H}, @code{\m}, @code{\M}, +@code{\R}, @code{\s}, and @code{\S} are transparent for recognizing the +beginning of a line only in compatibility mode (this is a rather obscure +feature). For example, the code + +@Example +.de xx +Hallo! +.. +\fB.xx\fP +@endExample + +prints @samp{Hallo!} in bold face if in compatibility mode, and +@samp{.xx} in bold face otherwise. + +@cindex @code{\A}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\|}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\^}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\&}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\@{}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\@}}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\@key{SP}}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\'}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\`}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\-}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\_}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\!}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\%}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\c}, incompatibilities with @acronym{AT&T} @code{troff} GNU @code{troff} does not allow the use of the escape sequences @code{\|}, @code{\^}, @code{\&}, @code{\@{}, @code{\@}}, @code{\@key{SP}}, @code{\'}, @code{\`}, @code{\-}, @code{\_}, @code{\!}, @@ -8981,9 +12516,11 @@ registers, fonts or environments; @acronym{UNIX} @code{troff} does. The avoiding use of these escape sequences in names. @cindex fractional point sizes +@cindex fractional type sizes @cindex point sizes, fractional -@rqindex ps -@cindex @code{ps}, incompatibilities with Unix @code{troff} +@cindex type sizes, fractional +@cindex sizes, fractional +@cindex @code{ps} request, incompatibilities with @acronym{AT&T} @code{troff} Fractional point sizes cause one noteworthy incompatibility. In @acronym{UNIX} @code{troff} the @code{ps} request ignores scale indicators and thus @@ -8997,30 +12534,25 @@ sets the point size to 10@w{ }points, whereas in GNU @code{troff} it sets the point size to 10@w{ }scaled points. @xref{Fractional Type Sizes}, for more information. -@rqindex bd -@rqindex cs -@rqindex tkf -@rqindex tr -@rqindex fp -@cindex @code{bd}, incompatibilities with Unix @code{troff} -@cindex @code{cs}, incompatibilities with Unix @code{troff} -@cindex @code{tkf}, incompatibilities with Unix @code{troff} -@cindex @code{tr}, incompatibilities with Unix @code{troff} -@cindex @code{fp}, incompatibilities with Unix @code{troff} -@cindex input and output characters, compatibility with Unix -@cindex output characters, compatibility with Unix -@cindex characters, input and output, compatibility with Unix +@cindex @code{bd} request, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{cs} request, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{tr} request, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{fp} request, incompatibilities with @acronym{AT&T} @code{troff} +@cindex input characters and output glyphs, compatibility with @acronym{AT&T} @code{troff} +@cindex output glyphs, and input characters,compatibility with @acronym{AT&T} @code{troff} +@cindex characters, input, and output glyphs, compatibility with @acronym{AT&T} @code{troff} +@cindex glyphs, output, and input characters, compatibility with @acronym{AT&T} @code{troff} In GNU @code{troff} there is a fundamental difference between -unformatted, input characters, and formatted, output characters. -Everything that affects how an output character is output is stored -with the character; once an output character has been constructed it is +(unformatted) input characters and (formatted) output glyphs. +Everything that affects how a glyph is output is stored +with the glyph node; once a glyph node has been constructed it is unaffected by any subsequent requests that are executed, including @code{bd}, @code{cs}, @code{tkf}, @code{tr}, or @code{fp} requests. -Normally output characters are constructed from input characters at the -moment immediately before the character is added to the current output +Normally glyphs are constructed from input characters at the +moment immediately before the glyph is added to the current output line. Macros, diversions and strings are all, in fact, the same type of -object; they contain lists of input characters and output characters in -any combination. An output character does not behave like an input +object; they contain lists of input characters and glyph nodes in +any combination. A glyph node does not behave like an input character for the purposes of macro processing; it does not inherit any of the special properties that the input character from which it was constructed might have had. For example, @@ -9033,14 +12565,13 @@ constructed might have had. For example, .x @endExample -@esindex \e -@esindex \! -@esindex \? -@cindex @code{\e}, incompatibilities with Unix @code{troff} -@cindex @code{\!}, incompatibilities with Unix @code{troff} -@cindex @code{\?}, incompatibilities with Unix @code{troff} -@cindex transparent output, incompatibilities with Unix @code{troff} -@cindex output, transparent, incompatibilities with Unix @code{troff} +@cindex printing backslash (@code{\\}, @code{\e}, @code{\E}, @code{\[rs]}) +@cindex backslash, printing (@code{\\}, @code{\e}, @code{\E}, @code{\[rs]}) +@cindex @code{\e}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\!}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex @code{\?}, incompatibilities with @acronym{AT&T} @code{troff} +@cindex transparent output, incompatibilities with @acronym{AT&T} @code{troff} +@cindex output, transparent, incompatibilities with @acronym{AT&T} @code{troff} @noindent prints @samp{\\} in GNU @code{troff}; each pair of input backslashes is turned into one output backslash and the resulting output backslashes @@ -9051,24 +12582,14 @@ correct way to obtain a printable backslash is to use the @code{\e} escape sequence: This always prints a single instance of the current escape character, regardless of whether or not it is used in a diversion; it also works in both GNU @code{troff} and @acronym{UNIX} -@code{troff}. To store, for some reason, an escape sequence in a +@code{troff}.@footnote{To be completely independent of the current +escape character, use @code{\(rs} which represents a reverse solidus +(backslash) glyph.} To store, for some reason, an escape sequence in a diversion that will be interpreted when the diversion is reread, either use the traditional @code{\!} transparent output facility, or, if this is unsuitable, the new @code{\?} escape sequence. -@c XXX .tl compatibility mode -> input stack level -@c XXX .if compatibility mode -> input stack level - -@xref{Diversions}, for more information. - - -@c ===================================================================== - -@node Summary, , Implementation Differences, gtroff Reference -@section Summary -@cindex summary - -@c XXX documentation +@xref{Diversions}, and @ref{Gtroff Internals}, for more information. @@ -9097,8 +12618,8 @@ which are freely available. @node geqn, gtbl, Preprocessors, Preprocessors @section @code{geqn} -@cindex @code{eqn} -@cindex @code{geqn} +@cindex @code{eqn}, the program +@cindex @code{geqn}, the program @c XXX @@ -9120,8 +12641,8 @@ which are freely available. @node gtbl, gpic, geqn, Preprocessors @section @code{gtbl} -@cindex @code{tbl} -@cindex @code{gtbl} +@cindex @code{tbl}, the program +@cindex @code{gtbl}, the program @c XXX @@ -9143,8 +12664,8 @@ which are freely available. @node gpic, ggrn, gtbl, Preprocessors @section @code{gpic} -@cindex @code{pic} -@cindex @code{gpic} +@cindex @code{pic}, the program +@cindex @code{gpic}, the program @c XXX @@ -9166,8 +12687,8 @@ which are freely available. @node ggrn, grap, gpic, Preprocessors @section @code{ggrn} -@cindex @code{grn} -@cindex @code{ggrn} +@cindex @code{grn}, the program +@cindex @code{ggrn}, the program @c XXX @@ -9189,7 +12710,7 @@ which are freely available. @node grap, grefer, ggrn, Preprocessors @section @code{grap} -@cindex @code{grap} +@cindex @code{grap}, the program A free implementation of @code{grap}, written by Ted Faber, is available as an extra package from the following address: @@ -9203,8 +12724,8 @@ is available as an extra package from the following address: @node grefer, gsoelim, grap, Preprocessors @section @code{grefer} -@cindex @code{refer} -@cindex @code{grefer} +@cindex @code{refer}, the program +@cindex @code{grefer}, the program @c XXX @@ -9226,8 +12747,8 @@ is available as an extra package from the following address: @node gsoelim, , grefer, Preprocessors @section @code{gsoelim} -@cindex @code{soelim} -@cindex @code{gsoelim} +@cindex @code{soelim}, the program +@cindex @code{gsoelim}, the program @c XXX @@ -9284,7 +12805,7 @@ is available as an extra package from the following address: @node grotty, grops, Special Characters, Output Devices @section @code{grotty} -@cindex @code{grotty} +@cindex @code{grotty}, the program @c XXX @@ -9301,12 +12822,29 @@ is available as an extra package from the following address: @c XXX +@c The following is no longer true; fix and extend it. + +@c @pindex less +@c @cindex Teletype +@c @cindex ISO 6249 SGR +@c @cindex terminal control sequences +@c @cindex control sequences, for terminals +@c For TTY output devices, underlining is done by emitting sequences of +@c @samp{_} and @samp{\b} (the backspace character) before the actual +@c character. Literally, this is printing an underline character, then +@c moving back one character position, and printing the actual character +@c at the same position as the underline character (similar to a +@c typewriter). Usually, a modern terminal can't interpret this (and the +@c original Teletype machines for which this sequence was appropriate are +@c no longer in use). You need a pager program like @code{less} which +@c translates this into ISO 6429 SGR sequences to control terminals. + @c ===================================================================== @node grops, grodvi, grotty, Output Devices @section @code{grops} -@cindex @code{grops} +@cindex @code{grops}, the program @c XXX @@ -9328,8 +12866,8 @@ is available as an extra package from the following address: @node Embedding PostScript, , Invoking grops, grops @subsection Embedding @sc{PostScript} -@cindex embedding postscript -@cindex postscript, embedding +@cindex embedding PostScript +@cindex PostScript, embedding @c XXX @@ -9338,7 +12876,7 @@ is available as an extra package from the following address: @node grodvi, grolj4, grops, Output Devices @section @code{grodvi} -@cindex @code{grodvi} +@cindex @code{grodvi}, the program @c XXX @@ -9360,7 +12898,7 @@ is available as an extra package from the following address: @node grolj4, grolbp, grodvi, Output Devices @section @code{grolj4} -@cindex @code{grolj4} +@cindex @code{grolj4}, the program @c XXX @@ -9382,7 +12920,7 @@ is available as an extra package from the following address: @node grolbp, grohtml, grolj4, Output Devices @section @code{grolbp} -@cindex @code{grolbp} +@cindex @code{grolbp}, the program @c XXX @@ -9404,29 +12942,64 @@ is available as an extra package from the following address: @node grohtml, gxditview, grolbp, Output Devices @section @code{grohtml} -@cindex @code{grohtml} +@cindex @code{grohtml}, the program @c XXX @menu * Invoking grohtml:: +* grohtml specific registers and strings:: @end menu @c --------------------------------------------------------------------- -@node Invoking grohtml, , grohtml, grohtml +@node Invoking grohtml, grohtml specific registers and strings, grohtml, grohtml @subsection Invoking @code{grohtml} @cindex invoking @code{grohtml} @cindex @code{grohtml}, invoking @c XXX +@c --------------------------------------------------------------------- + +@node grohtml specific registers and strings, , Invoking grohtml, grohtml +@subsection @code{grohtml} specific registers and strings +@cindex registers specific to @code{grohtml} +@cindex strings specific to @code{grohtml} +@cindex @code{grohtml}, registers and strings + +@DefmpregList {ps4html, grohtml} +@DefstrListEnd {www-image-template, grohtml} +The registers @code{ps4html} and @code{www-image-template} are defined +by the @code{pre-grohtml} preprocessor. @code{pre-grohtml} reads in +the @code{troff} input, marks up the inline equations and passes the +result firstly to + +@Example +troff -Tps -rps4html=1 -dwww-image-template=@var{template} +@endExample + +@noindent +and secondly to + +@Example +troff -Thtml +@endExample + +The PostScript device is used to create all the image files, and the +register @code{ps4html} enables the macro sets to ignore floating +keeps, footers, and headings. + +The register @code{www-image-template} is set to the user specified +template name or the default name. +@endDefmpreg + @c ===================================================================== @node gxditview, , grohtml, Output Devices @section @code{gxditview} -@cindex @code{gxditview} +@cindex @code{gxditview}, the program @c XXX @@ -9454,7 +13027,8 @@ is available as an extra package from the following address: @cindex file formats @cindex formats, file -@c XXX +All files read and written by @code{gtroff} are text files. The +following two sections describe their format. @menu * gtroff Output:: @@ -9466,280 +13040,887 @@ is available as an extra package from the following address: @node gtroff Output, Font Files, File formats, File formats @section @code{gtroff} Output -@cindex @code{gtroff} output +@cindex @code{gtroff}, output @cindex output, @code{gtroff} -This section describes the format output of GNU @code{troff}. The -output format used by GNU @code{troff} is very similar -- but -not identical -- to that used by -@acronym{UNIX} device-independent @code{troff} (@code{ditroff}). +This section describes the intermediate output format of GNU +@code{troff}. This output is produced by a run of @code{gtroff} +before it is fed into a device postprocessor program. + +As @code{groff} is a wrapper program around @code{gtroff} that +automatically calls a postprocessor, this output does not show up +normally. This is why it is called @dfn{intermediate}. +@code{groff} provides the option @option{-Z} to inhibit postprocessing, +such that the produced intermediate output is sent to standard output +just like calling @code{gtroff} manually. + +@cindex troff output +@cindex output, troff +@cindex intermediate output +@cindex output, intermediate +Here, the term @dfn{troff output} describes what is output by +@code{gtroff}, while @dfn{intermediate output} refers to the language +that is accepted by the parser that prepares this output for the +postprocessors. This parser is smarter on whitespace and implements +obsolete elements for compatibility, otherwise both formats are the +same.@footnote{The parser and postprocessor for intermediate output +can be found in the file@* +@file{@var{groff-source-dir}/src/libs/libdriver/input.cc}.} + +The main purpose of the intermediate output concept is to facilitate +the development of postprocessors by providing a common programming +interface for all devices. It has a language of its own that is +completely different from the @code{gtroff} language. While the +@code{gtroff} language is a high-level programming language for text +processing, the intermediate output language is a kind of low-level +assembler language by specifying all positions on the page for writing +and drawing. + +The intermediate output produced by @code{gtroff} is fairly readable, +while output from @acronym{AT&T} @code{troff} is rather hard to +understand because of strange habits that are still supported, but not +used any longer by @code{gtroff}. @menu -* Output Format:: -* Device Control:: -* Drawing Functions:: -* Line Continuation:: +* Language Concepts:: +* Command Reference:: +* Intermediate Output Examples:: +* Output Language Compatibility:: @end menu @c --------------------------------------------------------------------- -@node Output Format, Device Control, gtroff Output, gtroff Output -@subsection Output Format -@cindex output format -@cindex format of output +@node Language Concepts, Command Reference, gtroff Output, gtroff Output +@subsection Language Concepts -@cindex 8-bit input -@cindex input, 8-bit -The output format is text based, as opposed to a binary format (like -@TeX{} DVI). The output format is @w{8-bit} clean, thus single -characters can have the eighth bit set, as can the names of fonts and -special characters. +During the run of @code{gtroff}, the input data is cracked down to the +information on what has to be printed at what position on the intended +device. So the language of the intermediate output format can be quite +small. Its only elements are commands with and without arguments. +In this section, the term @dfn{command} always refers to the intermediate +output language, and never to the @code{gtroff} language used for document +formatting. There are commands for positioning and text writing, for drawing, and +for device controlling. -The output format consists of single command characters with attached -parameters which are separated from subsequent text by whitespace or a -newline. +@menu +* Separation:: +* Argument Units:: +* Document Parts:: +@end menu -The names of characters and fonts can be of arbitrary length; drivers -should not assume that they are only two characters long (as -@code{ditroff} does). +@node Separation, Argument Units, Language Concepts, Language Concepts +@subsubsection Separation + +@acronym{AT&T} @code{troff} output has strange requirements on whitespace. +The @code{gtroff} output parser, however, is smart about whitespace by +making it maximally optional. The whitespace characters, i.e., the +tab, space, and newline characters, always have a syntactical meaning. +They are never printable because spacing within the output is always +done by positioning commands. + +Any sequence of space or tab characters is treated as a single +@dfn{syntactical space}. It separates commands and arguments, but is +only required when there would occur a clashing between the command code +and the arguments without the space. Most often, this happens when +variable-length command names, arguments, argument lists, or command +clusters meet. Commands and arguments with a known, fixed length need +not be separated by syntactical space. + +A line break is a syntactical element, too. Every command argument can be +followed by whitespace, a comment, or a newline character. Thus a +@dfn{syntactical line break} is defined to consist of optional +syntactical space that is optionally followed by a comment, and a +newline character. + +The normal commands, those for positioning and text, consist of a +single letter taking a fixed number of arguments. For historical reasons, +the parser allows to stack such commands on the same line, but +fortunately, in @code{gtroff}'s intermediate output, every command with +at least one argument is followed by a line break, thus providing +excellent readability. + +The other commands -- those for drawing and device controlling -- +have a more complicated structure; some recognize long command names, +and some take a variable number of arguments. So all @samp{D} and +@samp{x} commands were designed to request a syntactical line break +after their last argument. Only one command, @w{@samp{x X}}, +has an argument that can stretch over several lines; all other +commands must have all of their arguments on the same line as the +command, i.e., the arguments may not be splitted by a line break. + +Empty lines (these are lines containing only space and/or a comment), can +occur everywhere. They are just ignored. + +@node Argument Units, Document Parts, Separation, Language Concepts +@subsubsection Argument Units + +Some commands take integer arguments that are assumed to represent +values in a measurement unit, but the letter for the corresponding +scale indicator is not written with the output command arguments. +Most commands assume the scale indicator @samp{u}, the basic unit of +the device, some use @samp{z}, the scaled point unit of the device, +while others, such as the color commands, expect plain integers. + +Note that single characters can have the eighth bit set, as can the +names of fonts and special characters. The names of characters and +fonts can be of arbitrary length. A character that is to be printed +will always be in the current font. + +A string argument is always terminated by the next whitespace +character (space, tab, or newline); an embedded @samp{#} character is +regarded as part of the argument, not as the beginning of a comment +command. An integer argument is already terminated by the next +non-digit character, which then is regarded as the first character of +the next argument or command. + +@node Document Parts, , Argument Units, Language Concepts +@subsubsection Document Parts + +A correct intermediate output document consists of two parts, the +@dfn{prologue} and the @dfn{body}. + +The task of the prologue is to set the general device parameters +using three exactly specified commands. @code{gtroff}'s prologue +is guaranteed to consist of the following three lines (in that order): + +@Example +x T @var{device} +x res @var{n} @var{h} @var{v} +x init +@endExample -When a character is to be printed, that character is always in the -current font. Unlike @code{ditroff}, it is not necessary for drivers to -search special fonts to find a character. +@noindent +with the arguments set as outlined in @ref{Device Control Commands}. +Note that the parser for the intermediate output format is able to +swallow additional whitespace and comments as well even in the +prologue. + +The body is the main section for processing the document data. +Syntactically, it is a sequence of any commands different from the +ones used in the prologue. Processing is terminated as soon as the +first @w{@samp{x stop}} command is encountered; the last line of any +@code{gtroff} intermediate output always contains such a command. + +Semantically, the body is page oriented. A new page is started by a +@samp{p} command. Positioning, writing, and drawing commands are +always done within the current page, so they cannot occur before the +first @samp{p} command. Absolute positioning (by the @samp{H} and +@samp{V} commands) is done relative to the current page; all other +positioning is done relative to the current location within this page. -@table @code -@item H@var{n} -@c XXX +@c --------------------------------------------------------------------- -@item V@var{n} -@c XXX +@node Command Reference, Intermediate Output Examples, Language Concepts, gtroff Output +@subsection Command Reference -@item h@var{n} -@c XXX +This section describes all intermediate output commands, both from +@acronym{AT&T} @code{troff} as well as the @code{gtroff} extensions. -@item v@var{n} -@c XXX +@menu +* Comment Command:: +* Simple Commands:: +* Graphics Commands:: +* Device Control Commands:: +* Obsolete Command:: +@end menu -@item c@var{n} -@c XXX +@node Comment Command, Simple Commands, Command Reference, Command Reference +@subsubsection Comment Command -@item C@var{n} -@c XXX +@table @code +@item #@var{anything}@angles{end of line} +A comment. Ignore any characters from the @samp{#} character up to +the next newline character. -@item @var{nn}@var{c} -@c XXX +This command is the only possibility for commenting in the intermediate +output. Each comment can be preceded by arbitrary syntactical space; +every command can be terminated by a comment. +@end table -@item t@var{xxx} -@var{xxx} is any sequence of characters terminated by a space or a -newline; the first character should be printed at the current position, -the the current horizontal position should be increased by the width of -the first character, and so on for each character. The width of the -character is that given in the font file, appropriately scaled for the -current point size, and rounded so that it is a multiple of the -horizontal resolution. Special characters cannot be printed using this -command. +@node Simple Commands, Graphics Commands, Comment Command, Command Reference +@subsubsection Simple Commands -@kindex tcommand -@pindex DESC@r{, and @code{tcommand}} -This command is only allowed if the @samp{tcommand} line is present in -the @file{DESC} file. +The commands in this subsection have a command code consisting of a +single character, taking a fixed number of arguments. Most of them +are commands for positioning and text writing. These commands are +smart about whitespace. Optionally, syntactical space can be inserted +before, after, and between the command letter and its arguments. +All of these commands are stackable, i.e., they can be preceded by +other simple commands or followed by arbitrary other commands on the +same line. A separating syntactical space is only necessary when two +integer arguments would clash or if the preceding argument ends with a +string argument. + +@table @code +@ignore +.if (\n[@USE_ENV_STACK] == 1) \{\ +.command { +Open a new environment by copying the actual device configuration data +to the environment stack. +. +The current environment is setup by the device specification and +manipulated by the setting commands. +. +. +.command } +Close the actual environment (opened by a preceding +.BR { \~command) +and restore the previous environment from the environment +stack as the actual device configuration data. +. +\} \" endif @USE_ENV_STACK +@end ignore -@item u@var{n} @var{xxx} -This is same as the @samp{t} command except that after printing each -character, the current horizontal position is increased by the sum of -the width of that character and@w{ }@var{n}. +@item C @var{xxx}@angles{whitespace} +Print a special character named @var{xxx}. The trailing +syntactical space or line break is necessary to allow glyph names +of arbitrary length. The glyph is printed at the current print +position; the glyph's size is read from the font file. The print +position is not changed. + +@item c @var{g} +Print glyph@w{ }@var{g} at the current print position;@footnote{@samp{c} +is actually a misnomer since it outputs a glyph.} the glyph's size is +read from the font file. The print position is not changed. + +@item f @var{n} +Set font to font number@w{ }@var{n} (a non-negative integer). + +@item H @var{n} +Move right to the absolute vertical position@w{ }@var{n} (a +non-negative integer in basic units @samp{u} relative to left edge +of current page. + +@item h @var{n} +Move @var{n} (a non-negative integer) basic units @samp{u} horizontally +to the right. The original @acronym{UNIX} troff manual allows negative +values for @var{n} also, but @code{gtroff} doesn't use this. + +@item m @var{color-scheme} @r{[}@var{component} @dots{}@r{]} +Set the color for text (glyphs), line drawing, and the outline of +graphic objects using different color schemes; the analoguous command +for the filling color of graphic objects is @samp{DF}. The color +components are specified as integer arguments between 0 and 65536. +The number of color components and their meaning vary for the +different color schemes. These commands are generated by +@code{gtroff}'s escape sequence @code{\m}. No position changing. +These commands are a @code{gtroff} extension. -This command is only allowed if the @samp{tcommand} line is present in -the @file{DESC} file. +@table @code +@item mc @var{cyan} @var{magenta} @var{yellow} +Set color using the CMY color scheme, having the 3@w{ }color components +@var{cyan}, @var{magenta}, and @var{yellow}. -@item n@var{a}@var{b} -@c XXX +@item md +Set color to the default color value (black in most cases). +No component arguments. -@item p@var{n} -@c XXX +@item mg @var{gray} +Set color to the shade of gray given by the argument, an integer +between 0 (black) and 65536 (white). -@item s@var{n} -@kindex sizescale -@pindex DESC@r{, and @code{sizescale}} -The argument to the @samp{s} command is in scaled points (units of -points/@var{n}, where @var{n} is the argument to the @samp{sizescale} -command in the @file{DESC} file). +@item mk @var{cyan} @var{magenta} @var{yellow} @var{black} +Set color using the CMYK color scheme, having the 4@w{ }color components +@var{cyan}, @var{magenta}, @var{yellow}, and @var{black}. -@item f@var{n} -@item x @dots{} \n -Device control. -@c XXX more info +@item mr @var{red} @var{green} @var{blue} +Set color using the RGB color scheme, having the 3@w{ }color components +@var{red}, @var{green}, and @var{blue}. -@item D@var{c} @var{x}@dots{}\n -@c XXX @end table -@c --------------------------------------------------------------------- +@item N @var{n} +Print glyph with index@w{ }@var{n} (a non-negative integer) of the +current font. This command is a @code{gtroff} extension. + +@item n @var{b} @var{a} +Inform the device about a line break, but no positioning is done by +this command. In @acronym{AT&T} @code{troff}, the integer arguments +@var{b} and@w{ }@var{a} informed about the space before and after the +current line to make the intermediate output more human readable +without performing any action. In @code{groff}, they are just ignored, but +they must be provided for compatibility reasons. + +@item p @var{n} +Begin a new page in the outprint. The page number is set +to@w{ }@var{n}. This page is completely independent of pages formerly +processed even if those have the same page number. The vertical +position on the outprint is automatically set to@w{ }0. All +positioning, writing, and drawing is always done relative to a page, +so a @samp{p} command must be issued before any of these commands. + +@item s @var{n} +Set point size to @var{n}@w{ }scaled points (this is unit @samp{z}). +@acronym{AT&T} @code{troff} used the unit points (@samp{p}) instead. +@xref{Output Language Compatibility}. + +@item t @var{xxx}@angles{whitespace} +@itemx t @var{xxx} @var{dummy-arg}@angles{whitespace} +Print a word, i.e., a sequence of characters @var{xxx} representing +output glyphs which names are single characters, terminated by +a space character or a line break; an optional second integer argument +is ignored (this allows the formatter to generate an even number of +arguments). The first glyph should be printed at the current +position, the current horizontal position should then be increased by +the width of the first glyph, and so on for each glyph. +The widths of the glyphs are read from the font file, scaled for the +current point size, and rounded to a multiple of the horizontal +resolution. Special characters cannot be printed using this command +(use the @samp{C} command for special characters). This command is a +@code{gtroff} extension; it is only used for devices whose @file{DESC} +file contains the @code{tcommand} keyword (@pxref{DESC File Format}). + +@item u @var{n} @var{xxx}@angles{whitespace} +Print word with track kerning. This is the same as the @samp{t} +command except that after printing each glyph, the current +horizontal position is increased by the sum of the width of that +glyph and@w{ }@var{n} (an integer in basic units @samp{u}). +This command is a @code{gtroff} extension; it is only used for devices +whose @file{DESC} file contains the @code{tcommand} keyword +(@pxref{DESC File Format}). + +@item V @var{n} +Move down to the absolute vertical position@w{ }@var{n} (a +non-negative integer in basic units @samp{u}) relative to upper edge +of current page. + +@item v @var{n} +Move @var{n}@w{ }basic units @samp{u} down (@var{n} is a non-negative +integer). The original @acronym{UNIX} troff manual allows negative +values for @var{n} also, but @code{gtroff} doesn't use this. -@node Device Control, Drawing Functions, Output Format, gtroff Output -@subsection Device Control -@cindex device control -@cindex control of devices +@item w +Informs about a paddable white space to increase readability. +The spacing itself must be performed explicitly by a move command. -The @samp{x} command is normally followed by a letter or word indicating -the function to perform, followed by white space separated arguments. +@end table -The first argument can be abbreviated to the first letter. +@node Graphics Commands, Device Control Commands, Simple Commands, Command Reference +@subsubsection Graphics Commands + +Each graphics or drawing command in the intermediate output starts +with the letter @samp{D}, followed by one or two characters that +specify a subcommand; this is followed by a fixed or variable number +of integer arguments that are separated by a single space character. +A @samp{D} command may not be followed by another command on the same line +(apart from a comment), so each @samp{D} command is terminated by a +syntactical line break. + +@code{gtroff} output follows the classical spacing rules (no space +between command and subcommand, all arguments are preceded by a +single space character), but the parser allows optional space between +the command letters and makes the space before the first argument +optional. As usual, each space can be any sequence of tab and space +characters. + +Some graphics commands can take a variable number of arguments. +In this case, they are integers representing a size measured in basic +units @samp{u}. The arguments called @var{h1}, @var{h2}, @dots{}, +@var{hn} stand for horizontal distances where positive means right, +negative left. The arguments called @var{v1}, @var{v2}, @dots{}, +@var{vn} stand for vertical distances where positive means down, +negative up. All these distances are offsets relative to the current +location. + +Unless indicated otherwise, each graphics command directly corresponds +to a similar @code{gtroff} @code{\D} escape sequence. @xref{Drawing +Requests}. + +Unknown @samp{D} commands are assumed to be device-specific. +Its arguments are parsed as strings; the whole information is then +sent to the postprocessor. + +In the following command reference, the syntax element +@angles{line break} means a syntactical line break as defined above. @table @code -@item x init -@c XXX +@item D~ @var{h1} @var{v1} @var{h2} @var{v2} @dots{} @var{hn} @var{vn}@angles{line break} +Draw B-spline from current position to offset (@var{h1},@var{v1}), +then to offset (@var{h2},@var{v2}), if given, etc.@: up to +(@var{hn},@var{vn}). This command takes a variable number of argument +pairs; the current position is moved to the terminal point of the drawn +curve. + +@item Da @var{h1} @var{v1} @var{h2} @var{v2}@angles{line break} +Draw arc from current position to +(@var{h1},@var{v1})@math{+}(@var{h2},@var{v2}) with center at +(@var{h1},@var{v1}); then move the current position to the final point +of the arc. + +@item DC @var{d}@angles{line break} +@itemx DC @var{d} @var{dummy-arg}@angles{line break} +Draw a solid circle using the current fill color with +diameter@w{ }@var{d} (integer in basic units @samp{u}) with leftmost +point at the current position; then move the current position to the +rightmost point of the circle. An optional second integer argument is +ignored (this allows the formatter to generate an even number of +arguments). This command is a @code{gtroff} extension. + +@item Dc @var{d}@angles{line break} +Draw circle line with diameter@w{ }@var{d} (integer in basic units +@samp{u}) with leftmost point at the current position; then move the +current position to the rightmost point of the circle. + +@item DE @var{h} @var{v}@angles{line break} +Draw a solid ellipse in the current fill color with a horizontal +diameter of@w{ }@var{h} and a vertical diameter of@w{ }@var{v} (both +integers in basic units @samp{u}) with the leftmost point at the +current position; then move to the rightmost point of the ellipse. +This command is a @code{gtroff} extension. + +@item De @var{h} @var{v}@angles{line break} +Draw an outlined ellipse with a horizontal diameter of@w{ }@var{h} +and a vertical diameter of@w{ }@var{v} (both integers in basic units +@samp{u}) with the leftmost point at current position; then move to +the rightmost point of the ellipse. + +@item DF @var{color-scheme} @r{[}@var{component} @dots{}@r{]}@angles{line break} +Set fill color for solid drawing objects using different color +schemes; the analoguous command for setting the color of text, line +graphics, and the outline of graphic objects is @samp{m}. +The color components are specified as integer arguments between 0 and +65536. The number of color components and their meaning vary for the +different color schemes. These commands are generated by @code{gtroff}'s +escape sequences @w{@code{\D'F @dots{}'}} and @code{\M} (with no other +corresponding graphics commands). No position changing. This command +is a @code{gtroff} extension. -@item x T -@c XXX +@table @code +@item DFc @var{cyan} @var{magenta} @var{yellow}@angles{line break} +Set fill color for solid drawing objects using the CMY color scheme, +having the 3@w{ }color components @var{cyan}, @var{magenta}, and +@var{yellow}. -@item x res @var{n} @var{h} @var{v} -@c XXX +@item DFd@angles{line break} +Set fill color for solid drawing objects to the default fill color value +(black in most cases). No component arguments. + +@item DFg @var{gray}@angles{line break} +Set fill color for solid drawing objects to the shade of gray given by +the argument, an integer between 0 (black) and 65536 (white). + +@item DFk @var{cyan} @var{magenta} @var{yellow} @var{black}@angles{line break} +Set fill color for solid drawing objects using the CMYK color scheme, +having the 4@w{ }color components @var{cyan}, @var{magenta}, @var{yellow}, +and @var{black}. + +@item DFr @var{red} @var{green} @var{blue}@angles{line break} +Set fill color for solid drawing objects using the RGB color scheme, +having the 3@w{ }color components @var{red}, @var{green}, and @var{blue}. -@item x H -@c XXX more info -The argument to the @w{@samp{x Height}} command is also in scaled -points. @end table -The first three output commands are guaranteed to be: +@item Df @var{n}@angles{line break} +The argument@w{ }@var{n} must be an integer in the range @math{-32767} +to 32767. -@Example -x T device -x res n h v -x init -@endExample +@table @asis +@item @math{0 @LE @var{n} @LE 1000} +Set the color for filling solid drawing objects to a shade of gray, +where 0 corresponds to solid white, 1000 (the default) to solid black, +and values in between to intermediate shades of gray; this is +obsoleted by command @samp{DFg}. -@noindent -For example, the input +@item @math{@var{n} @LT 0} or @math{@var{n} @LT 1000} +Set the filling color to the color that is currently being used for +the text and the outline, see command @samp{m}. For example, the +command sequence @Example -crunchy \fH\s+2frog\s0\fP!? +mg 0 0 65536 +Df -1 @endExample @noindent -produces +sets all colors to blue. -@c XXX example +@end table +@noindent +No position changing. This command is a @code{gtroff} extension. + +@item Dl @var{h} @var{v}@angles{line break} +Draw line from current position to offset (@var{h},@var{v}) (integers +in basic units @samp{u}); then set current position to the end of the +drawn line. + +@item Dp @var{h1} @var{v1} @var{h2} @var{v2} @dots{} @var{hn} @var{vn}@angles{line break} +Draw a polygon line from current position to offset (@var{h1},@var{v1}), +from there to offset (@var{h2},@var{v2}), etc.@: up to offset +(@var{hn},@var{vn}), and from there back to the starting position. +For historical reasons, the position is changed by adding the sum of +all arguments with odd index to the actual horizontal position and the +even ones to the vertical position. Although this doesn't make sense +it is kept for compatibility. @ignore -@Example -... sample output here ... -@endExample +As the polygon is closed, the end of drawing is the starting point, so +the position doesn't change. @end ignore +This command is a @code{gtroff} extension. -@c --------------------------------------------------------------------- +@item Dp @var{h1} @var{v1} @var{h2} @var{v2} @dots{} @var{hn} @var{vn}@angles{line break} +Draw a solid polygon in the current fill color rather than an outlined +polygon, using the same arguments and positioning as the corresponding +@samp{Dp} command. +@ignore +No position changing. +@end ignore +This command is a @code{gtroff} extension. + +@item Dt @var{n}@angles{line break} +Set the current line thickness to@w{ }@var{n} (an integer in basic +units @samp{u}) if @math{@var{n}>0}; if @math{@var{n}=0} select the +smallest available line thickness; if @math{@var{n}<0} set the line +thickness proportional to the point size (this is the default before +the first @samp{Dt} command was specified). For historical reasons, +the horizontal position is changed by adding the argument to the actual +horizontal position, while the vertical position is not changed. +Although this doesn't make sense it is kept for compatibility. +@ignore +No position changing. +@end ignore +This command is a @code{gtroff} extension. -@node Drawing Functions, Line Continuation, Device Control, gtroff Output -@subsection Drawing Functions -@cindex drawing functions -@cindex functions for drawing +@end table -@pindex gpic -The @samp{D} drawing command has been extended. These extensions are -used by GNU @code{pic} only if the @option{-x} option is given. +@node Device Control Commands, Obsolete Command, Graphics Commands, Command Reference +@subsubsection Device Control Commands + +Each device control command starts with the letter @samp{x}, +followed by a space character (optional or arbitrary space or tab in +@code{gtroff}) and a subcommand letter or word; each argument (if any) +must be preceded by a syntactical space. All @samp{x} commands are +terminated by a syntactical line break; no device control command can +be followed by another command on the same line (except a comment). + +The subcommand is basically a single letter, but to increase +readability, it can be written as a word, i.e., an arbitrary sequence +of characters terminated by the next tab, space, or newline character. +All characters of the subcommand word but the first are simply ignored. +For example, @code{gtroff} outputs the initialization command +@w{@samp{x i}} as @w{@samp{x init}} and the resolution command +@w{@samp{x r}} as @w{@samp{x res}}. -@xref{Drawing Requests}. +In the following, the syntax element @angles{line break} means a +syntactical line break (@pxref{Separation}). @table @code -@c XXX ... -@item Df @var{n} -Set the shade of gray to be used for filling solid objects to@w{ -}@var{n}; @var{n}@w{ }must be an integer between 0 and@w{ }1000, where 0 -corresponds solid white and 1000 to solid black, and values in between -correspond to intermediate shades of gray. This applies only to solid -circles, solid ellipses and solid polygons. By default, a level of@w{ -}1000 is used. Whatever color a solid object has, it should -completely obscure everything beneath it. A value greater than@w{ }1000 -or less than@w{ }0 can also be used: this means fill with the shade of -gray that is currently being used for lines and text. Normally this -is black, but some drivers may provide a way of changing this. - -@item DC @var{d} -Draw a solid circle with a diameter of@w{ }@var{d} with the leftmost -point at the current position. - -@item DE @var{dx} @var{dy} -Draw a solid ellipse with a horizontal diameter of@w{ }@var{dx} and a -vertical diameter of@w{ }@var{dy} with the leftmost point at the current -position. +@item xF @var{name}@angles{line break} +The @samp{F} stands for @var{Filename}. + +Use @var{name} as the intended name for the current file in error +reports. This is useful for remembering the original file name when +@code{gtroff} uses an internal piping mechanism. The input file is +not changed by this command. This command is a @code{gtroff} extension. + +@item xf @var{n} @var{s}@angles{line break} +The @samp{f} stands for @var{font}. + +Mount font position@w{ }@var{n} (a non-negative integer) with font +named@w{ }@var{s} (a text word). @xref{Font Positions}. + +@item xH @var{n}@angles{line break} +The @samp{H} stands for @var{Height}. + +Set glyph height to@w{ }@var{n} (a positive integer in scaled +points @samp{z}). @acronym{AT&T} @code{troff} uses the unit points +(@samp{p}) instead. @xref{Output Language Compatibility}. + +@item xi@angles{line break} +The @samp{i} stands for @var{init}. + +Initialize device. This is the third command of the prologue. + +@item xp@angles{line break} +The @samp{p} stands for @var{pause}. + +Parsed but ignored. The original @acronym{UNIX} troff manual writes + +@display +pause device, can be restarted +@end display + +@item xr @var{n} @var{h} @var{v}@angles{line break} +The @samp{r} stands for @var{resolution}. + +Resolution is@w{ }@var{n}, while @var{h} is the minimal horizontal +motion, and @var{v} the minimal vertical motion possible with this +device; all arguments are positive integers in basic units @samp{u} +per inch. This is the second command of the prologue. + +@item xS @var{n}@angles{line break} +The @samp{S} stands for @var{Slant}. + +Set slant to@w{ }@var{n} (an integer in basic units @samp{u}). + +@item xs@angles{line break} +The @samp{s} stands for @var{stop}. + +Terminates the processing of the current file; issued as the last +command of any intermediate troff output. + +@item xt@angles{line break} +The @samp{t} stands for @var{trailer}. + +Generate trailer information, if any. In @var{gtroff}, this is +actually just ignored. + +@item xT @var{xxx}@angles{line break} +The @samp{T} stands for @var{Typesetter}. + +Set name of device to word @var{xxx}, a sequence of characters ended +by the next white space character. The possible device names coincide +with those from the @code{groff} @option{-T} option. This is the first +command of the prologue. + +@item xu @var{n}@angles{line break} +The @samp{u} stands for @var{underline}. + +Configure underlining of spaces. If @var{n} is@w{ }1, start +underlining of spaces; if @var{n} is@w{ }0, stop underlining of spaces. +This is needed for the @code{cu} request in nroff mode and is ignored +otherwise. This command is a @code{gtroff} extension. + +@item xX @var{anything}@angles{line break} +The @samp{x} stands for @var{X-escape}. + +Send string @var{anything} uninterpreted to the device. If the line +following this command starts with a @samp{+} character this line is +interpreted as a continuation line in the following sense. The +@samp{+} is ignored, but a newline character is sent instead to the +device, the rest of the line is sent uninterpreted. The same applies +to all following lines until the first character of a line is not a +@samp{+} character. This command is generated by the @code{gtroff} +escape sequence @code{\X}. The line-continuing feature is a +@code{gtroff} extension. -@item Dp @var{dx1} @var{dy1} @var{dx2} @var{dy2} @dots{} @var{dxn} @var{dyn} -Draw a polygon with automatic closure. The first vertex is at the -current position, the second vertex at an offset (@var{dx1},@var{dy1}) -from the current position, the second vertex at an offset -(@var{dx2},@var{dy2}) from the first vertex, and so on up to the -@var{n}@dmn{th} vertex. At the moment, GNU @code{pic} only uses this -command to generate triangles and rectangles. - -@item DP @var{dx1} @var{dy1} @var{dx2} @var{dy2} @dots{} @var{dxn} @var{dyn} -Like @code{Dp} but draw a solid rather than outlined polygon. - -@item Dt @var{n} -@cindex line thickness -@cindex thickness of lines -Set the current line thickness to @var{n}@w{ }machine units. -Traditionally, @acronym{UNIX} @code{troff} drivers use a line thickness -proportional to the current point size; drivers should continue to do -this if no @code{Dt} command has been given, or if a @code{Dt} command -has been given with a negative value of@w{ }@var{n}. A zero value of@w{ -}@var{n} selects the smallest available line thickness. @end table -@esindex \D -A difficulty arises in how the current position should be changed after -the execution of these commands. This is not of great importance since -the code generated by GNU @code{pic} does not depend on this. Given a -drawing command of the form +@node Obsolete Command, , Device Control Commands, Command Reference +@subsubsection Obsolete Command +In @acronym{AT&T} @code{troff} output, the writing of a single +glyph is mostly done by a very strange command that combines a +horizontal move and a single character giving the glyph name. It +doesn't have a command code, but is represented by a 3-character +argument consisting of exactly 2@w{ }digits and a character. -@Example -\D'@var{c} @var{x1} @var{y1} @var{x2} @var{y2} @dots{} @var{xn} @var{yn}' -@endExample +@table @asis +@item @var{dd}@var{g} +Move right @var{dd} (exactly two decimal digits) basic units @samp{u}, +then print glyph@w{ }@var{g} (represented as a single character). + +In @code{gtroff}, arbitrary syntactical space around and within this +command is allowed to be added. Only when a preceding command on the +same line ends with an argument of variable length a separating space +is obligatory. In @acronym{AT&T} @code{troff}, large clusters of these +and other commands are used, mostly without spaces; this made such output +almost unreadable. + +@end table + +For modern high-resolution devices, this command does not make sense +because the width of the glyphs can become much larger than two +decimal digits. In @code{gtroff}, this is only used for the devices +@code{X75}, @code{X75-12}, @code{X100}, and @code{X100-12}. For other +devices, the commands @samp{t} and @samp{u} provide a better +functionality. + +@c --------------------------------------------------------------------- + +@node Intermediate Output Examples, Output Language Compatibility, Command Reference, gtroff Output +@subsection Intermediate Output Examples + +This section presents the intermediate output generated from the same +input for three different devices. The input is the sentence +@samp{hell world} fed into @code{gtroff} on the command line. + +@table @asis +@item High-resolution device @code{ps} + +This is the standard output of @code{gtroff} if no @option{-T} option +is given. + +@example +@group +shell> echo "hell world" | groff -Z -T ps + +x T ps +x res 72000 1 1 +x init +@end group +p1 +x font 5 TR +f5 +s10000 +V12000 +H72000 +thell +wh2500 +tw +H96620 +torld +n12000 0 +@group +x trailer +V792000 +x stop +@end group +@end example -@esindex \w -@vindex st -@vindex sb @noindent -where @var{c} is not one of @samp{c}, @samp{e}, @samp{l}, @samp{a} or -@samp{~}, @acronym{UNIX} @code{troff} treats each x@w{ }value -as a horizontal quantity, and each y@w{ }value as a vertical -quantity; it assumes that the width of the drawn object is the sum of -all x@w{ }values, and that the height is the sum of all y@w{ }values. -(The assumption about the height can be seen by examining the @code{st} -and @code{sb} registers after using such a @code{D}@w{ }command in a -@code{\w} escape sequence.) This rule also holds for all the original -drawing commands with the exception of @code{De}. For the sake of -compatibility GNU @code{troff} also follows this rule, even though it -produces an ugly result in the case of the @code{Df}, @code{Dt}, and, to -a lesser extent, @code{DE}@w{ }commands. Thus after executing a -@code{D}@w{ }command of the form +This output can be fed into @code{grops} to get its representation as +a PostScript file. -@Example -D@var{c} @var{x1} @var{y1} @var{x2} @var{y2} @dots{} @var{xn} @var{yn} -@endExample +@item Low-resolution device @code{latin1} + +This is similar to the high-resolution device except that the +positioning is done at a minor scale. Some comments (lines starting +with @samp{#}) were added for clarification; they were not generated +by the formatter. + +@example +@group +shell> echo "hell world" | groff -Z -T latin1 + +# prologue +x T latin1 +x res 240 24 40 +x init +@end group +# begin a new page +p1 +# font setup +x font 1 R +f1 +s10 +# initial positioning on the page +V40 +H0 +# write text `hell' +thell +# inform about space, and issue a horizontal jump +wh24 +# write text `world' +tworld +# announce line break, but do nothing because ... +n40 0 +@group +# ... the end of the document has been reached +x trailer +V2640 +x stop +@end group +@end example @noindent -the current position should be increased horizontally by the sum of all -x@w{ }values and vertically by the sum of all y@w{ }values. +This output can be fed into @code{grotty} to get a formatted text +document. + +@item @acronym{AT&T} @code{troff} output +Since a computer monitor has a very low resolution compared to modern +printers the intermediate output for the X@w{ }Window devices can use +the jump-and-write command with its 2-digit displacements. + +@example +@group +shell> echo "hell world" | groff -Z -T X100 + +x T X100 +x res 100 1 1 +x init +@end group +p1 +x font 5 TR +f5 +s10 +V16 +H100 +# write text with jump-and-write commands +ch07e07l03lw06w11o07r05l03dh7 +n16 0 +@group +x trailer +V1100 +x stop +@end group +@end example + +@noindent +This output can be fed into @code{xditview} or @code{gxditview} +for displaying in@w{ }X. + +Due to the obsolete jump-and-write command, the text clusters in the +@acronym{AT&T} @code{troff} output are almost unreadable. + +@end table @c --------------------------------------------------------------------- -@node Line Continuation, , Drawing Functions, gtroff Output -@subsection Line Continuation -@cindex line continuation in output commands -@cindex output commands, line continuation +@node Output Language Compatibility, , Intermediate Output Examples, gtroff Output +@subsection Output Language Compatibility -There is a continuation convention which permits the argument to the -@w{@samp{x X}} command to contain newlines: When outputting the argument -to the @w{@samp{x X}} command, GNU @code{troff} follows each newline -in the argument with a @samp{+} character (as usual, it terminates -the entire argument with a newline); thus if the line after the line -containing the @w{@samp{x X}} command starts with @samp{+}, then the -newline ending the line containing the @w{@samp{x X}} command should be -treated as part of the argument to the @w{@samp{x X}} command, the -@samp{+} should be ignored, and the part of the line following the -@samp{+} should be treated like the part of the line following the -@w{@samp{x X}} command. +The intermediate output language of @acronym{AT&T} @code{troff} +was first documented in the @acronym{UNIX} troff manual, with later +additions documented in @cite{A Typesetter-indenpendent TROFF}, +written by Brian Kernighan. + +The @code{gtroff} intermediate output format is compatible with this +specification except for the following features. + +@itemize @bullet +@item +The classical quasi device independence is not yet implemented. + +@item +The old hardware was very different from what we use today. So the +@code{groff} devices are also fundamentally different from the ones in +@acronym{AT&T} @code{troff}. For example, the @acronym{AT&T} +PostScript device is called @code{post} and has a resolution of only +720 units per inch, suitable for printers 20 years ago, while +@code{groff}'s @code{ps} device has a resolution of +72000 units per inch. Maybe, by implementing some rescaling +mechanism similar to the classical quasi device independence, +@code{groff} could emulate @acronym{AT&T}'s @code{post} device. + +@item +The B-spline command @samp{D~} is correctly handled by the +intermediate output parser, but the drawing routines aren't +implemented in some of the postprocessor programs. + +@item +The argument of the commands @samp{s} and @w{@samp{x H}} has the +implicit unit scaled point @samp{z} in @code{gtroff}, while +@acronym{AT&T} @code{troff} has point (@samp{p}). This isn't an +incompatibility but a compatible extension, for both units coincide +for all devices without a @code{sizescale} parameter in the @file{DESC} +file, including all postprocessors from @acronym{AT&T} and +@code{groff}'s text devices. The few @code{groff} devices with +a @code{sizescale} parameter either do not exist for @acronym{AT&T} +@code{troff}, have a different name, or seem to have a different +resolution. So conflicts are very unlikely. + +@item +The position changing after the commands @samp{Dp}, @samp{DP}, and +@samp{Dt} is illogical, but as old versions of @code{gtroff} used this +feature it is kept for compatibility reasons. + +@ignore +Temporarily, there existed some confusion on the positioning after the +@samp{D} commands that are groff extensions. This has been clarified +by establishing the classical rule for all @code{groff} drawing commands: + +@itemize +@item +The position after a graphic object has been drawn is at its end; +for circles and ellipses, the `end' is at the right side. + +@item +From this, the positionings specified for the drawing commands above +follow quite naturally. +@end itemize +@end ignore + +@end itemize @c ===================================================================== @@ -9750,9 +13931,11 @@ treated as part of the argument to the @w{@samp{x X}} command, the @cindex files, font The @code{gtroff} font format is roughly a superset of the -@code{ditroff} font format. Unlike the @code{ditroff} font format, -there is no associated binary format; all files are text files. The -font files for device @var{name} are stored in a directory +@code{ditroff} font format (as used in later versions of @acronym{AT&T} +@code{troff} and its descendants). Unlike the @code{ditroff} font +format, there is no associated binary format; all files are text +files.@footnote{Plan@w{ }9 @code{troff} has also abandoned the binary +format.} The font files for device @var{name} are stored in a directory @file{dev@var{name}}. There are two types of file: a device description file called @file{DESC} and for each font@w{ }@var{f} a font file called@w{ }@file{@var{f}}. @@ -9766,25 +13949,27 @@ called@w{ }@file{@var{f}}. @node DESC File Format, Font File Format, Font Files, Font Files @subsection @file{DESC} File Format -@cindex @file{DESC} file format -@cindex font description file format +@cindex @file{DESC} file, format +@cindex font description file, format @cindex format of font description file @pindex DESC@r{ file format} -The @file{DESC} file can contain the following types of line: +The @file{DESC} file can contain the following types of line. Except +for the @code{charset} keyword which must comes last (if at all), the +order of the lines is not important. @table @code @item res @var{n} @kindex res -There are @var{n} machine units per inch. +There are @var{n}@w{ }machine units per inch. @item hor @var{n} @kindex hor -The horizontal resolution is @var{n} machine units. +The horizontal resolution is @var{n}@w{ }machine units. @item vert @var{n} @kindex vert -The vertical resolution is @var{n} machine units. +The vertical resolution is @var{n}@w{ }machine units. @item sizescale @var{n} @kindex sizescale @@ -9798,17 +13983,34 @@ One scaled point is equal to one point/@var{n}. The arguments to the Quantities in the font files are given in machine units for fonts whose point size is @var{n}@w{ }scaled points. +@item prepro @var{program} +@kindex prepro +Call @var{program} as a preprocessor. Currently, this keyword is used +by @code{groff} with option @option{-Thtml} only. + +@item postpro @var{program} +@kindex postpro +Call @var{program} as a postprocessor. For example, the line + +@Example +postpro grodvi +@endExample + +@noindent +in the file @file{devdvi/DESC} makes @code{groff} call @code{grodvi} +if option @option{-Tdvi} is given (and @option{-Z} isn't used). + @item tcommand @kindex tcommand This means that the postprocessor can handle the @samp{t} and @samp{u} -output commands. +intermediate output commands. @item sizes @var{s1} @var{s2} @dots{} @var{sn} 0 @kindex sizes This means that the device has fonts at @var{s1}, @var{s2}, @dots{} -@var{sn} scaled points. The list of sizes must be terminated by a@w{ -}0. Each @var{si} can also be a range of sizes @var{m}-@var{n}. The -list can extend over more than one line. +@var{sn} scaled points. The list of sizes must be terminated by@w{ }0 +(this is digit zero). Each @var{si} can also be a range of sizes +@var{m}-@var{n}. The list can extend over more than one line. @item styles @var{S1} @var{S2} @dots{} @var{Sm} @kindex styles @@ -9820,36 +14022,84 @@ The first @var{m}@w{ }font positions are associated with styles Fonts @var{F1} @dots{} @var{Fn} are mounted in the font positions @var{m}+1, @dots{}, @var{m}+@var{n} where @var{m} is the number of styles. This command may extend over more than one line. A font name -of@var{ }0 means no font is mounted on the corresponding font position. +of@w{ }0 means no font is mounted on the corresponding font position. @item family @var{fam} @kindex family The default font family is @var{fam}. +@item use_charnames_in_special +@kindex use_charnames_in_special +This command indicates that @code{gtroff} should encode special +characters inside special commands. Currently, this is only used +by the @acronym{HTML} output device. @xref{Postprocessor Access}. + +@item papersize @var{string} @dots{} +@kindex papersize +Select a paper size. Valid values for @var{string} are the ISO paper +types @code{A0}-@code{A7}, @code{B0}-@code{B7}, @code{C0}-@code{C7}, +@code{D0}-@code{D7}, @code{DL}, and the US paper types @code{letter}, +@code{legal}, @code{tabloid}, @code{ledger}, @code{statement}, +@code{executive}, @code{com10}, and @code{monarch}. Case is not significant +for @var{string} if it holds predefined paper types. Alternatively, +@var{string} can be a file name (e.g.@: @file{/etc/papersize}); if the file +can be opened, @code{groff} reads the first line and tests for the above +paper sizes. Finally, @var{string} can be a custom paper size in the format +@code{@var{length},@var{width}} (no spaces before and after the comma). +Both @var{length} and @var{width} must have a unit appended; valid values +are @samp{i} for inches, @samp{C} for centimeters, @samp{p} for points, and +@samp{P} for picas. Example: @code{12c,235p}. An argument which starts +with a digit is always treated as a custom paper format. @code{papersize} +sets both the vertical and horizontal dimension of the output medium. + +More than one argument can be specified; @code{groff} scans from left to +right and uses the first valid paper specification. + +@item pass_filenames +@kindex pass_filenames +Tell @code{gtroff} to emit the name of the source file currently +being processed. This is achieved by the intermediate output command +@samp{F}. Currently, this is only used by the @acronym{HTML} output +device. + +@item print @var{program} +@kindex print +Use @var{program} as a spooler program for printing. If omitted, +the @option{-l} and @option{-L} options of @code{groff} are ignored. + @item charset @kindex charset This line and everything following in the file are ignored. It is allowed for the sake of backwards compatibility. @end table -The @code{res}, @code{unitwidth}, @code{fonts} and @code{sizes} lines +The @code{res}, @code{unitwidth}, @code{fonts}, and @code{sizes} lines are mandatory. Other commands are ignored by @code{gtroff} but may be used by postprocessors to store arbitrary information about the device in the @file{DESC} file. -@c XXX add other commands resp. xrefs to output devices -@c XXX add obsolete commands +@kindex spare1 +@kindex spare2 +@kindex biggestfont +Here a list of obsolete keywords which are recognized by @code{groff} +but completely ignored: @code{spare1}, @code{spare2}, +@code{biggestfont}. + @c --------------------------------------------------------------------- @node Font File Format, , DESC File Format, Font Files @subsection Font File Format -@cindex font file format +@cindex font file, format +@cindex font description file, format @cindex format of font files +@cindex format of font description files -A font file has two sections. The first section is a sequence of lines -each containing a sequence of blank delimited words; the first word in -the line is a key, and subsequent words give a value for that key. +A @dfn{font file}, also (and probably better) called a @dfn{font +description file}, has two sections. The first section is a sequence +of lines each containing a sequence of blank delimited words; the first +word in the line is a key, and subsequent words give a value for that +key. @table @code @item name @var{f} @@ -9862,21 +14112,22 @@ The normal width of a space is@w{ }@var{n}. @item slant @var{n} @kindex slant -The characters of the font have a slant of @var{n}@w{ }degrees. +The glyphs of the font have a slant of @var{n}@w{ }degrees. (Positive means forward.) @item ligatures @var{lig1} @var{lig2} @dots{} @var{lign} [0] @kindex ligatures -Characters @var{lig1}, @var{lig2}, @dots{}, @var{lign} are ligatures; +Glyphs @var{lig1}, @var{lig2}, @dots{}, @var{lign} are ligatures; possible ligatures are @samp{ff}, @samp{fi}, @samp{fl}, @samp{ffi} and @samp{ffl}. For backwards compatibility, the list of ligatures may be terminated with a@w{ }0. The list of ligatures may not extend over more than one line. @item special +@cindex special fonts @kindex special -The font is special; this means that when a character is requested that -is not present in the current font, it is searched for in any +The font is @dfn{special}; this means that when a glyph is requested +that is not present in the current font, it is searched for in any special fonts that are mounted. @end table @@ -9896,68 +14147,94 @@ subsection. These subsections can appear in any order. Each subsection starts with a word on a line by itself. @kindex charset -The word @code{charset} starts the character set subsection. The -@code{charset} line is followed by a sequence of lines. Each line gives -information for one character. A line comprises a number of fields -separated by blanks or tabs. The format is +The word @code{charset} starts the character set +subsection.@footnote{This keyword is misnamed since it starts a list +of ordered glyphs, not characters.} The @code{charset} line is +followed by a sequence of lines. Each line gives information for one +glyph. A line comprises a number of fields separated by blanks or +tabs. The format is -@c XXX fix it for new HTML additions - -@Example -@var{name} @var{metrics} @var{type} @var{code} @var{comment} -@endExample +@quotation +@var{name} @var{metrics} @var{type} @var{code} +[@var{entity-name}] [@code{--} @var{comment}] +@end quotation @cindex 8-bit input @cindex input, 8-bit -@esindex \N +@cindex accessing unnamed glyphs with @code{\N} +@cindex unnamed glyphs, accessing with @code{\N} +@cindex characters, unnamed, accessing with @code{\N} +@cindex glyphs, unnamed, accessing with @code{\N} @kindex --- @noindent -@var{name} identifies the character: If @var{name} is a single -character@w{ }@var{c} then it corresponds to the @code{gtroff} input -character @var{c}; if it is of the form @samp{\@var{c}} where @var{c} is -a single character, then it corresponds to the @code{gtroff} input -character@w{ }\@var{c}; otherwise it corresponds to the groff input -character @samp{\[@var{name}]}. (If it is exactly two characters -@var{xx} it can be entered as @samp{\(@var{xx}}.) @code{gtroff} -supports 8-bit characters; however some utilities have difficulties with -eight-bit characters. For this reason, there is a convention that the -name @samp{char@var{n}} is equivalent to the single character whose code -is@w{ }@var{n}. For example, @samp{char163} would be equivalent to the -character with code@w{ }163 which is the pounds sterling sign in @w{ISO -Latin-1} character set. The name @samp{---} is special and indicates -that the character is unnamed; such characters can only be used by means -of the @code{\N} escape sequence in @code{gtroff}. - -@c XXX input encodings vs. output encodings - -The @var{type} field gives the character type: +@var{name} identifies the glyph name@footnote{The distinction between +input, characters, and output, glyphs, is not clearly separated in the +terminology of @code{groff}; for example, the @code{char} request +should be called @code{glyph} since it defines an output entity.}: +If @var{name} is a single character@w{ }@var{c} then it corresponds +to the @code{gtroff} input character@w{ }@var{c}; if it is of the form +@samp{\@var{c}} where @var{c} is a single character, then it +corresponds to the special character @code{\[@var{c}]}; otherwise it +corresponds to the special character @samp{\[@var{name}]}. If it +is exactly two characters @var{xx} it can be entered as +@samp{\(@var{xx}}. Note that single-letter special characters can't +be accessed as @samp{\@var{c}}; the only exception is @samp{\-} which +is identical to @code{\[-]}. + +@code{gtroff} supports 8-bit input characters; however some utilities +have difficulties with eight-bit characters. For this reason, there is +a convention that the entity name @samp{char@var{n}} is equivalent to +the single input character whose code is@w{ }@var{n}. For example, +@samp{char163} would be equivalent to the character with code@w{ }163 +which is the pounds sterling sign in the @w{ISO Latin-1} character set. +You shouldn't use @samp{char@var{n}} entities in font description files +since they are related to input, not output. Otherwise, you get +hard-coded connections between input and output encoding which +prevents use of different (input) character sets. + +The name @samp{---} is special and indicates that the glyph is +unnamed; such glyphs can only be used by means of the @code{\N} +escape sequence in @code{gtroff}. + +The @var{type} field gives the glyph type: @table @code @item 1 -the character has an descender, for example, `p'; +the glyph has a descender, for example, @samp{p}; @item 2 -the character has an ascender, for example, `b'; +the glyph has an ascender, for example, @samp{b}; @item 3 -the character has both an ascender and a descender, for example, `('. +the glyph has both an ascender and a descender, for example, @samp{(}. @end table The @var{code} field gives the code which the postprocessor uses to -print the character. The character can also be input to @code{gtroff} -using this code by means of the @code{\N} escape sequence. The code can -be any integer. If it starts with @samp{0} it is interpreted as +print the glyph. The glyph can also be input to @code{gtroff} +using this code by means of the @code{\N} escape sequence. @var{code} +can be any integer. If it starts with @samp{0} it is interpreted as octal; if it starts with @samp{0x} or @samp{0X} it is interpreted as -hexadecimal. +hexadecimal. Note, however, that the @code{\N} escape sequence only +accepts a decimal integer. -Anything on the line after the @var{code} field is ignored. +The @var{entity-name} field gives an @acronym{ASCII} string +identifying the glyph which the postprocessor uses to print the +@code{gtroff} glyph @var{name}. This field is optional and has been +introduced so that the @acronym{HTML} device driver can encode its +character set. For example, the glyph @samp{\[Po]} is +represented as @samp{£} in @acronym{HTML} 4.0. + +Anything on the line after the @var{entity-name} field resp.@: after +@samp{--} will be ignored. The @var{metrics} field has the form: -@Example -@var{width}[,@var{height}[,@var{depth}[,@var{italic_correction} - [,@var{left_italic_correction}[,@var{subscript_correction}]]]]] -@endExample +@display +@group +@var{width}[@code{,}@var{height}[@code{,}@var{depth}[@code{,}@var{italic-correction} + [@code{,}@var{left-italic-correction}[@code{,}@var{subscript-correction}]]]]] +@end group +@end display @noindent There must not be any spaces between these subfields (it has been split @@ -9965,22 +14242,21 @@ here into two lines for better legibility only). Missing subfields are assumed to be@w{ }0. The subfields are all decimal integers. Since there is no associated binary format, these values are not required to fit into a variable of type @samp{char} as they are in @code{ditroff}. -The @var{width} subfield gives the width of the character. The -@var{height} subfield gives the height of the character (upwards is -positive); if a character does not extend above the baseline, it should -be given a zero height, rather than a negative height. The @var{depth} -subfield gives the depth of the character, that is, the distance below -the lowest point below the baseline to which the character extends -(downwards is positive); if a character does not extend below above the -baseline, it should be given a zero depth, rather than a negative depth. -The @var{italic_correction} subfield gives the amount of space that -should be added after the character when it is immediately to be -followed by a character from a roman font. The -@var{left_italic_correction} subfield gives the amount of space that -should be added before the character when it is immediately to be -preceded by a character from a roman font. The -@var{subscript_correction} gives the amount of space that should be -added after a character before adding a subscript. This should be less +The @var{width} subfield gives the width of the glyph. The @var{height} +subfield gives the height of the glyph (upwards is positive); if a +glyph does not extend above the baseline, it should be given a zero +height, rather than a negative height. The @var{depth} subfield gives +the depth of the glyph, that is, the distance from the baseline to the +lowest point below the baseline to which the glyph extends (downwards is +positive); if a glyph does not extend below the baseline, it should be +given a zero depth, rather than a negative depth. The +@var{italic-correction} subfield gives the amount of space that should +be added after the glyph when it is immediately to be followed by a +glyph from a roman font. The @var{left-italic-correction} subfield +gives the amount of space that should be added before the glyph when it +is immediately to be preceded by a glyph from a roman font. The +@var{subscript-correction} gives the amount of space that should be +added after a glyph before adding a subscript. This should be less than the italic correction. A line in the @code{charset} section can also have the format @@ -9990,7 +14266,7 @@ A line in the @code{charset} section can also have the format @endExample @noindent -This indicates that @var{name} is just another name for the character +This indicates that @var{name} is just another name for the glyph mentioned in the preceding line. @kindex kernpairs @@ -10002,17 +14278,16 @@ sequence of lines of the form: @endExample @noindent -This means that when character @var{c1} appears next to character -@var{c2} the space between them should be increased by@w{ }@var{n}. -Most entries in the kernpairs section have a negative value for@w{ -}@var{n}. +This means that when glyph @var{c1} appears next to glyph @var{c2} +the space between them should be increased by@w{ }@var{n}. Most +entries in the kernpairs section have a negative value for@w{ }@var{n}. @c ===================================================================== @c ===================================================================== -@node Installation, Request Index, File formats, Top +@node Installation, Copying This Manual, File formats, Top @chapter Installation @cindex installation @@ -10023,8 +14298,22 @@ Most entries in the kernpairs section have a negative value for@w{ @c ===================================================================== @c ===================================================================== -@node Request Index, Escape Index, Installation, Top -@chapter Request Index +@node Copying This Manual, Request Index, Installation, Top +@appendix Copying This Manual + +@menu +* GNU Free Documentation License:: License for copying this manual. +@end menu + +@include fdl.texi + + + +@c ===================================================================== +@c ===================================================================== + +@node Request Index, Escape Index, Copying This Manual, Top +@appendix Request Index Requests appear without the leading control character (normally either @samp{.} or @samp{'}). @@ -10037,7 +14326,10 @@ Requests appear without the leading control character (normally either @c ===================================================================== @node Escape Index, Operator Index, Request Index, Top -@chapter Escape Index +@appendix Escape Index + +Any escape sequence @code{\@var{X}} with @var{X} not in the list below +emits a warning, printing glyph @var{X}. @printindex es @@ -10047,7 +14339,7 @@ Requests appear without the leading control character (normally either @c ===================================================================== @node Operator Index, Register Index, Escape Index, Top -@chapter Operator Index +@appendix Operator Index @printindex op @@ -10057,7 +14349,15 @@ Requests appear without the leading control character (normally either @c ===================================================================== @node Register Index, Macro Index, Operator Index, Top -@chapter Register Index +@appendix Register Index + +The macro package or program a specific register belongs to is appended in +brackets. + +A register name@w{ }@code{x} consisting of exactly one character can be +accessed as @samp{\nx}. A register name @code{xx} consisting of exactly +two characters can be accessed as @samp{\n(xx}. Register names @code{xxx} +of any length can be accessed as @samp{\n[xxx]}. @printindex vr @@ -10067,7 +14367,10 @@ Requests appear without the leading control character (normally either @c ===================================================================== @node Macro Index, String Index, Register Index, Top -@chapter Macro Index +@appendix Macro Index + +The macro package a specific macro belongs to is appended in brackets. +They appear without the leading control character (normally @samp{.}). @printindex ma @@ -10077,7 +14380,16 @@ Requests appear without the leading control character (normally either @c ===================================================================== @node String Index, Glyph Name Index, Macro Index, Top -@chapter String Index +@appendix String Index + +The macro package or program a specific string belongs to is appended in +brackets. + +A string name@w{ }@code{x} consisting of exactly one character can be +accessed as @samp{\*x}. A string name @code{xx} consisting of exactly +two characters can be accessed as @samp{\*(xx}. String names @code{xxx} +of any length can be accessed as @samp{\*[xxx]}. + @printindex st @@ -10087,13 +14399,13 @@ Requests appear without the leading control character (normally either @c ===================================================================== @node Glyph Name Index, Font File Keyword Index, String Index, Top -@chapter Glyph Name Index +@appendix Glyph Name Index A glyph name @code{xx} consisting of exactly two characters can be accessed as @samp{\(xx}. Glyph names @code{xxx} of any length can be accessed as @samp{\[xxx]}. -@printindex gl +@c XXX @@ -10101,7 +14413,7 @@ accessed as @samp{\[xxx]}. @c ===================================================================== @node Font File Keyword Index, Program and File Index, Glyph Name Index, Top -@chapter Font File Keyword Index +@appendix Font File Keyword Index @printindex ky @@ -10111,7 +14423,7 @@ accessed as @samp{\[xxx]}. @c ===================================================================== @node Program and File Index, Concept Index, Font File Keyword Index, Top -@chapter Program and File Index +@appendix Program and File Index @printindex pg @@ -10121,12 +14433,9 @@ accessed as @samp{\[xxx]}. @c ===================================================================== @node Concept Index, , Program and File Index, Top -@chapter Concept Index +@appendix Concept Index @printindex cp - -@summarycontents -@contents @bye diff --git a/contrib/groff/doc/pic.ms b/contrib/groff/doc/pic.ms index 627a84f..9206526 100644 --- a/contrib/groff/doc/pic.ms +++ b/contrib/groff/doc/pic.ms @@ -3,14 +3,14 @@ .\" There is no hope that this will ever look right under nroff. .\" .\" Comments beginning with %% are cut lines so portions of this - \" document can be automatically extracted. %%TUTORIAL%% begins the +.\" document can be automatically extracted. %%TUTORIAL%% begins the .\" tutorial part; %%REFERENCE%% the reference part. %%POSTLUDE%% the - \" bibliography and end matter after the reference part. +.\" bibliography and end matter after the reference part. .\" .\" This document was written for free use and redistribution by .\" Eric S. Raymond <esr@thyrsus.com> in August 1995. .\" -.\" $Id: pic.ms,v 1.4 2001/06/24 13:03:27 wlemb Exp $ +.\" $Id: pic.ms,v 1.19 2002/09/20 12:14:56 wlemb Exp $ .\" .\" Set a proper TeX .ie t .ds tx T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X @@ -28,13 +28,13 @@ Making Pictures With GNU PIC .AU Eric S. Raymond .AI -<esr@snark.thyrsus.com> +\[la]\fIesr@snark.thyrsus.com\fP\[ra] .AB The \fBpic\fP language is a \fBtroff\fP extension that makes it easy to create and alter box-and-arrow diagrams of the kind frequently used in technical papers and textbooks. This paper is both an introduction -to and reference for \fIgpic\fP(1), the implementation distributed by -the Free Software Foundation for use with \fIgroff\fP(1). +to and reference for \fIgpic\/\fP(1), the implementation distributed by +the Free Software Foundation for use with \fIgroff\/\fP(1). .AE .\"%%TUTORIAL%% .NH 1 @@ -50,44 +50,42 @@ layouts, and other kinds of illustration involving repetitive uses of simple geometric forms and splines. Because these descriptions are procedural and object-based, they are both compact and easy to modify. .PP -The \fIgpic\fP(1) implementation of \fBpic\fP is distributed by the -Free Software Foundation for use with their \fIgroff\fP(1) +The \fIgpic\/\fP(1) implementation of \fBpic\fP is distributed by the +Free Software Foundation for use with their \fIgroff\/\fP(1) implementation of \fBtroff\fP. Because both implementations are widely available in source form for free, they are good bets for writing very portable documentation. .NH 2 PIC Versions .PP -The original 1984 pre-\fIditroff\fP(1) version of \fBpic\fP is long +The original 1984 pre-\fIditroff\/\fP(1) version of \fBpic\fP is long obsolete. The rewritten 1991 version is still available as part of the Documenter's Work Bench module of System V. .PP Where differences between Documenter's Work Bench (1991) \fBpic\fP and GNU \fBpic\fP need to be described, original \fBpic\fP is referred to as -"DWB pic". Details on the history of the program are given at the end -of this document. +\[lq]DWB pic\[rq]. Details on the history of the program are given at the +end of this document. .PP -In this document, the \fIgpic\fP(1) extensions will be marked as such. +In this document, the \fIgpic\/\fP(1) extensions will be marked as such. .NH 1 Invoking PIC .PP Every \fBpic\fP description is a little program, which gets compiled -by \fIpic\fP(1) into \fIgtroff\fP(1) macros. Programs that process or -display \fIgtroff\fP(1) output need not know or care that parts of the +by \fIpic\/\fP(1) into \fIgtroff\/\fP(1) macros. Programs that process or +display \fIgtroff\/\fP(1) output need not know or care that parts of the image began life as \fBpic\fP descriptions. .PP -The \fIpic\fP(1) program tries to translate anything between \fB.PS\fP +The \fIpic\/\fP(1) program tries to translate anything between \fB.PS\fP and \fB.PE\fP markers, and passes through everything else. The normal definitions of \fB.PS\fP and \fB.PE\fP in the \fIms\fP macro package and elsewhere have also the side-effect of centering the \fBpic\fP output on the page. -.PP -Other details of the \fI[gt]roff\fP(1) interface .NH 2 PIC Error Messages .PP -If you make a \fBpic\fP syntax error, \fIgpic\fP(1) will issue an -error message in the standard \fIgcc\fP(1)-like syntax. A typical +If you make a \fBpic\fP syntax error, \fIgpic\/\fP(1) will issue an +error message in the standard \fIgcc\/\fP(1)-like syntax. A typical error message looks like this, .KS .DS @@ -98,7 +96,7 @@ pic:pic.ms:<nnn>: giving up on this picture .R .KE .LP -where <nnn> is a line number, and <token> is a token near (usually +where \[la]nnn\[ra] is a line number, and \[la]token\[ra] is a token near (usually just after) the error location. .NH 1 Basic PIC Concepts @@ -112,11 +110,11 @@ flow of data in \fBpic\fP processing: .PS ellipse "document"; arrow; -box "\fIgpic\fP(1)" +box width 0.6 "\fIgpic\/\fP(1)" arrow; -box width 1.2 "\fIgtbl\fP(1) or \fIgeqn\fP(1)" "(optional)" dashed; +box width 1.1 "\fIgtbl\/\fP(1) or \fIgeqn\/\fP(1)" "(optional)" dashed; arrow; -box "\fIgtroff\fP(1)"; +box width 0.6 "\fIgtroff\/\fP(1)"; arrow; ellipse "PostScript" .PE @@ -125,17 +123,19 @@ ellipse "PostScript" This was produced from the following \fBpic\fP program: .KS .DS +.ps -1 +.vs -1 .CW \&.PS -\&ellipse "document"; -\&arrow; -\&box "\\fIpic\\fP(1)" -\&arrow; -\&box width 1.2 "\\fIgtbl\\fP(1) or \\fIgeqn\\fP(1)" "(optional)" dashed; -\&arrow; -\&box "\\fIgtroff\\fP(1)"; -\&arrow; -\&ellipse "PostScript" +ellipse "document"; +arrow; +box width 0.6 "\efIpic\e/\efP(1)" +arrow; +box width 1.1 "\efIgtbl\e/\efP(1) or \efIgeqn\e/\efP(1)" "(optional)" dashed; +arrow; +box width 0.6 "\efIgtroff\e/\efP(1)"; +arrow; +ellipse "PostScript" \&.PE .DE .R @@ -152,8 +152,9 @@ this facility in detail in the next section). We also get to see \fBpic\fP's simple syntax. Statements are ended by newlines or semicolons. String quotes are required around all text arguments, whether or not they contain spaces. In general, the order -of command arguments and modifiers like "width 1.2" or "dashed" doesn't -matter, except that the order of text arguments is significant. +of command arguments and modifiers like \[lq]width 1.2\[rq] or +\[lq]dashed\[rq] doesn't matter, except that the order of text arguments +is significant. .PP Here are all but one of the basic \fBpic\fP objects at their default sizes: .KS @@ -177,7 +178,7 @@ to collect objects into \fIblock composites\fP which allows you to treat the whole group as a single object (resembling a box) for many purposes. We'll describe both of these later on. .PP -The box, ellipse, circle, and block composite objects are \fIclosed\fR; +The box, ellipse, circle, and block composite objects are \fIclosed\/\fR; lines, arrows, arcs and splines are \fIopen\fP. This distinction will often be important in explaining command modifiers. .PP @@ -187,17 +188,17 @@ which introduces some more basic concepts: .DS .CW \&.PS -\&box "box"; -\&move; -\&line "line" ""; -\&move; -\&arrow "arrow" ""; -\&move; -\&circle "circle"; -\&move; -\&ellipse "ellipse"; -\&move; -\&arc; down; move; "arc" +box "box"; +move; +line "line" ""; +move; +arrow "arrow" ""; +move; +circle "circle"; +move; +ellipse "ellipse"; +move; +arc; down; move; "arc" \&.PE .DE .ft R @@ -264,7 +265,8 @@ arc cw; move; "arc"; .PE .CE "6: Result of \fBarc cw; move; \"arc\"\fP" .PP -All we've done differently here is specify "cw" for a clockwise arc. +All we've done differently here is specify \[lq]cw\[rq] for a clockwise arc +(\[lq]ccw\[rq] specifies counter-clockwise direction). Observe how it changes the default direction to down, rather than up. .PP Another good way to see this via with the following program: @@ -283,7 +285,7 @@ line; arc; arc cw; line; .PE .CE "7: Result of \fBline; arc; arc cw; line\fP" .LP -Notice that we did not have to specify "up" for the second arc to be +Notice that we did not have to specify \[lq]up\[rq] for the second arc to be joined to the end of the first. .PP Finally, observe that a string, alone, is treated as text to be @@ -297,16 +299,14 @@ Sizes and Spacing Sizes are specified in inches. If you don't like inches, it's possible to set a global style variable \fBscale\fP that changes the unit. Setting \fBscale = 2.54\fP will effectively change the internal -unit to centimeters (all other size variable valuess will be scaled +unit to centimeters (all other size variable values will be scaled correspondingly). .NH 2 Default Sizes of Objects .PP Here are the default sizes for \fBpic\fP objects: -.RS -.KS -.TS -tab(@), linesize(2); +.TS H +center, tab(@), linesize(2); lb | lb l | l. .sp 2p @@ -314,6 +314,7 @@ Object@Default Size .sp 2p _ .sp 2p +.TH box@0.75" wide by 0.5" high circle@0.5" diameter ellipse@0.75" wide by 0.5" high @@ -323,8 +324,6 @@ arrow@0.5" long .sp 5p _ .TE -.KE -.RE .PP The simplest way to think about these defaults is that they make the other basic objects fit snugly into a default-sized box. @@ -333,19 +332,19 @@ Objects Do Not Stretch! .PP Text is rendered in the current font with normal troff line spacing. Boxes, circles, and ellipses do \fInot\fP automatically resize to fit -enclosed text. Thus, if you say \fBbox "text far too long"\fP -you'll get this: +enclosed text. Thus, if you say \fBbox "this text far too long for a +default box"\fP you'll get this: .KS .PS box "this text is far too long for a default box" .PE .CE "1: Boxes do not automatically resize" -.PP +.LP which is probably not the effect you want. .NH 2 Resizing Boxes .PP -To change the box size, you can specify a box width with the "width" +To change the box size, you can specify a box width with the \[lq]width\[rq] modifier: .KS .PS @@ -353,16 +352,15 @@ box width 3 "this text is far too long for a default box" .PE .CE "2: Result of \fBbox width 3 \"text far too long\"\fP" .PP -This modifier takes a dimension in inches. There is also a "height" +This modifier takes a dimension in inches. There is also a \[lq]height\[rq] modifier that will change a box's height. The \fBwidth\fP keyword may -be abbreviated to \fBewid\fP; the \fBheight\fP keyword to -\fBheight\fP. +be abbreviated to \fBwid\fP; the \fBheight\fP keyword to \fBht\fP. .NH 2 Resizing Other Object Types .PP -To change the size of a circle, give it a \fBrad\fP or \fBdiam\fP -modifier; this changes the radius or diameter of the circle, according -to the numeric argument that follows. +To change the size of a circle, give it a \fBrad[ius]\fP or +\fBdiam[eter]\fP modifier; this changes the radius or diameter of the +circle, according to the numeric argument that follows. .KS .PS {circle rad 0.1; move down 0.2 from last circle .s; "0.1"}; @@ -376,8 +374,8 @@ it how many inches to move in the current direction. Ellipses are sized to fit in the rectangular box defined by their axes, and can be resized with \fBwidth\fP and \fBheight\fP like boxes. .PP -You can also change the radius of curvature of an arc with \fBrad\fP -(which specifies the radius of the circle of which the arc is a segnmment). +You can also change the radius of curvature of an arc with \fBrad[ius]\fP +(which specifies the radius of the circle of which the arc is a segment). Larger values yield flatter arcs. .KS .PS @@ -401,7 +399,7 @@ of its type. As an example, the program .DS .CW \&.PS -\&box; box wid 1 ht 1; box same; box +box; box wid 1 ht 1; box same; box \&.PE .R .DE @@ -428,19 +426,23 @@ of the drawing area as being gridded with standard-sized boxes. # Draw a demonstration up left arrow with grid box overlay define gridarrow { + move right 0.1 [ {arrow up left $1;} box wid 0.5 ht 0.5 dotted with .nw at last arrow .end; - for i = 2 to ($1 / 0.5) do - { + for i = 2 to ($1 / 0.5) do { box wid 0.5 ht 0.5 dotted with .sw at last box .se; } move down from last arrow .center; [ - if ( $1 == boxht ) then { "\fBline up left\fP" } else { sprintf("\fBarrow up left %g\fP", $1) }; + if ( $1 == boxht ) then { + "\fBline up left\fP" + } else { + sprintf("\fBarrow up left %g\fP", $1) + } ] ] - move right from last [] .e; + move right 0.1 from last [] .e; } gridarrow(0.5); gridarrow(1); @@ -452,9 +454,10 @@ undef gridarrow .NH 2 Multi-Segment Line Objects .PP -A "line" or "arrow" object may actually be a path consisting of any number of -segments of varying lengths and directions. To describe a path, -connect several line or arrow commands with the keyword \fBthen\fP. +A \[lq]line\[rq] or \[lq]arrow\[rq] object may actually be a path +consisting of any number of segments of varying lengths and directions. +To describe a path, connect several line or arrow commands with the +keyword \fBthen\fP. .KS .PS define zigzag { $1 right 1 then down .5 left 1 then right 1 } @@ -487,7 +490,7 @@ undef zigzag; .CE "3: \fBspline right 1 then down .5 left 1 then right 1\fP" .PP You can describe many natural-looking but irregular curves this -way. For example: +way. For example: .KS .PS [spline right then up then left then down ->;] @@ -499,18 +502,18 @@ move up 0.2; [spline left then up right then down right ->;] .PE .CE "4: Two more spline examples" -.PP +.LP Note the arrow decorations. Arrowheads can be applied naturally to any path-based object, line or spline. We'll see how in the next section. .NH 1 -Decorating Objects. +Decorating Objects .NH 2 Dashed Objects .PP We've already seen that the modifier \fBdashed\fP can change the line style of an object from solid to dashed. GNU \fBgpic\fP permits you to -dot or dash ellipses, circles, and arcs (and splines in \(*tx mode +dot or dash ellipses, circles, and arcs (and splines in \*[tx] mode only); some versions of DWB may only permit dashing of lines and boxes. It's possible to change the dash interval by specifying a number after the modifier. @@ -532,7 +535,7 @@ box dashed 0.2 "0.2"; Dotted Objects .PP Another available qualifier is \fBdotted\fP. GNU \fBgpic\fP permits -you to dot or dash ellipses, circles, and arcs (and splines in \(*tx +you to dot or dash ellipses, circles, and arcs (and splines in \*[tx] mode only); some versions of DWB may only permit dashing of lines and boxes. It too can be suffixed with a number to specify the interval between dots: @@ -553,20 +556,20 @@ box dotted 0.2 "0.2"; Rounding Box Corners .PP It is also possible, in GNU \fBgpic\fP only, to modify a box so it has -rounded corners +rounded corners: .KS .PS box rad 0.05 "rad 0.05"; move; box rad 0.1 "rad 0.1"; move; -box rad 0.15 "rad=0.15"; +box rad 0.15 "rad 0.15"; move; -box rad 0.2 "rad=0.2"; +box rad 0.2 "rad 0.2"; move; -box rad 0.25 "rad=0.25"; +box rad 0.25 "rad 0.25"; .PE -.CE "3: \fBbox rad\fP with increasing radius values;" +.CE "3: \fBbox rad\fP with increasing radius values" .PP Radius values higher than half the minimum box dimension are silently truncated to that value. @@ -584,29 +587,30 @@ line <- -> .PP In fact, the \fBarrow\fP command is just shorthand for \fBline ->\fP. And there is a double-head modifier <->, so the figure above could have been made -with \fCWline <->\fP. +with \fBline <->\fP. .PP Arrowheads have a \fBwidth\fP attribute, the distance across the rear; and a \fBheight\fP attribute, the length of the arrowhead along the shaft. .PP Arrowhead style is controlled by the style variable \fBarrowhead\fP. The DWB and GNU versions interpret it differently. DWB defaults to -open arrowheads and an \fBarrowhead\fP value of 2; the Kernighan -paper says a value of 7 will make solid arrowheads. GNU \fBgpic\fP -defaults to solid arrowheads and an \fBarrowhead\fP value of 1; a -value of 0 will produce open arrowheads. +open arrowheads and an \fBarrowhead\fP value of\~2; the Kernighan +paper says a value of\~7 will make solid arrowheads. GNU \fBgpic\fP +defaults to solid arrowheads and an \fBarrowhead\fP value of\~1; a +value of\~0 will produce open arrowheads. Note that solid arrowheads are +always filled with the current outline color. .NH 2 Line Thickness .PP It's also possible to change the line thickness of an object (this is -a GNU extension, DWB \fBpic\fP doesn't support it.). +a GNU extension, DWB \fBpic\fP doesn't support it). The default thickness of the lines used to draw objects is controlled by the .B linethick variable. This gives the thickness of lines in points. A negative value means use the default thickness: -in \(*tx output mode, this means use a thickness of 8 milliinches; -in \(*tx output mode with the +in \*[tx] output mode, this means use a thickness of 8 milliinches; +in \*[tx] output mode with the .B -c option, this means use the line thickness specified by .B .ps @@ -624,10 +628,10 @@ line. .NH 2 Invisible Objects .PP -The modifier \fBinvis\fP makes an object entirely invisible. This +The modifier \fBinvis[ible]\fP makes an object entirely invisible. This used to be useful for positioning text in an invisible object that is properly joined to neighboring ones. Newer DWB versions and GNU -\fBpic\fP treat standalone text in exactly this way. +\fBpic\fP treat stand-alone text in exactly this way. .NH 2 Filled Objects .PP @@ -640,9 +644,9 @@ and different defaults. DWB \fBfillval\fP defaults to 0.3 and smaller values are darker; GNU \fBfillval\fP uses 0 for white and 1 for black. .KS .PS -circle fill; move; circle fill 0.4; move; circle fill 0.2; +circle fill; move; circle fill 0.4; move; circle fill 0.9; .PE -.CE "5: \fBcircle fill; move; circle fill 0.4; move; circle fill 0.9;\fB" +.CE "5: \fBcircle fill; move; circle fill 0.4; move; circle fill 0.9;\fR" .PP GNU \fBgpic\fP makes some additional guarantees. A fill value greater than 1 can also be used: this means fill with the shade of gray that @@ -652,16 +656,40 @@ The invisible attribute does not affect the filling of objects. Any text associated with a filled object will be added after the object has been filled, so that the text will not be obscured by the filling. .PP -The closed-object modifier \fBsolid\fR is equivalent to \fBfill\fR -with the darkest fill value (DWB \fBpic\fR had this capability but -mentioned it only in a reference opinion). +The closed-object modifier \fBsolid\fP is equivalent to \fBfill\fP +with the darkest fill value (DWB \fBpic\fP had this capability but +mentioned it only in a reference section). +.NH 2 +Colored Objects +.PP +As a GNU extension, three additional modifiers are available to specify +colored objects. \fBoutline\fP sets the color of the outline, \fBshaded\fP +the fill color, and \fBcolor\fP sets both. All three keywords expect a +suffix specifying the color. Example: +.KS +.PS +box color "yellow"; arrow color "cyan"; circle shaded "green" outline "black"; +.PE +.CE "6: \fBbox color ""yellow""; arrow color ""cyan""; \ +circle shaded ""green"" outline ""black"";\fR" +.PP +Alternative spellings are \fBcolour\fP, \fBcolored\fP, \fBcoloured\fP, +and \fBoutlined\fP. +.PP +Currently, color support is not available in \*[tx] mode. Predefined color +names for \fIgroff\/\fP(1) are in the device macro files, for example +\f(CWps.tmac\fP; additional colors can be defined with the \fB.defcolor\fP +request (see the manual page of GNU \fItroff\/\fP(1) for more details). +.PP +\fBpic\fP assumes that at the beginning of a picture both glyph and fill +color are set to the default value. .NH 1 More About Text Placement .PP By default, text is centered at the geometric center of the object it is -associated with. The modifier \fBljust\fR causes the left end to be +associated with. The modifier \fBljust\fP causes the left end to be at the specified point (which means that the text lies to the right of -the specified place!), The modifier \fBrjust\fP puts the right end at +the specified place!), the modifier \fBrjust\fP puts the right end at the place. The modifiers \fBabove\fP and \fBbelow\fP center the text one half line space in the given direction. .PP @@ -678,10 +706,10 @@ move; .PE .CE "1: Text attributes" .PP -What actually happens is that n text strings are centered in a box +What actually happens is that \fIn\fP text strings are centered in a box that is \fBtextwid\fP wide by \fBtextht\fP high. Both these variables are initially zero (that is \fBpic\fR's way of not making assumptions -about \fI[tg]roff\fP(1)'s default point size). +about \fI[tg]roff\/\fP(1)'s default point size). .PP In GNU \fBgpic\fR, objects can have an .B aligned @@ -746,14 +774,14 @@ in the obvious way: .PS box; arrow; circle; down; arrow; ellipse .PE -.CE "3: \fBbox; arrow; circle; down; arrow; ellipse\fP +.CE "3: \fBbox; arrow; circle; down; arrow; ellipse\fP" .LP You might have expected that program to yield this: .KS .PS box; arrow; circle; move to last circle .s; down; arrow; ellipse .PE -.CE "4: More intuitive? +.CE "4: More intuitive?" .LP But, in fact, to get Figure \*[SN]3 you have to do this: .KS @@ -771,6 +799,7 @@ ellipse .R .DE .KE +.LP Why is this? Because the exit point for the current direction is already set when you draw the object. The second arrow in Figure \*[SN]2 dropped downwards from the circle's attachment point for an @@ -792,22 +821,23 @@ Naming Objects By Order Of Drawing The simplest (and generally the most useful) way to name an object is with a \fBlast\fP clause. It needs to be followed by an object type name; \fBbox\fP, \fBcircle\fP, \fBellipse\fP, \fBline\fP, \fBarrow\fP, -\fBspline\fP or \fB[]\fP (the last type refers to a \fIcomposite +\fBspline\fP, \fB""\fP, or \fB[]\fP (the last type refers to a \fIcomposite object\fP which we'll discuss later). So, for example, the \fBlast circle\fP clause in the program attached to Figure \*[SN]3 refers to the last circle drawn. .PP More generally, objects of a given type are implicitly numbered -(starting from 1). You can refer to (say) the third ellipse in the +(starting from\~1). You can refer to (say) the third ellipse in the current picture with \fB3rd ellipse\fP, or to the first box as \fB1st -box\fP, or to the fifth line as \fB5th line\fP. +box\fP, or to the fifth text string (which isn't an attribute to another +object) as \fB5th ""\fP. .PP -Objects are also numbered backwards by type from the last one of +Objects are also numbered backwards by type from the last one. You can say \fB2nd last box\fP to get the second-to-last box, or -\fB3rd last ellipse\fP to get the third-to-last box. +\fB3rd last ellipse\fP to get the third-to-last ellipse. .PP -In places where \fIn\fBth\fR is allowed, \fB`\fIexpr\fB'th\fR is also allowed. -Note that +In places where \fIn\/\fBth\fR is allowed, \fB`\fIexpr\/\fB'th\fR is +also allowed. Note that .B 'th is a single token: no space is allowed between the .B ' @@ -815,13 +845,13 @@ and the \fBth\fP. For example, .IP .KS -.R .DS +.CW for i = 1 to 4 do { line from `i'th box.nw to `i+1'th box.se } -.R .DE +.R .KE .NH 2 Naming Objects With Labels @@ -838,7 +868,7 @@ A: box "first" "object" move; B: ellipse "second" "object" move; -arrow left at A; +arrow right at A .r; \&.PE .R .DE @@ -852,7 +882,7 @@ A: box "first" "object" move; B: ellipse "second" "object" move; -arrow left at A .l; +arrow right at A .r; .PE .CE "1: Example of label use" The \fBat\fP statement in the fourth line uses the label \fBA\fP (the @@ -883,7 +913,7 @@ and Y increases upwards). An absolute location may always be written in the conventional form as two comma-separated numbers surrounded by parentheses (and this is recommended for clarity). In contexts where it creates no ambiguity, the pair of X and Y coordinates suffices -without punctuation. +without parentheses. .PP It is a good idea to avoid absolute coordinates, however. They tend to make picture descriptions difficult to understand and modify. @@ -893,7 +923,7 @@ relative to \fBpic\fP objects and previous locations. .NH 2 Locations Relative to Objects .PP -The symbol \fBhere\fP always refers to the position of the last object +The symbol \fBHere\fP always refers to the position of the last object drawn or the destination of the last \fBmove\fP. .PP Alone and unqualified, a \fBlast circle\fP or any other way of @@ -945,10 +975,13 @@ explanation of Figure 7.3's program is now complete. \&\fB.s\fP, \fB.e\fP, and \fB.w\fP respectively; they can even be abbreviated to \fB.t\fP, \fB.b\fP, \fB.l\fP and \fB.r\fP). .PP -The names \fBcenter\fP, \fBtop\fP, \fBbottom\fP, \fBleft\fP and -\fBright\fP can also be used (without the leading dot) in a prefix -form marked by \fBof\fP; thus, \fBcenter of last circle\fP and -\fBtop of 2nd last ellipse\fP are both valid object references. +The names \fBcenter\fP, \fBtop\fP, \fBbottom\fP, \fBleft\fP, \fBright\fP, +\fBnorth\fP, \fBsouth\fP, \fBeast\fP, and \fBwest\fP can also be used +(without the leading dot) in a prefix form marked by \fBof\fP; thus, +\fBcenter of last circle\fP and \fBtop of 2nd last ellipse\fP are both +valid object references. Finally, the names \fBleft\fP and \fBright\fP +can be prefixed with \fBupper\fP and \fBlower\fP which both have the +obvious meaning. .PP Arc objects also have compass point; they are the compass points of the implied circle. @@ -956,26 +989,25 @@ the implied circle. Locations Relative to Open Objects .PP Every open object (line, arrow, arc, or spline) has three named -points; \fB.start\fP, \fB.center\fP, and \fB.end\fP. They can -also be used without leading dots in the \fBof\fP prefix form. +points: \fB.start\fP, \fB.center\fP (or \fB.c\fP), and \fB.end\fP. They +can also be used without leading dots in the \fBof\fP prefix form. The center of an arc is the center of its circle, but the center of a line, path, or spline is halfway between its endpoints. .KS .PS define critical { [ ME: $1; - dot(ME.c); ".center" rjust at ME.center + (-0.1, 0.1) - dot(ME.start); ".start" rjust at ME.start + (-0.1, 0.1) - dot(ME.end); ".end" rjust at ME.end + (-0.1, 0.1) + dot(ME.c); "\fB.center\fP" rjust at ME.center + (-0.1, 0.1) + dot(ME.start); "\fB.start\fP" rjust at ME.start + (-0.1, 0.1) + dot(ME.end); "\fB.end\fP" rjust at ME.end + (-0.1, 0.1) ] - move down 0.2 from last [] .s; } critical(line up right 1); -move right from last [] .e; +move right 1 from last [] .e; critical(arc rad 0.5 cw); -move right from last [] .e; +move down 0.5 from 2nd last [] .s; critical(line right 1 then down .5 left 1 then right 1); -move right from last [] .e; +move right 1 from last [] .e; critical(spline right 1 then up right then left then left 1); .PE .CE "2: Special points on open objects" @@ -988,7 +1020,9 @@ combine them to specify new positions. .NH 3 Vector Sums and Displacements .PP -Any two positions may be added or subtracted to yield a new position. +Positions may be added or subtracted to yield a new position (to be +more precise, you can only add a position and an expression pair; the +latter must be on the right side of the addition or subtraction sign). The result is the conventional vector sum or difference of coordinates. For example, \fBlast box .ne + (0.1, 0)\fP is a valid position. This example illustrates a common use, to define a position slightly offset @@ -998,12 +1032,12 @@ Interpolation Between Positions .PP A position may be interpolated between any two positions. The syntax is `\fIfraction\fP \fBof the way between\fP \fIposition1\fP \fBand\fP -\fIposition2\fP.' For example, you can say \fB1/3 of the way between +\fIposition2\fP'. For example, you can say \fB1/3 of the way between here and last ellipse .ne\fP. The fraction may be in numerator/denominator form or may be an ordinary number (values are -\&\fInot\fP restricted to [0,1]). As an alternative to this verbose -syntax, you can say `\fIfraction\fP \fB<\fP\fIposition1\fP \fB,\fP -\fIposition2\fP\fB>\fP.'; thus, the example could also be written +\fInot\fP restricted to [0,1]). As an alternative to this verbose +syntax, you can say `\fIfraction\fP \fB<\,\fP\fIposition1\fP \fB,\fP +\fIposition2\/\fP\fB>\fP'; thus, the example could also be written as \fB1/3 <here, last ellipse>\fP. .KS .PS @@ -1013,10 +1047,11 @@ dot(P); move right 0.1; "P"; .PE .CE "3: \fBP: 1/3 of the way between last arrow .start and last arrow .end\fP" .PP -This facility can be used, for example, to double connections. +This facility can be used, for example, to draw double connections. .KS .PS -A: box "yin"; move; B: box "yang"; +A: box "yin"; move; +B: box "yang"; arrow right at 1/4 <A.e,A.ne>; arrow left at 1/4 <B.w,B.sw>; .PE @@ -1041,7 +1076,7 @@ Note the use of the short form for interpolating points. Projections of Points .PP Given two positions \fIp\fP and \fIq\fP, the position -\fB(\fP\fIp\fP\fB,\fP \fIq\fP\fB)\fP has the X coordinate of \fIp\fP +\fB(\,\fP\fIp\fP\fB,\fP \fIq\fP\fB)\fP has the X coordinate of \fIp\fP and the Y coordinate of \fIq\fP. This can be helpful in placing an object at one of the corners of the virtual box defined by two other objects. @@ -1079,7 +1114,7 @@ mechanism for connecting objects. For example, the following program box "from" move 0.75; ellipse "to" -arc cw from 1/3 of the way \\ +arc cw from 1/3 of the way \e between last box .n and last box .ne to last ellipse .n; \&.PE .R @@ -1092,36 +1127,46 @@ yields: box "from" move 0.75; ellipse "to" -arc cw from 1/3 of the way between last box .n and last box .ne to last ellipse .n; +arc cw from 1/3 of the way \ + between last box .n and last box .ne to last ellipse .n; .PE .CE "6: A tricky connection specified with English-like syntax" .PP The \fBwith\fP modifier allows you to identify a named attachment -point of an object with another point. This is very useful for connecting -objects in a natural way. For an example, consider these two programs: +point of an object (or a position within the object) with another point. +This is very useful for connecting objects in a natural way. For an +example, consider these two programs: .KS .PS [ - box wid 0.5 ht 0.5; box wid 0.75 ht 0.75; - move down from last box .s 0.1; + [ + box wid 0.5 ht 0.5; + box wid 0.75 ht 0.75; + ] + move down 0.3 from last [] .s 0.1; "\fBbox wid 0.5 ht 0.5; box wid 0.75 ht 0.75\fP" ] -move from last [].e 2 +move from last [].e 1.5 [ - box wid 0.5 ht 0.5; box wid 0.75 ht 0.75 with .sw at last box .se; - move down from last box .s 0.1; - "\fBbox wid 0.5 ht 0.5; box wid 0.75 ht 0.75 with .sw at last box .se;\fP" + [ + box wid 0.5 ht 0.5; + box wid 0.75 ht 0.75 with .sw at last box .se; + ] + move down 0.3 from last [] .s 0.1; + box invisible "\fBbox wid 0.5 ht 0.5;\fP" \ + "\fBbox wid 0.75 ht 0.75 with .sw at last box .se;\fP" ] .PE .CE "7: Using the \fBwith\fP modifier for attachments" .NH 2 -The chop modifier +The `chop' Modifier .PP When drawing lines between circles that don't intersect them at a compass point, it is useful to be able to shorten a line by the radius of the circle at either or both ends. Consider the following program: .KS .DS +.CW \&.PS circle "x" circle "y" at 1st circle - (0.4, 0.6) @@ -1131,6 +1176,7 @@ arrow from 2nd circle to 3rd circle chop arrow from 3rd circle to 1st circle chop \&.PE .DE +.R .KE .LP It yields the following: @@ -1146,11 +1192,11 @@ arrow from 3rd circle to 1st circle chop .CE "8: The \fBchop\fR modifier" .LP Notice that the \fBchop\fR attribute moves arrowheads rather than -stepping on them. By default, the \fBchop\fR modifier shortens both +stepping on them. By default, the \fBchop\fR modifier shortens both ends of the line by \fBcirclerad\fR. By suffixing it with a number you can change the amount of chopping. .PP -If you say \fBline ... chop \fIr1\fP chop \fIr2\fP\fR with \fIr1\fP +If you say \fBline .\|.\|.\& chop \fIr1\fP chop \fIr2\fP\fR with \fIr1\fP and \fIr2\fP both numbers, you can vary the amount of chopping at both ends. You can use this in combination with trigonometric functions to write code that will deal with more complex intersections. @@ -1176,15 +1222,15 @@ Here is an example. The program fragment .KS .DS .CW -\&A: [ -\& circle; -\& line up 1 at last circle .n; -\& line down 1 at last circle .s; -\& line right 1 at last circle .e; -\& line left 1 at last circle .w; -\& box dashed with .nw at last circle .se + (0.2, -0.2); -\& Caption: center of last box; -\&] +A: [ + circle; + line up 1 at last circle .n; + line down 1 at last circle .s; + line right 1 at last circle .e; + line left 1 at last circle .w; + box dashed with .nw at last circle .se + (0.2, -0.2); + Caption: center of last box; +] .R .DE .KE @@ -1212,13 +1258,13 @@ compass([junction()]); To refer to one of the composite's attachment points, you can say (for example) \fBA .s\fP. For purposes of object naming, composites are a class. You could write \fBlast [] .s\fP as an equivalent -refrence, usable anywhere a location is needed. This construction is +reference, usable anywhere a location is needed. This construction is very important for putting together large, multi-part diagrams. .PP -Blocks are also a variable-scoping mechanism, like a \fIgroff\fP(1) +Blocks are also a variable-scoping mechanism, like a \fIgroff\/\fP(1) environment. All variable assignments done inside a block are undone at the end of it. To get at values within a block, write a name of -the block followed by a dot, followed by the variable or label you +the block followed by a dot, followed by the label you want. For example, we could refer the the center of the box in the above composite as \fBlast [] .Caption\fP or \fBA.Caption\fP. .PP @@ -1237,6 +1283,30 @@ modifier. This means that the example composite could be placed relative to its caption box by a command containing \fBwith A.Caption at\fP. .PP +Note that both width and height of the block composite object are always +positive: +.KS +.PS +[ + [ + box wid -0.5 ht 0.5 + box wid 0.75 ht 0.75 + ] + move down 0.3 from last [].s 0.1 + "\fBbox wid -0.5 ht 0.5; box wid 0.75 ht 0.75\fP" +] +move from last [].e 2 +[ + [ + [ box wid -0.5 ht 0.5 ] + box wid 0.75 ht 0.75 + ] + move down 0.3 from last [].s 0.1 + "\fB[box wid -0.5 ht 0.5]; box wid 0.75 ht 0.75\fP" +] +.PE +.CE "3: Composite block objects always have positive width and height +.PP Blocks may be nested. This means you can use block attachment points to build up complex diagrams hierarchically, from the inside out. Note that \fBlast\fP and the other sequential naming mechanisms @@ -1261,7 +1331,7 @@ the arrow in the last line will be attached to object \fBP\fP, not object \fBQ\fP. .PP In DWB \fBpic\fP, only references one level deep into enclosed blocks -were permitted. GNU \fBgpic\fP removes this restriction. +were permitted. GNU \fBgpic\fP removes this restriction. .PP The combination of block variable scoping, assignability of labels and the macro facility that we'll describe later on can be used to @@ -1275,7 +1345,7 @@ change its overall behavior. We've mentioned several of them in previous sections. They're all described here. For each variable, the default is given. .TS H -tab(@), linesize(2); +center, tab(@), linesize(2); lb | lb | lb l | n | l. .sp 2p @@ -1285,9 +1355,10 @@ _ .sp 2p .TH boxht@0.5@Default height of a box -boxwid@0.75@Default height of a box +boxwid@0.75@Default width of a box lineht@0.5@Default length of vertical line linewid@0.75@Default length of horizontal line +linethick@-1@Default line thickness arcrad @0.25@Default radius of an arc circlerad@0.25@Default radius of a circle ellipseht@0.5@Default height of an ellipse @@ -1320,8 +1391,8 @@ size-related state variables so that their values remain equivalent in the new units. .PP The command \fBreset\fP resets all style variables to their defaults. -You can give it a comma-separated list of variable names as arguments, -in which case it resets only those. +You can give it a list of variable names as arguments (optionally +separated by commas), in which case it resets only those. .PP State variables retain their values across pictures until reset. .NH 1 @@ -1336,18 +1407,35 @@ Anywhere a number is expected, the language will also accept a variable. Variables may be the built-in style variable described in the last section, or new variables created by assignment. .PP -DWB \fBpic\fP supports only the ordinary assignment via =, defines the -variable in the current block if it is not already defined there, and -then changes the value in the current block. -GNU \fBgpic\fP supports an alternate form of assignment using :=. The -.I variable -(right side) must already be defined, -and the value of -.I variable -will be changed only in the innermost block in which it is defined. +DWB \fBpic\fP supports only the ordinary assignment via \fB=\fP, which +defines the variable (on the left side of the equal sign) in the current +block if it is not already defined there, and then changes the value (on +the right side) in the current block. The variable is not visible outside +of the block. This is similar to the C\~programming language where a +variable within a block shadows a variable with the same name outside of +the block. +.PP +GNU \fBgpic\fP supports an alternate form of assignment using \fB:=\fP. +The variable must already be defined, and the value will be assigned to +that variable without creating a variable local to the current block. +For example, this +.KS +.DS +.CW +x=5 +y=5 +[ + x:=3 + y=3 +] +print x " " y +.DE +.KE +.LP +prints \fB3 5\fP. .PP You can use the height, width, radius, and x and y coordinates of any -object or corner in expressions If \fBA\fP is an object label or name, +object or corner in expressions. If \fBA\fP is an object label or name, all the following are valid: .KS .DS @@ -1360,30 +1448,34 @@ A.ht # and its height .R .DE .KE +.LP Note the second expression, showing how to extract a corner coordinate. .PP -Basic arithmetic resembling those of C operators are available; +, *, --, /, and %. So is ^ for exponentiation. Grouping is permitted in -the usual way using parentheses. GNU \fBgpic\fP allows logical -operators to appear in expressions; ! (logical negation, not -factorial), &&, ||, ==, !=, >=, <=, <, >. +Basic arithmetic resembling those of C operators are available; \fB+\fP, +\fB*\fP, \fB-\fP, \fB/\fP, and \fB%\fP. So is \fB^\fP for exponentiation. +Grouping is permitted in the usual way using parentheses. GNU \fBgpic\fP +allows logical operators to appear in expressions; \fB!\&\fP (logical +negation, not factorial), \fB&&\fP, \fB|\||\fP, \fB==\fP, \fB!=\fP, +\fB>=\fP, \fB<=\fP, \fB<\fP, \fB>\fP. .PP Various built-in functions are supported: \fBsin(\fIx\fB)\fR, \fBcos(\fIx\fB)\fR, \fBlog(\fIx\fB)\fR, \fBexp(\fIx\fB)\fR, \fBsqrt(\fIx\fB)\fR, \fBmax(\fIx\fB,\fIy\fB)\fR, \fBatan2(\fIx\fB,\fIy\fB)\fR, \fBmin(\fIx\fB,\fIy\fB)\fR, -\fBint(\fIx\fB)\fR, and \fBrand()\fP. +\fBint(\fIx\fB)\fR, \fBrand()\fP, and \fBsrand()\fP. Both \fBexp\fP and \fBlog\fP are -base 10; \fBint\fP does integer truncation; and \fBrand()\fP returns a -random number in [0-1). +base\~10; \fBint\fP does integer truncation; \fBrand()\fP returns a +random number in [0-1), and \fBsrand()\fP sets the seed for +a new sequence of pseudo-random numbers to be returned by \fBrand()\fP +(\fBsrand()\fP is a GNU extension). .PP GNU \fBgpic\fP also documents a one-argument form or rand, \fBrand(\fIx\fB)\fR, which returns a random number between 1 and \fIx\fP, but this is deprecated and may be removed in a future version. .PP -The function \fBsprintf()\fP behaves like a C \fIsprintf\fP(3) that -only takes %, %e, %f, and %g format strings. +The function \fBsprintf()\fP behaves like a C \fIsprintf\/\fP(3) +function that only takes %, %e, %f, and %g format strings. .NH 1 Macros .PP @@ -1402,65 +1494,71 @@ This defines \fIname\fR as a macro to be replaced by the replacement text (not including the braces). The macro may be called as .DS .CW -\fIname\fB(\fIarg1, arg2, ... argn\fB)\fR +\fIname\fB(\fIarg1, arg2, \|.\|.\|.\& argn\fB)\fR .R .DE .LP -The arguments (if any) will be substituted for tokens $1, $2 ... $n +The arguments (if any) will be substituted for tokens \fB$1\fP, \fB$2\fP +\&.\|.\|.\& \fB$n\fP appearing in the replacement text. .PP -As an example of macro use, consider the following: +As an example of macro use, consider this: .KS .DS .CW +.ps -1 +.vs -1 \&.PS -\&# Plot a single jumper in a $1 by $2 box, $3 is the on-off state -\&define jumper { [ -\& shrinkfactor = 0.8; -\& Outer: box invis wid 0.5 ht 1; -\& -\& # Count on end ] to reset these -\& boxwid = Outer.wid * shrinkfactor / 2; -\& boxht = Outer.ht * shrinkfactor / 2; -\& -\& box fill (!$1) with .s at center of Outer; -\& box fill ($1) with .n at center of Outer; -\&] } -\& -\&# Plot a block of six jumpers -\&define jumperblock { -\& jumper($1); -\& jumper($2); -\& jumper($3); -\& jumper($4); -\& jumper($5); -\& jumper($6); -\& -\& jwidth = last [].Outer.wid; -\& jheight = last [].Outer.ht; -\& -\& box with .nw at 6th last [].nw wid 6*jwidth ht jheight; -\& -\& # Use {} to avoid changing position from last box draw. -\& # This is necessary so move in any direction will work as expected -\& {"Jumpers in state $1$2$2$3$4$5$6" at last box .s + (0, -0.2);} -\&} -\& -\&# Sample macro invocations -\&jumperblock(1,1,0,0,1,0); -\&move; -\&jumperblock(1,0,1,0,1,1); -.PE +# Plot a single jumper in a box, $1 is the on-off state. +define jumper { [ + shrinkfactor = 0.8; + Outer: box invis wid 0.45 ht 1; + + # Count on end ] to reset these + boxwid = Outer.wid * shrinkfactor / 2; + boxht = Outer.ht * shrinkfactor / 2; + + box fill (!$1) with .s at center of Outer; + box fill ($1) with .n at center of Outer; +] } + +# Plot a block of six jumpers. +define jumperblock { + jumper($1); + jumper($2); + jumper($3); + jumper($4); + jumper($5); + jumper($6); + + jwidth = last [].Outer.wid; + jheight = last [].Outer.ht; + + box with .nw at 6th last [].nw wid 6*jwidth ht jheight; + + # Use {} to avoid changing position from last box draw. + # This is necessary so move in any direction will work as expected + {"Jumpers in state $1$2$3$4$5$6" at last box .s + (0, -0.2);} +} + +# Sample macro invocations. +jumperblock(1,1,0,0,1,0); +move; +jumperblock(1,0,1,0,1,1); +\&.PE +.ps +.vs .R .DE .KE +.LP It yields the following: .KS .PS -# Plot a single jumper in a $1 by $2 box, $3 is the on-off state +# Plot a single jumper in a box, $1 is the on-off state. define jumper { [ shrinkfactor = 0.8; - Outer: box invis wid 0.5 ht 1; + Outer: box invis wid 0.45 ht 1; # Count on end ] to reset these boxwid = Outer.wid * shrinkfactor / 2; @@ -1486,12 +1584,12 @@ define jumperblock { # Use {} to avoid changing position from last box draw. # This is necessary so move in any direction will work as expected - {"Jumpers in state $1$2$2$3$4$5$6" at last box .s + (0, -0.2);} + {"Jumpers in state $1$2$3$4$5$6" at last box .s + (0, -0.2);} } # Sample macro invocations jumperblock(1,1,0,0,1,0); -move; +move 0.25; jumperblock(1,0,1,0,1,1); .PE .CE "1: Sample use of a macro" @@ -1500,9 +1598,10 @@ This macro example illustrates how you can combine [], brace grouping, and variable assignment to write true functions. .PP One detail the example above does not illustrate is the fact that -macro argument parsing is not token-oriented. If you call \fBjumper( -1 )\fP, the value of $1 will be \fB" 1 "\fP. You could even call -\fBjumper(big string)\fP to give $1 the value \fB"big string"\fP. +macro argument parsing is not token-oriented. If you call +\fBjumper(\ 1\ )\fP, the value of $1 will be \fB"\ 1\ "\fP. You could +even call \fBjumper(big\ string)\fP to give $1 the value +\fB"big\ string"\fP. .PP If you want to pass in a coordinate pair, you can avoid getting tripped up by the comma by wrapping the pair in parentheses. @@ -1527,37 +1626,39 @@ The statement .DS \f(CWcopy\fP \fIfilename\fR .DE +.LP inserts the contents of \fIfilename\fR in the \fBpic\fP input stream. -Any .PS/.PE pair in the file will be ignored. This, you can use this -to include pre-generated images. +Any \fB.PS\fP/\fB.PE\fP pair in the file will be ignored. This, you +can use this to include pre-generated images. .PP A variant of this statement replicates the \fBcopy thru\fP feature of -\fIgrap\fP(1). If you say +\fIgrap\fP(1). The call .DS \f(CWcopy\fP \fIfilename\fR \f(CWthru\fP \fImacro\fP .DE .LP -calls the \fImacro\fP (which may be either a name or replacement text) +calls \fImacro\fP (which may be either a name or replacement text) on the arguments obtained by breaking each line of the file into -blank-separated fields. The macro may have up to 9 arguments. The +blank-separated fields. The macro may have up to 9\~arguments. The replacement text may be delimited by braces or by a pair of instances of any character not appearing in the rest of the text. .PP If you write .DS -\f(CWcopy thru\fP \fImacro\fP +\f(CWcopy\fP \f(CWthru\fP \fImacro\fP .DE .LP omitting the filename, lines to be parsed are taken from the input -source up to the next .PE. +source up to the next \fB.PE\fP. .PP -In either of the \fBcopy\fP commands, GNU \fBgpic\fP permits a -trailing `\fBuntil\fP \fIword\fP' clause to be added which terminates +In either of the last two \fBcopy\fP commands, GNU \fBgpic\fP permits a +trailing `\fBuntil\fP \fIword\/\fP' clause to be added which terminates the copy when the first word matches the argument (the default behavior is therefore equivalent to \fBuntil .PE\fP). .PP Accordingly, the command .RS +.KS .IP .ft CW .nf @@ -1571,10 +1672,12 @@ box \&.PE .R .fi +.KE .RE .LP is equivalent to .RS +.KS .IP .ft CW .nf @@ -1586,14 +1689,14 @@ box \&.PE .R .fi +.KE .RE .NH 2 Debug Messages .PP -The command \fBprint\fR accepts any number of comma-separated -arguments, concatenates their output forms, and writes the result to -standard error. Each argument must be an expression, a position, or -a text string. +The command \fBprint\fR accepts any number of arguments, concatenates +their output forms, and writes the result to standard error. Each +argument must be an expression, a position, or a text string. .NH 2 Escape to Post-Processor .PP @@ -1603,23 +1706,23 @@ If you write .DE .LP \fBpic\fP concatenates the arguments and pass them through as a line -to troff or \*(tx. Each +to troff or \*[tx]. Each .I arg must be an expression, a position, or text. This has a similar effect to a line beginning with .B . or -\fB\e\fR, +\fB\e\fR\|, but allows the values of variables to be passed through. .NH 2 Executing Shell Commands .PP The command .DS -\f(CWsh { \fIanything...\fP }\fP +\f(CWsh\fP \f(CW{\fP \fIanything.\|.\|.\fP \f(CW}\fP .DE .LP -macroexpands the text in braces, then executes it as a shell command. +macro-expands the text in braces, then executes it as a shell command. This could be used to generate images or data tables for later inclusion. The delimiters shown as {} here may also be two copies of any one character not present in the shell command text. In either @@ -1657,12 +1760,12 @@ for i = 0 to 2 * pi by 0.1 do { .LP The syntax of the \fBfor\fP statement is: .DS -\fBfor\fR \fIvariable\fR \fB=\fR \fIexpr1\fR \fBto\fR \fIexpr2\fR \ -[\fBby\fR [\fB*\fR]\fIexpr3\fR] \fBdo\fR \fIX\fR \fIbody\fR \fIX\fR +\fBfor\fR \fIvariable\fR \fB=\fR \fIexpr1\/\fR \fBto\fR \fIexpr2\/\fR \ +[\fBby\fR [\fB*\fR]\fIexpr3\/\fR] \fBdo\fR \fIX\fR \fIbody\fR \fIX\fR .DE The semantics are as follows: Set .I variable -to \fIexpr\fR1 . +to \fIexpr1\fR. While the value of .I variable is less than or equal to @@ -1677,10 +1780,10 @@ if .B by is not given, increment .I variable -by 1. +by\~1. If .I expr3 -is prefixed by +is prefixed by\~\c .B * then .I variable @@ -1688,12 +1791,13 @@ will instead be multiplied by \fIexpr3\fR. .I X can be any character not occurring in -\fIbody\fR; or the two Xs may be paired braces (as in the \fBsh\fR command). +\fIbody\fR; or the two \fIX\/\fPs may be paired braces (as in the +\fBsh\fR command). .PP The syntax of the \fBif\fP statement is as follows: .DS \fBif\fR \fIexpr\fR \fBthen\fR \fIX\fR \fIif-true\fR \fIX\fR \ -[\fBelse\fR \fIY\fR \fIif-false\fR \fIY\fR] +[\fBelse\fR \fIY\fR \fIif-false\fR \fIY\/\fR] .DE Its semantics are as follows: Evaluate \fIexpr\fR; @@ -1708,81 +1812,91 @@ can be any character not occurring in can be any character not occurring in \fIif-false\fR. .PP -Eithe or both of the X or Y pairs may instead be balanced pairs of -braces ({ and }) as in the \fBsh\fR command. In either case, the +Eithe or both of the +.I X +or +.I Y +pairs may instead be balanced pairs of +braces ({ and\~}) as in the \fBsh\fR command. In either case, the \fIif-true\fR may contain balanced pairs of braces. None of these delimiters will be seen inside strings. .PP All the usual relational operators my be used in conditional expressions; -! (logical negation, not factorial), &&, ||, ==, !=, >=, <=, <, >. +\fB!\&\fP (logical negation, not factorial), \fB&&\fP, \fB|\||\fP, \fB==\fP, +\fB!=\fP, \fB>=\fP, \fB<=\fP, \fB<\fP, \fB>\fP. .PP -String comparison is also supported using == and !=. String +String comparison is also supported using \fB==\fP and \fB!=\fP. String comparisons may need to be parenthesized to avoid syntactic ambiguities. .NH 1 Interface To [gt]roff .PP The output of \fBpic\fP is \fB[gt]roff\fP drawing commands. The GNU -\fIgpic\fP(1) command warns that it relies on drawing extensions -present in \fIgroff\fP(1) that are not present in \fItroff\fP(1). +\fIgpic\/\fP(1) command warns that it relies on drawing extensions +present in \fIgroff\/\fP(1) that are not present in \fItroff\/\fP(1). .NH 2 Scaling Arguments .PP -The DWB \fIpic\fP(1) program will accept one or two arguments to +The DWB \fIpic\/\fP(1) program will accept one or two arguments to \&\fB.PS\fP, which is interpreted as a width and height in inches to -which the results of \fIpic\fP(1) should be scaled (width and height +which the results of \fIpic\/\fP(1) should be scaled (width and height scale independently). If there is only one argument, it is interpreted as a width to scale the picture to, and height will be scaled by the same proportion. .PP GNU \fBgpic\fP is less general; it will accept a single width to scale to, or a zero width and a maximum height to scale to. With -two nonzero arguments, it will scale to the maximum height. +two non-zero arguments, it will scale to the maximum height. .NH 2 How Scaling is Handled .PP -When \fBpic\fP processes a picture description on input, it passes .PS -and .PE through to the postprocessor. The .PS gets decorated with two -numeric arguments which are the X and Y dimensions of the picture in -inches. The post-processor can use these to reserve space for the -picture and center it. +When \fBpic\fP processes a picture description on input, it passes +\fB.PS\fP and \fB.PE\fP through to the postprocessor. The \fB.PS\fP +gets decorated with two numeric arguments which are the X and +Y\~dimensions of the picture in inches. The post-processor can use +these to reserve space for the picture and center it. .PP -The \fBmgs\fP macros, for example, include the following definitions: +The GNU incarnation of the \fBms\fP macro package, for example, includes +the following definitions: .KS .DS +.ps -1 +.vs -1 .CW \&.de PS \&.br -\&.sp \\n[DD]u -\&.ie \\n[.$]<2 .@error bad arguments to PS (not preprocessed with pic?) -\&.el \{\ -\&. ds@need (u;\\$1)+1v -\&. in +(u;\\n[.l]-\\n[.i]-\\$2/2>?0) -\&.\} +\&.sp \e\en[DD]u +\&.ie \e\en[.$]<2 .@error bad arguments to PS (not preprocessed with pic?) +\&.el \e{\e +\&. ds@need (u;\e\e$1)+1v +\&. in +(u;\e\en[.l]-\e\en[.i]-\e\e$2/2>?0) +\&.\e} \&.. \&.de PE \&.par@reset -\&.sp \\n[DD]u+.5m +\&.sp \e\en[DD]u+.5m \&.. .R .DE +.ps +.vs .KE .LP -Equivalent definition will be supplied by GNU \fIpic\fP(1) if you use -the -mpic option; this should make it usable with macro pages other -than \fIms\fR(1). +Equivalent definition will be supplied by GNU \fIpic\/\fP(1) if you use +the \-mpic option; this should make it usable with macro pages other +than \fIms\/\fR(1). .PP -if .PF is used instead of .PE, the \fBtroff\fP position is restored to -what it was at the picture start (Kernighan notes that the F stands -for "flyback"). +If \fB.PF\fP is used instead of \fB.PE\fP, the \fBtroff\fP position is +restored to what it was at the picture start (Kernighan notes that +the\~F stands for \[lq]flyback\[rq]). .PP The invocation .DS -\&\fB.PS <\fP\fIfile\fP +\&\fB.PS <\,\fP\fIfile\fP .DE .LP -causes the contents of \fIfile\fP to replace the .PS line. This -feature is deprecated; use \fBcopy file\fR instead). +causes the contents of \fIfile\fP to replace the \fB.PS\fP line. This +feature is deprecated; use `\fBcopy\fP \fIfile\fR' instead). .PP By default, input lines that begin with a period are passed to the postprocessor, embedded at the corresponding point in the output. @@ -1796,10 +1910,10 @@ The state of \fB[gt]roff\fP's fill mode is preserved across pictures. .PP The Kernighan paper notes that there is a subtle problem with complicated equations inside \fBpic\fR pictures; they come out wrong if -\fIeqn\fP(1) has to leave extra vertical space for the equation. +\fIeqn\/\fP(1) has to leave extra vertical space for the equation. If your equation involves more than subscripts and superscripts, you must add to the beginning of each equation the extra information -\f(CWspace 0\fP. He gives the following example: +\fBspace\~0\fP. He gives the following example: .KS .DS .CW @@ -1823,16 +1937,16 @@ arrow Interface to TeX .PP .PP -\*(tx mode is enabled by the +\*[tx] mode is enabled by the .B \-t option. -In \*(tx mode, pic will define a vbox called +In \*[tx] mode, pic will define a vbox called .B \egraph for each picture. You must yourself print that vbox using, for example, the command .RS .LP -.B +.CW \ecenterline{\ebox\egraph} .RE .LP @@ -1840,15 +1954,15 @@ Actually, since the vbox has a height of zero this will produce slightly more vertical space above the picture than below it; .RS .LP -.B +.CW \ecenterline{\eraise 1em\ebox\egraph} .RE .LP would avoid this. .PP -You must use a \*(tx driver that supports the +You must use a \*[tx] driver that supports the .B tpic -specials, version 2. +specials, version\~2. .PP Lines beginning with .B \e @@ -1856,16 +1970,16 @@ are passed through transparently; a .B % is added to the end of the line to avoid unwanted spaces. You can safely use this feature to change fonts or to -change the value of \fI\ebaselineskip\fR. +change the value of \fB\ebaselineskip\fR. Anything else may well produce undesirable results; use at your own risk. Lines beginning with a period are not given any special treatment. .PP -The \(*tx mode of \fIpic\fP(1) will \fInot\fP translate \fBtroff\fP +The \*[tx] mode of \fIpic\/\fP(1) will \fInot\fP translate \fBtroff\fP font and size changes included in text strings! .NH 1 Obsolete Commands .PP -GNU \fIgpic\fP(1) has a command +GNU \fIgpic\/\fP(1) has a command .DS \fBplot\fR \fIexpr\fR [\fB"\fItext\fB"\fR] .DE @@ -1876,7 +1990,7 @@ with an argument of \fIexpr\fP. If .I text -is omitted a format string of "%g" is used. +is omitted a format string of \fB"%g"\fP is used. Attributes can be specified in the same way as for a normal text object. Be very careful that you specify an appropriate format string; @@ -1887,44 +2001,51 @@ This is deprecated in favour of Some Larger Examples .PP Here are a few larger examples, with complete source code. -.PP One of our earlier examples is generated in an instructive way using a for loop: .KS .DS +.ps -1 +.vs -1 .CW \&.PS -\&# Draw a demonstration up left arrow with grid box overlay -\&define gridarrow -\&{ -\& [ -\& {arrow up left $1;} -\& box wid 0.5 ht 0.5 dotted with .nw at last arrow .end; -\& for i = 2 to ($1 / 0.5) do -\& { -\& box wid 0.5 ht 0.5 dotted with .sw at last box .se; -\& } -\& move down from last arrow .center; -\& [ -\& if ( $1 == boxht ) then { "\\fBline up left\\fP" } else { sprintf("\\fBarrow up left %g\\fP", $1) }; -\& ] -\& ] -\& move right from last [] .e; -\&} -\&gridarrow(0.5); -\&gridarrow(1); -\&gridarrow(1.5); -\&gridarrow(2); -\&undef gridarrow +# Draw a demonstration up left arrow with grid box overlay +define gridarrow +{ + move right 0.1 + [ + {arrow up left $1;} + box wid 0.5 ht 0.5 dotted with .nw at last arrow .end; + for i = 2 to ($1 / 0.5) do + { + box wid 0.5 ht 0.5 dotted with .sw at last box .se; + } + move down from last arrow .center; + [ + if ( $1 == boxht ) \e + then { "\efBline up left\efP" } \e + else { sprintf("\efBarrow up left %g\efP", $1) }; + ] + ] + move right 0.1 from last [] .e; +} +gridarrow(0.5); +gridarrow(1); +gridarrow(1.5); +gridarrow(2); +undef gridarrow \&.PE .R .DE +.ps +.vs .KE .KS .PS # Draw a demonstration up left arrow with grid box overlay define gridarrow { + move right 0.1 [ {arrow up left $1;} box wid 0.5 ht 0.5 dotted with .nw at last arrow .end; @@ -1934,10 +2055,12 @@ define gridarrow } move down from last arrow .center; [ - if ( $1 == boxht ) then { "\fBline up left\fP" } else { sprintf("\fBarrow up left %g\fP", $1) }; + if ( $1 == boxht ) \ + then { "\fBline up left\fP" } \ + else { sprintf("\fBarrow up left %g\fP", $1) }; ] ] - move right from last [] .e; + move right 0.1 from last [] .e; } gridarrow(0.5); gridarrow(1); @@ -1951,71 +2074,75 @@ Here's an example concocted to demonstrate layout of a large, multiple-part pattern: .KS .DS +.ps -1 +.vs -1 .CW \&.PS -\&define filter {box ht 0.25 rad 0.125} -\&lineht = 0.25; -\&Top: [ -\& right; -\& box "\\fBms\\fR" "sources"; -\& move; -\& box "\\fBHTML\\fR" "sources"; -\& move; -\& box "\\fBlinuxdoc-sgml\\fP" "sources" wid 1.5; -\& move; -\& box "\\fBTexinfo\\fP" "sources"; -\& -\& line down from 1st box .s lineht; -\& A: line down; -\& line down from 2nd box .s; filter "\\fBhtml2ms\\fP"; -\& B: line down; -\& line down from 3rd box .s; filter "\\fBformat\\fP"; -\& C: line down; -\& line down from 4th box .s; filter "\\fBtexi2roff\\fP"; -\& D: line down; -\&] -\&move down 1 from last [] .s; -\&Anchor: box wid 1 ht 0.75 "\\fBms\\fR" "intermediate" "form"; -\&arrow from Top.A.end to Anchor.nw; -\&arrow from Top.B.end to 1/3 of the way between Anchor.nw and Anchor.ne; -\&arrow from Top.C.end to 2/3 of the way between Anchor.nw and Anchor.ne; -\&arrow from Top.D.end to Anchor.ne -\&{ -\& # PostScript column -\& move to Anchor .sw; -\& line down left then down ->; -\& filter "\\fBpic\\fP"; -\& arrow; -\& filter "\\fBeqn\\fP"; -\& arrow; -\& filter "\\fBtbl\\fP"; -\& arrow; -\& filter "\\fBgroff\\fP"; -\& arrow; -\& box "PostScript"; -\& -\& # HTML column -\& move to Anchor .se; -\& line down right then down ->; -\& A: filter dotted "\\fBpic2img\\fP"; -\& arrow; -\& B: filter dotted "\\fBeqn2html\\fP"; -\& arrow; -\& C: filter dotted "\\fBtbl2html\\fP"; -\& arrow; -\& filter "\\fBms2html\\fP"; -\& arrow; -\& box "HTML"; -\& -\& # Nonexistence caption -\& box dashed wid 1 at B + (2, 0) "These tools" "don't yet exist"; -\& line chop 0 chop 0.1 dashed from last box .nw to A.e ->; -\& line chop 0 chop 0.1 dashed from last box .w to B.e ->; -\& line chop 0 chop 0.1 dashed from last box .sw to C.e ->; -\&} +define filter {box ht 0.25 rad 0.125} +lineht = 0.25; +Top: [ + right; + box "\efBms\efR" "sources"; + move; + box "\efBHTML\efR" "sources"; + move; + box "\efBlinuxdoc-sgml\efP" "sources" wid 1.5; + move; + box "\efBTexinfo\efP" "sources"; + + line down from 1st box .s lineht; + A: line down; + line down from 2nd box .s; filter "\efBhtml2ms\efP"; + B: line down; + line down from 3rd box .s; filter "\efBformat\efP"; + C: line down; + line down from 4th box .s; filter "\efBtexi2roff\efP"; + D: line down; +] +move down 1 from last [] .s; +Anchor: box wid 1 ht 0.75 "\efBms\efR" "intermediate" "form"; +arrow from Top.A.end to Anchor.nw; +arrow from Top.B.end to 1/3 of the way between Anchor.nw and Anchor.ne; +arrow from Top.C.end to 2/3 of the way between Anchor.nw and Anchor.ne; +arrow from Top.D.end to Anchor.ne +{ + # PostScript column + move to Anchor .sw; + line down left then down ->; + filter "\efBpic\efP"; + arrow; + filter "\efBeqn\efP"; + arrow; + filter "\efBtbl\efP"; + arrow; + filter "\efBgroff\efP"; + arrow; + box "PostScript"; + + # HTML column + move to Anchor .se; + line down right then down ->; + A: filter dotted "\efBpic2img\efP"; + arrow; + B: filter dotted "\efBeqn2html\efP"; + arrow; + C: filter dotted "\efBtbl2html\efP"; + arrow; + filter "\efBms2html\efP"; + arrow; + box "HTML"; + + # Nonexistence caption + box dashed wid 1 at B + (2, 0) "These tools" "don't yet exist"; + line chop 0 chop 0.1 dashed from last box .nw to A.e ->; + line chop 0 chop 0.1 dashed from last box .w to B.e ->; + line chop 0 chop 0.1 dashed from last box .sw to C.e ->; +} \&.PE .R .DE +.ps +.vs .KE .KS .PS @@ -2086,7 +2213,7 @@ arrow from Top.D.end to Anchor.ne .NH 1 PIC Reference .PP -This is an annotated grammar of PIC. +This is an annotated grammar of \fBpic\fP. .NH 2 Lexical Items .PP @@ -2094,42 +2221,68 @@ In general, \fBpic\fP is a free-format, token-oriented language that ignores whitespace outside strings. But certain lines and contructs are specially interpreted at the lexical level: .PP -A comment begins with # and continues to \en (comments may also follow -text in a line). A line beginning with a period or backslash may be -interpreted as text to be passed through to the post-processor, -depending on command-line options. An end-of-line backslash is -interpreted as a request to continue the line; the backslash and -following newline are ignored. -.LP +A comment begins with \fB#\fP and continues to \fB\en\fP (comments may +also follow text in a line). A line beginning with a period or +backslash may be interpreted as text to be passed through to the +post-processor, depending on command-line options. An end-of-line +backslash is interpreted as a request to continue the line; the +backslash and following newline are ignored. +.PP +.RS Here are the grammar terminals: -.IP <number> -A decimal numeric constant. May contain a decimal point or be -expressed in scientific notation in the style of \fIprintf\fP(3)'s %e -escape. (All variables are represented internally in floating-point.) -.IP <string> -Any ASCII characters surrounded by a pair of double quotes. May -contain a double quote if preceded by a backslash. -.IP <variable> -A lower-case alphabetic character, followed by any number of -alphanumerics. (Values of variables are preserved across pictures.) -.IP <label> -An upper-case alphabetic character, followed by any number of -alphanumerics. +.IP \s[-1]INT\s[0] +A positive integer. +.IP \s[-1]NUMBER\s[0] +A floating point numeric constant. May contain a decimal point or be +expressed in scientific notation in the style of \fIprintf\/\fP(3)'s %e +escape. A trailing `i' or `I' (indicating the unit `inch') is ignored. +.IP \s[-1]TEXT\s[0] +A string enclosed in double quotes. A double quote within \s[-1]TEXT\s[0] +must be preceded by a backslash. Instead of \s[-1]TEXT\s[0] you can use +.DS +.CW +sprintf ( TEXT [, <expr> ...] ) +.R +.DE +.IP +except after the `until' and `last' keywords, and after all ordinal +keywords (`th' and friends). +.IP \s[-1]VARIABLE\s[0] +A string starting with a character from the set [a-z], optionally +followed by one or more characters of the set [a-zA-Z0-9_]. +(Values of variables are preserved across pictures.) +.IP \s[-1]LABEL\s[0] +A string starting with a character from the set [A-Z], optionally +followed by one or more characters of the set [a-zA-Z0-9_]. +.IP \s[-1]COMMAND-LINE\s[0] +A line starting with a command character (`.' in groff mode, `\e' in +\*[tx] mode). +.IP \s[-1]BALANCED-TEXT\s[0] +A string either enclosed by `{' and `}' or with \fIX\fP and \fIX\fP, +where \fIX\fP doesn't occur in the string. +.IP \s[-1]BALANCED-BODY\s[0] +Delimiters as in \s[-1]BALANCED-TEXT\s[0]; the body will be interpreted as +`\fB\[la]command\[ra].\|.\|.\fP'. +.IP \s[-1]FILENAME\s[0] +The name of a file. This has the same semantics as \s[-1]TEXT\s[0]. +.IP \s[-1]MACRONAME\s[0] +Either \s[-1]VARIABLE\s[0] or \s[-1]LABEL\s[0]. +.RE .NH 2 Semi-Formal Grammar .PP -Tokens not enclosed in <> are literals, except: +Tokens not enclosed in \[la]\|\[ra] are literals, except: .IP 1. -\en is a newline +\fB\en\fP is a newline. .IP 2. -three dots is a suffix meaning \&`replace with 0 or more repetitions -of the preceding element. +Three dots is a suffix meaning `replace with 0 or more repetitions +of the preceding element(s). .IP 3. -enclosure in square brackets has its usual meaning of `this clause is +An enclosure in square brackets has its usual meaning of `this clause is optional'. .IP 4. Square-bracket-enclosed portions within tokens are optional. Thus, -\fBh[eigh]t\fR matches either `height' or `ht'. +`h\^[eigh]\^t' matches either `height' or `ht'. .LP If one of these special tokens has to be referred to literally, it is surrounded with single quotes. @@ -2137,169 +2290,351 @@ surrounded with single quotes. The top-level \fBpic\fP object is a picture. .DS .CW -<picture> ::= .PS [width [height]]\en - <statement> ... - .PE \en +<picture> ::= + .PS [NUMBER [NUMBER]]\en + <statement> ... + .PE \en .R .DE -.LP -The \fIwidth\fP and \fIheight\fP arguments, if present, cause -\fBpic\fR to attempt to scale the picture to the given dimensions in -inches. In no case, however, will the X and Y dimensions of the -picture exceed the values of the style variables \fBmaxpswid\fP, -\fBmaxpsheight\fP (which default to the normal 8.5 by 11 page size)\fP. -.LP -If the ending .PS is replaced by .PF, the page vertical position is -restored to its value at the time .PS was encountered. Another -alternate form of invocation is \f(CW.PS <\fIfilename\fR, which -replaces the .PS line with a file to be interpreted by \fBpic\fR (but +.PP +The arguments, if present, represent the width and height of the picture, +causing \fBpic\fR to attempt to scale it to the given dimensions in +inches. In no case, however, will the X and Y\~dimensions of the +picture exceed the values of the style variables \fBmaxpswid\fP and +\fBmaxpsheight\fP (which default to the normal 8.5\^i by 11\^i page size). +.PP +If the ending `.PE' is replaced by `.PF', the page vertical position is +restored to its value at the time `.PS' was encountered. Another +alternate form of invocation is `.PS\ <\s[-1]FILENAME\s[0]', which +replaces the `.PS' line with a file to be interpreted by \fBpic\fR (but this feature is deprecated). -.LP -The .PS, .PE, and .PF macros to perform centering and scaling are +.PP +The `.PS', `.PE', and `.PF' macros to perform centering and scaling are normally supplied by the post-processor. +.PP +In the following, either `|' or a new line starts an alternative. .DS .CW - -<statement> ::= <command> ; - <command> \en - -<command> ::= <primitive> <modifier>... - <label> : <command> - <label> : <position> - <variable> = <expr> - <direction> - { <command> ... } - '[' <command> ... ']' - for <var> = <expr> to <expr> [by <expr>] do { <command> ... } - if <expr> then { <command> ... } [else { <command> ... }] - copy <filename> [until <word>] - copy <filename> thru <macroname> [until <word>] - sh <balanced-text> - print <print-item> - reset [ <variable> ... ] +<statement> ::= + <command> ; + <command> \en .R .DE -.LP -The current position and direction are saved on entry to a { } and -restored on exit from it. -.LP -Drawn objects within [ ] are treated as a single composite object with -a rectangular shape (that of the bounding box of all the elements). -Variable and label assignments within a block are local to the block. -Current direction of motion is restored to the value at start of block -upon exit. Position is \fInot\fR restored (unlike { }) instead, the -current position becomes the exit position for the current direction -on the block's bounding box. .DS .CW -<primitive> ::= box \fR# Closed object -- rectangle\fP - circle \fR# Closed object -- circle\fP - ellipse \fR# Closed object -- ellipse\fP - arc \fR# Open object -- quarter-circle\fP - line \fR# Open object -- line\fP - arrow \fR# Open object -- line with arrowhead\fP - spline \fR# Open object -- spline curve\fP - move - <text> <text> ... \fR# Text within invisible box\fP - -<attribute> ::= h[eigh]t <expr> \fR# Set height of closed figure \fP - wid[th] <expr> \fR# Set width of closed figure \fP - rad[ius] <expr> \fR# Set radius of circle/arc \fP - diam[eter] <expr> \fR# Set diameter of circle/arc \fP - up [ <expr> ] \fR# Move up \fP - down [ <expr> ] \fR# Move down \fP - left [ <expr> ] \fR# Move left \fP - right [ <expr> ] \fR# Move right \fP - from <position> \fR# Set from position of open figure\fP - to <position> \fR# Set to position of open figure\fP - at <position> \fR# Set center of open figure\fP - with <corner> \fR# Fix corner at specified location\fP - by <expr> <expr> \fR# Set object's attachment point\fP - then \fR# Sequential segment composition\fP - dotted [ <expr> ] \fR# Set dotted line style\fP - dashed [ <expr> ] \fR# Set dashed line style\fP - chop [ <expr> ] \fR# Chop end(s) of segment\fP - -> \fR# Decorate with "to" arrow\fP - <- \fR# Decorate with "from" arrow\fP - <-> \fR# Decorate with both arrows\fP - invis \fR# Make primitive invisible\fP - solid \fR# Make closed figure solid\fP - fill <expr> \fR# Set fill density for figure\fP - same \fR# Copy size of previous object\fP - <text> <text> ... \fR# Text within object\fP - <expr> \fR# Motion in the current direction\fR +<command> ::= + <primitive> [<attribute>] + LABEL : [;] <command> + LABEL : [;] <command> [<position>] + { <command> ... } + VARIABLE [:] = <any-expr> + up | down | left | right + COMMAND-LINE + command <print-arg> ... + print <print-arg> ... + sh BALANCED-TEXT + copy FILENAME + copy [FILENAME] thru MACRONAME [until TEXT] + copy [FILENAME] thru BALANCED-BODY [until TEXT] + for VARIABLE = <expr> to <expr> [by [*] <expr>] do BALANCED-BODY + if <any-expr> then BALANCED-BODY [else BALANCED-BODY] + reset [VARIABLE [[,] VARIABLE ...]] +.R +.DE +.DS +.CW +<print-arg> ::= + TEXT + <expr> + <position> .R .DE -.LP -Missing attributes are supplied from defaults; inappropriate ones are -silently ignored. For lines, splines, and arcs, height and width -refer to arrowhead size. .PP -The \f(CWat\fP primitive sets the center of the current object. The -\f(CWwith\fP attribute fixes the specified feature of the given object -to a specified location. +The current position and direction are saved on entry to a `{\ .\|.\|.\ }' +construction and restored on exit from it. .PP -The \f(CWby\fR primitive is not documented in the tutorial portion of -the Kernighan paper, and should probably be considered unreliable. +Note that in `if' constructions, newlines can only occur in +\s[-1]BALANCED-BODY\s[0]. This means that +.DS +.CW +if +{ ... } +else +{ ... } +.R +.DE .PP -The primitive \fBarrow\fR is a synonym for \fBline ->\fR. +will fail. You have to use the braces on the same line as the keywords: .DS .CW -<text> ::= <string> [ <placement> ... ] - sprintf("format", <expr> ...) [ <placement> ... ] - -<placement> ::= center | ljust | rjust | above | below +if { +\&... +} else { +\&... +} .R .DE -.LP +.PP +This restriction doesn't hold for the body after the `do' in a `for' +construction. +.DS +.CW +<any-expr> ::= + <expr> + <text-expr> + <any-expr> <logical-op> <any-expr> + ! <any-expr> +.R +.DE +.DS +.CW +<logical-op> ::= + == | != | && | '||' +.R +.DE +.DS +.CW +<text-expr> ::= + TEXT == TEXT + TEXT != TEXT +.R +.DE +.PP +Logical operators are handled specially by \fBpic\fP since they can +deal with text strings also. \fBpic\fP uses \%\fIstrcmp\/\fP(3) to test +for equality of strings; an empty string is considered as `false' for +`&&' and `|\||'. +.DS +.CW +<primitive> ::= + box \fR# closed object \[em] rectangle\fP + circle \fR# closed object \[em] circle\fP + ellipse \fR# closed object \[em] ellipse\fP + arc \fR# open object \[em] quarter-circle\fP + line \fR# open object \[em] line\fP + arrow \fR# open object \[em] line with arrowhead\fP + spline \fR# open object \[em] spline curve\fP + move + TEXT TEXT ... \fR# text within invisible box\fP + plot <expr> TEXT \fR# formatted text\fP + '[' <command> ... ']' +.R +.DE +.PP +Drawn objects within `[\ .\|.\|.\ ]' are treated as a single composite +object with a rectangular shape (that of the bounding box of all the +elements). Variable and label assignments within a block are local to +the block. Current direction of motion is restored to the value at start +of block upon exit. Position is \fInot\fR restored (unlike `{\ }'); +instead, the current position becomes the exit position for the current +direction on the block's bounding box. +.DS +.CW +<attribute> ::= + h[eigh]t <expr> \fR# set height of closed figure \fP + wid[th] <expr> \fR# set width of closed figure \fP + rad[ius] <expr> \fR# set radius of circle/arc \fP + diam[eter] <expr> \fR# set diameter of circle/arc \fP + up [<expr>] \fR# move up \fP + down [<expr>] \fR# move down \fP + left [<expr>] \fR# move left \fP + right [<expr>] \fR# move right \fP + from <position> \fR# set from position of open figure\fP + to <position> \fR# set to position of open figure\fP + at <position> \fR# set center of open figure\fP + with <path> \fR# fix corner/named point at specified location\fP + with <position> \fR# fix position of object at specified location\fP + by <expr-pair> \fR# set object's attachment point\fP + then \fR# sequential segment composition\fP + dotted [<expr>] \fR# set dotted line style\fP + dashed [<expr>] \fR# set dashed line style\fP + thick[ness] <expr> \fR# set thickness of lines\fP + chop [<expr>] \fR# chop end(s) of segment\fP + '->' | '<-' | '<->' \fR# decorate with arrows\fP + invis[ible] \fR# make primitive invisible\fP + solid \fR# make closed figure solid\fP + fill[ed] [<expr>] \fR# set fill density for figure\fP + colo[u]r[ed] TEXT \fR# set fill and outline color for figure\fP + outline[d] TEXT \fR# set outline color for figure\fP + shaded TEXT \fR# set fill color for figure\fP + same \fR# copy size of previous object\fP + cw | ccw \fR# set orientation of curves\fP + ljust | rjust \fR# adjust text horizontally\fP + above | below \fR# adjust text vertically\fP + aligned \fR# align parallel to object\fP + TEXT TEXT ... \fR# text within object\fP + <expr> \fR# motion in the current direction\fR +.R +.DE +.PP +Missing attributes are supplied from defaults; inappropriate ones are +silently ignored. For lines, splines, and arcs, height and width +refer to arrowhead size. +.PP +The `at' primitive sets the center of the current object. The +`with' attribute fixes the specified feature of the given object +to a specified location. (Note that `with' is incorrectly described +in the Kernighan paper.) +.PP +The `by' primitive is not documented in the tutorial portion of +the Kernighan paper, and should probably be considered unreliable. +.PP +The primitive `arrow' is a synonym for `line\ ->'. +.PP Text is normally an attribute of some object, in which case successive strings are vertically stacked and centered on the object's center by default. Standalone text is treated as though placed in an invisible box. .PP A text item consists of a string or sprintf-expression, optionally -followed by positioning information. Text or format strings may -contain {gtn}roff font changes, size changes, and local motions, -provided those changes are undone before the end of the current item. +followed by positioning information. Text (or strings specified with +`sprintf' may contain [gtn]roff font changes, size changes, and local +motions, provided those changes are undone before the end of the current +item. .PP -A position is an (x, y) coordinate pair. There are lots of different +A position is an (x,y) coordinate pair. There are lots of different ways to specify positions: .DS .CW -<position> ::= <expr> , <expr> - <place> {+-} <expr> , <expr> - <place> {+-} ( <expr> , <expr> ) - ( <position> , <position> ) - <expr> [of the way] between <position> and <position> - <expr> '<' <position> , <position> '>' - ( <position> ) - -<place> ::= <label> [ <dot-corner> ] - <corner> of <label> - [0|1|2|3|4|5|6|7|8|9]th [last] <primitive> <dot-corner> - <expr>'th [last]<primitive> <dot-corner> - <corner> of [0|1|2|3|4|5|6|7|8|9]th [last] <primitive> - <corner> of <expr>'th [last] <primitive> - Here - -<dot-corner> ::= .n | .e | .w | .s | .ne | .nw | .se | .sw | .c | .start | .end - -<corner> ::= top | bot | left | right | start | end +<position> ::= + <position-not-place> + <place> .R .DE -.LP -As Kernighan notes, "since barbarisms like \fB1th\fP and \fB3th\fP are -barbaric, synonyms like \fB1st\fP and \fB3rd\fP are accepted as well". +.DS +.CW +<position-not-place> ::= + <expr-pair> + <position> + <expr-pair> + <position> - <expr-pair> + ( <position> , <position> ) + <expr> [of the way] between <position> and <position> + <expr> '<' <position> , <position> '>' +.R +.DE +.DS +.CW +<expr-pair> ::= + <expr> , <expr> + ( expr-pair ) +.R +.DE +.DS +.CW +<place> ::= + <label> + <label> <corner> + <corner> [of] <label> + Here +.R +.DE +.DS +.CW +<label> ::= + LABEL [. LABEL ...] + <nth-primitive> +.R +.DE +.DS +.CW +<corner> ::= + .n | .e | .w | .s + .ne | .se | .nw | .sw + .c[enter] | .start | .end + .t[op] | .b[ot[tom]] | .l[eft] | .r[ight] + left | right | <top-of> | <bottom-of> + <north-of> | <south-of> | <east-of> | <west-of> + <center-of> | <start-of> | <end-of> + upper left | lower left | upper right | lower right +.R +.DE +.DS +.CW +<xxx-of> ::= + xxx \fR# followed by `of'\fP +.R +.DE +.DS +.CW +<nth-primitive> ::= + <ordinal> <object-type> + [<ordinal>] last <object-type> +.R +.DE +.DS +.CW +<ordinal> ::= + INT th + INT st | INT nd | INT rd + ` <any-expr> 'th +.R +.DE +.DS +.CW +<object-type> ::= + box + circle + ellipse + arc + line + arrow + spline + '[]' + TEXT +.R +.DE +.PP +As Kernighan notes, \[lq]since barbarisms like \fB1th\fP and \fB3th\fP are +barbaric, synonyms like \fB1st\fP and \fB3rd\fP are accepted as well.\[rq] Objects of a given type are numbered from 1 upwards in order of declaration; the \fBlast\fP modifier counts backwards. .PP -The "'th" form (which allows you to select a previous object with an -expression, as opposed to a numeric literal) is not documented in DWB -\fBpic\fR(1). +The \[lq]'th\[rq] form (which allows you to select a previous object with +an expression, as opposed to a numeric literal) is not documented in DWB's +\fIpic\/\fR(1). +.PP +The \[la]\|\fIxxx\fP-of\|\[ra] rule is special: The lexical parser checks whether +\fIxxx\fP is followed by the token `of' without eliminating it so that +the grammar parser can still see `of'. Valid examples of specifying a +place with corner and label are thus +.DS +.CW +A .n +\&.n of A +\&.n A +north of A +.R +.DE +.LP +while +.DS +.CW +north A +A north +.R +.DE +both cause a syntax error. (DWB \fBpic\fP also allows the weird form +`A\ north\ of'.) +.PP +Here the special rules for the `with' keyword using a path: +.DS +.CW +<path> ::= + <relative-path> + ( <relative-path> , <relative-path> ) +.R +.DE +.DS +.CW +<relative-path> ::= + <corner> + . LABEL [. LABEL ...] [<corner>] +.R +.DE .PP The following style variables control output: .TS H -tab(@), linesize(2); +center tab(@), linesize(2); lb | lb | lb l | n | l. .sp 2p @@ -2332,40 +2667,51 @@ fillval@0.5@Default fill value _ .TE Any of these can be set by assignment, or reset using the \fBreset\fP -statement. Style variables assigned within [] blocks are restored to +statement. Style variables assigned within `[\ ]' blocks are restored to their beginning-of-block value on exit; top-level assignments persist across pictures. Dimensions are divided by \fBscale\fR on output. .PP All \fBpic\fP expressions are evaluated in floating point; units -default to inches. Expressions have the following simple grammar, -with semantics very similar to C expressions: +are always inches (a trailing `i' or `I' is ignored). Expressions have +the following simple grammar, with semantics very similar to +C\~expressions: .DS .CW -<expr> ::= <expr> <op> <expr> - ! <expr> - ( <expr> ) - - <expr> - <variable> - <number> - <place> .x - <place> .y - <place> .ht - <place> .wid - <place> .rad - sin(<expr>) - cos(<expr>) - log(<expr>) - exp(<expr>) - sqrt(<expr>) - max(<expr>, <expr>...) - atan2(<expr>, <expr>) - min(<expr>, <expr>...) - int(<expr>) - rand() - -<op> := + | - | * | / | % | ^ | - != | == | '<' | '>' | >= | <= | - '||' | && +<expr> ::= + VARIABLE + NUMBER + <place> <place-attribute> + <expr> <op> <expr> + - <expr> + ( <any-expr> ) + ! <expr> + <func1> ( <any-expr> ) + <func2> ( <any-expr> , <any-expr> ) + rand ( ) +.R +.DE +.DS +.CW +<place-attribute> + .x | .y | .h[eigh]t | .wid[th] | .rad +.R +.DE +.DS +.CW +<op> ::= + + | - | * | / | % | ^ | '<' | '>' | '<=' | '>=' +.R +.DE +.DS +.CW +<func1> ::= + sin | cos | log | exp | sqrt | int | rand | srand +.R +.DE +.DS +.CW +<func2> ::= + atan2 | max | min .R .DE .LP @@ -2377,7 +2723,7 @@ of the grammar (they behave as pre-processor macros to the language). These may be used to define pseudo-functions. .DS .CW -\fBdefine\fP \fIname\fP \fB{\fP \fIreplacement text \fB}\fP +\fBdefine\fP \fIname\fP \fB{\fP \fIreplacement-text\fP \fB}\fP .R .DE .LP @@ -2385,49 +2731,58 @@ This defines \fIname\fR as a macro to be replaced by the replacement text (not including the braces). The macro may be called as .DS .CW -\fIname\fB(\fIarg1, arg2, ... argn\fB)\fR +\fIname\/\fB(\,\fIarg1, arg2, .\|.\|., argn\fB\/)\fR .R .DE .LP -The arguments (if any) will be substituted for tokens $1, $2 ... $n -appearing in the replacement text. To undefine a macro, say \fBundef\fP +The arguments (if any) will be substituted for tokens $1, $2 .\|.\|.\& $n +appearing in the replacement text. To undefine a macro, say \fBundef\fP \fIname\fR, specifying the name to be undefined. .\"%%POSTLUDE%% .NH 1 History and Acknowledgements .PP Original \fBpic\fP was written to go with Joseph Ossanna's original -\&\fItroff\fP(1) by Brian Kernighan, and later re-written by Kernighan +\fItroff\/\fP(1) by Brian Kernighan, and later re-written by Kernighan with substantial enhancements (apparently as part of the evolution of -\&\fItroff\fP(1) into \&\fIditroff\fP(1) to generate +\fItroff\/\fP(1) into \fIditroff\/\fP(1) to generate device-independent output). .PP The language had been inspired by some earlier graphics languages including \fBideal\fP and \fBgrap\fP. Kernighan credits Chris van Wyk (the designer of \fBideal\fP) with many of the ideas that went into \fBpic\fP. +.PP +.\" the original definitions of EQ and EN cause insertion of vertical +.\" space which is not appropriate here +.de EQ +.. +.de EN +.. .EQ delim $$ .EN -.PP The \fBpic\fP language was originally described by Brian Kernighan in Bell Labs Computing Science Technical Report #116 (you can obtain a PostScript copy of the revised version, [1], by sending a mail message to -\&\fInetlib@research.att.com\fP with a body of \&`send 116 from -research/cstr'.). There have been two revisions, in 1984 and 1991. +\fInetlib@research.att.com\fP with a body of `send 116 from +research/cstr'). There have been two revisions, in 1984 and 1991. .PP The document you are reading effectively subsumes Kernighan's -description; it was written to fill in lacunae in the exposition and -integrate in descriptions of the GNU \fIgpic\fP(1) features. +description; it was written to fill in lacun\[ae] in the exposition and +integrate in descriptions of the GNU \fIgpic\/\fP(1) features. .PP -The GNU \fBgpic\fR implementation was written and is maintained by -James Clark \fI<jjc@jclark.com>\fP. +The GNU \fBgpic\fR implementation was written by James Clark +\[la]\,\fIjjc@jclark.com\/\fP\[ra]. It is currently maintained by Werner +Lemberg \[la]\,\fIwl@gnu.org\/\fP\[ra]. .NH 1 Bibliography .IP 1. -Kernighan, B. W. \fBPIC -- A Graphics Language for Typesetting -(Revised User Manual)\fP Bell Labs Computing Science Technical Report +Kernighan, B. W. \fBPIC \[em] A Graphics Language for Typesetting +(Revised User Manual)\fP. Bell Labs Computing Science Technical Report #116, December 1991. .IP 2. -Van Wyk, C.J. \fBA high-level language for specifying pictures\fP \fIACM -Transactions On Graphics\fP 1,2 (1982) 163-182. +Van Wyk, C. J. \fBA high-level language for specifying pictures\fP. +\fIACM Transactions On Graphics\fP 1,2 (1982) 163-182. +. +.\" end of pic.ms diff --git a/contrib/groff/doc/texinfo.tex b/contrib/groff/doc/texinfo.tex index faad86b..c83af30 100644 --- a/contrib/groff/doc/texinfo.tex +++ b/contrib/groff/doc/texinfo.tex @@ -3,10 +3,10 @@ % Load plain if necessary, i.e., if running under initex. \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi % -\def\texinfoversion{2000-05-28.15} +\def\texinfoversion{2002-03-26.08-wl} % -% Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99 -% Free Software Foundation, Inc. +% Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, +% 2000, 01, 02 Free Software Foundation, Inc. % % This texinfo.tex file is free software; you can redistribute it and/or % modify it under the terms of the GNU General Public License as @@ -30,14 +30,17 @@ % Please try the latest version of texinfo.tex before submitting bug % reports; you can get the latest version from: % ftp://ftp.gnu.org/gnu/texinfo.tex -% (and all GNU mirrors, see http://www.gnu.org/order/ftp.html) -% ftp://texinfo.org/tex/texinfo.tex -% ftp://us.ctan.org/macros/texinfo/texinfo.tex -% (and all CTAN mirrors, finger ctan@us.ctan.org for a list). -% /home/gd/gnu/doc/texinfo.tex on the GNU machines. +% (and all GNU mirrors, see http://www.gnu.org/order/ftp.html) +% ftp://texinfo.org/texinfo/texinfo.tex +% ftp://tug.org/tex/texinfo.tex +% (and all CTAN mirrors, see http://www.ctan.org), +% and /home/gd/gnu/doc/texinfo.tex on the GNU machines. +% % The texinfo.tex in any given Texinfo distribution could well be out % of date, so if that's what you're using, please check. -% Texinfo has a small home page at http://texinfo.org/. +% +% Texinfo has a small home page at http://texinfo.org/ and also +% http://www.gnu.org/software/texinfo. % % Send bug reports to bug-texinfo@gnu.org. Please include including a % complete document in each bug report with which we can reproduce the @@ -50,13 +53,13 @@ % texindex foo.?? % tex foo.texi % tex foo.texi -% dvips foo.dvi -o # or whatever, to process the dvi file; this makes foo.ps. -% The extra runs of TeX get the cross-reference information correct. +% dvips foo.dvi -o # or whatever; this makes foo.ps. +% The extra TeX runs get the cross-reference information correct. % Sometimes one run after texindex suffices, and sometimes you need more % than two; texi2dvi does it as many times as necessary. % % It is possible to adapt texinfo.tex for other languages. You can get -% the existing language-specific files from ftp://ftp.gnu.org/gnu/texinfo/. +% the existing language-specific files from the full Texinfo distribution. \message{Loading texinfo [version \texinfoversion]:} @@ -170,6 +173,16 @@ }% \fi +% add check for \lastpenalty to plain's definitions. If the last thing +% we did was a \nobreak, we don't want to insert more space. +% +\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount + \removelastskip\penalty-50\smallskip\fi\fi} +\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount + \removelastskip\penalty-100\medskip\fi\fi} +\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount + \removelastskip\penalty-200\bigskip\fi\fi} + % For @cropmarks command. % Do @cropmarks to get crop marks. % @@ -431,7 +444,7 @@ % environments. --karl, 6may93 %{\advance \baselineskip by -\singlespaceskip %\kern \baselineskip}% - \setleading \singlespaceskip + \setleading\singlespaceskip } %% Simple single-character @ commands @@ -688,16 +701,54 @@ where each line of input produces a line of output.} \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount \leftline{\hskip\leftskip{\rm#1}}}} -% @inmargin{TEXT} puts TEXT in the margin next to the current paragraph. - -\def\inmargin#1{% -\strut\vadjust{\nobreak\kern-\strutdepth - \vtop to \strutdepth{\baselineskip\strutdepth\vss - \llap{\rightskip=\inmarginspacing \vbox{\noindent #1}}\null}}} +% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current +% paragraph. For more general purposes, use the \margin insertion +% class. WHICH is `l' or `r'. +% \newskip\inmarginspacing \inmarginspacing=1cm \def\strutdepth{\dp\strutbox} - -%\hbox{{\rm#1}}\hfil\break}} +% +\def\doinmargin#1#2{\strut\vadjust{% + \nobreak + \kern-\strutdepth + \vtop to \strutdepth{% + \baselineskip=\strutdepth + \vss + % if you have multiple lines of stuff to put here, you'll need to + % make the vbox yourself of the appropriate size. + \ifx#1l% + \llap{\ignorespaces #2\hskip\inmarginspacing}% + \else + \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% + \fi + \null + }% +}} +\def\inleftmargin{\doinmargin l} +\def\inrightmargin{\doinmargin r} +% +% @inmargin{TEXT [, RIGHT-TEXT]} +% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; +% else use TEXT for both). +% +\def\inmargin#1{\parseinmargin #1,,\finish} +\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. + \setbox0 = \hbox{\ignorespaces #2}% + \ifdim\wd0 > 0pt + \def\lefttext{#1}% have both texts + \def\righttext{#2}% + \else + \def\lefttext{#1}% have only one text + \def\righttext{#1}% + \fi + % + \ifodd\pageno + \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin + \else + \def\temp{\inleftmargin\lefttext}% + \fi + \temp +} % @include file insert text of that file as input. % Allow normal characters that we make active in the argument (a file name). @@ -785,18 +836,43 @@ where each line of input produces a line of output.} % \def\asis#1{#1} -% @math means output in math mode. -% We don't use $'s directly in the definition of \math because control -% sequences like \math are expanded when the toc file is written. Then, -% we read the toc file back, the $'s will be normal characters (as they -% should be, according to the definition of Texinfo). So we must use a -% control sequence to switch into and out of math mode. +% @math outputs its argument in math mode. +% We don't use $'s directly in the definition of \math because we need +% to set catcodes according to plain TeX first, to allow for subscripts, +% superscripts, special math chars, etc. +% +% @math does not do math typesetting in section titles, index +% entries, and other such contexts where the catcodes are set before +% @math gets a chance to work. This could perhaps be fixed, but for now +% at least we can have real math in the main text, where it's needed most. % -% This isn't quite enough for @math to work properly in indices, but it -% seems unlikely it will ever be needed there. +\let\implicitmath = $%$ font-lock fix % -\let\implicitmath = $ -\def\math#1{\implicitmath #1\implicitmath} +% One complication: _ usually means subscripts, but it could also mean +% an actual _ character, as in @math{@var{some_variable} + 1}. So make +% _ within @math be active (mathcode "8000), and distinguish by seeing +% if the current family is \slfam, which is what @var uses. +% +{\catcode95 = \active % 95 = _ +\gdef\mathunderscore{% + \catcode95=\active + \def_{\ifnum\fam=\slfam \_\else\sb\fi}% +}} +% +% Another complication: we want \\ (and @\) to output a \ character. +% FYI, plain.tex uses \\ as a temporary control sequence (why?), but +% this is not advertised and we don't care. Texinfo does not +% otherwise define @\. +% +% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. +\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} +% +\def\math{% + \tex + \mathcode`\_="8000 \mathunderscore + \let\\ = \mathbackslash + \implicitmath\finishmath} +\def\finishmath#1{#1\implicitmath\Etex} % @bullet and @minus need the same treatment as @math, just above. \def\bullet{\implicitmath\ptexbullet\implicitmath} @@ -879,19 +955,25 @@ where each line of input produces a line of output.} \def\dopdfimage#1#2#3{% \def\imagewidth{#2}% \def\imageheight{#3}% + % without \immediate, pdftex seg faults when the same image is + % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) \ifnum\pdftexversion < 14 - \pdfimage + \immediate\pdfimage \else - \pdfximage + \immediate\pdfximage \fi \ifx\empty\imagewidth\else width \imagewidth \fi \ifx\empty\imageheight\else height \imageheight \fi - {#1.pdf}% + \ifnum\pdftexversion<13 + #1.pdf% + \else + {#1.pdf}% + \fi \ifnum\pdftexversion < 14 \else \pdfrefximage \pdflastximage \fi} - \def\pdfmkdest#1{\pdfdest name{#1@} xyz} - \def\pdfmkpgn#1{#1@} + \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}} + \def\pdfmkpgn#1{#1} \let\linkcolor = \Blue % was Cyan, but that seems light? \def\endlink{\Black\pdfendlink} % Adding outlines to PDF; macros for calculating structure of outlines @@ -903,7 +985,7 @@ where each line of input produces a line of output.} \expandafter\xdef\csname#1\endcsname{\the\tempnum}} \def\pdfmakeoutlines{{% \openin 1 \jobname.toc - \ifeof 1\else\bgroup + \ifeof 1\else\begingroup \closein 1 \indexnofonts \def\tt{} @@ -913,32 +995,34 @@ where each line of input produces a line of output.} \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace % \def\chapentry ##1##2##3{} + \let\appendixentry = \chapentry \def\unnumbchapentry ##1##2{} \def\secentry ##1##2##3##4{\advancenumber{chap##2}} - \def\unnumbsecentry ##1##2{} + \def\unnumbsecentry ##1##2##3{\advancenumber{chap##2}} \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}} - \def\unnumbsubsecentry ##1##2{} + \def\unnumbsubsecentry ##1##2##3##4{\advancenumber{sec##2.##3}} \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}} - \def\unnumbsubsubsecentry ##1##2{} + \def\unnumbsubsubsecentry ##1##2##3##4##5{\advancenumber{subsec##2.##3.##4}} \input \jobname.toc \def\chapentry ##1##2##3{% \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}} + \let\appendixentry = \chapentry \def\unnumbchapentry ##1##2{% \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} \def\secentry ##1##2##3##4{% \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}} - \def\unnumbsecentry ##1##2{% - \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} + \def\unnumbsecentry ##1##2##3{% + \pdfoutline goto name{\pdfmkpgn{##3}}{##1}} \def\subsecentry ##1##2##3##4##5{% \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}} - \def\unnumbsubsecentry ##1##2{% - \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} + \def\unnumbsubsecentry ##1##2##3##4{% + \pdfoutline goto name{\pdfmkpgn{##4}}{##1}} \def\subsubsecentry ##1##2##3##4##5##6{% \pdfoutline goto name{\pdfmkpgn{##6}}{##1}} - \def\unnumbsubsubsecentry ##1##2{% - \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} + \def\unnumbsubsubsecentry ##1##2##3##4##5{% + \pdfoutline goto name{\pdfmkpgn{##5}}{##1}} \input \jobname.toc - \egroup\fi + \endgroup\fi }} \def\makelinks #1,{% \def\params{#1}\def\E{END}% @@ -988,6 +1072,7 @@ where each line of input produces a line of output.} \def\pdfurl#1{% \begingroup \normalturnoffactive\def\@{@}% + \let\value=\expandablevalue \leavevmode\Red \startlink attr{/Border [0 0 0]}% user{/Subtype /Link /A << /S /URI /URI (#1) >>}% @@ -1015,9 +1100,8 @@ where each line of input produces a line of output.} \def\makelink{\addtokens{\toksB}% {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} \def\pdflink#1{% - \startlink attr{/Border [0 0 0]} goto name{\mkpgn{#1}} + \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} \linkcolor #1\endlink} - \def\mkpgn#1{#1@} \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} \fi % \ifx\pdfoutput @@ -1034,9 +1118,26 @@ where each line of input produces a line of output.} % We don't need math for this one. \def\ttsl{\tenttsl} -% Use Computer Modern fonts at \magstephalf (11pt). -\newcount\mainmagstep -\mainmagstep=\magstephalf +% Default leading. +\newdimen\textleading \textleading = 13.2pt + +% Set the baselineskip to #1, and the lineskip and strut size +% correspondingly. There is no deep meaning behind these magic numbers +% used as factors; they just match (closely enough) what Knuth defined. +% +\def\lineskipfactor{.08333} +\def\strutheightpercent{.70833} +\def\strutdepthpercent {.29167} +% +\def\setleading#1{% + \normalbaselineskip = #1\relax + \normallineskip = \lineskipfactor\normalbaselineskip + \normalbaselines + \setbox\strutbox =\hbox{% + \vrule width0pt height\strutheightpercent\baselineskip + depth \strutdepthpercent \baselineskip + }% +} % Set the font macro #1 to the font named #2, adding on the % specified font prefix (normally `cm'). @@ -1066,13 +1167,16 @@ where each line of input produces a line of output.} \def\scshape{csc} \def\scbshape{csc} +\newcount\mainmagstep \ifx\bigger\relax -\let\mainmagstep=\magstep1 -\setfont\textrm\rmshape{12}{1000} -\setfont\texttt\ttshape{12}{1000} + % not really supported. + \let\mainmagstep=\magstep1 + \setfont\textrm\rmshape{12}{1000} + \setfont\texttt\ttshape{12}{1000} \else -\setfont\textrm\rmshape{10}{\mainmagstep} -\setfont\texttt\ttshape{10}{\mainmagstep} + \mainmagstep=\magstephalf + \setfont\textrm\rmshape{10}{\mainmagstep} + \setfont\texttt\ttshape{10}{\mainmagstep} \fi % Instead of cmb10, you many want to use cmbx10. % cmbx10 is a prettier font on its own, but cmb10 @@ -1103,6 +1207,18 @@ where each line of input produces a line of output.} \font\smalli=cmmi9 \font\smallsy=cmsy9 +% Fonts for small examples (8pt). +\setfont\smallerrm\rmshape{8}{1000} +\setfont\smallertt\ttshape{8}{1000} +\setfont\smallerbf\bfshape{10}{800} +\setfont\smallerit\itshape{8}{1000} +\setfont\smallersl\slshape{8}{1000} +\setfont\smallersf\sfshape{8}{1000} +\setfont\smallersc\scshape{10}{800} +\setfont\smallerttsl\ttslshape{10}{800} +\font\smalleri=cmmi8 +\font\smallersy=cmsy8 + % Fonts for title page: \setfont\titlerm\rmbshape{12}{\magstep3} \setfont\titleit\itbshape{10}{\magstep4} @@ -1115,6 +1231,7 @@ where each line of input produces a line of output.} \font\titlei=cmmi12 scaled \magstep3 \font\titlesy=cmsy10 scaled \magstep4 \def\authorrm{\secrm} +\def\authortt{\sectt} % Chapter (and unnumbered) fonts (17.28pt). \setfont\chaprm\rmbshape{12}{\magstep2} @@ -1140,20 +1257,6 @@ where each line of input produces a line of output.} \font\seci=cmmi12 scaled \magstep1 \font\secsy=cmsy10 scaled \magstep2 -% \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad. -% \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded. -% \setfont\ssecsl\slshape{10}{\magstep1} -% \setfont\ssectt\ttshape{10}{\magstep1} -% \setfont\ssecsf\sfshape{10}{\magstep1} - -%\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx. -%\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than -%\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1. -%\setfont\ssectt\ttshape{10}{1315} -%\setfont\ssecsf\sfshape{10}{1315} - -%\let\ssecbf=\ssecrm - % Subsection fonts (13.15pt). \setfont\ssecrm\rmbshape{12}{\magstephalf} \setfont\ssecit\itbshape{10}{1315} @@ -1170,17 +1273,16 @@ where each line of input produces a line of output.} % In order for the font changes to affect most math symbols and letters, % we have to define the \textfont of the standard families. Since -% texinfo doesn't allow for producing subscripts and superscripts, we -% don't bother to reset \scriptfont and \scriptscriptfont (which would -% also require loading a lot more fonts). +% texinfo doesn't allow for producing subscripts and superscripts except +% in the main text, we don't bother to reset \scriptfont and +% \scriptscriptfont (which would also require loading a lot more fonts). % \def\resetmathfonts{% - \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy - \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf - \textfont\ttfam = \tentt \textfont\sffam = \tensf + \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy + \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf + \textfont\ttfam=\tentt \textfont\sffam=\tensf } - % The font-changing commands redefine the meanings of \tenSTYLE, instead % of just \STYLE. We do this so that font changes will continue to work % in math mode, where it is the current \fam that is relevant in most @@ -1191,7 +1293,7 @@ where each line of input produces a line of output.} \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl - \resetmathfonts} + \resetmathfonts \setleading{\textleading}} \def\titlefonts{% \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc @@ -1220,7 +1322,14 @@ where each line of input produces a line of output.} \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy \let\tenttsl=\smallttsl - \resetmathfonts \setleading{11pt}} + \resetmathfonts \setleading{10.5pt}} +\def\smallerfonts{% + \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl + \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc + \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy + \let\tenttsl=\smallerttsl + \resetmathfonts \setleading{9.5pt}} +\let\smallexamplefonts = \smallerfonts % Set up the default fonts, so we can use them for creating boxes. % @@ -1237,6 +1346,7 @@ where each line of input produces a line of output.} \setfont\shortcontrm\rmshape{12}{1000} \setfont\shortcontbf\bxshape{12}{1000} \setfont\shortcontsl\slshape{12}{1000} +\setfont\shortconttt\ttshape{12}{1000} %% Add scribe-like font environments, plus @l for inline lisp (usually sans %% serif) and @ii for TeX italic @@ -1334,11 +1444,19 @@ where each line of input produces a line of output.} \def\realdash{-} \def\codedash{-\discretionary{}{}{}} -\def\codeunder{\ifusingtt{\normalunderscore\discretionary{}{}{}}{\_}} +\def\codeunder{% + % this is all so @math{@code{var_name}+1} can work. In math mode, _ + % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) + % will therefore expand the active definition of _, which is us + % (inside @code that is), therefore an endless loop. + \ifusingtt{\ifmmode + \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. + \else\normalunderscore \fi + \discretionary{}{}{}}% + {\_}% +} \def\codex #1{\tclose{#1}\endgroup} -%\let\exp=\tclose %Was temporary - % @kbd is like @code, except that if the argument is just one @key command, % then @kbd has no effect. @@ -1476,7 +1594,8 @@ where each line of input produces a line of output.} \let\subtitlerm=\tenrm \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}% % - \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}% + \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines + \let\tt=\authortt}% % % Leave some space at the very top of the page. \vglue\titlepagetopglue @@ -1523,6 +1642,10 @@ where each line of input produces a line of output.} \oldpage \endgroup % + % Need this before the \...aftertitlepage checks so that if they are + % in effect the toc pages will come out with page numbers. + \HEADINGSon + % % If they want short, they certainly want long too. \ifsetshortcontentsaftertitlepage \shortcontents @@ -1536,10 +1659,6 @@ where each line of input produces a line of output.} \global\let\contents = \relax \global\let\shortcontents = \relax \fi - % - \ifpdf \pdfmakepagedesttrue \fi - % - \HEADINGSon } \def\finishtitlepage{% @@ -2297,18 +2416,19 @@ width0pt\relax} \fi \let\item = \relax } -% Ignore @ignore ... @end ignore. +% Ignore @ignore, @ifhtml, @ifinfo, @ifplaintext, @ifnottex, @html, @menu, +% @direntry, and @documentdescription. % \def\ignore{\doignore{ignore}} - -% Ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu, and @direntry text. -% -\def\ifinfo{\doignore{ifinfo}} \def\ifhtml{\doignore{ifhtml}} +\def\ifinfo{\doignore{ifinfo}} +\def\ifplaintext{\doignore{ifplaintext}} \def\ifnottex{\doignore{ifnottex}} \def\html{\doignore{html}} \def\menu{\doignore{menu}} \def\direntry{\doignore{direntry}} +\def\documentdescription{\doignore{documentdescription}} +\def\documentdescriptionword{documentdescription} % @dircategory CATEGORY -- specify a category of the dir file % which this file should belong to. Ignore this in TeX. @@ -2335,14 +2455,21 @@ width0pt\relax} \fi % We must not have @c interpreted as a control sequence. \catcode`\@ = 12 % - % Make the letter c a comment character so that the rest of the line - % will be ignored. This way, the document can have (for example) - % @c @end ifinfo - % and the @end ifinfo will be properly ignored. - % (We've just changed @ to catcode 12.) - \catcode`\c = 14 + \def\ignoreword{#1}% + \ifx\ignoreword\documentdescriptionword + % The c kludge breaks documentdescription, since + % `documentdescription' contains a `c'. Means not everything will + % be ignored inside @documentdescription, but oh well... + \else + % Make the letter c a comment character so that the rest of the line + % will be ignored. This way, the document can have (for example) + % @c @end ifinfo + % and the @end ifinfo will be properly ignored. + % (We've just changed @ to catcode 12.) + \catcode`\c = 14 + \fi % - % And now expand that command. + % And now expand the command defined above. \doignoretext } @@ -2414,10 +2541,14 @@ width0pt\relax} \fi \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont \let\tensf=\nullfont - % Similarly for index fonts (mostly for their use in smallexample). + % Similarly for index fonts. \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont \let\smallsf=\nullfont + % Similarly for smallexample fonts. + \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont + \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont + \let\smallersf=\nullfont % % Don't complain when characters are missing from the fonts. \tracinglostchars = 0 @@ -2529,19 +2660,21 @@ width0pt\relax} \fi \def\ifclearfail{\nestedignore{ifclear}} \defineunmatchedend{ifclear} -% @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text -% following, through the first @end iftex (etc.). Make `@end iftex' -% (etc.) valid only after an @iftex. +% @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we +% read the text following, through the first @end iftex (etc.). Make +% `@end iftex' (etc.) valid only after an @iftex. % \def\iftex{\conditionalsucceed{iftex}} \def\ifnothtml{\conditionalsucceed{ifnothtml}} \def\ifnotinfo{\conditionalsucceed{ifnotinfo}} +\def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}} \defineunmatchedend{iftex} \defineunmatchedend{ifnothtml} \defineunmatchedend{ifnotinfo} +\defineunmatchedend{ifnotplaintext} -% We can't just want to start a group at @iftex (for example) and end it -% at @end iftex, since then @set commands inside the conditional have no +% We can't just want to start a group at @iftex (etc.) and end it at +% @end iftex, since then @set commands inside the conditional have no % effect (they'd get reverted at the end of the group). So we must % define \Eiftex to redefine itself to be its previous value. (We can't % just define it to fail again with an ``unmatched end'' error, since @@ -2593,42 +2726,48 @@ width0pt\relax} \fi } % @defindex foo == \newindex{foo} - +% \def\defindex{\parsearg\newindex} % Define @defcodeindex, like @defindex except put all entries in @code. - +% +\def\defcodeindex{\parsearg\newcodeindex} +% \def\newcodeindex#1{% \iflinks \expandafter\newwrite \csname#1indfile\endcsname \openout \csname#1indfile\endcsname \jobname.#1 \fi \expandafter\xdef\csname#1index\endcsname{% - \noexpand\docodeindex{#1}} + \noexpand\docodeindex{#1}}% } -\def\defcodeindex{\parsearg\newcodeindex} % @synindex foo bar makes index foo feed into index bar. % Do this instead of @defindex foo if you don't want it as a separate index. -% The \closeout helps reduce unnecessary open files; the limit on the -% Acorn RISC OS is a mere 16 files. -\def\synindex#1 #2 {% - \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname - \expandafter\closeout\csname#1indfile\endcsname - \expandafter\let\csname#1indfile\endcsname=\synindexfoo - \expandafter\xdef\csname#1index\endcsname{% define \xxxindex - \noexpand\doindex{#2}}% -} - +% % @syncodeindex foo bar similar, but put all entries made for index foo % inside @code. -\def\syncodeindex#1 #2 {% - \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname - \expandafter\closeout\csname#1indfile\endcsname - \expandafter\let\csname#1indfile\endcsname=\synindexfoo - \expandafter\xdef\csname#1index\endcsname{% define \xxxindex - \noexpand\docodeindex{#2}}% +% +\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} +\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} + +% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), +% #3 the target index (bar). +\def\dosynindex#1#2#3{% + % Only do \closeout if we haven't already done it, else we'll end up + % closing the target index. + \expandafter \ifx\csname donesynindex#2\endcsname \undefined + % The \closeout helps reduce unnecessary open files; the limit on the + % Acorn RISC OS is a mere 16 files. + \expandafter\closeout\csname#2indfile\endcsname + \expandafter\let\csname\donesynindex#2\endcsname = 1 + \fi + % redefine \fooindfile: + \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname + \expandafter\let\csname#2indfile\endcsname=\temp + % redefine \fooindex: + \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% } % Define \doindex, the driver for all \fooindex macros. @@ -2648,9 +2787,23 @@ width0pt\relax} \fi \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} +% Take care of texinfo commands likely to appear in an index entry. +% (Must be a way to avoid doing expansion at all, and thus not have to +% laboriously list every single command here.) +% \def\indexdummies{% \def\ { }% +\def\@{@}% change to @@ when we switch to @ as escape char in aux files. +% Need these in case \tex is in effect and \{ is a \delimiter again. +% But can't use \lbracecmd and \rbracecmd because texindex assumes +% braces and backslashes are used only as delimiters. +\let\{ = \mylbrace +\let\} = \myrbrace +\def\_{{\realbackslash _}}% +\normalturnoffactive +% % Take care of the plain tex accent commands. +\def\,##1{\realbackslash ,{##1}}% \def\"{\realbackslash "}% \def\`{\realbackslash `}% \def\'{\realbackslash '}% @@ -2663,69 +2816,66 @@ width0pt\relax} \fi \def\u{\realbackslash u}% \def\v{\realbackslash v}% \def\H{\realbackslash H}% +\def\dotless##1{\realbackslash dotless {##1}}% % Take care of the plain tex special European modified letters. -\def\oe{\realbackslash oe}% -\def\ae{\realbackslash ae}% -\def\aa{\realbackslash aa}% -\def\OE{\realbackslash OE}% -\def\AE{\realbackslash AE}% \def\AA{\realbackslash AA}% -\def\o{\realbackslash o}% +\def\AE{\realbackslash AE}% +\def\L{\realbackslash L}% +\def\OE{\realbackslash OE}% \def\O{\realbackslash O}% +\def\aa{\realbackslash aa}% +\def\ae{\realbackslash ae}% \def\l{\realbackslash l}% -\def\L{\realbackslash L}% +\def\oe{\realbackslash oe}% +\def\o{\realbackslash o}% \def\ss{\realbackslash ss}% -% Take care of texinfo commands likely to appear in an index entry. -% (Must be a way to avoid doing expansion at all, and thus not have to -% laboriously list every single command here.) -\def\@{@}% will be @@ when we switch to @ as escape char. -% Need these in case \tex is in effect and \{ is a \delimiter again. -% But can't use \lbracecmd and \rbracecmd because texindex assumes -% braces and backslashes are used only as delimiters. -\let\{ = \mylbrace -\let\} = \myrbrace -\def\_{{\realbackslash _}}% -\def\w{\realbackslash w }% +% +% Although these internals commands shouldn't show up, sometimes they do. \def\bf{\realbackslash bf }% +\def\gtr{\realbackslash gtr}% +\def\hat{\realbackslash hat}% +\def\less{\realbackslash less}% %\def\rm{\realbackslash rm }% -\def\sl{\realbackslash sl }% \def\sf{\realbackslash sf}% +\def\sl{\realbackslash sl }% +\def\tclose##1{\realbackslash tclose {##1}}% \def\tt{\realbackslash tt}% -\def\gtr{\realbackslash gtr}% -\def\less{\realbackslash less}% -\def\hat{\realbackslash hat}% +% +\def\b##1{\realbackslash b {##1}}% +\def\i##1{\realbackslash i {##1}}% +\def\sc##1{\realbackslash sc {##1}}% +\def\t##1{\realbackslash t {##1}}% +\def\r##1{\realbackslash r {##1}}% +% \def\TeX{\realbackslash TeX}% -\def\dots{\realbackslash dots }% -\def\result{\realbackslash result}% -\def\equiv{\realbackslash equiv}% -\def\expansion{\realbackslash expansion}% -\def\print{\realbackslash print}% -\def\error{\realbackslash error}% -\def\point{\realbackslash point}% -\def\copyright{\realbackslash copyright}% -\def\tclose##1{\realbackslash tclose {##1}}% +\def\acronym##1{\realbackslash acronym {##1}}% +\def\cite##1{\realbackslash cite {##1}}% \def\code##1{\realbackslash code {##1}}% -\def\uref##1{\realbackslash uref {##1}}% -\def\url##1{\realbackslash url {##1}}% -\def\env##1{\realbackslash env {##1}}% \def\command##1{\realbackslash command {##1}}% +\def\dfn##1{\realbackslash dfn {##1}}% +\def\dots{\realbackslash dots }% +\def\emph##1{\realbackslash emph {##1}}% +\def\env##1{\realbackslash env {##1}}% +\def\file##1{\realbackslash file {##1}}% +\def\kbd##1{\realbackslash kbd {##1}}% +\def\key##1{\realbackslash key {##1}}% +\def\math##1{\realbackslash math {##1}}% \def\option##1{\realbackslash option {##1}}% -\def\dotless##1{\realbackslash dotless {##1}}% \def\samp##1{\realbackslash samp {##1}}% -\def\,##1{\realbackslash ,{##1}}% -\def\t##1{\realbackslash t {##1}}% -\def\r##1{\realbackslash r {##1}}% -\def\i##1{\realbackslash i {##1}}% -\def\b##1{\realbackslash b {##1}}% -\def\sc##1{\realbackslash sc {##1}}% -\def\cite##1{\realbackslash cite {##1}}% -\def\key##1{\realbackslash key {##1}}% -\def\file##1{\realbackslash file {##1}}% +\def\strong##1{\realbackslash strong {##1}}% +\def\uref##1{\realbackslash uref {##1}}% +\def\url##1{\realbackslash url {##1}}% \def\var##1{\realbackslash var {##1}}% -\def\kbd##1{\realbackslash kbd {##1}}% -\def\dfn##1{\realbackslash dfn {##1}}% -\def\emph##1{\realbackslash emph {##1}}% -\def\acronym##1{\realbackslash acronym {##1}}% +\def\w{\realbackslash w }% +% +% These math commands don't seem likely to be used in index entries. +\def\copyright{\realbackslash copyright}% +\def\equiv{\realbackslash equiv}% +\def\error{\realbackslash error}% +\def\expansion{\realbackslash expansion}% +\def\point{\realbackslash point}% +\def\print{\realbackslash print}% +\def\result{\realbackslash result}% % % Handle some cases of @value -- where the variable name does not % contain - or _, and the value does not contain any @@ -2739,7 +2889,7 @@ width0pt\relax} \fi % If an index command is used in an @example environment, any spaces % therein should become regular spaces in the raw index file, not the -% expansion of \tie (\\leavevmode \penalty \@M \ ). +% expansion of \tie (\leavevmode \penalty \@M \ ). {\obeyspaces \gdef\unsepspaces{\obeyspaces\let =\space}} @@ -2750,7 +2900,10 @@ width0pt\relax} \fi \def\indexdummydots{...} \def\indexnofonts{% -% Just ignore accents. +\def\@{@}% +% how to handle braces? +\def\_{\normalunderscore}% +% \let\,=\indexdummyfont \let\"=\indexdummyfont \let\`=\indexdummyfont @@ -2766,45 +2919,49 @@ width0pt\relax} \fi \let\H=\indexdummyfont \let\dotless=\indexdummyfont % Take care of the plain tex special European modified letters. -\def\oe{oe}% -\def\ae{ae}% -\def\aa{aa}% -\def\OE{OE}% -\def\AE{AE}% \def\AA{AA}% -\def\o{o}% +\def\AE{AE}% +\def\L{L}% +\def\OE{OE}% \def\O{O}% +\def\aa{aa}% +\def\ae{ae}% \def\l{l}% -\def\L{L}% +\def\oe{oe}% +\def\o{o}% \def\ss{ss}% -\let\w=\indexdummyfont -\let\t=\indexdummyfont -\let\r=\indexdummyfont -\let\i=\indexdummyfont +% +% Don't no-op \tt, since it isn't a user-level command +% and is used in the definitions of the active chars like <, >, |, etc. +% Likewise with the other plain tex font commands. +%\let\tt=\indexdummyfont +% \let\b=\indexdummyfont -\let\emph=\indexdummyfont -\let\strong=\indexdummyfont -\let\cite=\indexdummyfont +\let\i=\indexdummyfont +\let\r=\indexdummyfont \let\sc=\indexdummyfont -%Don't no-op \tt, since it isn't a user-level command -% and is used in the definitions of the active chars like <, >, |... -%\let\tt=\indexdummyfont -\let\tclose=\indexdummyfont -\let\code=\indexdummyfont -\let\url=\indexdummyfont -\let\uref=\indexdummyfont -\let\env=\indexdummyfont +\let\t=\indexdummyfont +% +\let\TeX=\indexdummytex \let\acronym=\indexdummyfont +\let\cite=\indexdummyfont +\let\code=\indexdummyfont \let\command=\indexdummyfont -\let\option=\indexdummyfont +\let\dfn=\indexdummyfont +\let\dots=\indexdummydots +\let\emph=\indexdummyfont +\let\env=\indexdummyfont \let\file=\indexdummyfont -\let\samp=\indexdummyfont \let\kbd=\indexdummyfont \let\key=\indexdummyfont +\let\math=\indexdummyfont +\let\option=\indexdummyfont +\let\samp=\indexdummyfont +\let\strong=\indexdummyfont +\let\uref=\indexdummyfont +\let\url=\indexdummyfont \let\var=\indexdummyfont -\let\TeX=\indexdummytex -\let\dots=\indexdummydots -\def\@{@}% +\let\w=\indexdummyfont } % To define \realbackslash, we must make \ not be an escape. @@ -2860,16 +3017,17 @@ width0pt\relax} \fi % Now the real index entry with the fonts. \toks0 = {#2}% % - % If third (subentry) arg is present, add it to the index - % string. And include a space. + % If the third (subentry) arg is present, add it to the index + % line to write. \ifx\thirdarg\emptymacro \else - \toks0 = \expandafter{\the\toks0 \space #3}% + \toks0 = \expandafter{\the\toks0{#3}}% \fi % - % Set up the complete index entry, with both the sort key - % and the original text, including any font commands. We write - % three arguments to \entry to the .?? file, texindex reduces to - % two when writing the .??s sorted result. + % Set up the complete index entry, with both the sort key and + % the original text, including any font commands. We write + % three arguments to \entry to the .?? file (four in the + % subentry case), texindex reduces to two when writing the .??s + % sorted result. \edef\temp{% \write\csname#1indfile\endcsname{% \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}% @@ -3091,11 +3249,18 @@ width0pt\relax} \fi \def\primary #1{\line{#1\hfil}} \newskip\secondaryindent \secondaryindent=0.5cm - -\def\secondary #1#2{ -{\parfillskip=0in \parskip=0in -\hangindent =1in \hangafter=1 -\noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par +\def\secondary#1#2{{% + \parfillskip=0in + \parskip=0in + \hangindent=1in + \hangafter=1 + \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill + \ifpdf + \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. + \else + #2 + \fi + \par }} % Define two-column mode, which we use to typeset indexes. @@ -3155,7 +3320,6 @@ width0pt\relax} \fi % % Double the \vsize as well. (We don't need a separate register here, % since nobody clobbers \vsize.) - \advance\vsize by -\ht\partialpage \vsize = 2\vsize } @@ -3169,6 +3333,7 @@ width0pt\relax} \fi % previous page. \dimen@ = \vsize \divide\dimen@ by 2 + \advance\dimen@ by -\ht\partialpage % % box0 will be the left-hand column, box2 the right. \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ @@ -3176,15 +3341,18 @@ width0pt\relax} \fi \unvbox255 \penalty\outputpenalty } +% +% Re-output the contents of the output page -- any previous material, +% followed by the two boxes we just split, in box0 and box2. \def\pagesofar{% - % Re-output the contents of the output page -- any previous material, - % followed by the two boxes we just split, in box0 and box2. \unvbox\partialpage % \hsize = \doublecolumnhsize \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}% } +% +% All done with double columns. \def\enddoublecolumns{% \output = {% % Split the last of the double-column material. Leave it on the @@ -3209,8 +3377,9 @@ width0pt\relax} \fi % \endgroup where \vsize got restored). \pagegoal = \vsize } +% +% Called at the end of the double column material. \def\balancecolumns{% - % Called at the end of the double column material. \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. \dimen@ = \ht0 \advance\dimen@ by \topskip @@ -3383,19 +3552,24 @@ width0pt\relax} \fi \global\let\subsubsection = \numberedsubsubsec } +% we use \chapno to avoid indenting back +\def\appendixbox#1{% + \setbox0 = \hbox{\putwordAppendix{} \the\chapno}% + \hbox to \wd0{#1\hss}} + \outer\def\appendix{\parsearg\appendixyyy} \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz \def\appendixzzz #1{% \secno=0 \subsecno=0 \subsubsecno=0 \global\advance \appendixno by 1 \message{\putwordAppendix\space \appendixletter}% -\chapmacro {#1}{\putwordAppendix{} \appendixletter}% +\chapmacro {#1}{\appendixbox{\putwordAppendix{} \appendixletter}}% \gdef\thissection{#1}% \gdef\thischaptername{#1}% \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}% \toks0 = {#1}% -\edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}% - {\putwordAppendix{} \appendixletter}}}% +\edef\temp{\noexpand\writetocentry{\realbackslash appendixentry{\the\toks0}% + {\appendixletter}}}% \temp \appendixnoderef \global\let\section = \appendixsec @@ -3472,7 +3646,8 @@ width0pt\relax} \fi \def\unnumberedseczzz #1{% \plainsecheading {#1}\gdef\thissection{#1}% \toks0 = {#1}% -\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry{\the\toks0}}}% +\edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry% + {\the\toks0}{\the\chapno}}}% \temp \unnumbnoderef \nobreak @@ -3511,7 +3686,7 @@ width0pt\relax} \fi \plainsubsecheading {#1}\gdef\thissection{#1}% \toks0 = {#1}% \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry% - {\the\toks0}}}% + {\the\toks0}{\the\chapno}{\the\secno}}}% \temp \unnumbnoderef \nobreak @@ -3552,7 +3727,7 @@ width0pt\relax} \fi \plainsubsubsecheading {#1}\gdef\thissection{#1}% \toks0 = {#1}% \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry% - {\the\toks0}}}% + {\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}}}% \temp \unnumbnoderef \nobreak @@ -3764,7 +3939,7 @@ width0pt\relax} \fi % argument, which will end up as the last argument to the \...entry macro. % % We open the .toc file here instead of at @setfilename or any other -% given time so that @contents can be put in the document anywhere. +% fixed time so that @contents can be put in the document anywhere. % \newif\iftocfileopened \def\writetocentry#1{% @@ -3773,6 +3948,14 @@ width0pt\relax} \fi \global\tocfileopenedtrue \fi \iflinks \write\tocfile{#1{\folio}}\fi + % + % Tell \shipout to create a page destination if we're doing pdf, which + % will be the target of the links in the table of contents. We can't + % just do it on every page because the title pages are numbered 1 and + % 2 (the page numbers aren't printed), and so are the first two pages + % of the document. Thus, we'd have two destinations named `1', and + % two named `2'. + \ifpdf \pdfmakepagedesttrue \fi } \newskip\contentsrightmargin \contentsrightmargin=1in @@ -3828,19 +4011,21 @@ width0pt\relax} \fi \startcontents{\putwordShortTOC}% % \let\chapentry = \shortchapentry + \let\appendixentry = \shortappendixentry \let\unnumbchapentry = \shortunnumberedentry % We want a true roman here for the page numbers. \secfonts - \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl + \let\rm=\shortcontrm \let\bf=\shortcontbf + \let\sl=\shortcontsl \let\tt=\shortconttt \rm \hyphenpenalty = 10000 \advance\baselineskip by 1pt % Open it up a little. \def\secentry ##1##2##3##4{} - \def\unnumbsecentry ##1##2{} + \def\unnumbsecentry ##1##2##3{} \def\subsecentry ##1##2##3##4##5{} - \def\unnumbsubsecentry ##1##2{} + \def\unnumbsubsecentry ##1##2##3##4{} \def\subsubsecentry ##1##2##3##4##5##6{} - \def\unnumbsubsubsecentry ##1##2{} + \def\unnumbsubsubsecentry ##1##2##3##4##5{} \openin 1 \jobname.toc \ifeof 1 \else \closein 1 @@ -3863,16 +4048,24 @@ width0pt\relax} \fi % The last argument is the page number. % The arguments in between are the chapter number, section number, ... -% Chapter-level things, for both the long and short contents. +% Chapters, in the main contents. \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}} - -% See comments in \dochapentry re vbox and related settings +% +% Chapters, in the short toc. +% See comments in \dochapentry re vbox and related settings. \def\shortchapentry#1#2#3{% \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}% } +% Appendices, in the main contents. +\def\appendixentry#1#2#3{% + \dochapentry{\appendixbox{\putwordAppendix{} #2}\labelspace#1}{#3}} +% +% Appendices, in the short toc. +\let\shortappendixentry = \shortchapentry + % Typeset the label for a chapter or appendix for the short contents. -% The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter. +% The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter. % We could simplify the code here by writing out an \appendixentry % command in the toc file for appendices, instead of using \chapentry % for both, but it doesn't seem worth it. @@ -3880,38 +4073,31 @@ width0pt\relax} \fi \newdimen\shortappendixwidth % \def\shortchaplabel#1{% - % Compute width of word "Appendix", may change with language. - \setbox0 = \hbox{\shortcontrm \putwordAppendix}% - \shortappendixwidth = \wd0 - % - % We typeset #1 in a box of constant width, regardless of the text of - % #1, so the chapter titles will come out aligned. - \setbox0 = \hbox{#1}% - \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi - % - % This space should be plenty, since a single number is .5em, and the + % This space should be enough, since a single number is .5em, and the % widest letter (M) is 1em, at least in the Computer Modern fonts. + % But use \hss just in case. % (This space doesn't include the extra space that gets added after % the label; that gets put in by \shortchapentry above.) - \advance\dimen0 by 1.1em - \hbox to \dimen0{#1\hfil}% + \dimen0 = 1em + \hbox to \dimen0{#1\hss}% } +% Unnumbered chapters. \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}} \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}} % Sections. \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}} -\def\unnumbsecentry#1#2{\dosecentry{#1}{#2}} +\def\unnumbsecentry#1#2#3{\dosecentry{#1}{#3}} % Subsections. \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}} -\def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}} +\def\unnumbsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} % And subsubsections. \def\subsubsecentry#1#2#3#4#5#6{% \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}} -\def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}} +\def\unnumbsubsubsecentry#1#2#3#4#5{\dosubsubsecentry{#1}{#5}} % This parameter controls the indentation of the various levels. \newdimen\tocindent \tocindent = 3pc @@ -3952,7 +4138,7 @@ width0pt\relax} \fi \def\tocentry#1#2{\begingroup \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks % Do not use \turnoffactive in these arguments. Since the toc is - % typeset in cmr, so characters such as _ would come out wrong; we + % typeset in cmr, characters such as _ would come out wrong; we % have to do the usual translation tricks. \entry{#1}{#2}% \endgroup} @@ -3972,36 +4158,27 @@ width0pt\relax} \fi \message{environments,} % @foo ... @end foo. +% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. +% % Since these characters are used in examples, it should be an even number of % \tt widths. Each \tt character is 1en, so two makes it 1em. -% Furthermore, these definitions must come after we define our fonts. -\newbox\dblarrowbox \newbox\longdblarrowbox -\newbox\pushcharbox \newbox\bullbox -\newbox\equivbox \newbox\errorbox - -%{\tentt -%\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil} -%\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil} -%\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil} -%\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil} -% Adapted from the manmac format (p.420 of TeXbook) -%\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex -% depth .1ex\hfil} -%} - -% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. +% \def\point{$\star$} \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} +% The @error{} command. % Adapted from the TeXbook's \boxit. +% +\newbox\errorbox +% {\tentt \global\dimen0 = 3em}% Width of the box. \dimen2 = .55pt % Thickness of rules % The text. (`r' is open on the right, `e' somewhat less so on the left.) \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt} - +% \global\setbox\errorbox=\hbox to \dimen0{\hfil \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. \advance\hsize by -2\dimen2 % Rules. @@ -4012,8 +4189,7 @@ width0pt\relax} \fi \kern3pt\vrule width\dimen2}% Space to right. \hrule height\dimen2} \hfil} - -% The @error{} command. +% \def\error{\leavevmode\lower.7ex\copy\errorbox} % @tex ... @end tex escapes into raw Tex temporarily. @@ -4053,9 +4229,9 @@ width0pt\relax} \fi \def\@{@}% \let\Etex=\endgroup} -% Define @lisp ... @endlisp. +% Define @lisp ... @end lisp. % @lisp does a \begingroup so it can rebind things, -% including the definition of @endlisp (which normally is erroneous). +% including the definition of @end lisp (which normally is erroneous). % Amount to narrow the margins by for @lisp. \newskip\lispnarrowing \lispnarrowing=0.4in @@ -4086,9 +4262,17 @@ width0pt\relax} \fi % is reset to zero; thus the \afterenvbreak inserts no space -- but the % start of the next paragraph will insert \parskip % -\def\aboveenvbreak{{\advance\envskipamount by \parskip -\endgraf \ifdim\lastskip<\envskipamount -\removelastskip \penalty-50 \vskip\envskipamount \fi}} +\def\aboveenvbreak{{% + \ifnum\lastpenalty < 10000 + \advance\envskipamount by \parskip + \endgraf + \ifdim\lastskip<\envskipamount + \removelastskip + \penalty-50 + \vskip\envskipamount + \fi + \fi +}} \let\afterenvbreak = \aboveenvbreak @@ -4220,7 +4404,7 @@ width0pt\relax} \fi \def\smalllispx{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}% \def\Esmallexample{\nonfillfinish\endgroup}% - \smallfonts + \smallexamplefonts \lisp } @@ -4231,12 +4415,12 @@ width0pt\relax} \fi \let\Edisplay = \nonfillfinish \gobble } - +% % @smalldisplay (when @smallbook): @display plus smaller fonts. % \def\smalldisplayx{\begingroup \def\Esmalldisplay{\nonfillfinish\endgroup}% - \smallfonts \rm + \smallexamplefonts \rm \display } @@ -4248,12 +4432,12 @@ width0pt\relax} \fi \let\Eformat = \nonfillfinish \gobble } - +% % @smallformat (when @smallbook): @format plus smaller fonts. % \def\smallformatx{\begingroup \def\Esmallformat{\nonfillfinish\endgroup}% - \smallfonts \rm + \smallexamplefonts \rm \format } @@ -4271,6 +4455,7 @@ width0pt\relax} \fi \gobble } + % @quotation does normal linebreaking (hence we can't use \nonfillstart) % and narrows the margins. % @@ -4293,6 +4478,173 @@ width0pt\relax} \fi } +% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} +% If we want to allow any <char> as delimiter, +% we need the curly braces so that makeinfo sees the @verb command, eg: +% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org +% +% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. +% +% [Knuth] p. 344; only we need to do '@' too +\def\dospecials{% + \do\ \do\\\do\@\do\{\do\}\do\$\do\&% + \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~} +% +% [Knuth] p. 380 +\def\uncatcodespecials{% + \def\do##1{\catcode`##1=12}\dospecials} +% +% [Knuth] pp. 380,381,391 +% Disable Spanish ligatures ?` and !` of \tt font +\begingroup + \catcode`\`=\active\gdef`{\relax\lq} +\endgroup +% +% Setup for the @verb command. +% +% Eight spaces for a tab +\begingroup + \catcode`\^^I=\active + \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} +\endgroup +% +\def\setupverb{% + \tt % easiest (and conventionally used) font for verbatim + \def\par{\leavevmode\endgraf}% + \catcode`\`=\active + \tabeightspaces + % Respect line breaks, + % print special symbols as themselves, and + % make each space count + % must do in this order: + \obeylines \uncatcodespecials \sepspaces +} + +% Setup for the @verbatim environment +% +% Real tab expansion +\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount +% +\def\starttabbox{\setbox0=\hbox\bgroup} +\begingroup + \catcode`\^^I=\active + \gdef\tabexpand{% + \catcode`\^^I=\active + \def^^I{\leavevmode\egroup + \dimen0=\wd0 % the width so far, or since the previous tab + \divide\dimen0 by\tabw + \multiply\dimen0 by\tabw % compute previous multiple of \tabw + \advance\dimen0 by\tabw % advance to next multiple of \tabw + \wd0=\dimen0 \box0 \starttabbox + }% + } +\endgroup +\def\setupverbatim{% + % Easiest (and conventionally used) font for verbatim + \tt + \def\par{\leavevmode\egroup\box0\endgraf}% + \catcode`\`=\active + \tabexpand + % Respect line breaks, + % print special symbols as themselves, and + % make each space count + % must do in this order: + \obeylines \uncatcodespecials \sepspaces + \everypar{\starttabbox}% +} + +% Do the @verb magic: verbatim text is quoted by unique +% delimiter characters. Before first delimiter expect a +% right brace, after last delimiter expect closing brace: +% +% \def\doverb'{'<char>#1<char>'}'{#1} +% +% [Knuth] p. 382; only eat outer {} +\begingroup + \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12 + \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] +\endgroup +% +\def\verb{\begingroup\setupverb\doverb} +% +% +% Do the @verbatim magic: define the macro \doverbatim so that +% the (first) argument ends when '@end verbatim' is reached, ie: +% +% \def\doverbatim#1@end verbatim{#1} +% +% For Texinfo it's a lot easier than for LaTeX, +% because texinfo's \verbatim doesn't stop at '\end{verbatim}': +% we need not redefine '\', '{' and '}' +% +% Inspired by LaTeX's verbatim command set [latex.ltx] +%% Include LaTeX hack for completeness -- never know +%% \begingroup +%% \catcode`|=0 \catcode`[=1 +%% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active +%% \catcode`\\=12|gdef|doverbatim#1@end verbatim[ +%% #1|endgroup|def|Everbatim[]|end[verbatim]] +%% |endgroup +\begingroup + \catcode`\ =\active + \gdef\doverbatim#1@end verbatim{#1\end{verbatim}} +\endgroup +% +\def\verbatim{% + \def\Everbatim{\nonfillfinish\endgroup}% + \begingroup + \nonfillstart + \advance\leftskip by -\defbodyindent + \begingroup\setupverbatim\doverbatim +} + +% @verbatiminclude FILE - insert text of file in verbatim environment. +% +% Allow normal characters that we make active in the argument (a file name). +\def\verbatiminclude{% + \begingroup + \catcode`\\=12 + \catcode`~=12 + \catcode`^=12 + \catcode`_=12 + \catcode`|=12 + \catcode`<=12 + \catcode`>=12 + \catcode`+=12 + \parsearg\doverbatiminclude +} +\def\setupverbatiminclude{% + \begingroup + \nonfillstart + \advance\leftskip by -\defbodyindent + \begingroup\setupverbatim +} +% +\def\doverbatiminclude#1{% + % Restore active chars for included file. + \endgroup + \begingroup + \def\thisfile{#1}% + \expandafter\expandafter\setupverbatiminclude\input\thisfile + \endgroup\nonfillfinish\endgroup +} + +% @copying ... @end copying. +% Save the text away for @insertcopying later. +% +\newbox\copyingbox +% +\def\copying{\begingroup + \parindent = 0pt % looks wrong on title page + \def\Ecopying{\egroup\endgroup}% + \global\setbox\copyingbox = \vbox\bgroup +} + +% @insertcopying. +% +\def\insertcopying{\unvcopy\copyingbox} + + \message{defuns,} % @defun etc. @@ -4620,7 +4972,7 @@ width0pt\relax} \fi % #1 is the data type, #2 the name, #3 the args. \def\deftypefunheaderx #1#2 #3\relax{% \doind {fn}{\code{#2}}% Make entry in function index -\begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypefun}% +\begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}% \deftypefunargs {#3}\endgroup % \catcode 61=\other % Turn off change made in \defparsebody } @@ -4629,9 +4981,9 @@ width0pt\relax} \fi \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader} -% \defheaderxcond#1\relax$$$ +% \defheaderxcond#1\relax$.$ % puts #1 in @code, followed by a space, but does nothing if #1 is null. -\def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi} +\def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi} % #1 is the classification. #2 is the data type. #3 is the name and args. \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax} @@ -4641,7 +4993,7 @@ width0pt\relax} \fi \begingroup \normalparens % notably, turn off `&' magic, which prevents % at least some C++ text from working -\defname {\defheaderxcond#2\relax$$$#3}{#1}% +\defname {\defheaderxcond#2\relax$.$#3}{#1}% \deftypefunargs {#4}\endgroup % \catcode 61=\other % Turn off change made in \defparsebody } @@ -4687,7 +5039,7 @@ width0pt\relax} \fi \def\deftypeopheader#1#2#3#4{% \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index \begingroup - \defname{\defheaderxcond#2\relax$$$#3} + \defname{\defheaderxcond#2\relax$.$#3} {\deftypeopcategory\ \putwordon\ \code{#1}}% \deftypefunargs{#4}% \endgroup @@ -4702,7 +5054,7 @@ width0pt\relax} \fi \def\deftypemethodheader#1#2#3#4{% \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index \begingroup - \defname{\defheaderxcond#2\relax$$$#3}{\putwordMethodon\ \code{#1}}% + \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}% \deftypefunargs{#4}% \endgroup } @@ -4716,7 +5068,7 @@ width0pt\relax} \fi \def\deftypeivarheader#1#2#3{% \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index \begingroup - \defname{\defheaderxcond#2\relax$$$#3} + \defname{\defheaderxcond#2\relax$.$#3} {\putwordInstanceVariableof\ \code{#1}}% \defvarargs{#3}% \endgroup @@ -4799,7 +5151,7 @@ width0pt\relax} \fi % is actually part of the data type, which should not be put into the index. \def\deftypevarheader #1#2{% \dovarind#2 \relax% Make entry in variables index -\begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypevar}% +\begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}% \interlinepenalty=10000 \endgraf\nobreak\vskip -\parskip\nobreak \endgroup} @@ -4810,7 +5162,7 @@ width0pt\relax} \fi \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader} \def\deftypevrheader #1#2#3{\dovarind#3 \relax% -\begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1} +\begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1} \interlinepenalty=10000 \endgraf\nobreak\vskip -\parskip\nobreak \endgroup} @@ -4970,7 +5322,7 @@ width0pt\relax} \fi \message{Warning: redefining \the\macname}% \else \expandafter\ifx\csname \the\macname\endcsname \relax - \else \errmessage{The name \the\macname\space is reserved}\fi + \else \errmessage{Macro name \the\macname\space already defined}\fi \global\cslet{macsave.\the\macname}{\the\macname}% \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% % Add the macroname to \macrolist @@ -5251,13 +5603,15 @@ width0pt\relax} \fi \ifpdf \leavevmode \getfilename{#4}% - \ifnum\filenamelength>0 - \startlink attr{/Border [0 0 0]}% - goto file{\the\filename.pdf} name{#1@}% - \else - \startlink attr{/Border [0 0 0]}% - goto name{#1@}% - \fi + {\normalturnoffactive + \ifnum\filenamelength>0 + \startlink attr{/Border [0 0 0]}% + goto file{\the\filename.pdf} name{#1}% + \else + \startlink attr{/Border [0 0 0]}% + goto name{#1}% + \fi + }% \linkcolor \fi % @@ -5519,8 +5873,15 @@ width0pt\relax} \fi % \smallfonts \rm % - % Hang the footnote text off the number. - \hang + % Because we use hanging indentation in footnotes, a @noindent appears + % to exdent this text, so make it be a no-op. makeinfo does not use + % hanging indentation so @noindent can still be needed within footnote + % text after an @example or the like (not that this is good style). + \let\noindent = \relax + % + % Hang the footnote text off the number. Use \everypar in case the + % footnote extends for more than one paragraph. + \everypar = {\hang}% \textindent{\thisfootno}% % % Don't crash into the line above the footnote text. Since this @@ -5537,24 +5898,6 @@ width0pt\relax} \fi }%end \catcode `\@=11 -% Set the baselineskip to #1, and the lineskip and strut size -% correspondingly. There is no deep meaning behind these magic numbers -% used as factors; they just match (closely enough) what Knuth defined. -% -\def\lineskipfactor{.08333} -\def\strutheightpercent{.70833} -\def\strutdepthpercent {.29167} -% -\def\setleading#1{% - \normalbaselineskip = #1\relax - \normallineskip = \lineskipfactor\normalbaselineskip - \normalbaselines - \setbox\strutbox =\hbox{% - \vrule width0pt height\strutheightpercent\baselineskip - depth \strutdepthpercent \baselineskip - }% -} - % @| inserts a changebar to the left of the current line. It should % surround any changed text. This approach does *not* work if the % change spans more than two lines of output. To handle that, we would @@ -5619,40 +5962,44 @@ width0pt\relax} \fi \global\warnednoepsftrue \fi \else - \imagexxx #1,,,\finish + \imagexxx #1,,,,,\finish \fi } % % Arguments to @image: % #1 is (mandatory) image filename; we tack on .eps extension. % #2 is (optional) width, #3 is (optional) height. -% #4 is just the usual extra ignored arg for parsing this stuff. -\def\imagexxx#1,#2,#3,#4\finish{% +% #4 is (ignored optional) html alt text. +% #5 is (ignored optional) extension. +% #6 is just the usual extra ignored arg for parsing this stuff. +\newif\ifimagevmode +\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup + \catcode`\^^M = 5 % in case we're inside an example + \normalturnoffactive % allow _ et al. in names + % If the image is by itself, center it. + \ifvmode + \imagevmodetrue + \nobreak\bigskip + % Usually we'll have text after the image which will insert + % \parskip glue, so insert it here too to equalize the space + % above and below. + \nobreak\vskip\parskip + \nobreak + \line\bgroup\hss + \fi + % + % Output the image. \ifpdf - \centerline{\dopdfimage{#1}{#2}{#3}}% + \dopdfimage{#1}{#2}{#3}% \else % \epsfbox itself resets \epsf?size at each figure. \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi - \begingroup - \catcode`\^^M = 5 % in case we're inside an example - % If the image is by itself, center it. - \ifvmode - \nobreak\bigskip - % Usually we'll have text after the image which will insert - % \parskip glue, so insert it here too to equalize the space - % above and below. - \nobreak\vskip\parskip - \nobreak - \centerline{\epsfbox{#1.eps}}% - \bigbreak - \else - % In the middle of a paragraph, no extra space. - \epsfbox{#1.eps}% - \fi - \endgroup + \epsfbox{#1.eps}% \fi -} + % + \ifimagevmode \hss \egroup \bigbreak \fi % space after the image +\endgroup} \message{localization,} @@ -5721,10 +6068,12 @@ should work if nowhere else does.} } % Parameters in order: 1) textheight; 2) textwidth; 3) voffset; -% 4) hoffset; 5) binding offset; 6) topskip. Then whoever calls us can -% set \parskip and call \setleading for \baselineskip. +% 4) hoffset; 5) binding offset; 6) topskip, 7) pdf pageheight; +% 8) pdf pagewidth. We also call \setleading{\textleading}, so +% the caller should define \textleading. The caller should also +% set \parskip. % -\def\internalpagesizes#1#2#3#4#5#6{% +\def\internalpagesizes#1#2#3#4#5#6#7#8{% \voffset = #3\relax \topskip = #6\relax \splittopskip = \topskip @@ -5743,25 +6092,47 @@ should work if nowhere else does.} \normaloffset = #4\relax \bindingoffset = #5\relax % + \setleading{\textleading} + % \parindent = \defaultparindent \setemergencystretch + % + \ifpdf + \pdfpageheight #7\relax + \pdfpagewidth #8\relax + \fi +} + +% Use `small' versions. +% +\def\smallenvironments{% + \let\smalldisplay = \smalldisplayx + \let\smallexample = \smalllispx + \let\smallformat = \smallformatx + \let\smalllisp = \smalllispx } % @letterpaper (the default). \def\letterpaper{{\globaldefs = 1 \parskip = 3pt plus 2pt minus 1pt - \setleading{13.2pt}% + \textleading = 13.2pt % % If page is nothing but text, make it come out even. - \internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}% + \internalpagesizes{46\baselineskip}{6in}% + {\voffset}{.25in}% + {\bindingoffset}{36pt}% + {11in}{8.5in}% }} % Use @smallbook to reset parameters for 7x9.5 (or so) format. \def\smallbook{{\globaldefs = 1 \parskip = 2pt plus 1pt - \setleading{12pt}% + \textleading = 12pt % - \internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}% + \internalpagesizes{7.5in}{5.in}% + {\voffset}{.25in}% + {\bindingoffset}{16pt}% + {9.25in}{7in}% % \lispnarrowing = 0.3in \tolerance = 700 @@ -5769,47 +6140,77 @@ should work if nowhere else does.} \contentsrightmargin = 0pt \deftypemargin = 0pt \defbodyindent = .5cm - % - \let\smalldisplay = \smalldisplayx - \let\smallexample = \smalllispx - \let\smallformat = \smallformatx - \let\smalllisp = \smalllispx + \smallenvironments }} % Use @afourpaper to print on European A4 paper. \def\afourpaper{{\globaldefs = 1 - \setleading{12pt}% \parskip = 3pt plus 2pt minus 1pt + \textleading = 12pt % - \internalpagesizes{53\baselineskip}{160mm}{\voffset}{4mm}{\bindingoffset}{44pt}% + \internalpagesizes{53\baselineskip}{160mm}% + {\voffset}{4mm}% + {\bindingoffset}{44pt}% + {297mm}{210mm}% % \tolerance = 700 \hfuzz = 1pt }} +% Use @afivepaper to print on European A5 paper. +% From romildo@urano.iceb.ufop.br, 2 July 2000. +% He also recommends making @example and @lisp be small. +\def\afivepaper{{\globaldefs = 1 + \parskip = 2pt plus 1pt minus 0.1pt + \textleading = 12.5pt + % + \internalpagesizes{166mm}{120mm}% + {\voffset}{-8mm}% + {\bindingoffset}{8pt}% + {210mm}{148mm}% + % + \lispnarrowing = 0.2in + \tolerance = 800 + \hfuzz = 1.2pt + \contentsrightmargin = 0mm + \deftypemargin = 0pt + \defbodyindent = 2mm + \tableindent = 12mm + % + \smallenvironments +}} + % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin % 29mm, hence bottom margin 28mm, nominal side margin 3cm. \def\afourlatex{{\globaldefs = 1 - \setleading{13.6pt}% + \textleading = 13.6pt % \afourpaper - \internalpagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}% + \internalpagesizes{237mm}{150mm}% + {3.6mm}{3.6mm}% + {3mm}{7mm}% + {297mm}{210mm}% % + % Must explicitly reset to 0 because we call \afourpaper, apparently, + % although this does not entirely make sense. \globaldefs = 0 }} % Use @afourwide to print on European A4 paper in wide format. \def\afourwide{% \afourpaper - \internalpagesizes{6.5in}{9.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}% - % - \globaldefs = 0 + \internalpagesizes{6.5in}{9.5in}% + {\hoffset}{\normaloffset}% + {\bindingoffset}{7mm}% + {297mm}{210mm}% } % @pagesizes TEXTHEIGHT[,TEXTWIDTH] % Perhaps we should allow setting the margins, \topskip, \parskip, % and/or leading, also. Or perhaps we should compute them somehow. % +\newdimen \tempdima +\newdimen \tempdimb \def\pagesizes{\parsearg\pagesizesxxx} \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish} \def\pagesizesyyy#1,#2,#3\finish{{% @@ -5817,9 +6218,16 @@ should work if nowhere else does.} \globaldefs = 1 % \parskip = 3pt plus 2pt minus 1pt - \setleading{13.2pt}% + \setleading{\textleading}% % - \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}% + \tempdima #1\relax + \advance\tempdima by 1in + \tempdimb #2\relax + \advance\tempdimb by 1in + \internalpagesizes{#1}{\hsize}% + {\voffset}{\normaloffset}% + {\bindingoffset}{44pt}% + {\tempdima}{\tempdimb}% }} % Set default to letter. @@ -5847,7 +6255,7 @@ should work if nowhere else does.} \def\normalless{<} \def\normalgreater{>} \def\normalplus{+} -\def\normaldollar{$} +\def\normaldollar{$}%$ font-lock fix % This macro is used to make a character print one way in ttfont % where it can probably just be output, and another way in other fonts, @@ -5896,7 +6304,7 @@ should work if nowhere else does.} \catcode`\+=\active \def+{{\tt \char 43}} \catcode`\$=\active -\def${\ifusingit{{\sl\$}}\normaldollar} +\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix %\catcode 27=\active %\def^^[{$\diamondsuit$} @@ -5941,7 +6349,7 @@ should work if nowhere else does.} @let<=@normalless @let>=@normalgreater @let+=@normalplus -@let$=@normaldollar} +@let$=@normaldollar}%$ font-lock fix @def@normalturnoffactive{@let"=@normaldoublequote @let\=@normalbackslash @@ -5952,7 +6360,7 @@ should work if nowhere else does.} @let<=@normalless @let>=@normalgreater @let+=@normalplus -@let$=@normaldollar} +@let$=@normaldollar}%$ font-lock fix % Make _ and + \other characters, temporarily. % This is canceled by @fixbackslash. diff --git a/contrib/groff/doc/webpage.ms b/contrib/groff/doc/webpage.ms new file mode 100644 index 0000000..f40b29b --- /dev/null +++ b/contrib/groff/doc/webpage.ms @@ -0,0 +1,969 @@ +.\" This file gives a small example how a web page could look like if created +.\" with groff. +.\" +.\" +.\" To make it work with other output devices also, we include www.tmac +.\" directly. +.\" +.nr PS 10 +.nr VS 12 +.if '\*[.T]'html' .nr LL 10i +.if r ps4html .nr LL 10i +.mso www.tmac +. +.de blm-macro +. nr tmp \\n[.i] +. LP +. in \\n[tmp]u +.. +.blm blm-macro +. +.HX 0 +. +.defcolor mydarkred rgb 0.65f 0.1f 0.2f +.defcolor mydarkgreen rgb 0.1f 0.5f 0.2f +.defcolor mydarkblue rgb 0.1f 0.2f 0.6f +. +.ds GNU \m[mydarkred]G\m[]\m[mydarkgreen]N\m[]\m[mydarkblue]U\m[] +. +.HTL +.NHR +. +Home of Groff (GNU Troff). +. +.HTML-IMAGE-LEFT +.PSPIC -L gnu.eps 2i 2i +.ie r ps4html \ +. nop \v'-0.66i'\h'2.0i'\s[100]\*[GNU] Troff\s0 +.el \ +. nop \v'-0.66i'\h'2.0i'\s[60]\*[GNU] Troff\s0 +.HTML-IMAGE-END +. +.HnS 1 +.HR +GNU Troff +.URL http://\:groff.ffii.org/ (Groff) +\[em] a +.URL http://\:www.gnu.org/ GNU +project. +Hosted by +.URL http://\:ffii.org/ FFII . +.HR +.HnE +.LK + +.DC T HE mydarkred +groff (GNU Troff) software +is a typesetting package which reads plain text mixed with +formatting commands and produces formatted output. +Groff now supports HTML. +. +. +.SH +Download + +.URL "ftp://\:groff.ffii.org/\:pub/\:groff/" Germany +| +.URL "ftp://\:ftp.gnu.org/\:gnu/\:groff/" USA + +.URL http://\:www.gnu.org/\:copyleft/\:gpl.html License +| +.URL http://\:ffii.org/\:mailman/\:listinfo/\:groff/ "Mailing list" +| +.URL "http://\:gnuwin32.sf.net/\:packages/\:groffl.htm" "Groff for Windows" + +User issues lead: +.MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding" +.br +Technical issues lead: +.MTO wl@\:gnu.org "Werner Lemberg" +. +. +.SH +README + +This is the GNU groff document formatting system. +The version number is given in the file VERSION. + +Included in this release are implementations of troff, pic, eqn, tbl, refer, +the \-man macros and the \-ms macros, and drivers for PostScript, TeX dvi +format, HP LaserJet 4 printers, HTML format (still alpha), and +typewriter-like devices. +Also included is a modified version of the Berkeley \-me macros, an enhanced +version of the X11 xditview previewer, and an implementation of the \-mm +macros contributed by +.MTO jh@\:axis.se "J\[:o]rgen H\[:a]gg" . + +See the file INSTALL for installation instructions. +You will require a C++ compiler. + +The file NEWS describes recent user-visible changes to groff. + +Groff is free software. +See the file COPYING for copying permission. + +The file PROBLEMS describes various problems that have been encountered in +compiling, installing, and running groff. + +For the moment, the documentation assumes that you are already familiar with +the Unix versions of troff, \-man, \-ms and the preprocessors. + +The most recent released version of groff is always available by anonymous +ftp from ftp.gnu.org in the directory pub/\:gnu/\:groff. + +A CVS repository is now available, containing the current development +version of groff. +You can access it with the commands + +.RS +.nf +.ft C +export CVSROOT=:pserver:anoncvs@anoncvs.ffii.org:/var/cvs +cvs login +cvs -z9 co groff +.ft P +.fi +.RE + +(if the prompt for the password appears, just press the enter key). +After a successful login you no longer need the first two commands; an +update of a checked out repository should be done with + +.RS +.ft C +cvs -z9 update -dP +.ft P +.RE + +Please read the info pages of cvs for further details. + +Alternatively, you can download snapshots (which are updated twice a day) +from +.URL ftp://\:ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz here +or a diff file relative to the latest official groff release as: + +.RS +.ft C +ftp://ftp.ffii.org/pub/groff/devel/groff-\[la]version\[ra]-current.diff.gz +.ft P +.RE + +Assuming that groff-\[la]version\[ra].tar.gz and +groff-\[la]version\[ra]-current.diff.gz are in the same directory, do the +following to apply the diff file: + +.RS +.nf +.ft C +tar xzvf groff-\[la]version\[ra].tar.gz +cd groff-\[la]version\[ra] +gunzip -c ../groff-\[la]version\[ra]-current.diff.gz | patch -p1 +.ft P +.fi +.RE + +Please report bugs using the form in the file BUG-REPORT; the idea of this +is to make sure that FSF has all the information it needs to fix the bug. +At the very least, read the BUG-REPORT form and make sure that you supply +all the information that it asks for. +Even if you are not sure that something is a bug, report it using +BUG-REPORT: this will enable us to determine whether it really is a bug or +not. + +Three mailing lists are available: + +.ULS +.LI +.MTO bug-groff@gnu.org bug-groff@gnu.org +for reporting bugs + +.LI +.MTO groff@gnu.org groff@gnu.org +for general discussion of groff + +.LI +.MTO groff-commit@ffii.org groff-commit@ffii.org +a read-only list showing logs of commitments to the CVS repository +.ULE + +Note that groff@gnu.org is an alias for +.MTO groff@\:ffii.org groff@\:ffii.org ; +you must be subscribed to the `groff' list to send mails. + +To subscribe, send e-mail to \[la]list\[ra]-request@\[la]domain\[ra] +(example: +.MTO groff-request@\:ffii.org groff-request@\:ffii.org ) +with the word `subscribe' in either the +subject or body of the e-mail (don't include the quotes). + +GNU groff was written by +.MTO jjc@\:jclark.com "James Clark" . +It is now maintained by +.MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding" +and +.MTO wl@\:gnu.org "Werner Lemberg" . +. +. +.SH +NEWS VERSION 1.18.1 +. +.SH 2 +troff + +.ULS +.LI +The non-slanted PostScript font definition files have been regenerated to +include left and right italic correction values. +Applying those to a glyph (this is, prepending the glyph with `\e,' and +appending `\e/' to the glyph) sets the glyph width to the real value given +by the horizontal bounding box values. +Without those escapes, the advance width for the particular glyph is used +(which can differ considerably). + +Most users will neither need this feature nor notice a difference in +existing documents (provided \e, and \e/ is used as advertised, namely for +italic fonts only); its main goal is to improve image generation with +grohtml. + +This is an experimental change, and feedback is welcome. +.ULE +. +.SH 2 +tbl + +.ULS +.LI +Added global option `nospaces' to ignore leading and trailing spaces in data +items. +.ULE +. +.SH 2 +grolbp + +.ULS +.LI +The option \-w (\-\-linewidth) has been added (similar to other device +drivers) to set the default line width. +.ULE +. +.SH 2 +grn + +.ULS +.LI +Support for b-spline and Bezier curves has been added. +.ULE +. +.SH 2 +groffer + +.ULS +.LI +New option \-\-shell to select the shell under wich groffer shall run. +.ULE +. +.SH 2 +Macro Packages + +.ULS +.LI +The string `Am' (producing an ampersand) has been added to mdoc for +compatibility with NetBSD. + +.LI +`.IX' is now deprecated for mom; you should use `.IQ' (Indent Quit) +instead. + +.LI +In mom, new inlines `FWD', `BCK', `UP', and `DOWN' deal with horizontal +and vertical movements; please refer to contrib/mom/NEWS for more +details. + +.LI +New macro ENDNOTES_HDRFTR_CENTER for mom to better control headers. +.ULE +. +.SH 2 +Miscellaneous + +.ULS +.LI +The `papersize' keyword in the DESC file now accepts multiple arguments. +It is scanned from left to the right, and the first valid argument is used. +This makes it possible to provide a fallback paper size. + +Example: +.RS +.ft C +papersize /etc/papersize a4 +.ft P +.RE + +.LI +A local font directory has been prepended to the default font path; it +defaults to /usr/local/share/groff/site-font. Similar to the normal +font searching process, files must be placed into a dev\fIXXX\fP +subdirectory, e.g. + +.RS +.ft C +/usr/local/share/groff/site-font/devps/FOO +.ft P +.RE + +for a PostScript font definition file FOO. +.ULE +. +. +.SH +NEWS VERSION 1.18 + +This section describes recent user-visible changes in groff. +Bug fixes are not described. +There are more details in the man pages. + +.ad c +\s[+5]\m[red]\ +Please read the changes below regarding +.ie '\*[.T]'html' \ +. URL #grotty grotty , +.el \ +. nop grotty, +groff's tty frontend.\ +\m[]\s[0] +.br +.ad n +. +.SH 2 +Troff + +.ULS +.LI +Color support has been added to troff and pic (and to the device drivers +grops, grodvi, grotty, and grohtml -- other preprocessors and drivers will +follow). +A new function `defcolor' defines colors; the escape sequence `\em' sets the +drawing color, the escape sequence `\eM' specifies the background color for +closed objects created with \eD'.\|.\|.' commands. +`\em[]' and `\eM[]' switch back to the previous color. +`\em' and `\eM' correspond to the new troff output command sets starting +with `m' and `DF'. +The device-specific default color is called `default' and can't be +redefined. + +Use the `color' request to toggle the usage of colors (default is on); the +read-only register `.color' is\~0 if colors are not active, and non-zero +otherwise. + +The old `Df' output command is mapped onto `DFg'; all color output +commands don't change the current font position (consequently, `Df' +doesn't either). + +Outputting color can be disabled in troff and groff with the option\~\-c +(it is always disabled in compatibility mode). +See the section on grotty for the +.ie '\*[.T]'html' \ +. URL #GROFF_NO_SGR GROFF_NO_SGR +.el \ +. nop GROFF_NO_SGR +environment variable also. + +For defining color components as fractions between 0 and\~1, a new scaling +indicator `f' has been defined: 1f\~=\~65536u. +For testing whether a color is defined (with .if and .ie), a new +conditional operator `m' is available. + +More details can be found in the groff_diff.7 manual page and in +groff.texinfo. + +.LI +Similar to \em and \eM, \ef[] switches back to the previous font. +\efP (and \ef[P]) is still valid for backwards compatibility. + +.LI +The new escape \eF is the same as `.fam'; \eF[] switches back to previous +family -- \eF[P] selects family `P'. + +.LI +Two new glyph symbols are available: `eu' is the official Euro symbol; +`Eu' is a font-specific glyph variant. + +.LI +The new glyph symbols `t+\-', `tdi', and `tmu' are textual variants of +`+\-', `di', and `mu', respectively. + +.LI +Latin-1 character 181 (PS name `mu', Unicode name U+00B5 MICRO SIGN) has +got the troff glyph name `mc'. + +.LI +\-Tutf8 is now available on EBCDIC hosts. + +.LI +Strings can take arguments, using this syntax: \e*[foo\~arg1\~arg2\~.\|.\|.]. +Example: +.RS +.nf +.ft C +\&.ds xxx This is a \e\e$1 test. +\e*[xxx nice] +.ft P +.fi +.RE + +.LI +It is now possible to have whitespace between the first and second dot (or +the name of the ending macro) to end a macro definition. +Example: +.RS +.nf +.ft C +\&.de ! +\&.. +\&. +\&.de foo +\&. nop Hello, I'm `foo'. +\&. nop I will now define `bar'. +\&. de bar ! +\&. nop Hello, I'm `bar'. +\&. ! +\&.. +.ft P +.fi +.RE + +.LI +`.fn' is a new string-valued register which returns the (internal) real +font name; styles and families are properly concatenated. + +.LI +Three new read/write registers `seconds', `minutes', and `hours' contain +the current time, set at start-up of troff. +Use the `af' request to control their output format. + +.LI +The new request `fchar' can be used to provide fallback characters. +It has the same syntax as the `char' request; the only difference is that +a character defined with `.char' hides the glyph with the same name in the +current font, whereas a character defined with `.fchar' is checked only if +the particular glyph isn't found in the current font. +This test happens before checking special fonts. + +.LI +In analogy to the `tmc' request, `.writec' is the same as `.write' but +doesn't emit a final newline. + +.LI +The new request `itc' is a variant of `.it' for which a line interrupted +with \ec counts as one input line. + +.LI +Two new requests `ds1' and `as1' which are similar to `ds' and `as' but +with compatibility mode disabled during expansion of strings defined by +them. + +.LI +The syntax of the `substring' request has been changed: +The first character in a string now has index\~0, the last character +has index\~\-1. +Note that this is an incompatible change. + +.LI +To emit strings directly to the intermediate output, a new `output' +request has been added; it is similar to `\e!' used at the top level. + +.LI +`.hpf' has been extended. +It can now handle most TeX hyphenation pattern files without +modification. +To do that, the commands \epatterns, \ehyphenation, and \eendinput are +recognized. +Please refer to groff_diff.7 for more information. + +.LI +`hpfcode' is a new request to provide an input encoding mapping for the +`hpf' request. + +.LI +The new request `hpfa' appends hyphenation patterns (`hpf' replaces +already existing patterns). + +.LI +A new request `ami' (append macro indirect) has been added. +The first and second parameter of `ami' are taken from string registers +rather than directly; this very special request is needed to make +`trace.tmac' independent from the escape character (which might even +be disabled). + +.LI +The new request `sizes' is similar to the `sizes' command in DESC files. +It expects the same syntax; the data must be on a single line, and the +final `0' can be omitted. + +.LI +`trin' (translate input) is a new request which is similar to `tr' with +the exception that the `asciify' request will use the character code (if +any) before the character translation. +Example: +.RS +.nf +.ft C +\&.trin ax +\&.di xxx +a +\&.br +\&.di +\&.xxx +\&.trin aa +\&.asciify xxx +\&.xxx +.ft P +.fi +.RE + +The result is `x\~a'. Using `tr', the result would be `x\~x'. + +.LI +The request `pvs' isn't new, but hasn't been documented before. +It adds vertical space after a line has been output. +This makes it an alternative to the `ls' request to produce +double-spaced documents. +The read-only register `.pvs' holds the current amount of the +post-vertical line space. + +.LI +For compatibility with plan 9's troff, multiple `pi' requests are +supported: + +.RS +.nf +.ft C +\&.pi foo +\&.pi bar +.ft P +.fi +.RE + +is now equivalent to +.RS +.ft C +\&.pi foo | bar +.ft P +.RE + +.LI +A new escape sequence `\eO' is available to disable and enable glyph +output. +Please see groff_diff.man and groff.texinfo for more details. + +.LI +The escapes `\e%', `\e&', `\e)', and `\e:' no longer cause an error in \eX; +they are ignored now. +Additionally `\e\ ' and `\e~' are converted to single space characters. + +.LI +The default tab distance in nroff mode is now 0.8i to be compatible +with UNIX troff. + +.LI +Using the latin-1 input character 0xAD (soft hyphen) for the `shc' +request was a bad idea. +Instead, it is now translated to `\e%', and the default hyphenation +character is again \e[hy]. +Note that the glyph \e[shc] is not useful for typographic purposes; +it only exists to have glyph names for all latin-1 characters. +.ULE +. +.SH 2 +Macro Packages + +.ULS +.LI +.MTO df191@\:ncf.ca "Peter Schaffter" +has contributed a new major macro package called `mom', mainly for +non-scientific writers, which takes care of many typographic issues. +It comes with a complete reference (in HTML format) and some examples. +`mom' has been designed to format documents for PostScript output only. + +.LI +Two macros `AT' (AT&T) and `UC' (Univ. of California) have been added to +the man macros for compatibility with older BSD releases. + +.LI +Both the man and mdoc macro packages now use the LL and LT registers for +setting the line and title length, respectively (similar to those +registers in the ms macro package). +If not set on the command line or in a macro file loaded before the macro +package itself, they default to 78n in nroff mode and 6.5i in troff mode. + +.LI +The `\-xwidth' specifier in the mdoc macro package has been removed. +Its functionality is now integrated directly into `\-width'. +Similarly, `\-column' has been extended to has this functionality also. + +.LI +A new macro `Ex' has been added to the mdoc macro package to document an +exit status. + +.LI +`troff.man' has been split. Differences to UNIX troff are now documented +in the new man page `groff_diff.man'. + +.LI +The PSPIC macro has been extended to work with DVI output (`pspic.tmac' is +now automatically loaded for \-Tdvi), using a dvips special to load the EPS +file. + +.LI +The trace.tmac package now traces calls to `am' also. +Additionally, it works in compatibility mode. + +.LI +`troff.1' has been split. +Differences to UNIX troff are now documented in the new man page +`groff_diff.7'. + +.LI +`groff_mwww.7' has been renamed to `groff_www.7'. +The file mwww.tmac has been removed. + +.LI +`groff_ms.7' has been completely rewritten. +It now contains a complete reference to the ms macros. + +.LI +`groff_trace.7' documents the trace macro package. + +.LI +Changes in www.tmac + +Note that HTML support is still in alpha change, so it is rather likely +that both macro names and macro syntax will change. +Some of the macros mentioned below aren't really new but haven't been +documented properly before. + +.ULS +.LI +The following macros have been renamed: +.RS +.nf +MAILTO -> MTO +IMAGE -> IMG +LINE -> HR +.fi +.RE + +.LI +For consistency, the macros `URL', `FTL', and `MTO' now all have the +address as the first parameter followed by the description. + +.LI +By default, grohtml generates links to all section headings at the top +of the document. +Use the new `LK' macro to specify a different place. + +.LI +For specifying the background color and a background image, use the +new macros `BCL' and `BGIMG', respectively. + +.LI +The macro `NHR' has been added; it suppresses the generation of top and +bottom rules which grohtml emits by default. + +.LI +The new macro `HX' determines the cut-off point for automatic link +generation to headings. + +.LI +The image position parameter names in `IMG' have been changed to `\-L', +`\-R', and `\-C'. + +.LI +New macro `PIMG' for inclusion of a PNG image (it will automatically +convert it into an EPS file if not \-Thtml is used). + +.LI +New macro `MPIMG' for putting a PNG image into the left or right margin +(it will automatically convert it into an EPS file if not \-Thtml is used). + +.LI +New macros `HnS', `HnE' to start and end a header line block. + +.LI +New macro `DC' to produce dropcap characters. + +.LI +New macro `HTL' to generate an HTML title line only but no H1 heading. + +.LI +New macros `ULS' and `ULE' to start and end an unordered list. +The new macro `LI' inserts a list item. +.ULE +.ULE +. +. +.SH 2 +groff + +.ULS +.LI +The new command line `\-c' disables color output (which is always disabled +in compatibility mode). +.ULE +. +. +.SH 2 +Nroff + +.ULS +.LI +Two new command line options `\-c' and `\-C'; the former passes `\-c' to +grotty (switching to the old output scheme); the latter passes `\-C' to +groff (enabling compatibility mode). +.ULE +. +. +.SH 2 +pic + +.ULS +.LI +New keywords `color' (or `colour', `colored', `coloured'), `outline' (or +`outlined'), and `shaded' are available. +`outline' sets the color of the outline, `shaded' the fill color, and +`color' sets both. +Example: +.RS +.ft C +circle shaded "green" outline "black" ; +.ft P +.RE + +Filled arrows always use the outline color for filling. + +Color support for TeX output is not implemented yet. +.ULE +. +. +.SH 2 +Pic2graph + +.ULS +.LI +A new script contributed by +.MTO esr@\:thyrsus.com "Eric S.\~Raymond" . +It converts a PIC diagram into a cropped image. +Since it uses gs and the PNM library, virtually all graphics formats +are available for output. +.ULE +. +. +.SH 2 +Eqn2graph + +.ULS +.LI +A new script contributed by +.MTO esr@\:thyrsus.com "Eric S.\~Raymond" . +It converts an EQN diagram into a cropped image. +Since it uses gs and the PNM library, virtually all graphics formats +are available for output. +.ULE +. +. +.SH 2 +Groffer + +.ULS +.LI +A new script contributed by +.MTO bwarken@mayn.de "Bernd Warken" . +It displays groff files and man pages on X and tty, taking care of most +parameters automatically. +.ULE +. +. +.SH 2 +Grog + +.ULS +.LI +Documents using the mom macro package are recognized. +.ULE +. +. +.SH 2 +grops + +.ULS +.LI +Color support has been added. + +.LI +A new option `\-p' is available to select the output paper size. +It has the same syntax as the new `papersize' keyword in the DESC file. +.ULE +. +. +.SH 2 +Grodvi + +.ULS +.LI +By default, font sizes are now available in the range 5\-10000pt, similar +to PS fonts. +If you want the old behaviour (i.e., font sizes at discrete values only), +insert the following at the start of your document: +.RS +.nf +.ft C +\&.if '\e*[.T]'dvi' \e +\&. sizes 500 600 700 800 900 1000 1095 1200 1400 1440 1600 \e +\& 1728 1800 2000 2074 2200 2400 2488 2800 3600 +.ft P +.fi +.RE + +.LI +A new font file HBI (using cmssbxo10; this is slanted sans serif bold +extended) has been added. + +.LI +Two font families are now available: `T' and `H'. + +.LI +EC and TC fonts have been integrated. +Use `\-mec' (calling the file ec.tmac) to switch to them. +Those fonts give a much better coverage of the symbols defined by groff +than the CM fonts. + +Note that ec.tmac must be called before any language-specific files; it +doesn't take care of hcode values. + +.LI +Color support has been added. +For drawing commands, colors are translated to gray values currently. +.ULE +. +. +.TAG grotty +.SH 2 +Grotty + +.ULS +.LI +Color support has been added, using the SGR (ISO\~6429, sometimes called +ANSI color) escape sequences. + +.LI +SGR escape sequences are now used by default for underlining and bold +printing also, no longer using the backspace character trick. +To revert to the old behaviour, use the `\-c' switch. + +Note that you have to use the `\-R' option of `less' to make SGR escapes +display correctly. +On the other hand, terminal programs and consoles like `xterm' which +support SGR sequences natively can directly display the output of grotty. +Consequently, the options `\-b', `\-B', `\-u', and `\-U' work only in +combination with `\-c' and are ignored silently otherwise. + +For the `man' program, it may be necessary to add the `\-R' option of +`less' to the $PAGER environment variable; alternatively, you can use +`man's `\-P' option (or adapt its configuration file accordingly). +See man(1) for more details. + +.TAG GROFF_NO_SGR +.LI +If the environment variable GROFF_NO_SGR is set, SGR output is disabled, +reverting to the old behaviour. + +.LI +A new special \eX'tty:\~sgr\~n' has been added; if n is non-zero or missing, +enable SGR output (the default). + +.LI +If the new option `\-i' is used (only in SGR mode), grotty sends escape +sequences to set the italic font attribute instead of the underline +attribute for italic fonts. +Note that many terminals don't have support for this (including xterm). +.ULE +. +. +.SH 2 +grohtml + +.ULS +.LI +Color support for glyphs has been added. + +.LI +New option `\-h' to select the style of headings in HTML output. + +.LI +New option `\-b' to set the background colour to white. + +.LI +New options `\-a' and `\-g' to control the number of bits for anti-aliasing +used for text and graphics, respectively. +Default value is\~4; 0\~means no anti-aliasing. + +.LI +groff character/glyph entities now map onto HTML\~4 character entities. +.ULE +. +. +.SH 2 +Grolbp + +.ULS +.LI +Valid paper sizes are now specified as with the new `papersize' keyword +in the DESC file. +Specifically, the old custom paper type format `custAAAxBBB' is no longer +supported. +.ULE +. +. +.SH 2 +Miscellaneous + +.ULS +.LI +A new manual page `ditroff.7' is available. + +.LI +The groff texinfo manual will now be installed, together with a bunch +of examples. + +.LI +A new keyword `papersize' has been added to the DESC file format. +Its argument is either + +.RS +.IP \[bu] +a predefined paper format (e.g. `A4' or `letter') + +.IP \[bu] +a file name pointing to a file which must contain a paper size +specification in its first line (e.g. `/etc/papersize') + +.IP \[bu] +a custom paper size definition like `35c,4i' +.RE + +See groff_font(5) for more details. +This keyword only affects the physical dimensions of the output medium; +grops, grolj4, and grolbp use it currently. +troff completely ignores it. +.ULE +. +.HR +. +\s-2\fIThis document was produced using +.URL http://groff.ffii.org/ groff-\n[.x].\n[.y].\n[.Y] . +.br +The image at the top has been contributed by Imogen Mulley (born 1991), +based on a similar picture found on the +.URL http://www.gnu.org "GNU server" . +.HR +.\" EOF |
