summaryrefslogtreecommitdiff
path: root/man
Commit message (Collapse)AuthorAgeFilesLines
* groff_diff(7): Fix missing punctuation.G. Branden Robinson2023-05-171-1/+1
|
* [docs]: Update discussion of `ss` request.G. Branden Robinson2023-05-132-4/+13
| | | | | | | | * 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.
* 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.
* [man pages]: Revise some syntax synopses.G. Branden Robinson2023-05-061-1/+1
| | | | | | | | | | | | | 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.
* [docs]: Update macro, font description dir stuff.G. Branden Robinson2023-05-061-2/+4
|
* groff_out(5): Edit "Simple commands" subsection.G. Branden Robinson2023-05-051-112/+111
|
* [man pages]: Adjust dead-tree pagination.G. Branden Robinson2023-05-051-0/+2
| | | | Also drop an unnecessary paragraph break in glilypond(1).
* [docs]: Tighten wording.G. Branden Robinson2023-05-041-4/+4
| | | | This recovers good page breaks in roff(7).
* [docs]: Fix content and style nits.G. Branden Robinson2023-05-041-46/+94
| | | | | | | | | | | | | | | | | | * 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
|
* 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-011-17/+9
| | | | | | | | | * 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.
* 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.
* [docs]: Reduce use of term "entity".G. Branden Robinson2023-04-242-40/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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).
* [docs]: Tweak escape/control character discussion.G. Branden Robinson2023-04-241-30/+33
| | | | | | | | | | * 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-2/+3
| | | | | | | | | | | | | (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.
* [docs]: Fix content and style nits.G. Branden Robinson2023-04-211-5/+6
| | | | | | | | 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(7): Fix missing word.G. Branden Robinson2023-04-161-1/+2
|
* [docs]: Minimally document `tag`, `taga` requests.G. Branden Robinson2023-04-141-0/+7
| | | | | | | | | | | | | | | | | | | * 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.
* groff(7): Fix content and markup nits.G. Branden Robinson2023-04-141-1/+1
| | | | Use correct metasyntactic variable name. Use font alternation macro.
* [docs]: Cross reference copy mode consistently.G. Branden Robinson2023-04-091-2/+6
| | | | ...but drop one cross reference that is already quite close to another.
* [docs]: Clarify interactions with aliased names.G. Branden Robinson2023-04-092-15/+53
|
* groff(7): Fix comma splice.G. Branden Robinson2023-04-091-1/+1
|
* groff(7): Tighten wording.G. Branden Robinson2023-04-091-1/+1
| | | | Fix orphaned partial word and buy a vee for a forthcoming commit.
* groff(7): Add "Punning names" section.G. Branden Robinson2023-04-091-25/+27
| | | | We have a "Diversions" section for it to follow now.
* groff(7): Fix internal cross reference.G. Branden Robinson2023-04-091-1/+1
| | | | Use correct lettercase.
* [docs]: Revise localization discussion.G. Branden Robinson2023-04-012-34/+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".
* groff(7): Fix goof in list.G. Branden Robinson2023-04-011-2/+2
|
* [docs]: Fix Savannah #63812.G. Branden Robinson2023-03-221-3/+14
| | | | | | | | | | | * 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.
* [man pages]: Define page-local `MR` fallback.G. Branden Robinson2023-02-227-0/+105
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [man pages]: Provide page-local fallback definition of new `MR` macro. I didn't think I was going to have to do this, but the premier site on the web for viewing Linux man pages, Michael Kerrisk's man7.org, has been pulling snapshots of the pages themselves without upgrading the underlying macros, and so man page cross references set with `MR` are getting lost in its presentations. (I acknowledge: Ingo Schwarze warned me something like this could happen.) This definition is intended as a stopgap measure only. I want to revert this after groff 1.23 is released and has spread to some reasonable degree. * contrib/chem/chem.1.man: * contrib/eqn2graph/eqn2graph.1.man: * contrib/gdiffmk/gdiffmk.1.man: * contrib/glilypond/glilypond.1.man: * contrib/gperl/gperl.1.man: * contrib/gpinyin/gpinyin.1.man: * contrib/grap2graph/grap2graph.1.man: * contrib/hdtbl/groff_hdtbl.7.man: * contrib/mm/groff_mm.7.man: * contrib/mm/groff_mmse.7.man: * contrib/mm/mmroff.1.man: * contrib/mom/groff_mom.7.man: * contrib/pdfmark/pdfroff.1.man: * contrib/pic2graph/pic2graph.1.man: * contrib/rfc1345/groff_rfc1345.7.man: * man/groff.7.man: * man/groff_char.7.man: * man/groff_diff.7.man: * man/groff_font.5.man: * man/groff_out.5.man: * man/groff_tmac.5.man: * man/roff.7.man: * src/devices/grodvi/grodvi.1.man: * src/devices/grohtml/grohtml.1.man: * src/devices/grolbp/grolbp.1.man: * src/devices/grolj4/grolj4.1.man: * src/devices/gropdf/gropdf.1.man: * src/devices/gropdf/pdfmom.1.man: * src/devices/grops/grops.1.man: * src/devices/grotty/grotty.1.man: * src/devices/xditview/gxditview.1.man: * src/preproc/eqn/eqn.1.man: * src/preproc/eqn/neqn.1.man: * src/preproc/grn/grn.1.man: * src/preproc/pic/pic.1.man: * src/preproc/preconv/preconv.1.man: * src/preproc/refer/refer.1.man: * src/preproc/soelim/soelim.1.man: * src/preproc/tbl/tbl.1.man: * src/roff/groff/groff.1.man: * src/roff/nroff/nroff.1.man: * src/roff/troff/troff.1.man: * src/utils/addftinfo/addftinfo.1.man: * src/utils/afmtodit/afmtodit.1.man: * src/utils/grog/grog.1.man: * src/utils/hpftodit/hpftodit.1.man: * src/utils/indxbib/indxbib.1.man: * src/utils/lkbib/lkbib.1.man: * src/utils/lookbib/lookbib.1.man: * src/utils/pfbtops/pfbtops.1.man: * src/utils/tfmtodit/tfmtodit.1.man: * src/utils/xtotroff/xtotroff.1.man: * tmac/groff_man.7.man.in: * tmac/groff_me.7.man: * tmac/groff_ms.7.man: * tmac/groff_trace.7.man: * tmac/groff_www.7.man: Do it. Fixes <https://savannah.gnu.org/bugs/?63825>. Thanks greatly to Alexis for identifying an issue with mandoc(1)'s handling of an earlier iteration of this fallback, and to John Gardner for identifying a method of detecting mandoc as the renderer at formatting time. Tested with groff 1.22.4, mandoc 1.14.5, and groff Git HEAD (of course). The sed script I used follows. /^\.cp 0/a\ .\ .\\" Define fallback for groff 1.23's MR macro if the system lacks it.\ .nr do-fallback 0\ .if !\\n(.f .nr do-fallback 1 \\" mandoc\ .if \\n(.g .if !d MR .nr do-fallback 1 \\" older groff\ .if !\\n(.g .nr do-fallback 1 \\" non-groff *roff\ .if \\n[do-fallback] \\{\\\ . de MR\ . ie \\\\n(.$=1 \\\ . I \\%\\\\$1\ . el \\\ . IR \\%\\\\$1 (\\\\$2)\\\\$3\ . .\ .\\}\ .rr do-fallback ANNOUNCE: Update bug counts. Credit Alexis with assistance.
* Revert "[man pages]: Define page-local `MR` fallback."G. Branden Robinson2023-02-217-91/+0
| | | | | | | | | | | This reverts commit 18d708e489758636ff9e168eee2592591755eb61. Unfortunately my clever hack [sic] does not work with mandoc 1.14.5, causing that tool to truncate the entire text of the man page after the summary description. The good news is that there is a simpler replacement that works better, forthcoming.
* groff(7): Fix typo.G. Branden Robinson2023-02-161-1/+1
|
* [docs]: Fix Savannah #68216.G. Branden Robinson2023-02-123-13/+70
| | | | | | | | | | | | | | | | | | | | | | | [docs]: Re-re-christen 'ESCAPE_AMPERSAND' ('\&'). Now call it a (non-transparent) "dummy character". Also rechristen 'ESCAPE_RIGHT_PARENTHESIS', ('\)') as the "transparent dummy character"; it has no impact on sentence-ending detection. * doc/groff.texi: * doc/meref.me.in: * man/groff.7.man: * man/groff_diff.7.man: * man/roff.7.man: * src/preproc/refer/refer.1.man: * tmac/groff_man.7.man.in: Do it. Fixes <https://savannah.gnu.org/bugs/?62816>. Thanks to Dave Kemper for the report and to the groff mailing list for the vigorous discussion. I don't expect my solution to please everyone. Also update references to the \& escape sequence in comments. ANNOUNCE: Update bug counts.
* groff(7): Adjust dead tree typography.G. Branden Robinson2023-02-121-3/+3
| | | | | Frotz with pagination in light of forthcoming commit. Tighten wording as a bonus.
* groff(7): Fix style nitsG. Branden Robinson2023-02-111-3/+4
| | | | | * Recast introductory discussion of adjustment. * Fix a parenthesis in the wrong font.
* Fix Savannah #63589.G. Branden Robinson2023-02-053-6/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Correct numerous typos and solecisms throughout the source tree. * ChangeLog: * ChangeLog.115: * ChangeLog.116: * ChangeLog.117: * ChangeLog.118: * ChangeLog.119: * ChangeLog.121: * ChangeLog.122: * Makefile.am: * NEWS: * PROBLEMS: * README: * contrib/chem/chem.am: * contrib/chem/chem.pl: * contrib/glilypond/README.txt: * contrib/glilypond/glilypond.pl: * contrib/hdtbl/groff_hdtbl.7.man: * contrib/mm/ChangeLog: * contrib/mm/m.tmac: * contrib/pdfmark/pdfmark.ms: * doc/automake.mom: * doc/groff.texi: * doc/me-revisions: * doc/webpage.ms: * m4/lib-link.m4: * man/groff.7.man: * man/groff_diff.7.man: * man/roff.7.man: * src/devices/grohtml/post-html.cpp: * src/devices/grolbp/lbp.h: * src/devices/gropdf/TODO: * src/devices/gropdf/gropdf.1.man: * src/devices/gropdf/gropdf.pl: * src/devices/xditview/ChangeLog: * src/devices/xditview/xditview.c: * src/libs/libdriver/input.cpp: * src/libs/libgroff/glyphuni.cpp: * src/preproc/eqn/eqn.1.man: * src/preproc/grn/gprint.h: * src/preproc/grn/main.cpp: * src/preproc/html/pre-html.cpp: * src/preproc/preconv/preconv.cpp: * src/preproc/tbl/table.cpp: * src/roff/groff/pipeline.c: * src/roff/groff/tests/substring_works.sh: * src/roff/groff/tests/use_point_size_escape_with_single_digit_arg.sh: * src/roff/troff/div.cpp: * src/roff/troff/input.cpp: * src/roff/troff/troff.1.man: * src/utils/grog/grog.pl: * src/utils/indxbib/indxbib.cpp: * src/utils/tfmtodit/tfmtodit.1.man: * tmac/doc-old.tmac: * tmac/doc.tmac: * tmac/groff_man.7.man.in: * tmac/hyphen.fr: Do it. Fixes <https://savannah.gnu.org/bugs/?63589>. Thanks to Bjarni Ingi Gislason for the report. * ANNOUNCE: Update bug counts. I also killed some pointless white space, refilled affected lines at 72 columns where convenient and non-disruptive to existing text flow, and corrected a misspelling of Ralph Corderoy's surname.
* [man pages]: Define page-local `MR` fallback.G. Branden Robinson2023-02-037-0/+91
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [man pages]: Provide page-local fallback definition of new `MR` macro. I didn't think I was going to have to do this, but the premier site on the web for viewing Linux man pages, Michael Kerrisk's man7.org, has been pulling snapshots of the pages themselves without upgrading the underlying macros, and so man page cross references set with `MR` are getting lost in its presentations. (I acknowledge: Ingo Schwarze warned me something like this could happen.) This definition is intended as a stopgap measure only. I want to revert this after groff 1.23 is released and has spread to some reasonable degree. * contrib/chem/chem.1.man: * contrib/eqn2graph/eqn2graph.1.man: * contrib/gdiffmk/gdiffmk.1.man: * contrib/glilypond/glilypond.1.man: * contrib/gperl/gperl.1.man: * contrib/gpinyin/gpinyin.1.man: * contrib/grap2graph/grap2graph.1.man: * contrib/hdtbl/groff_hdtbl.7.man: * contrib/mm/groff_mm.7.man: * contrib/mm/groff_mmse.7.man: * contrib/mm/mmroff.1.man: * contrib/mom/groff_mom.7.man: * contrib/pdfmark/pdfroff.1.man: * contrib/pic2graph/pic2graph.1.man: * contrib/rfc1345/groff_rfc1345.7.man: * man/groff.7.man: * man/groff_char.7.man: * man/groff_diff.7.man: * man/groff_font.5.man: * man/groff_out.5.man: * man/groff_tmac.5.man: * man/roff.7.man: * src/devices/grodvi/grodvi.1.man: * src/devices/grohtml/grohtml.1.man: * src/devices/grolbp/grolbp.1.man: * src/devices/grolj4/grolj4.1.man: * src/devices/gropdf/gropdf.1.man: * src/devices/gropdf/pdfmom.1.man: * src/devices/grops/grops.1.man: * src/devices/grotty/grotty.1.man: * src/devices/xditview/gxditview.1.man: * src/preproc/eqn/eqn.1.man: * src/preproc/eqn/neqn.1.man: * src/preproc/grn/grn.1.man: * src/preproc/pic/pic.1.man: * src/preproc/preconv/preconv.1.man: * src/preproc/refer/refer.1.man: * src/preproc/soelim/soelim.1.man: * src/preproc/tbl/tbl.1.man: * src/roff/groff/groff.1.man: * src/roff/nroff/nroff.1.man: * src/roff/troff/troff.1.man: * src/utils/addftinfo/addftinfo.1.man: * src/utils/afmtodit/afmtodit.1.man: * src/utils/grog/grog.1.man: * src/utils/hpftodit/hpftodit.1.man: * src/utils/indxbib/indxbib.1.man: * src/utils/lkbib/lkbib.1.man: * src/utils/lookbib/lookbib.1.man: * src/utils/pfbtops/pfbtops.1.man: * src/utils/tfmtodit/tfmtodit.1.man: * src/utils/xtotroff/xtotroff.1.man: * tmac/groff_man.7.man.in: * tmac/groff_me.7.man: * tmac/groff_ms.7.man: * tmac/groff_trace.7.man: * tmac/groff_www.7.man: Do it. The sed script I used follows. I patched neqn(1), which does not require compatibility mode, by hand. /^\.cp 0/a\ .\ .\\" Define fallback for groff 1.23's MR macro if the system lacks it.\ .de @@\ . de MR\ . ie \\n(.$=1 \\\ . I \%\\$1\ . el \\\ . IR \%\\$1 (\\$2)\\$3\ . \\\\.\ ..\ .if \\n(.g .if !d MR .@@\ .if !\\n(.g .@@\ .rm @@
* [docs]: Motivate line continuations better.G. Branden Robinson2023-02-021-1/+4
|
* groff(7): Add poor man's keep.G. Branden Robinson2023-02-021-0/+2
|
* groff(7): Fix thinko.G. Branden Robinson2023-02-021-2/+2
|
* groff(7): Add section "Diversions".G. Branden Robinson2023-01-211-0/+129
| | | | Also annotate parallelism brackets in our Texinfo manual.
* groff(7): Fix style and markup nits.G. Branden Robinson2023-01-211-3/+12
| | | | | | | | * Tighten discussion of macro definition macros. * Annotate material that parallels our Texinfo manual. * Apply poor man's keeps. Also add corresponding annotation to our Texinfo manual.
* groff(7): Relocate cautionary note.G. Branden Robinson2023-01-211-15/+15
| | | | Place it after all the applicable requests are presented.
* [docs]: Document input line trap cancellation.G. Branden Robinson2023-01-201-7/+16
| | | | ...and replacement.
* [docs]: Improve terminological discipline.G. Branden Robinson2023-01-201-1/+1
| | | | "input trap" -> "input line trap"
View Lorry Controller Status