[groff] 11/31: [nroff]: Describe program when asked for `--help`.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 4ec50d1366d1ebda6c495b5d36cfdc6da1b2fc71
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Jul 11 07:27:16 2024 -0500

    [nroff]: Describe program when asked for `--help`.
    
    * src/roff/nroff/nroff.sh: Describe program briefly when invoked with
      `--help` option.
---
 ChangeLog               | 5 +++++
 src/roff/nroff/nroff.sh | 5 +++++
 2 files changed, 10 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 6cca2f04c..6bc0115cd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2024-07-11  G. Branden Robinson <g.branden.robinson@gmail.com>
+
+       * src/roff/nroff/nroff.sh: Describe program briefly when invoked
+       with `--help` option.
+
 2024-07-11  G. Branden Robinson <g.branden.robinson@gmail.com>
 
        * src/roff/nroff/nroff.sh: Define `prog` variable as only the
diff --git a/src/roff/nroff/nroff.sh b/src/roff/nroff/nroff.sh
index b7973b7c9..5065f9ba0 100644
--- a/src/roff/nroff/nroff.sh
+++ b/src/roff/nroff/nroff.sh
@@ -37,6 +37,10 @@ usage="usage: $prog [-bcCEhikpRStUVz] [-d ctext] [-d 
string=text] \
 usage: $prog {-v | --version}
 usage: $prog --help"
 
+summary="
+Format documents with groff(1) for TTY (terminal) devices.
+See the nroff(1) manual page."
+
 for arg
 do
   if [ -n "$is_option_argument_pending" ]
@@ -77,6 +81,7 @@ do
       opts="$opts $arg" ;;
     --help)
       echo "$usage"
+      echo "$summary"
       exit 0 ;;
     --)
       shift