wl pushed a commit to branch master in repository groff. commit e3c63595385352cf1958bbe0c6bf2cab5d517afd Author: Werner Lemberg <w...@gnu.org> Date: Sun Oct 12 17:56:02 2014 +0200
* doc/groff.texinfo: s/which/that/ where apropriate. --- ChangeLog | 4 + doc/groff.texinfo | 352 ++++++++++++++++++++++++++-------------------------- 2 files changed, 180 insertions(+), 176 deletions(-) diff --git a/ChangeLog b/ChangeLog index 3cccca7..1d9b43c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2014-10-12 Werner LEMBERG <w...@gnu.org> + * doc/groff.texinfo: s/which/that/ where apropriate. + +2014-10-12 Werner LEMBERG <w...@gnu.org> + * doc/groff.texinfo: Various minor fixes. Most of those glitches have been found by comparing the info output diff --git a/doc/groff.texinfo b/doc/groff.texinfo index df3f63c..6cb352d 100644 --- a/doc/groff.texinfo +++ b/doc/groff.texinfo @@ -723,10 +723,10 @@ name @code{troff} is pronounced `@w{t-roff}' rather than `trough'. With @code{troff} came @code{nroff} (they were actually the same program except for some @samp{#ifdef}s), which was for producing output for line printers and character terminals. It understood everything @code{troff} -did, and ignored the commands which were not applicable (e.g.@: font +did, and ignored the commands that were not applicable (e.g.@: font changes). -Since there are several things which cannot be done easily in +Since there are several things that cannot be done easily in @code{troff}, work on several preprocessors began. These programs would transform certain parts of a document into @code{troff}, which made a very natural use of pipes in @acronym{UNIX}. @@ -749,7 +749,7 @@ from a previous one. @pindex ditroff @cindex @code{ditroff}, the program So, Brian Kernighan took on the task of rewriting @code{troff}. The -newly rewritten version produced device independent code which was very +newly rewritten version produced device independent code that 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 extensions, which @@ -776,7 +776,7 @@ The @code{soelim}, @code{pic}, @code{tbl}, and @code{eqn} preprocessors. @item Postprocessors for character devices, @sc{PostScript}, @TeX{} DVI, and X@tie{}Windows. GNU @code{troff} also eliminated the need for a -separate @code{nroff} program with a postprocessor which would produce +separate @code{nroff} program with a postprocessor that would produce @acronym{ASCII} output. @item @@ -784,7 +784,7 @@ A version of the @file{me} macros and an implementation of the @file{man} macros. @end itemize -Also, a front-end was included which could construct the, sometimes +Also, a front-end was included that could construct the, sometimes painfully long, pipelines required for all the post- and preprocessors. Development of GNU @code{troff} progressed rapidly, and saw the @@ -898,7 +898,7 @@ the most 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 @dfn{preprocessors} were written which +Therefore, programs called @dfn{preprocessors} were written that 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. @@ -914,14 +914,14 @@ preprocessors to use. (@code{tbl}), typesetting equations (@code{eqn}), drawing pictures (@code{pic} and @code{grn}), processing bibliographies (@code{refer}), and drawing chemical structures (@code{chem}). An -associated program which is useful when dealing with preprocessors is +associated program that is useful when dealing with preprocessors is @code{soelim}. A free implementation of @code{grap}, a preprocessor for drawing graphs, can be obtained as an extra package; @code{groff} can use @code{grap} also. -Unique to @code{groff} is the @code{preconv} preprocessor which enables +Unique to @code{groff} is the @code{preconv} preprocessor that enables @code{groff} to handle documents in various input encodings. There are other preprocessors in existence, but, unfortunately, no free @@ -937,7 +937,7 @@ mathematical pictures (@code{ideal}). @cindex output devices @cindex devices for output -@code{groff} actually produces device independent code which may be fed +@code{groff} actually produces device independent code that may be fed into a postprocessor to produce output for a particular device. Currently, @code{groff} has postprocessors for @sc{PostScript} devices, character terminals, X@tie{}Windows (for previewing), @TeX{} DVI format, @@ -987,7 +987,7 @@ 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 +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. @@ -1238,7 +1238,7 @@ macro file (including the start-up file). @item -R Preprocess with @code{grefer}. No mechanism is provided for passing arguments to @code{grefer} because most @code{grefer} options have -equivalent commands which can be included in the file. @xref{grefer}, +equivalent commands that can be included in the file. @xref{grefer}, for more details. @pindex troffrc @@ -1313,7 +1313,7 @@ For typewriter-like devices that support the @w{Latin-1} @cindex encoding, output, @w{utf-8} @cindex @w{utf-8}, output encoding @cindex output encoding, @w{utf-8} -For typewriter-like devices which use the Unicode (ISO@tie{}10646) +For typewriter-like devices that use the Unicode (ISO@tie{}10646) character set with @w{UTF-8} encoding. @item cp1047 @@ -1324,7 +1324,7 @@ character set with @w{UTF-8} encoding. @cindex cp1047, output encoding @cindex output encoding, cp1047 @cindex IBM cp1047 output encoding -For typewriter-like devices which use the @acronym{EBCDIC} encoding IBM +For typewriter-like devices that use the @acronym{EBCDIC} encoding IBM cp1047. @item lj4 @@ -1403,7 +1403,7 @@ automatically runs the appropriate postprocessor. @cindex variables in environment There are also several environment variables (of the operating system, -not within @code{gtroff}) which can modify the behavior of @code{groff}. +not within @code{gtroff}) that can modify the behavior of @code{groff}. @table @code @item GROFF_BIN_PATH @@ -1558,7 +1558,7 @@ 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 +All font files are kept in the @dfn{font directories}, which constitute the @dfn{font path}. The file search functions 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 @@ -1613,13 +1613,13 @@ A default paper size can be set in the device's @file{DESC} file. Most output devices also have a command line option @option{-p} to override the default paper size and option @option{-l} to use landscape orientation. @xref{DESC File Format}, for a description of the -@code{papersize} keyword which takes the same argument as @option{-p}. +@code{papersize} keyword, which takes the same argument as @option{-p}. @pindex papersize.tmac @pindex troffrc A convenient shorthand to set a particular paper size for @code{gtroff} is command line option @option{-dpaper=@var{size}}. This defines string -@code{paper} which is processed in file @file{papersize.tmac} (loaded in +@code{paper}, which is processed in file @file{papersize.tmac} (loaded in the start-up file @file{troffrc} by default). Possible values for @var{size} are the same as the predefined values for the @code{papersize} keyword (but only in lowercase) except @@ -1781,7 +1781,7 @@ format the output. For more detail on this, see @ref{Embedded Commands}. The word @dfn{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 +that appears on the same line as a request, and which modifies the meaning of that request. For example, the request @Example @@ -1797,7 +1797,7 @@ spaces one line, but @noindent spaces four lines. The number@tie{}4 is an argument to the @code{sp} -request which says to space four lines instead of one. Arguments are +request, which says to space four lines instead of one. Arguments are separated from the request and from each other by spaces (@emph{no} tabs). More details on this can be found in @ref{Request and Macro Arguments}. @@ -1833,7 +1833,7 @@ 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 +requests that describe how to format the text. Requests always have a period (@samp{.}) or an apostrophe (@samp{'}) as the first character of the input line. @@ -1932,11 +1932,11 @@ line. To start a new line without performing any other action, use @cindex features, common @code{gtroff} provides very low-level operations for formatting a -document. There are many common routine operations which are done in +document. There are many common routine operations that are done in all documents. These common operations are written into @dfn{macros} and collected into a @dfn{macro package}. -All macro packages provide certain common capabilities which fall into +All macro packages provide certain common capabilities that fall into the following categories. @menu @@ -1976,7 +1976,7 @@ sacred to be touched. @endExample @noindent -And there are also indented paragraphs which begin with a tag or label +And there are also indented paragraphs, which begin with a tag or label at the margin and the remaining text indented. @Example @@ -2051,7 +2051,7 @@ all the examples used in this document. @cindex quotes, major @cindex major quotes -@dfn{Major quotes} are quotes which are several lines long, and hence +@dfn{Major quotes} are quotes that are several lines long, and hence are set in from the rest of the text without quote marks around them. @cindex list @@ -2061,7 +2061,7 @@ justified like normal text, such as columns of figures or the examples used in this paper. @cindex keep -A @dfn{keep} is a display of lines which are kept on a single page if +A @dfn{keep} is a display of lines that 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. @@ -2069,7 +2069,7 @@ not. @cindex keep, floating @cindex floating keep @dfn{Floating keeps} move relative to the text. Hence, they are good -for things which are referred to by name, such as ``See figure@tie{}3''. +for things that are referred to by name, such as ``See figure@tie{}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. @@ -2091,7 +2091,7 @@ 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 +Most macro packages that supply this functionality also supply a means of automatically numbering either type of annotation. @c --------------------------------------------------------------------- @@ -2306,7 +2306,7 @@ versions of the @code{man} program. @emph{Always} use the @option{-rLL=@var{length}} option, or an equivalent @samp{.nr LL @var{length}} request, in preference to such a @samp{.ll @var{length}} request. In particular, note that in nroff mode, the request @samp{.ll -65n}, (with any @var{length} expression which evaluates equal to +65n}, (with any @var{length} expression that evaluates equal to 65@dmn{n}, i.e., the formatter's default line length in nroff mode), does @emph{not} set the line length to 65@dmn{n} (it is adjusted to the @code{man} macro package's default setting of 78@dmn{n}), whereas the @@ -2344,7 +2344,7 @@ following page numbers: 1, 2, 2a, 2b, 2c, etc. @pindex man.local This section describes the available macros for manual pages. For further customization, put additional macros and requests into the file -@file{man.local} which is loaded immediately after the @file{man} +@file{man.local}, which is loaded immediately after the @file{man} package. @Defmac {TH, title section [@Var{extra1} [@Var{extra2} [@Var{extra3}]]], man} @@ -2572,7 +2572,7 @@ macro is called, then the text of the next line appears in italic. @cindex @code{man} macros, default indentation @cindex default indentation [@code{man}] The default indentation is 7.2@dmn{n} in troff mode and 7@dmn{n} in -nroff mode except for @code{grohtml} which ignores indentation. +nroff mode except for @code{grohtml}, which ignores indentation. @Defmac {DT, , man} @cindex tab stops [@code{man}] @@ -3105,7 +3105,7 @@ Default: 5@dmn{n}. @endDefmpreg @Defmpreg {PORPHANS, ms} -Defines the minimum number of initial lines of any paragraph which +Defines the minimum number of initial lines of any paragraph that should be kept together, to avoid orphan lines at the bottom of a page. If a new paragraph is started close to the bottom of a page, and there is insufficient space to accommodate @code{PORPHANS} lines before an @@ -3118,7 +3118,7 @@ Default: 1. @endDefmpreg @Defmpreg {HORPHANS, ms} -Defines the minimum number of lines of the following paragraph which +Defines the minimum number of lines of the following paragraph that should be kept together with any section heading introduced by the @code{NH} or @code{SH} macros. If a section heading is placed close to the bottom of a page, and there is insufficient space to accommodate @@ -3862,9 +3862,9 @@ The @code{DE} macro ends the display. These two macros were formerly provided as aliases for @code{DS} and @code{DE}, respectively. They have been removed, and should no longer be used. The original implementations of @code{DS} and @code{DE} are -retained, and should be used instead. X11 documents which actually use +retained, and should be used instead. X11 documents that actually use @code{Ds} and @code{De} always load a specific macro file from the X11 -distribution (@file{macros.t}) which provides proper definitions for the +distribution (@file{macros.t}) that provides proper definitions for the two macros. @endDefmac @@ -4989,15 +4989,15 @@ groff -Tlatin1 -mlatin9 ... @noindent fails if you use the Euro character in the input. Usually, this -limitation is present only for devices which have a limited set of +limitation is present only for devices that have a limited set of output glyphs (e.g.@: @option{-Tascii} and @option{-Tlatin1}); for other -devices it is usually sufficient to install proper fonts which contain +devices it is usually sufficient to install proper fonts that contain the necessary glyphs. @pindex freeeuro.pfa @pindex ec.tmac Due to the importance of the Euro glyph in Europe, the groff package now -comes with a @sc{PostScript} font called @file{freeeuro.pfa} which +comes with a @sc{PostScript} font called @file{freeeuro.pfa}, which provides various glyph shapes for the Euro. In other words, @w{latin-9} encoding is supported for the @option{-Tps} device out of the box (@w{latin-2} isn't). @@ -5026,7 +5026,7 @@ command line @option{-mec} is used also to load the file @file{ec.tmac} specify various measurements. Most numeric parameters@footnote{those that specify vertical or horizontal motion or a type size} may have a @dfn{measurement unit} attached. These units are specified as a single -character which immediately follows the number or expression. Each of +character that immediately follows the number or expression. Each of these units are understood, by @code{gtroff}, to be a multiple of its @dfn{basic unit}. So, whenever a different measurement unit is specified @code{gtroff} converts this into its @dfn{basic units}. This @@ -5084,7 +5084,7 @@ Fractions. Value is 65536. The other measurements understood by @code{gtroff} depend on settings currently in effect in @code{gtroff}. These are very useful for -specifying measurements which should look proper with any size of text. +specifying measurements that should look proper with any size of text. @table @code @item m @@ -5145,7 +5145,7 @@ Everything is converted to basic units first. In the above example it is assumed that 1@dmn{i} equals@tie{}240@dmn{u}, and 1@dmn{m} equals@tie{}10@dmn{p} (thus 1@dmn{m} equals@tie{}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 +1680@dmn{u}/66@dmn{u}, which is 25@dmn{u}, and this is approximately 0.1@dmn{i}. As can be seen, a scaling indicator after a closing parenthesis is simply ignored. @@ -5287,7 +5287,7 @@ be expected. @cindex @code{-}, and page motion @cindex motion operators @cindex operators, motion -For many requests which cause a motion on the page, the unary operators +For many requests that cause a motion on the page, the unary operators @samp{+} and @samp{-} work differently if leading an expression. They then indicate a motion relative to the current position (down or up, respectively). @@ -5382,7 +5382,7 @@ And here are the invalid input characters if @code{groff} runs on an Currently, some of these reserved codepoints are used internally, thus making it non-trivial to extend @code{gtroff} to cover Unicode or other -character sets and encodings which use characters of these ranges. +character sets and encodings that use characters of these ranges. Note that invalid characters are removed before parsing; an identifier @code{foo}, followed by an invalid character, followed by @code{bar} is @@ -5402,7 +5402,7 @@ end-list @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 +(@samp{]}) in its name can't be accessed with escape sequences that 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]}. @@ -5506,10 +5506,10 @@ Most documents need more functionality beyond filling, adjusting and implicit line breaking. In order to gain further functionality, @code{gtroff} allows commands to be embedded into the text, in two ways. -The first is a @dfn{request} which takes up an entire line, and does +The first is a @dfn{request} that 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 usually embedded anywhere in +The other is an @dfn{escape} that 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. @@ -5535,7 +5535,7 @@ 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; see @ref{Character Translations}, for details. After this there may be -optional tabs or spaces followed by an identifier which is the name of +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 (@emph{no} tabs here). @@ -5594,7 +5594,7 @@ requests cause a break implicitly; using the single quote control character prevents this. @Defreg {.br} -A read-only number register which is set to@tie{}1 if a macro is called +A read-only number register, which is set to@tie{}1 if a macro is called with the normal control character (as defined with the @code{cc} request), and set to@tie{}0 otherwise. @@ -5639,7 +5639,7 @@ tabs for argument separation -- @code{gtroff} intentionally doesn't support this.} @cindex spaces, in a macro argument -An argument to a macro which is intended to contain spaces can either be +An argument to a macro that is intended to contain spaces can either be enclosed in double quotes, or have the spaces @dfn{escaped} with backslashes. This is @emph{not} true for requests. @@ -5660,13 +5660,13 @@ same effect of calling the @code{uh} macro with one argument, @samp{The Mouse Problem}.@footnote{The last solution, i.e., using escaped spaces, is ``classical'' in the sense that it can be found in most @code{troff} documents. Nevertheless, it is not optimal in all situations, since -@w{@samp{\ }} inserts a fixed-width, non-breaking space character which +@w{@samp{\ }} inserts a fixed-width, non-breaking space character that can't stretch. @code{gtroff} provides a different command @code{\~} to insert a stretchable, non-breaking space.} @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 +A double quote that isn't preceded by a space doesn't start a macro argument. If not closing a string, it is printed literally. For example, @@ -5734,7 +5734,7 @@ Double quotes in the @code{ds} request are handled differently. @cindex macros @code{gtroff} has a @dfn{macro} facility for defining a series of lines -which can be invoked by name. They are called in the same manner as +that can be invoked by name. They are called in the same manner as requests -- arguments also may be passed basically in the same manner. @xref{Writing Macros}, and @ref{Request and Macro Arguments}. @@ -5746,11 +5746,11 @@ requests -- arguments also may be passed basically in the same manner. @cindex escapes Escapes may occur anywhere in the input to @code{gtroff}. They usually -begin with a backslash and are followed by a single character which +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}. -Escape sequences which require an identifier as a parameter accept three +Escape sequences that require an identifier as a parameter accept three possible syntax forms. @itemize @bullet @@ -5797,7 +5797,7 @@ escape expects. Example: @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 +that does not occur in the argument (even a newline or a space character) in the following escapes: @code{\o}, @code{\b}, and @code{\X}. This makes e.g. @@ -6002,7 +6002,7 @@ Test Test @endExample -To avoid this, it is common to start the line with @code{.\"} which +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. @@ -6129,7 +6129,7 @@ For example, the following two lines are equivalent: @endExample Note that the complete transparency of @code{\R} can cause surprising -effects if you use number registers like @code{.k} which get evaluated +effects if you use number registers like @code{.k}, which get evaluated at the time they are accessed. @Example @@ -6157,7 +6157,7 @@ than the line length, and the line gets broken. In the first input line, since the @code{\R} escape leaves no traces, the check for the overfull line hasn't been done yet at the point where @code{\R} gets handled, and you get a value for the @code{.k} number -register which is even greater than the current line length. +register that is even greater than the current line length. In the second input line, the insertion of @code{\h'0'} to emit an invisible zero-width space forces @code{troff} to check the line length, @@ -6453,8 +6453,8 @@ returned. @cindex built-in registers @cindex registers, built-in -The following lists some built-in registers which are not described -elsewhere in this manual. Any register which begins with a @samp{.} is +The following lists some built-in registers that are not described +elsewhere in this manual. Any register that begins with a @samp{.} is read-only. A complete listing of all built-in registers can be found in @ref{Register Index}. @@ -6651,7 +6651,7 @@ number register @code{.T} is set to@tie{}1, and zero otherwise. @item \*[.T] @stindex .T @cindex output device name string register (@code{.T}) -A single read-write string register which contains the current output +A single read-write string register that contains the current output device (for example, @samp{latin1} or @samp{ps}). This is the only string register defined by @code{gtroff}. @end table @@ -6755,7 +6755,7 @@ Adjust text to the right margin, producing ragged-left text. @item c @cindex centered text @cindex @code{ce} request, difference to @samp{.ad@tie{}c} -Center filled text. This is different to the @code{ce} request which +Center filled text. This is different to the @code{ce} request, which only centers text without filling. @item b @@ -6897,7 +6897,7 @@ The request is ignored if there is no parameter. @cindex space, discardable, horizontal @cindex horizontal discardable space Another useful application of the @code{ss} request is to insert -discardable horizontal space, i.e., space which is discarded at a line +discardable horizontal space, i.e., space that is discarded at a line break. For example, paragraph-style footnotes could be separated this way: @@ -6936,12 +6936,12 @@ The following example demonstrates the differences. Here the input: @Example .ll 4i .ce 1000 -This is a small text fragment which shows the differences +This is a small text fragment that 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 +This is a small text fragment that shows the differences between the `.ce' and the `.ad c' request. @endExample @@ -6949,11 +6949,11 @@ between the `.ce' and the `.ad c' request. And here the result: @Example - This is a small text fragment which + This is a small text fragment that shows the differences between the `.ce' and the `.ad c' request. - This is a small text fragment which + This is a small text fragment that shows the differences between the `.ce' and the `.ad c' request. @endExample @@ -6968,7 +6968,7 @@ 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 +text to be centered. This is useful for any request that takes a number of lines as an argument. The @code{.ce} read-only number register contains the number of lines @@ -6996,7 +6996,7 @@ right-justified is associated with the current environment @cindex manipulating hyphenation @cindex hyphenation, manipulating -Here a description of requests which influence hyphenation. +Here a description of requests that influence hyphenation. @DefreqList {hy, [@Var{mode}]} @DefregListEndx {.hy} @@ -7192,9 +7192,9 @@ hyphenation patterns. @code{hpf} or @code{hpfa} then apply the mapping current list of patterns. Its arguments are pairs of character codes -- integers from 0 to@tie{}255. The request maps character code@tie{}@var{a} to code@tie{}@var{b}, code@tie{}@var{c} to -code@tie{}@var{d}, and so on. You can use character codes which would +code@tie{}@var{d}, and so on. You can use character codes that would be invalid otherwise. By default, everything maps to itself except -letters `A' to `Z' which map to `a' to `z'. +letters `A' to `Z', which map to `a' to `z'. @pindex troffrc @@ -7226,10 +7226,10 @@ start-up, groff only assigns hyphenation codes to the letters @samp{a}-@samp{z} (mapped to themselves) and to the letters @samp{A}-@samp{Z} (mapped to @samp{a}-@samp{z}); all other hyphenation codes are set to zero. Normally, hyphenation patterns contain only -lowercase letters which should be applied regardless of case. In +lowercase letters, which should be applied regardless of case. In other words, the words `FOO' and `Foo' should be hyphenated exactly the same way as the word `foo' is hyphenated, and this is what @code{hcode} -is good for. Words which contain other letters won't be hyphenated +is good for. Words that contain other letters won't be hyphenated properly if the corresponding hyphenation patterns actually do contain them. For example, the following @code{hcode} requests are necessary to assign hyphenation codes to the letters @samp{�������} (this is needed @@ -7246,7 +7246,7 @@ Without those assignments, groff treats German words like @w{`Kinderg�rten'} (the plural form of `kindergarten') as two substrings @w{`kinderg'} and @w{`rten'} because the hyphenation code of the umlaut@tie{}a is zero by default. There is a German hyphenation pattern -which covers @w{`kinder'}, so groff finds the hyphenation `kin-der'. +that covers @w{`kinder'}, so groff finds the hyphenation `kin-der'. The other two hyphenation points (`kin-der-g�r-ten') are missed. This request is ignored if it has no parameter. @@ -7500,7 +7500,7 @@ 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 which +when actual text is output or the @code{rs} request is encountered, which ends no-space mode. The read-only number register @code{.ns} is set to@tie{}1 as long as no-space mode is active. @@ -7537,7 +7537,7 @@ This escape is a non-interpreted tab character. In copy mode @DefregListEndx {.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 (overriding +letter @samp{T}) that 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 @@ -7548,7 +7548,7 @@ inch. .ta 1i 2i 3i 4i 5i 6i @endExample -Tab stops can also be specified using a leading @samp{+} which means +Tab stops can also be specified using a leading @samp{+}, 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. @@ -7591,7 +7591,7 @@ Some notes: The default unit of the @code{ta} request is @samp{m}. @item -A tab stop is converted into a non-breakable horizontal movement which +A tab stop is converted into a non-breakable horizontal movement that can be neither stretched nor squeezed. For example, @Example @@ -7601,7 +7601,7 @@ can be neither stretched nor squeezed. For example, @endExample @noindent -creates a single line which is a bit longer than 10@tie{}inches (a +creates a single line, which is a bit longer than 10@tie{}inches (a string is used to show exactly where the tab characters are). Now consider the following: @@ -7618,8 +7618,8 @@ horizontal movements, then splits the line after the second @samp{b} the user wants. @item -Superfluous tabs (i.e., tab characters which do not correspond to a tab -stop) are ignored except the first one which delimits the characters +Superfluous tabs (i.e., tab characters that 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 @@ -7648,7 +7648,7 @@ foo bar foobar @noindent 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 +right-justifies only `foo' because of the additional tab character, which marks the end of the string belonging to the last defined tab stop. @item @@ -7814,7 +7814,7 @@ This produces @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}. +It contains substrings that are separated by @dfn{padding characters}. The width of a field is the distance on the @emph{input} line from the position where the field starts to the next tab stop. A padding character inserts stretchable space similar to @TeX{}'s @code{\hss} @@ -7919,7 +7919,7 @@ the escape mechanism after an @code{eo} request. Note that changing the escape character globally likely breaks 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 +to convert a macro definition into an internal form that is independent of its representation (@TeX{} has this mechanism). If a macro is called, it is executed literally. @endDefreq @@ -7953,7 +7953,7 @@ emitted. @cindex copy-in mode, and @code{\E} @cindex mode, copy-in, and @code{\E} 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 +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 @@ -8138,7 +8138,7 @@ argument do exist. @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 +description files. This has a notable consequence that shows up in warnings like @code{can't find character with input code @var{XXX}} if the @code{tr} request isn't handled properly. @@ -8238,7 +8238,7 @@ 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 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}. +@file{tty.tmac}, which is loaded by the start-up file @code{troffrc}. @endDefreq @xref{Conditionals and Loops}, for more details on built-in conditions. @@ -8253,9 +8253,9 @@ device; the code for switching to nroff mode is in the file @cindex dimensions, line @cindex line dimensions -The following drawing shows the dimensions which @code{gtroff} uses for +The following drawing shows the dimensions that @code{gtroff} uses for placing a line of output onto the page. They are labeled with the -request which manipulates each dimension. +request that manipulates each dimension. @Example -->| in |<-- @@ -8469,7 +8469,7 @@ This is a test. This is a test. @endExample -The main usage of this feature is to define macros which act exactly at +The main usage of this feature is to define macros that act exactly at the place where called. @Example @@ -8513,7 +8513,7 @@ 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 +same line is ignored except @code{\R}, which works as usual. Anything before @code{\c} on the same line is appended to the current partial output line. The next non-command line after an interrupted line counts as a new input line. @@ -8551,7 +8551,7 @@ st. @endExample @end itemize -Note that an intervening control line which causes a break is stronger +Note that an intervening control line that causes a break is stronger than @code{\c}, flushing out the current partial line in the usual way. @cindex interrupted line register (@code{.int}) @@ -8604,7 +8604,7 @@ length to 11@dmn{i}. @cindex headers @cindex footers @cindex titles -@code{gtroff} provides several operations which help in setting up top +@code{gtroff} provides several operations that help in setting up top and bottom titles (or headers and footers). @Defreq {tl, @t{'}@Var{left}@t{'}@Var{center}@t{'}@Var{right}@t{'}} @@ -8769,7 +8769,7 @@ one line only. @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 (or the bottom page boundary if no trap is set), the space -is output immediately (ignoring a partially filled line which stays +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@tie{}1@dmn{v} if no argument is given; the default scaling indicator is @samp{v}. @@ -8842,7 +8842,7 @@ registers. 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 -devices, there is also at least one symbol font which contains various +devices, there is also at least one symbol font that contains various special symbols (Greek, mathematics). @menu @@ -9200,7 +9200,7 @@ that of any currently used position. The @code{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 @code{gtroff} after it has +font, which is used to refer to the font in @code{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. @@ -9257,7 +9257,7 @@ this is font 1 again @cindex ligature A @dfn{glyph} is a graphical representation of a @dfn{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 +glyph is something that 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 @@ -9314,7 +9314,7 @@ If the symbol has been defined with the @code{schar} request, use it. As a last resort, consult all fonts loaded up to now for special fonts and check them, starting with the lowest font number. Note that this can sometimes lead to surprising results since the @code{fonts} line in -the @file{DESC} file often contains empty positions which are filled +the @file{DESC} file often contains empty positions, which are filled later on. For example, consider the following: @Example @@ -9339,12 +9339,12 @@ contains glyph @code{foo} with a special shape fitting to font at font position@tie{}1, and @code{BAZ} at position@tie{}2. We now switch to a new font @code{XXX}, trying to access glyph -@code{foo} which is assumed to be missing. There are neither +@code{foo} that is assumed to be missing. There are neither font-specific special fonts for @code{XXX} nor any other fonts made special with the @code{special} request, so @code{gtroff} starts the search for special fonts in the list of already mounted fonts, with increasing font positions. Consequently, it finds @code{BAZ} before -@code{FOO} even for @code{XXX} which is not the intended behaviour. +@code{FOO} even for @code{XXX}, which is not the intended behaviour. @end itemize @xref{Font Files}, and @ref{Special Fonts}, for more details. @@ -9377,15 +9377,15 @@ groff -Tdvi -mec -man groff_char.7 > groff_char.dvi @cindex adobe glyph list (AGL) @cindex AGL (adobe glyph list) Glyph names not listed in groff_char(7) are derived algorithmically, -using a simplified version of the Adobe Glyph List (AGL) algorithm which +using a simplified version of the Adobe Glyph List (AGL) algorithm, which is described in @uref{http://partners.adobe.com@//public@//developer@//opentype@//index_glyph.html}. -The (frozen) set of glyph names which can't be derived algorithmically +The (frozen) set of glyph names that can't be derived algorithmically is called @dfn{groff glyph list (GGL)}. @itemize @bullet @item -A glyph for Unicode character U+@var{XXXX}[@var{X}[@var{X}]] which is +A glyph for Unicode character U+@var{XXXX}[@var{X}[@var{X}]], which is not a composite character is named @code{u@var{XXXX}@r{[}@var{X}@r{[}@var{X}@r{]]}}. @var{X} must be an uppercase hexadecimal digit. Examples: @code{u1234}, @code{u008E}, @@ -9406,7 +9406,7 @@ A glyph representing more than a single input character is named @noindent Example: @code{u0045_0302_0301}. -For simplicity, all Unicode characters which are composites must be +For simplicity, all Unicode characters that are composites must be decomposed maximally (this is normalization form@tie{}D in the Unicode standard); for example, @code{u00CA_0301} is not a valid glyph name since U+00CA (@sc{latin capital letter e with circumflex}) can be @@ -9417,7 +9417,7 @@ acute}. @item groff maintains a table to decompose all algorithmically derived glyph -names which are composites itself. For example, @code{u0100} (@sc{latin +names that are composites itself. For example, @code{u0100} (@sc{latin letter a with macron}) is automatically decomposed into @code{u0041_0304}. Additionally, a glyph name of the GGL is preferred to an algorithmically derived glyph name; groff also automatically does @@ -9454,11 +9454,11 @@ follows: @itemize @bullet @item -Any component which is found in the GGL is converted to the +Any component that is found in the GGL is converted to the @code{u@var{XXXX}} form. @item -Any component @code{u@var{XXXX}} which is found in the list of +Any component @code{u@var{XXXX}} that is found in the list of decomposable glyphs is decomposed. @item @@ -9478,7 +9478,7 @@ final glyph name would be @code{u0041_02DB}. Note this is not the expected result: The ogonek glyph @samp{ho} is a spacing ogonek, but for a proper composite a non-spacing ogonek (U+0328) is necessary. Looking into the file @file{composite.tmac} one can find @w{@samp{.composite ho -u0328}} which changes the mapping of @samp{ho} while a composite glyph +u0328}}, which changes the mapping of @samp{ho} while a composite glyph name is constructed, causing the final glyph name to be @code{u0041_0328}. @@ -9515,7 +9515,7 @@ This mapping is based on glyph names only; no check for the existence of either glyph is done. A set of default mappings for many accents can be found in the file -@file{composite.tmac} which is loaded at start-up. +@file{composite.tmac}, which is loaded at start-up. @endDefreq @Defesc {\\N, ', n, '} @@ -9662,7 +9662,7 @@ the hyphen in number ranges like `3000-5000', insert into your document. Note, however, that this can lead to bad layout if done without thinking; in most situations, a better solution instead of changing the @code{cflags} value is to insert @code{\:} right after the -hyphen at the places which really need a break point. +hyphen at the places that really need a break point. @item 128 Prohibit a line break before the character, but allow a line break after @@ -9829,7 +9829,7 @@ name. You can also use a special character range notation, consisting of a start character or symbol, followed by @samp{-}, and an end character or symbol. Internally, @code{gtroff} converts these two symbol names to -Unicode values (according to the groff glyph gist) which then give the +Unicode values (according to the groff glyph gist), which then give the start and end value of the range. If that fails, the class definition is skipped. @@ -9894,7 +9894,7 @@ Previous calls to @code{special} or @code{fspecial} are overwritten; without arguments, the particular list of special fonts is set to empty. Special fonts are searched in the order they appear as arguments. -All fonts which appear in a call to @code{special} or @code{fspecial} +All fonts that appear in a call to @code{special} or @code{fspecial} are loaded. @xref{Using Symbols}, for the exact search order of glyphs. @@ -10492,7 +10492,7 @@ Output the current line. @cindex line space, extra post-vertical (@code{\x}) Move the current point vertically by the @dfn{extra post-vertical line space}. This is the maximum value of all @code{\x} escapes with a -positive argument in the line which has just been output. +positive argument in the line that has just been output. @item @cindex post-vertical line spacing @@ -10552,7 +10552,7 @@ post-vertical spacing; it is associated with the current environment @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@tie{}by -default). There is a new scale indicator @samp{z} which has the effect +default). There is a new scale indicator @samp{z}, which has the effect of multiplying by @var{sizescale}. Requests and escape sequences in @code{gtroff} interpret arguments that represent a point size as being in units of scaled points, but they evaluate each such argument using a @@ -10575,7 +10575,7 @@ Similarly it would make no sense to use a scaling indicator other than @samp{z} or @samp{u} in a numeric expression whose default scale indicator was @samp{z}, and so @code{gtroff} disallows this as well. -There is also new scale indicator @samp{s} which multiplies by the +There is also new scale indicator @samp{s}, which multiplies by the 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. @@ -10661,7 +10661,7 @@ simply using an undefined string will cause it to be defined as empty. Define and access a string variable @var{name} (one-character name@tie{}@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 +form using brackets can take arguments that 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 and Macro Arguments}, and @ref{Parameters}. @@ -10677,7 +10677,7 @@ This is \*[foo nice]. 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 +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., string variables can be called within string variables. @@ -10972,7 +10972,7 @@ think of two different pools: one pool for objects (macros, strings, etc.), and another one for names. As soon as an object is defined, @code{gtroff} adds it to the object pool, adds its name to the name pool, and creates a link between them. When @code{als} creates an -alias, it adds a new name to the name pool which gets linked to the same +alias, it adds a new name to the name pool that gets linked to the same object as the old name. Now consider this example. @@ -10996,7 +10996,7 @@ The definition of macro @code{bar} replaces the old object this name is linked to. However, the alias to @code{foo} is still active! In other words, @code{foo} is still linked to the same object as @code{bar}, and the result of calling @code{bar} is an infinite, -recursive loop which finally leads to an error. +recursive loop that finally leads to an error. @cindex alias, string, removing (@code{rm}) @cindex alias, macro, removing (@code{rm}) @@ -11288,7 +11288,7 @@ Some remarks. @itemize @bullet @item The body of a @code{while} request is treated like the body of a -@code{de} request: @code{gtroff} temporarily stores it in a macro which +@code{de} request: @code{gtroff} temporarily stores it in a macro that is deleted after the loop has been exited. It can considerably slow down a macro if the body of the @code{while} request (within the macro) is large. Each time the macro is executed, the @code{while} body is @@ -11309,7 +11309,7 @@ parsed and stored again as a temporary macro. @noindent The traditional and ofter better solution (@acronym{UNIX} @code{troff} doesn't have the @code{while} request) is to use a recursive macro -instead which is parsed only once during its definition. +instead that is parsed only once during its definition. @Example .de yyy @@ -11367,7 +11367,7 @@ restarting the next iteration. @cindex writing macros @cindex macros, writing -A @dfn{macro} is a collection of text and embedded commands which can be +A @dfn{macro} is a collection of text and embedded commands that can be invoked multiple times. Use macros to define common operations. @xref{Strings}, for a (limited) alternative syntax to call macros. @@ -11404,7 +11404,7 @@ you can't use this as the end-of-macro macro: during a macro definition, @samp{..} is never handled as a call to @samp{.}, even if you say @samp{.de foo .} explicitly.} -Here a small example macro called @samp{P} which causes a break and +Here a small example macro called @samp{P} that causes a break and inserts some vertical space. It could be used to separate paragraphs. @Example @@ -11436,7 +11436,7 @@ for executing. @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 +backslash. Had we defined another macro within @code{bar} that takes a parameter, eight backslashes would be necessary before @samp{$1}. The @code{de1} request turns off compatibility mode while executing the @@ -11499,7 +11499,7 @@ Note that macro identifiers are shared with identifiers for strings and diversions. @xref{als,,the description of the @code{als} request}, for possible -pitfalls if redefining a macro which has been aliased. +pitfalls if redefining a macro that has been aliased. @endDefreq @DefreqList {am, name [@Var{end}]} @@ -11794,7 +11794,7 @@ Here a primitive solution for a two-column macro. @Example .pl 1.5i .ll 4i -This is a small test which shows how the +This is a small test that shows how the rt request works in combination with mk. .2c @@ -11807,7 +11807,7 @@ macro. Result: @Example -This is a small test which shows how the +This is a small test that shows how the rt request works in combination with mk. Starting here, isn't robust @@ -11832,7 +11832,7 @@ 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 +example, consider a page bottom trap macro that prints a marker in the margin to indicate continuation of a footnote or something similar. @endDefesc @@ -11927,7 +11927,7 @@ The length of the string `abc' is \w'abc'u. @result{} The length of the string `abc' is 72u. @endExample -Font changes may occur in @var{text} which don't affect current +Font changes may occur in @var{text}, which don't affect current settings. After use, @code{\w} sets several registers: @@ -12068,7 +12068,7 @@ 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 +@samp{|}), which draws back to the beginning of the input line. Default scaling indicator is @samp{m}. @cindex underscore glyph (@code{\[ru]}) @@ -12282,7 +12282,7 @@ text completely. .. @endExample -If you want a filled polygon which has exactly the same size as an +If you want a filled polygon that has exactly the same size as an unfilled one, you must draw both an unfilled and a filled polygon. A filled polygon is always smaller than an unfilled one because the latter uses straight lines with a given line thickness to connect the polygon's @@ -12367,7 +12367,7 @@ Instead, use the @code{eqn} preprocessor. @section Traps @cindex traps -@dfn{Traps} are locations, which, when reached, call a specified macro. +@dfn{Traps} are locations that, 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. @@ -12523,7 +12523,7 @@ 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 +biggest integer that can be represented in @code{groff}) if there are no diversion traps. @endDefreg @@ -12578,7 +12578,7 @@ much sense to use it outside of trap macros. @cindex @code{bp} request, and traps (@code{.pe}) @cindex traps, sprung by @code{bp} request (@code{.pe}) @cindex page ejecting register (@code{.pe}) -A read-only register which is set to@tie{}1 while a page is ejected with +A read-only register that is set to@tie{}1 while a page is ejected with the @code{bp} request (or by the end of input). Outside of traps this register is always zero. In the following @@ -12607,7 +12607,7 @@ Another line. @cindex traps, and diversions An important fact to consider while designing macros is that diversions and traps do not interact normally. For example, if a trap invokes a -header macro (while outputting a diversion) which tries to change the +header macro (while outputting a diversion) that tries to change the font on the current page, the effect is not visible before the diversion has completely been printed (except for input protected with @code{\!} or @code{\?}) since the data in the diversion is already formatted. In @@ -12649,10 +12649,10 @@ The number register @code{.t} still works within diversions. @cindex input line trap, setting (@code{it}) @cindex trap, input line, setting (@code{it}) Set an input line trap. @var{n}@tie{}is the number of lines of input -which may be read before springing the trap, @var{macro} is the macro to +that 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 next +For example, one possible use is to have a macro that prints the next @var{n}@tie{}lines in a bold font. @Example @@ -12705,13 +12705,13 @@ encounters a blank line in the input file. @cindex leading spaces macro (@code{lsm}) Set a leading spaces trap. @code{gtroff} executes @var{macro} when it encounters leading spaces in an input line; the implicit line break -which normally happens in this case is suppressed. A line consisting +that normally happens in this case is suppressed. A line consisting of spaces only, however, is treated as an empty line, possibly subject to an empty line macro set with the @code{blm} request. Leading spaces are removed from the input line before calling the leading spaces macro. The number of removed spaces is stored in -register @code{lsn}; the horizontal space which would be emitted if +register @code{lsn}; the horizontal space that would be emitted if there was no leading space macro is stored in register @code{lss}. Note that @code{lsn} and @code{lss} are available even if no leading space macro has been set. @@ -12724,7 +12724,7 @@ at all. Consider that a line starts with two spaces followed by that groff's current font is properly set to @samp{I}, but the leading space macro only sees @code{foo}, without the preceding @code{\fI}. If the macro should see the font escape you have to `protect' it with -something which creates a token, for example with @code{\&\fIfoo}. +something that creates a token, for example with @code{\&\fIfoo}. @endDefreq @c --------------------------------------------------------------------- @@ -12775,7 +12775,7 @@ page, which in turn makes @code{troff} exit immediately for the reasons just described. In most situations this is not intended. To always force processing the whole end macro independently of this -behaviour it is thus advisable to insert something which starts an +behaviour it is thus advisable to insert something that starts an empty partially filled line (@code{\c}) whenever there is a chance that a page break can happen. In the above example, the call of the @code{ne} request assures that the remaining code stays on the same @@ -12976,7 +12976,7 @@ After completing a diversion, the read-write number registers @code{dn} and @code{dl} contain the vertical and horizontal size of the diversion. Note that only the just processed lines are counted: For the computation of @code{dn} and @code{dl}, the requests @code{da} and @code{boxa} are -handled as if @code{di} and @code{box} had been used -- lines which have +handled as if @code{di} and @code{box} had been used -- lines that have been already stored in a macro are not taken into account. @Example @@ -13025,7 +13025,7 @@ been already stored in a macro are not taken into account. Prevent requests, macros, and escapes from being interpreted when read into a diversion. Both escapes take the given text and @dfn{transparently} embed it into the diversion. This is useful for -macros which shouldn't be invoked until the diverted text is actually +macros that shouldn't be invoked until the diverted text is actually output. The @code{\!} escape transparently embeds text up to and including the @@ -13074,7 +13074,7 @@ Both escapes read the data in copy mode. @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 +be used for example to control a postprocessor that processes the data before it is sent to the device driver. @cindex @code{\?}, in top-level diversion @@ -13101,7 +13101,7 @@ 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 +postprocessor that does something with the output before sending it to the output device, filtering out @var{string} again. @endDefreq @@ -13326,7 +13326,7 @@ level. @code{\O0} and @code{\O1} also reset the four registers @samp{opminx}, @samp{opminy}, @samp{opmaxx}, and @samp{opmaxy} to @minus{}1. @xref{Register Index}. These four registers mark the top left and -bottom right hand corners of a box which encompasses all written glyphs. +bottom right hand corners of a box that encompasses all written glyphs. For example the input text: @@ -13409,7 +13409,7 @@ 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@tie{}@code{f} has been introduced which +A new scaling indicator@tie{}@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@tie{}1 (1f equals 65536u). Example: @@ -13672,7 +13672,7 @@ Body of letter. 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 +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 @@ -13751,7 +13751,7 @@ 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 +print out the @code{nr} requests that set the number registers @code{H}, @code{M}, and @code{S}, and then reads those commands in with the @code{so} request. @@ -13868,7 +13868,7 @@ copy-in mode. @cindex postprocessor access @cindex access of postprocessor -There are two escapes which give information directly to the +There are two escapes that give information directly to the postprocessor. This is particularly useful for embedding @sc{PostScript} into the final document. @@ -13888,7 +13888,7 @@ Embeds its argument into the @code{gtroff} output preceded with @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 +space characters. All other escapes (except @code{\\}, which produces a backslash) cause an error. @cindex @code{device} request, and copy-in mode @@ -13932,7 +13932,7 @@ Control Commands}). @node Miscellaneous, Gtroff Internals, Postprocessor Access, gtroff Reference @section Miscellaneous -This section documents parts of @code{gtroff} which cannot (yet) be +This section documents parts of @code{gtroff} that cannot (yet) be categorized elsewhere in this manual. @Defreq {nm, [@Var{start} [@Var{inc} [@Var{space} [@Var{indent}]]]]} @@ -13941,7 +13941,7 @@ categorized elsewhere in this manual. @cindex numbers, line, printing (@code{nm}) Print line numbers. @var{start} is the line number of the @emph{next} output line. @var{inc} indicates which line numbers are printed. For -example, the value@tie{}5 means to emit only line numbers which are +example, the value@tie{}5 means to emit only line numbers that are multiples of@tie{}5; this defaults to@tie{}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, @@ -13954,7 +13954,7 @@ 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 +request), line numbers that 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 @@ -14116,7 +14116,7 @@ The search path for @var{filename} can be controlled with the @code{gtroff} processes input in three steps. One or more input 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 +@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. @@ -14133,13 +14133,13 @@ token @samp{:u} (representing u@tie{}umlaut). Later on, the character tokens @samp{f} and @samp{i} are merged to a single output node 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 +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 of +list of input tokens that have been passed unprocessed, and a list of output nodes. Consider the following the diversion. @Example @@ -14173,9 +14173,9 @@ It contains these elements. Elements 1, 7, and@tie{}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{\x}. The @code{br} request finishes the -current partial line, inserting a newline input token which is +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 +that the word space node has a fixed width that isn't stretchable anymore. To convert horizontal space nodes back to input tokens, use the @code{unformat} request. @@ -14202,7 +14202,7 @@ available by default, so we provide a substitution using the @noindent Now let us assume that we install an additional special font @samp{bar} -which has glyph @samp{foo}. +that has glyph @samp{foo}. @Example .special bar @@ -14266,7 +14266,7 @@ of the @emph{next} line. Without argument, the request is ignored. -This is a debugging aid for documents which are split into many files, +This is a debugging aid for documents that are split into many files, then put together with @code{soelim} and other preprocessors. Usually, it isn't invoked manually. @@ -14505,7 +14505,7 @@ Invalid numeric expressions. This is enabled by default. @itemx 4 @cindex fill mode @cindex mode, fill -In fill mode, lines which could not be broken so that their length was +In fill mode, lines that could not be broken so that their length was less than the line length. This is enabled by default. @item delim @@ -14635,7 +14635,7 @@ All warnings. @cindex compatibility mode @cindex mode, compatibility -GNU @code{troff} has a number of features which cause incompatibilities +GNU @code{troff} has a number of features that cause incompatibilities with documents written with old versions of @code{troff}. @cindex long names @@ -14813,7 +14813,7 @@ 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}.@footnote{To be completely independent of the current -escape character, use @code{\(rs} which represents a reverse solidus +escape character, use @code{\(rs}, which represents a reverse solidus (backslash) glyph.} To store, for some reason, an escape sequence in a diversion that is interpreted when the diversion is reread, either use the traditional @code{\!} transparent output facility, or, if this is @@ -15162,7 +15162,7 @@ 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 +a pager program like @code{less} that translates this into ISO@tie{}6429 SGR sequences to control terminals. @@ -15259,7 +15259,7 @@ places a rectangle of the specified @var{width} containing the coordinates) at the insertion point. If @var{height} is not specified, the embedded drawing is scaled proportionally. -@xref{Miscellaneous}, for the @code{psbb} request which automatically +@xref{Miscellaneous}, for the @code{psbb} request, which automatically generates the bounding box. This escape sequence is used internally by the macro @code{PSPIC} @@ -15293,7 +15293,7 @@ options: @table @option @item -d -Produce uncompressed PDFs which include debugging comments. +Produce uncompressed PDFs that include debugging comments. @item -e This forces @code{gropdf} to embed all used fonts in the PDF, @@ -15326,7 +15326,7 @@ line if it is included, but works anyway. @item -u@var{filename} @code{gropdf} normally includes a ToUnicode CMap with any font created using @file{text.enc} as the encoding file, this makes it easier to -search for words which contain ligatures. You can include your own CMap +search for words that contain ligatures. You can include your own CMap by specifying a @var{filename} or have no CMap at all by omitting the @var{filename}. @end table @@ -16629,7 +16629,7 @@ called@tie{}@file{@var{f}}. @pindex DESC@r{ file format} 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 +for the @code{charset} keyword, which must comes last (if at all), the order of the lines is not important. Later entries in the file, however, override previous values. @@ -16688,7 +16688,7 @@ the first line and tests for the above paper sizes. Finally, 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. +that 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. @@ -16763,7 +16763,7 @@ intermediate output commands. @item unicode @kindex unicode Indicate that the output device supports the complete Unicode -repertoire. Useful only for devices which produce @emph{character +repertoire. Useful only for devices that produce @emph{character entities} instead of glyphs. If @code{unicode} is present, no @code{charset} section is required in @@ -16806,7 +16806,7 @@ in the @file{DESC} file. @kindex spare1 @kindex spare2 @kindex biggestfont -Here a list of obsolete keywords which are recognized by @code{groff} +Here a list of obsolete keywords that are recognized by @code{groff} but completely ignored: @code{spare1}, @code{spare2}, @code{biggestfont}. @@ -16862,7 +16862,7 @@ file. @cindex comments in font files @cindex font files, comments @kindex # -The first section can contain comments which start with the @samp{#} +The first section can contain comments, which start with the @samp{#} character and extend to the end of a line. The second section contains one or two subsections. It must contain a @@ -16901,7 +16901,7 @@ 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{\[-]}. +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 @@ -16911,7 +16911,7 @@ the single input character whose code is@tie{}@var{n}. For example, which is the pounds sterling sign in the ISO@tie{}@w{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 +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; @@ -16931,7 +16931,7 @@ the glyph has an ascender, for example, @samp{b}; 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 +The @var{code} field gives the code that the postprocessor uses to 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 @@ -16940,7 +16940,7 @@ Note, however, that the @code{\N} escape sequence only accepts a decimal integer. The @var{entity-name} field gives an @acronym{ASCII} string identifying -the glyph which the postprocessor uses to print the @code{gtroff} glyph +the glyph that the postprocessor uses to print the @code{gtroff} glyph @var{name}. This field is optional and has been introduced so that the @code{grohtml} device driver can encode its character set. For example, the glyph @samp{\[Po]} is represented as @samp{£} in _______________________________________________ Groff-commit mailing list Groff-commit@gnu.org https://lists.gnu.org/mailman/listinfo/groff-commit