summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc/groff.texi: Revise discussion of `ce` request.HEADmasterG. Branden Robinson2023-05-171-12/+9
| | | | Also adjust dead-tree pagination.
* doc/groff.texi: Clarify discussion of `ec` & `eo`.G. Branden Robinson2023-05-171-22/+22
| | | | Also shift some forward references into footnotes.
* [ms]: Fix content nits in documentation.G. Branden Robinson2023-05-142-12/+22
| | | | | * Explicitly tell the reader how to end section heading text. * Describe the handling of display distance in more detail.
* doc/ms.ms: Work around Savannah #64005.G. Branden Robinson2023-05-131-0/+2
|
* 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-131-15/+14
| | | | | | | | * 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.
* 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.
* 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.
* 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-061-48/+52
|
* groff(1): Tighten wording.G. Branden Robinson2023-05-051-0/+1
|
* 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-041-6/+6
| | | | 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-042-9/+10
| | | | Also slightly recast in places for better style.
* [docs]: Fix content and style nits.G. Branden Robinson2023-05-041-67/+64
| | | | | | | | | | | | | | | | | | * 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.
* [docs]: Revise discussion of debugging.G. Branden Robinson2023-05-011-13/+15
| | | | | | | | | * 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.
* doc/groff.texi: Update re: encodings, Euro glyph.G. Branden Robinson2023-04-251-17/+15
| | | | | | The Euro glyph is important beyond Europe. Tighten wording.
* [docs]: Reduce use of term "entity".G. Branden Robinson2023-04-241-42/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-241-34/+34
| | | | | | | | | | * 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-241-4/+4
| | | | | | | | | | | | | (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.
* 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
|
* [docs]: Fix content and style nits.G. Branden Robinson2023-04-211-12/+14
| | | | | | | | 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).
* [docs]: Minimally document `tag`, `taga` requests.G. Branden Robinson2023-04-141-0/+5
| | | | | | | | | | | | | | | | | | | * doc/groff.texi (Postprocessor Access): * man/groff.7 (Request short reference): Do it. Fixes <https://savannah.gnu.org/bugs/?62695>. I don't know if we need to keep these. They do much the same thing as `device`, and are implemented nearly identically to each other. They have only one user, the also undocumented "devtag.tmac". One difference is that the `device` request constructs a "macro" (internally to GNU troff), and `tag{,a}` construct strings (from groff's string class, not the C++ standard library's). Possibly the type used for storage of the node contents is intended to address some of the same problems we've seen crop up in issues like Savannah #63074.
* [docs]: Fix typo.G. Branden Robinson2023-04-142-2/+2
|
* doc/ms.ms: Use `bp` requests better.G. Branden Robinson2023-04-091-8/+32
| | | | When forcing a page break to start a new section, break the line first.
* [docs]: Update discussion of ms page titles.G. Branden Robinson2023-04-092-10/+18
| | | | | * Mention the special behavior of the % character in titles. * Characterize traps as a formatter feature.
* doc/groff.texi: Fix misplaced punctuation.G. Branden Robinson2023-04-091-1/+1
|
* [docs]: Cross reference copy mode consistently.G. Branden Robinson2023-04-091-21/+24
| | | | ...but drop one cross reference that is already quite close to another.
* [docs]: Clarify interactions with aliased names.G. Branden Robinson2023-04-091-26/+33
|
* doc/groff.texi (Input Encodings): Tighten wording.G. Branden Robinson2023-04-011-2/+6
| | | | Also annotate a future direction for development of this document.
* doc/groff.texi (Requests and Macros): Clarify.G. Branden Robinson2023-04-011-4/+4
|
* [docs]: Revise localization discussion.G. Branden Robinson2023-04-011-9/+4
| | | | | | | | | | | | | | | | | | * doc/groff.texi: Drop staleness-prone material about localization setup and specific languages supported; replace with cross reference to groff_tmac(5). This material also doesn't document the formatter per se, and so is inappropriate for the "GNU troff reference" chapter. * man/groff_tmac.5.man (Localization files): Add introductory sentence summarizing their purpose. Add advice regarding the order of their loading; thanks to Nikita Ivanov for reporting this omission. * man/groff_tmac.5.man (Localization files): * man/groff.7.man (Localization): Improve robustness to future development by reorganizing and dropping version number references. In both documents, refer to "localization files" rather than "localization packages".
* [docs]: Fix Savannah #63812.G. Branden Robinson2023-03-221-0/+11
| | | | | | | | | | | * doc/groff.texi (Operators in Conditionals): * man/groff.7.in (Conditional expressions): Clarify how the output comparison operator is recognized. Fixes <https://savannah.gnu.org/bugs/?63812>. Thanks to John Gardner for the report. ANNOUNCE: Update bug counts.
* doc/groff.texi: Recast example.G. Branden Robinson2023-03-221-3/+3
|
* doc/groff.texi: Add forward reference.G. Branden Robinson2023-03-221-3/+4
|
* doc/groff.texi: Compactify some examples.G. Branden Robinson2023-03-221-8/+4
| | | | I need some vees to address Savannah #63812.
* doc/webpage.ms: Fix stale date.G. Branden Robinson2023-03-041-1/+1
| | | | Savannah #57855 pinches.
* doc/groff.texi: Shorten a node name.G. Branden Robinson2023-02-231-2/+2
| | | | | | | These can get too garrulous for GNU tar. tar: groff-1.23.0.rc3.27-41845/doc/groff.html.node/Unix-Version-7-ms-Macros-Not-Implemented-by-groff-ms.html: file name is too long (max 99); not dumped tar: Exiting with failure status due to previous errors
* [doc]: Uninstall groff Texinfo in HTML better.G. Branden Robinson2023-02-221-1/+2
| | | | | | | * Makefile.am (uninstall_groffdirs): Remove "html.mono" and "html.node" directories corresponding to HTML version of our Texinfo manual. * doc/doc.am (uninstall-html): Uninstall HTML version of our Texinfo manual more reliably.
* [doc]: Handle Texinfo output formats consistently.G. Branden Robinson2023-02-221-2/+12
| | | | | | | | | | | | | | | | | | | | [doc]: Handle output formats of our Texinfo manual more consistently. * doc/doc.am (install-doc): Add dependency on (Automake standard) target 'install-dvi'. (maintainer-clean-local): Remove our Texinfo manual in plain text format. (install-data-local): Add dependency on new target 'install-txt'. (install-txt): Install our Texinfo manual in plain text format. (uninstall-local): Add dependency on new target 'uninstall-txt'. (uninstall-txt): Uninstall our Texinfo manual in plain text format. Thanks to T. Kurt Bond for noticing the discrepancy.
* doc/doc.am: Fix install-{pdf,html}-local targets.G. Branden Robinson2023-02-221-3/+3
| | | | | | | | * doc/doc.am (install-pdf-local, install-html-local): Enable rules to work in out-of-tree builds. These rules aren't made by default (and so weren't causing failures); that's a separate issue.
* doc/doc.am: Drop redundant dependency.G. Branden Robinson2023-02-221-1/+1
| | | | | | * doc/doc.am (uninstall-hook): Drop dependency on "uninstall_mom"; this is not the appropriate place to declare it, and "uninstall_groffdirs" already depends on it in mom's Automake file.
* doc/meintro_fr.me.in: Translate English text.Thomas Dupond2023-02-221-7/+5
|
* doc/groff.texi: Drop redundant sentence.G. Branden Robinson2023-02-221-2/+1
| | | | Thanks to Dave Kemper for spotting this.
View Lorry Controller Status