gbranden pushed a commit to branch master
in repository groff.
commit 609e0dd686224bed3d08532d9b50ec647789eae5
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu Jul 3 22:47:59 2025 -0500
[addftinfo]: Improve usage message upon `--help`.
* src/utils/addftinfo/addftinfo.cpp (usage): Summarize purpose of
command when help is requested.
Also, adjectives demand nouns to which they can attach. "Standard
output" is a _stream_.
---
ChangeLog | 5 +++++
src/utils/addftinfo/addftinfo.1.man | 6 +++---
src/utils/addftinfo/addftinfo.cpp | 8 +++++++-
3 files changed, 15 insertions(+), 4 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 039e7c6af..4c7b76190 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2025-07-03 G. Branden Robinson <[email protected]>
+
+ * src/utils/addftinfo/addftinfo.cpp (usage): Summarize purpose
+ of command when help is requested.
+
2025-07-03 G. Branden Robinson <[email protected]>
* src/roff/troff/env.cpp: Trivially refactor. Use better data
diff --git a/src/utils/addftinfo/addftinfo.1.man
b/src/utils/addftinfo/addftinfo.1.man
index c96308697..d3c8883eb 100644
--- a/src/utils/addftinfo/addftinfo.1.man
+++ b/src/utils/addftinfo/addftinfo.1.man
@@ -10,7 +10,7 @@ fonts for use with
.\" Legal Terms
.\" ====================================================================
.\"
-.\" Copyright (C) 1989-2020 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
@@ -100,11 +100,11 @@ reads an
.RI AT&T \~troff
font description file
.IR font ,
-adds additional font metric information required by
+adds further font metric information required by
.\" We need the "GNU" below because the @g@ prefix might be empty.
GNU
.MR @g@troff @MAN1EXT@ ,
-and writes the combined result to the standard output.
+and writes the combined result to the standard output stream.
.
The information added is derived from the font's existing parameters and
assumptions about traditional
diff --git a/src/utils/addftinfo/addftinfo.cpp
b/src/utils/addftinfo/addftinfo.cpp
index 7f6090d9d..919b85c66 100644
--- a/src/utils/addftinfo/addftinfo.cpp
+++ b/src/utils/addftinfo/addftinfo.cpp
@@ -1,4 +1,4 @@
-/* Copyright (C) 1989-2024 Free Software Foundation, Inc.
+/* Copyright (C) 1989-2025 Free Software Foundation, Inc.
Written by James Clark ([email protected])
This file is part of groff.
@@ -143,6 +143,12 @@ static void usage(FILE *stream)
fputs(" resolution unit-width font\n", stream);
fprintf(stream, "usage: %s {-v | --version}\n"
"usage: %s --help\n", program_name, program_name);
+ if (stdout == stream)
+ fputs("\n"
+"Read an AT&T troff font description file, add further font metric\n"
+"information required by GNU troff, and write the combined result to\n"
+"the standard output stream. See the addftinfo(1) manual page.\n",
+ stream);
}
static void usage()
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
