gbranden pushed a commit to branch master
in repository groff.
commit e6f9a7a9aac0d1f78b6b7bf3de51b9ee18a58b9b
Author: Dave Kemper <[email protected]>
AuthorDate: Tue Jul 9 06:37:50 2024 +0000
[docs]: Revise "input file" usage.
Change the term "input file" to "input" in groff documentation in cases
where the referenced input need not come from a file.
Fixes <https://savannah.gnu.org/bugs/?65967>.
[Follow-ups:
1. Update the description of groff at its GNU home page to match the
language now in ANNOUNCE/groff.texi.in/groff.1.man.
2. Sync meintro_fr.me.in. Drop a "fichier"?
3. Change some instances of "input" to "the input" where that sounds
better.
--GBR]
---
ANNOUNCE | 2 +-
ChangeLog | 9 +++++++++
doc/groff.texi.in | 22 +++++++++++-----------
doc/meintro.me.in | 2 +-
man/groff.7.man | 2 +-
man/groff_diff.7.man | 2 +-
man/groff_tmac.5.man | 2 +-
man/roff.7.man | 8 ++++----
src/preproc/eqn/eqn.1.man | 4 ++--
src/preproc/grn/grn.1.man | 2 +-
src/preproc/pic/pic.1.man | 2 +-
src/preproc/preconv/preconv.1.man | 4 ++--
src/preproc/soelim/soelim.1.man | 4 ++--
src/preproc/tbl/tbl.1.man | 2 +-
src/roff/groff/groff.1.man | 10 +++++-----
src/roff/troff/troff.1.man | 2 +-
16 files changed, 44 insertions(+), 35 deletions(-)
diff --git a/ANNOUNCE b/ANNOUNCE
index 560a1113d..ff4912704 100644
--- a/ANNOUNCE
+++ b/ANNOUNCE
@@ -23,7 +23,7 @@ What is groff?
==============
groff (GNU roff) is a typesetting system that reads plain text input
-files that include formatting commands to produce output in PostScript,
+that includes formatting commands to produce output in PostScript,
PDF, HTML, or DVI formats or for display to a terminal. Formatting
commands can be low-level typesetting primitives, macros from a
supplied package, or user-defined macros. All three approaches can be
diff --git a/ChangeLog b/ChangeLog
index 540e3456a..69c21e990 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2024-07-09 Dave Kemper <[email protected]>
+
+ [docs]: Revise "input file" usage.
+
+ Change the term "input file" to "input" in groff documentation
+ in cases where the referenced input need not come from a file.
+
+ Fixes <https://savannah.gnu.org/bugs/?65967>.
+
2024-07-09 G. Branden Robinson <[email protected]>
[grohtml]: Pass `-blank-image=pass` to pnmcrop(1) if supported
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index d53344450..e76180b08 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -587,7 +587,7 @@ A history relating @code{groff} to its forerunners
@code{roff},
@c This language is slightly expanded from that in the "ANNOUNCE" file
@c and on the groff home page.
@code{groff} (GNU @code{roff}) is a typesetting system that reads plain
-text input files that include formatting commands to produce output in
+text input that includes formatting commands to produce output in
PostScript, PDF, HTML, or other formats, or for display to a terminal.
Formatting commands can be low-level typesetting primitives, macros from
a supplied package, or user-defined macros. All three approaches can be
@@ -1144,7 +1144,7 @@ spooler.
@item -m @var{mac}
Search for the macro package @file{@var{mac}.tmac} and read it prior to
-any input files. If not found, @file{tmac.@var{mac}} is attempted.
+any input. If not found, @file{tmac.@var{mac}} is attempted.
@xref{Macro Directories}. @command{groff} passes @option{-m} options
and their arguments to to @command{geqn}, @command{grap}, and
@command{ggrn}.
@@ -1399,8 +1399,8 @@ the utilities @command{indxbib} and @command{lookbib}.
@item GROFF_ENCODING
@tindex GROFF_ENCODING@r{, environment variable}
-Specify the assumed character encoding of input files. @command{groff}
-passes its value as an argument to the @command{preconv} preprocessor's
+Specify the assumed character encoding of input. @command{groff} passes
+its value as an argument to the @command{preconv} preprocessor's
@option{-e} option. This variable's existence implies the
@command{groff} option @option{-k}. If set but empty, @command{groff}
runs @code{preconv} without an @option{-e} option. @command{groff}'s
@@ -1759,8 +1759,8 @@ fruitfully.@footnote{The remainder of this chapter is
based on
which is distributed with @code{groff} as @file{meintro.me}.}
References are made throughout to more detailed information.
-GNU @command{troff} reads an input file prepared by the user and outputs
-a formatted document suitable for publication or framing. The input
+GNU @command{troff} reads input prepared by the user and outputs a
+formatted document suitable for publication or framing. The input
consists of text, or words to be printed, and embedded commands
(@slanted{requests} and @slanted{escape sequences}), which tell GNU
@code{troff} how to format the output. @xref{Formatter Instructions}.
@@ -5086,7 +5086,7 @@ both. GNU @code{troff} continues this tradition of
permitting an author
to compose a single master version of a document which can then be
rendered for a variety of output formats or devices.
-@code{roff} input files contain text interspersed with instructions to
+@code{roff} input contains text interspersed with instructions to
control the formatter. Even in the absence of such instructions, GNU
@code{troff} still processes its input in several ways, by filling,
hyphenating, breaking, and adjusting it, and supplementing it with
@@ -15239,10 +15239,10 @@ of qualifying lines enumerated in that environment.
@Defreq {blm, [@Var{name}]}
@cindex blank line macro (@code{blm})
Set a blank line trap, calling the macro @var{name} when GNU
-@code{troff} encounters a blank line in an input file, instead of the
-usual behavior (@pxref{Breaking}). A line consisting only of spaces is
-also treated as blank and subject to this trap. If no argument is
-supplied, the default blank line behavior is (re-)established.
+@code{troff} encounters a blank line in input, instead of the usual
+behavior (@pxref{Breaking}). A line consisting only of spaces is also
+treated as blank and subject to this trap. If no argument is supplied,
+the default blank line behavior is (re-)established.
@endDefreq
@c ---------------------------------------------------------------------
diff --git a/doc/meintro.me.in b/doc/meintro.me.in
index 1b70506d0..db2de1887 100644
--- a/doc/meintro.me.in
+++ b/doc/meintro.me.in
@@ -102,7 +102,7 @@ and
.pp
\*G, a computer program
that runs on the \*U operating system,
-reads an input file
+reads input
prepared by the user
and outputs a formatted paper
suitable for publication or framing.
diff --git a/man/groff.7.man b/man/groff.7.man
index 56f22e8e1..a3e6637ae 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -316,7 +316,7 @@ a program that reads device and font descriptions
.MR groff_font @MAN5EXT@ ),
interprets the
.I groff
-language expressed in text input files,
+language expressed in text input,
and translates that input into a device-independent output format
(\c
.MR groff_out @MAN5EXT@ )
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 4e1c1787e..b0eaaaa9c 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -1650,7 +1650,7 @@ If a blank line macro is thus defined,
.I groff
executes
.I name
-when a blank line is encountered in the input file,
+when a blank line is encountered in the input,
instead of the usual behavior.
.
A line consisting only of spaces is also treated as blank and subject to
diff --git a/man/groff_tmac.5.man b/man/groff_tmac.5.man
index 2c87fe825..a859cc2f0 100644
--- a/man/groff_tmac.5.man
+++ b/man/groff_tmac.5.man
@@ -1065,7 +1065,7 @@ The traditional method of employing a macro package is to
specify the
option to the formatter,
which then reads
.IR package 's
-macro file prior to any input files.
+macro file prior to any input.
.
Historically,
.I package
diff --git a/man/roff.7.man b/man/roff.7.man
index dea1b25af..60bd62e3d 100644
--- a/man/roff.7.man
+++ b/man/roff.7.man
@@ -111,7 +111,7 @@ and recommend further reading materials.
.\" BEGIN Keep roughly parallel with groff.texi nodes "Text" through
.\" "Tab Stops".
.I roff
-input files contain text interspersed with instructions to control the
+input contains text interspersed with instructions to control the
formatter.
.
Even in the absence of such instructions,
@@ -1581,9 +1581,9 @@ input.
.
Most
.I roff
-input files employ the macros of a document formatting package,
+input employs the macros of a document formatting package,
intermixed with instructions for one or more preprocessors,
-and are seasoned with escape sequences and requests from the
+and is seasoned with escape sequences and requests from the
.I roff
language.
.
@@ -2167,7 +2167,7 @@ to ignore the remainder of the input line.
.
.IP \[bu]
Use the empty request\[em]a control character followed immediately by a
-newline\[em]to visually manage separation of material in input files.
+newline\[em]to visually manage separation of material in input.
.
Many of the
.I groff
diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man
index 75349cb56..38830f194 100644
--- a/src/preproc/eqn/eqn.1.man
+++ b/src/preproc/eqn/eqn.1.man
@@ -110,7 +110,7 @@ is a
preprocessor that translates expressions in its own language,
embedded in
.MR roff @MAN7EXT@
-input files,
+input,
into mathematical notation typeset by
.MR @g@troff @MAN1EXT@ .
.
@@ -177,7 +177,7 @@ and finally in the standard macro directory
.
If it exists and is readable,
.I @g@eqn
-processes it before any input files.
+processes it before any input.
.
.
.P
diff --git a/src/preproc/grn/grn.1.man b/src/preproc/grn/grn.1.man
index cc9a6f969..0be9b02f9 100644
--- a/src/preproc/grn/grn.1.man
+++ b/src/preproc/grn/grn.1.man
@@ -355,7 +355,7 @@ picture.
This is meant to be used as a global parameter setting mechanism at
the beginning of the
.I @g@troff
-input file,
+input,
but can be used at any time to reset the default settings.
.
.
diff --git a/src/preproc/pic/pic.1.man b/src/preproc/pic/pic.1.man
index af464f7c3..7b19072fd 100644
--- a/src/preproc/pic/pic.1.man
+++ b/src/preproc/pic/pic.1.man
@@ -114,7 +114,7 @@ is a
preprocessor that translates descriptions of diagrammatic pictures
embedded in
.MR roff @MAN7EXT@
-or \*[tx] input files into the language understood by \*[tx] or
+or \*[tx] input into the language understood by \*[tx] or
.IR @g@troff .
.
It copies each
diff --git a/src/preproc/preconv/preconv.1.man
b/src/preproc/preconv/preconv.1.man
index 837720c7d..0f2901840 100644
--- a/src/preproc/preconv/preconv.1.man
+++ b/src/preproc/preconv/preconv.1.man
@@ -209,7 +209,7 @@ reads from a pipe,
the stream is not seekable,
and these detection methods are skipped.
.
-If character encoding detection of your input files is unreliable,
+If character encoding detection of your input is unreliable,
arrange for one of the other methods to succeed by using
.IR \%preconv 's
.B \-D
@@ -268,7 +268,7 @@ designated for \[lq]file-local variables\[rq].
interprets the following syntax if it occurs in a
.I roff
comment
-in the first or second line of the input file.
+in the first or second line of the input.
.
Both \[lq]\^\[rs]"\^\[rq] and \[lq]\^\[rs]#\^\[rq] comment forms are
recognized,
diff --git a/src/preproc/soelim/soelim.1.man b/src/preproc/soelim/soelim.1.man
index 935267a5e..25fda86db 100644
--- a/src/preproc/soelim/soelim.1.man
+++ b/src/preproc/soelim/soelim.1.man
@@ -99,7 +99,7 @@ document formatting system.
.I @g@soelim
works as a filter to eliminate source requests in
.MR roff @MAN7EXT@
-input files;
+input;
that is,
it replaces lines of the form
.RB \[lq] .so
@@ -314,7 +314,7 @@ to source files.
If a file to be sourced should also be preprocessed,
it must already be read
.I before
-the input file passes through the preprocessor.
+the input passes through the preprocessor.
.
.IR @g@soelim ,
normally invoked via
diff --git a/src/preproc/tbl/tbl.1.man b/src/preproc/tbl/tbl.1.man
index 75302ffaf..897f4e213 100644
--- a/src/preproc/tbl/tbl.1.man
+++ b/src/preproc/tbl/tbl.1.man
@@ -89,7 +89,7 @@ is a
.MR @g@troff @MAN1EXT@
preprocessor that translates descriptions of tables embedded in
.MR roff @MAN7EXT@
-input files into the language understood by
+input into the language understood by
.IR @g@troff .
.
It copies the contents of each
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index 318ee0445..122c0eba9 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -132,7 +132,7 @@ document formatting system.
.\" and on the groff home page.
GNU
.I roff
-is a typesetting system that reads plain text input files that include
+is a typesetting system that reads plain text input that includes
formatting commands to produce output in PostScript,
PDF,
HTML,
@@ -619,7 +619,7 @@ for input files.
.BI \-m\~ mac
Read macro package
.I mac
-before input files.
+before input.
.
.I groff
passes
@@ -1007,9 +1007,9 @@ A preprocessor interprets a domain-specific language that
produces
language output.
.
Frequently,
-such input is confined to sections or regions of a
+such input is confined to sections or regions of
.I roff
-input file
+input
(bracketed with macro calls specific to each preprocessor),
which it replaces.
.
@@ -1819,7 +1819,7 @@ and
.
.TP
.I GROFF_ENCODING
-Specify the assumed character encoding of input files.
+Specify the assumed character encoding of input.
.
.I groff
passes its value as an argument to
diff --git a/src/roff/troff/troff.1.man b/src/roff/troff/troff.1.man
index 046cfbd4b..e16ab9bde 100644
--- a/src/roff/troff/troff.1.man
+++ b/src/roff/troff/troff.1.man
@@ -360,7 +360,7 @@ option of Unix C compilers.
.BI \-m\~ mac
Search for the macro package
.RI mac .tmac
-and read it prior to any input files.
+and read it prior to any input.
.
If not found,
.IR tmac. mac
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
