gbranden pushed a commit to branch master
in repository groff.
commit 1365348524da80db798f7c12cf3f81d5d785ca7a
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu May 1 17:17:32 2025 -0500
indxbib(1): Fix content, style, and markup nits.
Content:
* Fix incorrect reference to documented program.
Style:
* Favor active voice over passive.
* Favor present tense over future.
Markup:
* Favor `PP` macro over `LP`.
---
src/utils/indxbib/indxbib.1.man | 37 +++++++++++++++++++------------------
1 file changed, 19 insertions(+), 18 deletions(-)
diff --git a/src/utils/indxbib/indxbib.1.man b/src/utils/indxbib/indxbib.1.man
index 8550fd946..d15d99ea0 100644
--- a/src/utils/indxbib/indxbib.1.man
+++ b/src/utils/indxbib/indxbib.1.man
@@ -7,7 +7,7 @@
.\" Legal Terms
.\" ====================================================================
.\"
-.\" Copyright (C) 1989-2024 Free Software Foundation, Inc.
+.\" Copyright (C) 1989-2025 Free Software Foundation, Inc.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
@@ -104,9 +104,9 @@ to speed their access by
and
.MR lkbib @MAN1EXT@ .
.
-Each created index is named
-.RI file @INDEX_SUFFIX@ ;
-writing is done to a temporary file which is then renamed to this.
+The program writes to a temporary file
+that it later renames to
+.RI file @INDEX_SUFFIX@ .
.
If no
.I file
@@ -114,12 +114,12 @@ operands are present
and no
.B \-o
option is given,
-.I @g@refer
+.I @g@indxbib
names the index
.IR \%@DEFAULT_INDEX_NAME@@INDEX_SUFFIX@ .
.
.
-.LP
+.PP
Bibliographic databases are divided into records by blank lines.
.
Within a record,
@@ -127,24 +127,24 @@ each field starts with a
.B %
character at the beginning of a line.
.
-Fields have a one letter name that follows the
+Fields have a one-letter name that follows the
.B %
character.
.
.
-.LP
-The values set by the
+.PP
+.I @g@indxbib
+stores the values set by the
.BR \-c ,
.BR \-l ,
.BR \-n ,
and
.B \-t
-options are stored in the index:
-when the index is searched,
-keys will be discarded and truncated in a
-manner appropriate to these options;
-the original keys will be used for verifying that any record
-found using the index actually contains the keys.
+options in the index:
+programs that search the index interpret them,
+discarding and truncating keys appropriately,
+and using the original keys to verify
+that any record found using the index actually contains the keys.
.
This means that a user of an index need not know whether these
options were used in the creation of the index,
@@ -153,10 +153,11 @@ would have been discarded during indexing
and that the user supplies at least the part of each key
that would have remained after being truncated during indexing.
.
-The value set by the
+.I @g@indxbib
+also stores the value set by the
.B \-i
-option is also stored in the index
-and will be used in verifying records found using the index.
+option in the index
+for use in verifying records found using it.
.
.
.\" ====================================================================
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
