gbranden pushed a commit to branch master
in repository groff.
commit 3baa8cf5f6d15a075107ffbab2924fe9ebc3054e
Author: G. Branden Robinson <[email protected]>
AuthorDate: Wed May 7 05:17:32 2025 -0500
gdiffmk(1): Recast some option descriptions.
Here's an illustration of gdiffmk(1) annotating this very change.
$ gdiffmk -D ./gdiffmk.1.old ./gdiffmk.1.new \
| nroff -man -T ascii -P -cbou \
| sed -n '/Options/,/Exit status/p'
Options
--help displays a usage message and --version shows version
information;
both exit afterward.
-a add-mark
[[ Use add-mark for source lines not in ]]
Annotate material absent from file1 but present in [[ file2.
De- |
fault: "+". ]]
file2 with add-mark (default: "+").
|
-B Suppress br [[ requests inserted by ]]
requests normally inserted by -D option. Use with caution;
such re- |
quests are the only way to guarantee that deletions and
small
changes are marked.
-c change-mark
[[ Use ]]
Annotate material differing between file1 and file2 with
change-mark |
[[ for changed source lines. Default: "|". ]]
(default: "|").
|
-d delete-mark
[[ Use the ]]
Annotate material present in file1 but absent from file2
with |
delete-mark [[ for deleted source lines. Default: "*". ]]
(default: "*").
|
-D [[ Show the deleted portions from changed and deleted text. ]]
Mark changed and deleted material with surrounding delimiters.
|
-M mark1 mark2
[[ Change the delimiting marks for the ]]
Use mark1 (default: "[[") and mark2 (default: "]]") as
delimiters |
when using the -D option. [[ It makes no sense to use this
option
without -D. Default delimiting marks: "[[" ... "]]". ]]
-x diff-command
*
Use the diff-command [[ command to perform the comparison of ]]
program to perform the comparison of file1 and file2. [[ In
partic- |
ular, ]]
diff-command [[ should accept the GNU diff(1) ]]
*
(default: diff) must accept GNU diff(1)'s -D [[ option.
Default: |
diff. ]]
extension option.
|
-- Treat all subsequent arguments as file names, even if they
begin
with "-".
Exit status
---
contrib/gdiffmk/gdiffmk.1.man | 73 ++++++++++++++++++++++---------------------
1 file changed, 38 insertions(+), 35 deletions(-)
diff --git a/contrib/gdiffmk/gdiffmk.1.man b/contrib/gdiffmk/gdiffmk.1.man
index 9e3afac43..831a76a35 100644
--- a/contrib/gdiffmk/gdiffmk.1.man
+++ b/contrib/gdiffmk/gdiffmk.1.man
@@ -9,7 +9,7 @@ files
.\" Legal Terms
.\" ====================================================================
.\"
-.\" Copyright (C) 2004-2023 Free Software Foundation, Inc.
+.\" Copyright (C) 2004-2025 Free Software Foundation, Inc.
.\"
.\" This file is part of gdiffmk, which is part of groff, the GNU roff
.\" typesetting system.
@@ -146,22 +146,21 @@ both exit afterward.
.
.TP
.BI \-a\~ add-mark
-Use
-.I add-mark
-for source lines not in
+Annotate material absent from
.I file1
but present in
-.IR file2 .
-.
-Default:
-.RB \[lq] + \[rq].
+.I file2
+with
+.I add-mark
+(default:
+.RB \[lq] + \[rq]).
.
.
.TP
.B \-B
Suppress
.B br
-requests inserted by
+requests normally inserted by
.B \-D
option.
.
@@ -172,59 +171,63 @@ changes are marked.
.
.TP
.BI \-c\~ change-mark
-Use
+Annotate material differing between
+.I file1
+and
+.I file2
+with
.I change-mark
-for changed source lines.
-.
-Default:
-.RB \[lq] | \[rq].
+(default:
+.RB \[lq] | \[rq]).
.
.
.TP
.BI \-d\~ delete-mark
-Use the
+Annotate material present in
+.I file1
+but absent from
+.I file2
+with
.I delete-mark
-for deleted source lines.
-.
-Default:
-.RB \[lq] * \[rq].
+(default:
+.RB \[lq] * \[rq]).
.
.TP
.B \-D
-Show the deleted portions from changed and deleted text.
+Mark changed and deleted material with surrounding delimiters.
.
.
.TP
.BI \-M\~ "mark1 mark2"
-Change the delimiting marks for the
+Use
+.I mark1
+(default:
+.RB \[lq] [[ \[rq])
+and
+.I mark2
+(default:
+.RB \[lq] ]] \[rq])
+as delimiters when using the
.B \-D
option.
.
-It makes no sense to use this option without
-.BR \-D .
-.
-Default delimiting marks:
-.RB \[lq] [[ "\[rq] .\|.\|.\& \[lq]" ]] \[rq].
-.
.
.TP
.BI \-x\~ diff-command
Use the
.I diff-command
-command to perform the comparison of
+program to perform the comparison of
.I file1
and
.IR file2 .
.
-In particular,
.I diff-command
-should accept the GNU
-.MR diff 1
+(default:
+.BR diff )
+must accept GNU
+.MR diff 1 's
.B \-D
-option.
-.
-Default:
-.BR diff .
+extension option.
.
.
.TP
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
