[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 06/27: preconv(1): Fix style nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 06/27: preconv(1): Fix style nits. |
Date: |
Mon, 28 Aug 2023 15:54:42 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 36f9463ee569382766b1745b326e1305bce4d187
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Aug 27 03:11:26 2023 -0500
preconv(1): Fix style nits.
* Fit document onto two U.S. letter pages.
* Use brief metasynactic variable names when describing, as opposed to
summarizing, options.
* Fix stranded partial word by revealing more about what `--version`
option does (most groff commands don't do configuration reporting).
* Use active voice more.
* Vary wording.
* Tighten wording.
* Annotate computations of tagged paragraph indentations.
---
src/preproc/preconv/preconv.1.man | 35 ++++++++++++++++++-----------------
1 file changed, 18 insertions(+), 17 deletions(-)
diff --git a/src/preproc/preconv/preconv.1.man
b/src/preproc/preconv/preconv.1.man
index 55ea8f58a..5fe409779 100644
--- a/src/preproc/preconv/preconv.1.man
+++ b/src/preproc/preconv/preconv.1.man
@@ -136,16 +136,17 @@ or if
.I file
is
.RB \[lq] \- \[rq],
-the standard input stream is read.
+.I preconv
+reads the standard input stream.
.
.
.PP
.I preconv
-tries to find the input encoding with the following algorithm,
+selects an input encoding with the following algorithm,
stopping at the first success.
.
.
-.IP 1. 4n
+.IP 1. 4n \" "1." + 2n
If the input encoding has been explicitly specified with option
.BR \-e ,
use it.
@@ -153,16 +154,16 @@ use it.
.
.IP 2.
If the input starts with a Unicode Byte Order Mark,
-determine the encoding as UTF-8,
+select UTF-8,
UTF-16,
or UTF-32 accordingly.
.
.
.IP 3.
If the input stream is seekable,
-check the first and second input lines for a recognized GNU\~Emacs
-file-local variable identifying the character encoding,
-here referred to as the \[lq]coding tag\[rq] for brevity.
+check the first two input lines for a GNU\~Emacs file-local variable
+identifying the character encoding,
+here referred to as the \[lq]coding tag\[rq].
.
If found,
use it.
@@ -238,8 +239,8 @@ Text editors that support more than a single character
encoding need
tags within the input files to mark the file's encoding.
.
While it is possible to guess the right input encoding with the help of
-heuristics that are reliable for a preponderance of natural language
-texts,
+heuristics that produce good results for a preponderance of natural
+language texts,
they are not absolutely reliable.
.
Heuristics can fail on inputs that are too short or don't represent a
@@ -507,26 +508,26 @@ while
.B \-v
and
.B \-\-version
-show version information;
+show version and configuration information;
all exit afterward.
.
.
-.TP
+.TP 10n \" "-D fbenc" + 2n
.B \-d
Emit debugging messages to the standard error stream.
.
.
.TP
-.BI \-D\~ fallback-encoding
-Report
-.I fallback-encoding
+.BI \-D\~ fbenc
+Select the fallback encoding
+.I fbenc
if all detection methods fail.
.
.
.TP
-.BI \-e\~ encoding
-Skip detection and assume
-.IR encoding ;
+.BI \-e\~ enc
+Skip detection and select encoding
+.IR enc ;
see
.IR groff 's
.B \-K
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 06/27: preconv(1): Fix style nits.,
G. Branden Robinson <=