Skip to content

Commit 4544adc

Browse files
committed
doc/imagewmark.1.md: pandoc-3.8 removed support for compact_definition_lists
Signed-off-by: Tim Janik <timj@gnu.org>
1 parent 49fb4aa commit 4544adc

File tree

3 files changed

+61
-33
lines changed

3 files changed

+61
-33
lines changed

doc/Makefile.mk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Licensed under the GNU GPL-3.0+: https://www.gnu.org/licenses/gpl-3.0.html
22

33
# == pandoc for manual pages ==
4-
doc/markdown-flavour := markdown-hard_line_breaks+compact_definition_lists+pandoc_title_block+autolink_bare_uris+emoji+lists_without_preceding_blankline
4+
doc/markdown-flavour := markdown-hard_line_breaks+pandoc_title_block+autolink_bare_uris+emoji+lists_without_preceding_blankline
55
doc/mans1 :=
66

77
# == doc/imagewmark-arch--help.md Helper ==

doc/imagewmark.1.md

Lines changed: 59 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ Imagewmark supports short and long options which start with two dashes (`--`).
2424

2525
`-h`, `--help`
2626
: Show a help message about command line usage.
27+
2728
`-v`, `--version`
28-
: Print information about the program version.
29+
: Print information about the program version.
2930

3031
# COMMANDS
3132

@@ -38,27 +39,37 @@ in *INPUT_IMG* and write the result into *OUTPUT_IMG*.
3839
**Command Options:**
3940

4041
`-h`, `--help`
41-
: Show this help message and exit.
42+
: Show this help message and exit.
43+
4244
`--dynamic-zoom` *DYNAMIC_ZOOM*
43-
: Zoom watermark depending on image size (default: -1).
45+
: Zoom watermark depending on image size (default: -1).
46+
4447
`--zoom` *ZOOM*
45-
: Set zoom factor for watermark (default: -1).
48+
: Set zoom factor for watermark (default: -1).
49+
4650
`--trace-psnr`
47-
: Compute PSNR (default: False).
51+
: Compute PSNR (default: False).
52+
4853
`--trace-quality`
49-
: Compute quality metrics (default: False).
54+
: Compute quality metrics (default: False).
55+
5056
`-v`, `--verbose`
51-
: Increase output messages or debugging info for multiple `-vv` (default: 0).
57+
: Increase output messages or debugging info for multiple `-vv` (default: 0).
58+
5259
`-q`, `--quiet`
53-
: Reduce output verbosity (default: None).
60+
: Reduce output verbosity (default: None).
61+
5462
`--strength` *STRENGTH*
55-
: Strength for embedded watermark (default: 2).
63+
: Strength for embedded watermark (default: 2).
64+
5665
`-P` *PLOTS*
57-
: Configure plots with colon separated keywords, 'most' or 'all' (default: None).
66+
: Configure plots with colon separated keywords, 'most' or 'all' (default: None).
67+
5868
`--key` *KEY*
59-
: Load watermarking key from file (default: None).
69+
: Load watermarking key from file (default: None).
70+
6071
`--test-key` *TEST_KEY*
61-
: Watermarking key (default: None).
72+
: Watermarking key (default: None).
6273

6374
## Get Watermark
6475
**get** [**OPTIONS**] *INPUT_IMG*
@@ -68,37 +79,52 @@ Extract a watermark message from the image given as *INPUT_IMG*.
6879
**Command Options:**
6980

7081
`-h`, `--help`
71-
: Show this help message and exit.
82+
: Show this help message and exit.
83+
7284
`--expect` *EXPECT*
73-
: Expected bit pattern for early exit (default: None).
85+
: Expected bit pattern for early exit (default: None).
86+
7487
`--json` [*JSONFILE*]
75-
: Write JSON results into file (default: None).
88+
: Write JSON results into file (default: None).
89+
7690
`--dump` *DUMP*
77-
: Debug flags to dump intermediate stages (default: ).
91+
: Debug flags to dump intermediate stages (default: ).
92+
7893
`--norm-peak-count` *NORM_PEAK_COUNT*
79-
: Number of normalized peaks to use for grid (default: 250).
94+
: Number of normalized peaks to use for grid (default: 250).
95+
8096
`--raw-peak-count` *RAW_PEAK_COUNT*
81-
: Number of raw peaks to use for grid (default: 250).
97+
: Number of raw peaks to use for grid (default: 250).
98+
8299
`--jsd-threshold` *JSD_THRESHOLD*
83-
: Jensen-Shannon divergence threshold that is sufficient to stop searching for more watermarks (default: 55%).
100+
: Jensen-Shannon divergence threshold that is sufficient to stop searching for more watermarks (default: 55%).
101+
84102
`--cornersync` {`on`,`off`,`auto`}
85-
: Set cornersync aided detection mode: 'on' forces it, 'off' disables it, 'auto' is the default.
103+
: Set cornersync aided detection mode: 'on' forces it, 'off' disables it, 'auto' is the default.
104+
86105
`--perspective`
87-
: Search for optimal perspective grids (default: False).
106+
: Search for optimal perspective grids (default: False).
107+
88108
`--original` *ORIGINAL*
89-
: Use original image for detection (default: ).
109+
: Use original image for detection (default: ).
110+
90111
`-v`, `--verbose`
91-
: Increase output messages or debugging info for multiple `-vv` (default: 0).
112+
: Increase output messages or debugging info for multiple `-vv` (default: 0).
113+
92114
`-q`, `--quiet`
93-
: Reduce output verbosity (default: None).
115+
: Reduce output verbosity (default: None).
116+
94117
`--strength` *STRENGTH*
95-
: Strength for embedded watermark (default: 2).
118+
: Strength for embedded watermark (default: 2).
119+
96120
`-P` *PLOTS*
97-
: Configure plots with colon separated keywords, 'most' or 'all' (default: None).
121+
: Configure plots with colon separated keywords, 'most' or 'all' (default: None).
122+
98123
`--key` *KEY*
99-
: Load watermarking key from file (default: None).
124+
: Load watermarking key from file (default: None).
125+
100126
`--test-key` *TEST_KEY*
101-
: Watermarking key (default: None).
127+
: Watermarking key (default: None).
102128

103129
## Generate Key Files
104130
**gen-key** [`-h`] [`-v`] [`-q`] *OUTPUT_KEY_FILE*
@@ -108,11 +134,13 @@ Generate a 128-bit watermarking key and write the result in hexadecimals into *O
108134
**Command Options:**
109135

110136
`-h`, `--help`
111-
: Show this help message and exit.
137+
: Show this help message and exit.
138+
112139
`-v`, `--verbose`
113-
: Increase output messages or debugging info for multiple `-vv` (default: 0).
140+
: Increase output messages or debugging info for multiple `-vv` (default: 0).
141+
114142
`-q`, `--quiet`
115-
: Reduce output verbosity (default: None).
143+
: Reduce output verbosity (default: None).
116144

117145

118146
# EXAMPLES

tests/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ extract/%.json: attack/%
135135
.NOTINTERMEDIATE: $(EXTRACT_FILES)
136136

137137
# == pandoc rules ==
138-
REPORT_FORMAT := markdown+compact_definition_lists+autolink_bare_uris+emoji+lists_without_preceding_blankline-smart-raw_tex-raw_html
138+
REPORT_FORMAT := markdown+autolink_bare_uris+emoji+lists_without_preceding_blankline-smart-raw_tex-raw_html
139139
%.html: %.md $(MAKEFILE)
140140
$(QGEN)
141141
$Q pandoc -f "$(REPORT_FORMAT)" $< -o $@.tmp.html

0 commit comments

Comments
 (0)