summaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* doc/meref.me.in: Fix content nit.G. Branden Robinson2023-05-131-1/+1
| | | | | | It's the placement, not the spacing, of headers and footers that the `hm`, `fm`, `tm`, and `bm` registers control. A reader might interpret "spacing" as "vertical spacing".
* [docs]: Update discussion of `ss` request.G. Branden Robinson2023-05-133-19/+27
| | | | | | | | * doc/groff.texi (Manipulating Filling and Adjustment): Recast. Tighten wording. Document conventional space width. Fully discuss inter-sentence spacing behavior before documenting registers. * man/groff_diff.7 (Extended requests): Sync with the foregoing. * man/groff.7 (Read-only registers): Use less cramped English.
* groff(7): Fix missing comma.G. Branden Robinson2023-05-131-1/+3
|
* roff(7): Fix content, style, and markup nits.G. Branden Robinson2023-05-131-124/+114
| | | | | | | | | | | | | | | | | | | | | | | | | Content: * Present concepts of font families, styles, and what makes special fonts special. * Reform terminology: migrate to "page description language" from "device-independent output format" and "intermediate output". * Elaborate on preprocessors' frequent use of their own languages. * Drop redundant sentence about "tmac files". * Add cross reference to groff_tmac(5) page when discussing availability of macro packages. Style: * Put vertical space before list of (relatively) well-known preprocessors that groff doesn't provide. * Stop hyphenating adverbially enhanced attributive phrase. * Tighten wording. * Generally recast, particularly material I hadn't already edited. Markup: * Use `\|` more aggressively to improve kerning (avoid glyph crowding) when changing styles. * Ensure that the example won't break in a confusing place. * Bump copyright range.
* doc/ms.ms: Set example comments in (Times) italic.G. Branden Robinson2023-05-131-3/+5
| | | | This makes it clearer to the novice that they need not be typed.
* groff_out(5): Fix content, style, and markup nits.G. Branden Robinson2023-05-081-17/+23
| | | | | | | | | | | | | | | | Content: * Say "break" instead of "line break". * Say "GNU troff" instead of "groff" where we are specifically describing the formatter's behavior. * Clarify that "w" command applies only to "normal" inter-word spaces. Style: * Simplify internal cross references to other commands. * Clarify contextuality of positioning, writing, and drawing commands. Markup: * Drop unnecessary macro agument quotation. * Fix missing input line break after macro call.
* doc/groff.texi: Further revise .sp, \x, \n[.a].G. Branden Robinson2023-05-071-46/+52
| | | | | | | | | | | | | * Shift example of `sp` interaction with traps to follow initial presentation of request. * Revise examples for clarity. Add comments to explain requests not yet formally introduced. * Clarify separateness of extra pre- and post-vertical line spacing. * More explicitly motivate why we don't have a "most recent extra pre-vertical line spacing" register. * Add forward cross reference to "Drawing Requests" node, since the bracket-building escape sequence has not yet been introduced. * Tighten wording.
* [man pages]: Revise some syntax synopses.G. Branden Robinson2023-05-066-6/+6
| | | | | | | | | | | | | Use ellipsis more idiomatically, favoring it over plurals, and including it within instead of outside option brackets for clarity. The construction: foo bar [baz] ... is ambiguous. If I specify no "baz", can "bar"s be repeated? Also say "argument" when we mean an option OR an operand.
* doc/groff.texi: Fix markup nit.G. Branden Robinson2023-05-061-6/+0
| | | | | | Delete some Texinfo @codequote* commands, thus marking the "Tabs and Fields", "Leaders", and "Fields" nodes as reviewed for ` and ' glyph usage in examples.
* doc/groff.texi: Revise vertical spacing material.G. Branden Robinson2023-05-061-87/+84
| | | | | | | | | | | | | | | | | | | | * Document text baseline location as a property of the output line. * Recast description of `sp` request entirely, describing more aspects of its behavior. Add forward cross references to implicated topics. Drop some material about trap interaction spread amid examples since we now handle that both earlier, in the initial presentation, and later, via cross references to the presentation of vertical position traps. * Recast description of `ls` request and `.L` register. * Recast description of `\x` escape sequence and `.a` register. Preview the terminology that occurs again later when the `vs` and `pvs` requests are presented. Say more to motivate the existence of these features. * Recast description of `ns` and `rs` requests and `.ns` register. * Shift Texinfo @codequote* commands, marking the section/node "Manipulating Spacing" as reviewed for ` and ' glyph usage in examples. Thanks to Dave Kemper for compelling me to review this subject.
* [docs]: Update macro, font description dir stuff.G. Branden Robinson2023-05-062-50/+56
|
* gropdf(1): Add "Macros" subsection with `pdfinfo`.G. Branden Robinson2023-05-061-0/+32
|
* gropdf(1): Fix more content/style/markup nits.G. Branden Robinson2023-05-061-38/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Content: * More carefully distinguish escape sequences from device control commands; the former are more general. * The *roff `\X` escape sequence is a device control command, not a "special". *roff already freights the latter term with enough meaning without hauling in TeX's use for it. * The "ps:" or "pdf:" part of a device control command escape sequence parameter is the "tag", not the entire parameter. It is a name spacing convention. * Clarify operation of `xrev` device control command. Style: * Recast: all device control commands are "extensions"; there is no standard set. * Convert mentions of (g)pic(1) and grops(1) to man page cross references. * Set pic(1) command names in bold, not italics. * Set "mom" macro package name in italics, not bold. * Set "gropdf" in italics, not bold. * Capitalize "PDF" in prose. * Protect Perl's "localtime" function name from hyphenation. * Hyphenate adjectival phrases. * Hyphenate metasyntactic variable consistently with its introduction. * Otherwise recast for (attempted) clarity and concision. Markup: * Use two empty requests where vertical space is expected. * Annotate a mismatch in conventions between grotty(1) and gropdf(1).
* gropdf(1): Fix content, style, and markup nits.G. Branden Robinson2023-05-051-38/+65
| | | | | | | | | | | | | | | | | | | | | | | Content: * Introduce the concept of convenience macros earlier, then rely on it. * Align terminology regarding page location traps with the rest of groff's documentation. * Align header/footer terminology with the rest of groff's documentation. Style: * Tighten wording. * Set macro call literals in bold. * Use imperative voice more when describing device control commands. * Present convenience macros _after_ full discussion of device control command behavior, not in the midst of it. * Coalesce some single-sentence paragraphs into their predecessors. Markup: * Set file names in italics. * Protect macro call literals from hyphenation. * Use an empty request between sentences. * Use two empty requests where vertical space is expected.
* gropdf(1): Add gpresent link and description.G. Branden Robinson2023-05-051-0/+13
| | | | | The page references it several times; we should explain what it is and link to it.
* groff_out(5): Edit "Simple commands" subsection.G. Branden Robinson2023-05-051-112/+111
|
* gropdf(1): Fix pagination nit.G. Branden Robinson2023-05-051-2/+0
| | | | | Drop a paragraph break after a very short paragraph to buy a vee and fix an orphaned line on U.S. letter paper.
* gropdf(1), pdfmom(1): Update authorship credits.G. Branden Robinson2023-05-052-1/+13
|
* [man pages]: Adjust dead-tree pagination.G. Branden Robinson2023-05-056-2/+14
| | | | Also drop an unnecessary paragraph break in glilypond(1).
* groff(1): Tighten wording.G. Branden Robinson2023-05-052-3/+2
|
* doc/groff.texi: Resequence built-in register list.G. Branden Robinson2023-05-041-70/+73
| | | | ...to put it in (mostly) lexicographic order.
* doc/groff.texi: Clarify register removal/renaming.G. Branden Robinson2023-05-041-2/+17
| | | | | | | | | * Explicitly state that register renaming doesn't affect read-only state or other special properties. * Add cautionary note above removing built-in registers. * Document difference from AT&T troff, which ignored attempts to remove read-only (but not writable built-in) registers. * Consistently use Texinfo @: command after prose colons.
* [docs]: Tighten wording.G. Branden Robinson2023-05-042-10/+10
| | | | This recovers good page breaks in roff(7).
* doc/ms.ms: Fix markup nits.G. Branden Robinson2023-05-041-3/+3
|
* [ms]: Align documentation.G. Branden Robinson2023-05-043-16/+20
| | | | Also slightly recast in places for better style.
* [docs]: Fix content and style nits.G. Branden Robinson2023-05-042-113/+158
| | | | | | | | | | | | | | | | | | * Recast description of `bd`, `backtrace`, and `lf` requests. * Explicitly associate `bd` request with `.b` register. * Introduce metasyntactic variable `message` for use with `ab` and `tm`-family requests, since it is interpreted differenly from the `contents` argument of string assignment and appendment requests. Document that special character escape sequences in a `message` are not interpreted. * Clarify that groff_diff(7) details only GNU troff extensions. * Set default argument assumed by `af` request in bold. * Document behavior of `ce` and `rj` requests when used with negative agument. * Fully discuss `ce`, `cf`, and `trf`'s interfaces before presenting examples. * Use "file" instead of "filename" as metasyntactic variable name with requests.
* groff(7): Clarify behavior of `lf` request.G. Branden Robinson2023-05-041-3/+3
| | | | | | It applies to the _next_ input line not the current one. (This differs from AT&T troff and is documented as such in groff_diff(7) and our Texinfo manual.)
* groff(7): Drop unnecessary language.G. Branden Robinson2023-05-041-6/+1
| | | | | | | It tried to be helpful, but risked the reader inferring too much, i.e., can you _not_ test non-Boolean-valued registers with control flow requests? (You can.) The preceding sections "Numeric expressions" and "Conditional expressions" provide the necessary foundation.
* groff(7): Summarize ligature modes.G. Branden Robinson2023-05-041-1/+7
|
* groff(7): Fix error; ligature mode is not Boolean.G. Branden Robinson2023-05-041-3/+3
|
* groff(1), troff(1): Document operand handling.G. Branden Robinson2023-05-042-1/+23
|
* man/groff.7.man: Update request short reference.G. Branden Robinson2023-05-011-16/+24
| | | | | | | * Add more cross references to related requests as registers. * Recast descriptions of Boolean-valued registers for consistency. * Clarify behavior of `.z` register when in top-level diversion, a term that once was not defined in this man page but now is.
* [docs]: Revise discussion of debugging.G. Branden Robinson2023-05-012-30/+24
| | | | | | | | | * Describe backtracing less circularly. * Use active voice more. * Drop this section's introductory paragraph from groff(7), which doesn't require it, being more of a reference. * Wrap long input line. * Bump document date.
* NEWS: Fix thinko.G. Branden Robinson2023-04-301-1/+1
|
* NEWS: Clarify item.G. Branden Robinson2023-04-281-2/+3
|
* groff_tmac(5): Drop unnecessary macro call.G. Branden Robinson2023-04-261-1/+0
| | | | Thanks to Alex Colomar (and mandoc(1)) for pointing it out.
* doc/groff.texi: Update re: encodings, Euro glyph.G. Branden Robinson2023-04-251-17/+15
| | | | | | The Euro glyph is important beyond Europe. Tighten wording.
* src/roff/troff/TODO: Remove implemented item.G. Branden Robinson2023-04-251-2/+0
| | | | Implemented in commit 41d05cbfac, 4 July 2019.
* ANNOUNCE: Reflect Savannah #64091 fix.G. Branden Robinson2023-04-251-3/+3
|
* [docs]: Reduce use of term "entity".G. Branden Robinson2023-04-244-99/+116
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Doug McIlroy noted this vague term, which groff employs for multiple purposes. Eliminate its application to input processing. There is now no longer such a thing as an "entity" in the groff language. * doc/groff.texi (Character Translations): Do it. Also clarify "nothing" as "the dummy character". (Using Symbols): Do it. Also recast explanation of difference between characters and glyphs. Explicitly state that spaces aren't glyphs. Document that `rchar` request can't remove definitions supplied by font description files. (Ligatures and Kerning): Speak of "special characters", not "entities". (Other Differences): Recast discussion of character-to-glyph transformation. Stop qualifying characters as "input". Recast discussion of example. * font/devutf8/NOTES: Revise use of terminology. Perform a Kemper notectomy. Wrap long lines. * man/groff.7.man (Request short reference) <char>: Speak of a "special character", not an "entity". <rchar>: Document that request can't remove definitions supplied by font description files. * man/groff_diff.7.man (Implementation differences): Sync with our Texinfo manual. The use of "entity" to describe how a glyph gets mapped back to a character (sequence) for the HTML and terminal output devices is retained. That usage is restricted to discussion of output drivers (code comments and function names notwithstanding).
* doc/groff.texi: Use idiomatic Texinfo notation.G. Branden Robinson2023-04-241-21/+26
| | | | Use "@code{\@key{RET}}" and "@code{\@key{SP}}" consistently.
* doc/groff.texi: Drop old cautionary note.G. Branden Robinson2023-04-241-30/+0
| | | | | | | | | | | | | This material dates to commit 21260e1cd2, 7 June 2002. Anyone using .tr éÉ back then, or, since December 2005 when preconv(1) became available, using that, must have long since migrated. Also this passage is getting in the way of my terminological reforms. Entities begone!
* [docs]: Tweak escape/control character discussion.G. Branden Robinson2023-04-242-64/+67
| | | | | | | | | | * Introduce term "ordinary character", an input character that is not invalid (cf. "special character"). * Recast discussion of control, no-break control, and escape control characters in terms of ordinary characters, ruling out the surmise that a special character can serve as any of these. * Parallelize wording of these. * Tighten and align wording with this terminology.
* [docs]: Further clarify end-of-sentence detection.G. Branden Robinson2023-04-243-6/+17
| | | | | | | | | | | | | (One hopes.) * doc/groff.texi (Sentences): * man/roff.7 (Concepts): Do it. Fixes <https://savannah.gnu.org/bugs/?64091>. Thanks to Ingo Schwarze and Dave Kemper for the report. Also fix whitespace nit. Thanks to Dave Kemper, he of the unflinching osprey gaze.
* PROBLEMS: Update expected diagnostic text.G. Branden Robinson2023-04-241-6/+3
| | | | Thanks to Dave Kemper for catching this.
* doc/groff.texi: Fix content and style nits.G. Branden Robinson2023-04-211-36/+36
| | | | | | | | | | | | | | | * Qualify claim that text lines produce output--they don't (right away) if they're diverted. * Fix copy-and-paste goof in description of `rj` request. * Use Texinfo @key command to mark keyboard control character input. * Refer to enablement _status_ as a Boolean value. * Prefer "non-positive" over "nonpositive". * Use Texinfo @: command after prose colons, for consistency with the rest of this document. * Drop unnecessary commas. * Drop empty requests in an example where we desperately need the vees. * Use active voice more, and otherwise tighten wording to buy vees and improve page layout.
* doc/groff.texi: Clarify `ss` request, hyphenation.G. Branden Robinson2023-04-211-10/+13
|
* groff_man*(7): Tighten wording.G. Branden Robinson2023-04-211-3/+2
|
* [docs]: Fix content and style nits.G. Branden Robinson2023-04-212-17/+20
| | | | | | | | Discuss alignment, adjustment, and margins more carefully. Adjustment doesn't spread output lines to "both margins" if the indentation is nonzero. Describe the adjustment process explicitly. Add emphasis distinguishing `.ce` from `.ad c`. Drop terms "ragged-left" and "ragged-right" from running text (but keep their concept index entries).
* groff_mm(7): Drop garbage.G. Branden Robinson2023-04-211-2/+0
|