Skip to content

Commit 90f0bb4

Browse files
author
Grok Compression
committed
CLI: fix more typos
1 parent ea1f08c commit 90f0bb4

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

doc/man/man1/grk_compress.1

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Default is false i.e.\ console is silent by default.
141141
\f[V]-i, --in-file [file]\f[R]
142142
.PP
143143
Input file.
144-
Either this argument or the \f[V]-batch_src\f[R] argument described
144+
Either this argument or the \f[V]--batch-src\f[R] argument described
145145
below is required.
146146
See above for supported input formats.
147147
.IP \[bu] 2
@@ -184,14 +184,14 @@ When using this option, output format must be specified using
184184
\f[V]-a, --out-dir [output directory]\f[R]
185185
.PP
186186
Output directory where compressed files are stored.
187-
Only relevant when the \f[V]-batch_src\f[R] flag is set.
187+
Only relevant when the \f[V]--batch-src\f[R] flag is set.
188188
Default: same directory as specified by \f[V]-y\f[R].
189189
.PP
190190
\f[V]-O, --out-fmt [J2K|J2C|JPC|JP2|JHC|JPH]\f[R]
191191
.PP
192192
Output format used to compress the images read from the directory
193-
specified with \f[V]-batch_src\f[R].
194-
Required when \f[V]-batch_src\f[R] option is used.
193+
specified with \f[V]--batch-src\f[R].
194+
Required when \f[V]--batch-src\f[R] option is used.
195195
Supported formats are \f[V]J2K\f[R], \f[V]J2C\f[R],\f[V]JP2\f[R],
196196
\f[V]JHC\f[R] and \f[V]JPH\f[R].
197197
.PP

doc/man/man1/grk_decompress.1

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ formats: \f[V]BMP\f[R],\f[V]PNG\f[R], \f[V]JPG\f[R], \f[V]PNM\f[R],
6262
\f[V]RAW\f[R] and \f[V]RAWL\f[R].
6363
To enable writing to \f[V]stdout\f[R], please ensure that the
6464
\f[V]-o\f[R] parameter is \f[B]not\f[R] present in the command line, and
65-
that the \f[V]-out_fmt\f[R] parameter is set to one of the supported
65+
that the \f[V]--out-fmt\f[R] parameter is set to one of the supported
6666
formats listed above.
6767
Note: the verbose flag \f[V]-v\f[R] will be ignored in this mode, as
6868
verbose output would corrupt the output file.
@@ -122,7 +122,7 @@ Console is silent by default.
122122
\f[V]-i, --in-file [file]\f[R]
123123
.PP
124124
Input file.
125-
Either this argument or the \f[V]-batch_src\f[R] argument described
125+
Either this argument or the \f[V]--batch-src\f[R] argument described
126126
below is required.
127127
Valid input image extensions are J2K, JP2 and JPC.
128128
When using this option output file must be specified using -o.
@@ -146,19 +146,19 @@ required.
146146
When image files are in the same directory as the executable, this can
147147
be indicated by a dot \f[V].\f[R] argument.
148148
When using this option, the output format must be specified using
149-
\f[V]-out_fmt\f[R].
149+
\f[V]--out-fmt\f[R].
150150
Output images are saved in the same folder.
151151
.PP
152152
\f[V]-a, --out-dir [output directory]\f[R]
153153
.PP
154154
Output directory where compressed files are stored.
155-
Only relevant when the \f[V]-batch_src\f[R] flag is set.
156-
Default: same directory as specified by \f[V]-batch_src\f[R].
155+
Only relevant when the \f[V]--batch-src\f[R] flag is set.
156+
Default: same directory as specified by \f[V]--batch-src\f[R].
157157
.PP
158158
\f[V]-O, --out-fmt [format]\f[R]
159159
.PP
160160
Output format used to decompress the code streams.
161-
Required when \f[V]-batch_src\f[R] option is used.
161+
Required when \f[V]--batch-src\f[R] option is used.
162162
See above for supported formats.
163163
.PP
164164
\f[V]-r, --reduce [reduce factor]\f[R]

doc/man/md/man1/grk_compress.1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Output information and warnings about encoding to console (errors are always out
8989

9090
`-i, --in-file [file]`
9191

92-
Input file. Either this argument or the `-batch_src` argument described below is required. See above for supported input formats.
92+
Input file. Either this argument or the `--batch-src` argument described below is required. See above for supported input formats.
9393

9494
* `PNG` requires `libpng` while `TIF/TIFF` requires `libtiff`
9595
* `JPG` requires `libjpeg` (or `libjpeg-turbo`), and only 8 bit precision is supported
@@ -107,7 +107,7 @@ Path to the folder where the images to be compressed are stored. Either this arg
107107

108108
`-a, --out-dir [output directory]`
109109

110-
Output directory where compressed files are stored. Only relevant when the `-batch_src` flag is set. Default: same directory as specified by `-y`.
110+
Output directory where compressed files are stored. Only relevant when the `--batch-src` flag is set. Default: same directory as specified by `-y`.
111111

112112
`-O, --out-fmt [J2K|J2C|JPC|JP2|JHC|JPH]`
113113

src/lib/codec/jp2/GrkCompress.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ static void compress_help_display(void)
368368
"Color Transformation (ICT) in place of the Reversible Color Transformation (RCT)\n");
369369
fprintf(stdout, "and the irreversible DWT 9-7 in place of the 5-3 filter. Default: off.\n");
370370
fprintf(stdout, "\n");
371-
fprintf(stdout, " `-p, -progression_order` [progression order]\n");
371+
fprintf(stdout, " `-p, --progression-order` [progression order]\n");
372372
fprintf(stdout, "\n");
373373
fprintf(stdout, "Progression order. The five progression orders are : `LRCP`, `RLCP`, `RPCL`,\n");
374374
fprintf(stdout, "`PCRL` and `CPRL`. Default: `LRCP`.\n");
@@ -1089,7 +1089,7 @@ GrkRC GrkCompress::parseCommandLine(int argc, char* argv[], CompressInitParams*
10891089
auto licenseOpt = app.add_option("-j,--license", license, "License");
10901090
auto serverOpt = app.add_option("-J,--server", server, "Server");
10911091
auto kernelBuildOptionsOpt =
1092-
app.add_option("-k,--kernel_build", kernelBuildOptions, "Kernel build options")
1092+
app.add_option("-k,--kernel-build", kernelBuildOptions, "Kernel build options")
10931093
->default_val(0);
10941094
auto inputFormatOpt = app.add_option("-K,--in-fmt", inputFormat, "Input format");
10951095
auto durationOpt =
@@ -1104,7 +1104,7 @@ GrkRC GrkCompress::parseCommandLine(int argc, char* argv[], CompressInitParams*
11041104
auto outputFileOpt = app.add_option("-o,--out-file", outputFile, "Output file");
11051105
auto outputFormatOpt = app.add_option("-O,--out-fmt", outputFormat, "Output format");
11061106
auto progressionOrderOpt =
1107-
app.add_option("-p,--progression_order", progressionOrder, "Progression order");
1107+
app.add_option("-p,--progression-order", progressionOrder, "Progression order");
11081108
auto pocOpt = app.add_option("-P,--poc", poc, "Progression order changes");
11091109
auto qualityOpt = app.add_option("-q,--quality", quality, "Layer rates expressed as quality");
11101110
auto captureResOpt = app.add_option("-Q,--capture-res", captureRes, "Capture resolution");

0 commit comments

Comments
 (0)