gbranden pushed a commit to branch master
in repository groff.
commit d4b0bce652f30e7322c4100949ed572325d35b63
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Dec 23 13:47:18 2023 -0600
[gdiffmk]: Abbreviate usage message.
* contrib/gdiffmk/gdiffmk.sh (Usage): Abbreviate usage message to just a
synopsis, a brief (recast) description, and a cross reference to the
man page, like groff(1) and grops(1).
* contrib/gdiffmk/gdiffmk.1.man (Synopsis, Description): Align language
with usage message (except that the latter uses the imperative mood,
and the man page the indicative).
---
contrib/gdiffmk/ChangeLog | 9 +++++++++
contrib/gdiffmk/gdiffmk.1.man | 9 ++++++---
contrib/gdiffmk/gdiffmk.sh | 41 ++++++++++-------------------------------
3 files changed, 25 insertions(+), 34 deletions(-)
diff --git a/contrib/gdiffmk/ChangeLog b/contrib/gdiffmk/ChangeLog
index df08bcc94..d99f4d7a3 100644
--- a/contrib/gdiffmk/ChangeLog
+++ b/contrib/gdiffmk/ChangeLog
@@ -1,3 +1,12 @@
+2023-12-23 G. Branden Robinson <[email protected]>
+
+ * gdiffmk.sh (Usage): Abbreviate usage message to just a
+ synopsis, a brief (recast) description, and a cross reference to
+ the man page, like groff(1) and grops(1).
+ * gdiffmk.1.man (Synopsis, Description): Align language with
+ usage message (except that the latter uses the imperative mood,
+ and the man page the indicative).
+
2023-12-19 G. Branden Robinson <[email protected]>
* gdiffmk.sh: Refactor.
diff --git a/contrib/gdiffmk/gdiffmk.1.man b/contrib/gdiffmk/gdiffmk.1.man
index a8b484a85..b9e80c9df 100644
--- a/contrib/gdiffmk/gdiffmk.1.man
+++ b/contrib/gdiffmk/gdiffmk.1.man
@@ -69,7 +69,7 @@ files
.RB [ \-\- ]
.I file1
.I file2
-.RI [ output ]
+.RI [ output-file ]
.YS
.
.
@@ -94,9 +94,12 @@ documents,
.I file1
and
.IR file2 ,
-and creates a
+and writes a
.I roff
-document consisting of
+to the standard output stream
+(or
+.IR output-file )
+consisting of
.I file2
with added margin character
.RB ( .mc )
diff --git a/contrib/gdiffmk/gdiffmk.sh b/contrib/gdiffmk/gdiffmk.sh
index 7f0be5ed7..8d8fc27ab 100644
--- a/contrib/gdiffmk/gdiffmk.sh
+++ b/contrib/gdiffmk/gdiffmk.sh
@@ -36,37 +36,16 @@ Usage () {
status=2
fi
cat >&2 <<EOF
-usage: ${CMD} [ OPTIONS ] FILE1 FILE2 [ OUTPUT ]
-Place difference marks into the new version of a groff/nroff/troff document.
-FILE1 and FILE2 are compared, using 'diff', and FILE2 is output with
-groff '.mc' requests added to indicate how it is different from FILE1.
-
- FILE1 Previous version of the groff file. '-' means standard input.
- FILE2 Current version of the groff file. '-' means standard input.
- Either FILE1 or FILE2 can be standard input, but not both.
- OUTPUT Copy of FILE2 with '.mc' commands added.
- '-' means standard output (the default).
- If the shell's 'test' does not support option -ef, OUTPUT
- can only be the standard output.
-
-OPTIONS:
- -a ADDMARK Mark for added groff source lines. Default: '+'.
- -c CHANGEMARK Mark for changed groff source lines. Default: '|'.
- -d DELETEMARK Mark for deleted groff source lines. Default: '*'.
-
- -D Show the deleted portions from changed and deleted text.
- Default delimiting marks: '[[' .... ']]'.
- -B By default, the deleted texts marked by the '-D' option end
- with an added troff '.br' command. This option prevents
- the added '.br'.
- -M MARK1 MARK2 Change the delimiting marks for the '-D' option.
-
- -x DIFFCMD Use a different diff(1) command;
- one that accepts the '-Dname' option, such as GNU diff.
- -s SEDCMD Use a different sed(1) command;
- such as GNU sed.
- --version Print version information on the standard output and exit.
- --help Print this message on the standard error.
+usage: ${CMD} [-a add-mark] [-c change-mark] [-d delete-mark] \
+[-x diff-command] [-D [-B] [-M mark1 mark2]] [--] file1 file2 \
+[output-file]
+usage: ${CMD} --version
+usage: ${CMD} --help
+
+Compare roff(7) documents file1 and file2, and write a roff document
+to the standard output stream (or output-file) consisting of file2 with
+added margin character ('mc') requests indicating output lines that
+differ from file1. See the gdiffmk(1) manual page.
EOF
exit $status
}
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
