Skip to content

Commit abf3704

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

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Output directory where compressed files are stored. Only relevant when the `--ba
111111

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

114-
Output format used to compress the images read from the directory specified with `-batch_src`. Required when `-batch_src` option is used. Supported formats are `J2K`, `J2C`,`JP2`, `JHC` and `JPH`.
114+
Output format used to compress the images read from the directory specified with `--batch-src`. Required when `--batch-src` option is used. Supported formats are `J2K`, `J2C`,`JP2`, `JHC` and `JPH`.
115115

116116
`-K, --in-fmt [pbm|pgm|ppm|pnm|pam|pgx|png|bmp|tif|raw|rawl|jpg]`
117117

doc/man/md/man1/grk_decompress.1.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Limitations
3232

3333
stdout
3434

35-
The decompresser can write output to `stdout` for the following formats: `BMP`,`PNG`, `JPG`, `PNM`, `RAW` and `RAWL`. To enable writing to `stdout`, please ensure that the `-o` parameter is **not** present in the command line, and that the `-out_fmt` parameter is set to one of the supported formats listed above. Note: the verbose flag `-v` will be ignored in this mode, as verbose output would corrupt the output file.
35+
The decompresser can write output to `stdout` for the following formats: `BMP`,`PNG`, `JPG`, `PNM`, `RAW` and `RAWL`. To enable writing to `stdout`, please ensure that the `-o` parameter is **not** present in the command line, and that the `--out-fmt` parameter is set to one of the supported formats listed above. Note: the verbose flag `-v` will be ignored in this mode, as verbose output would corrupt the output file.
3636

3737
Embedded ICC Profile
3838

@@ -69,23 +69,23 @@ Output information and warnings about decoding to console (errors are always out
6969

7070
`-i, --in-file [file]`
7171

72-
Input file. Either this argument or the `-batch_src` argument described below is required. Valid input image extensions are J2K, JP2 and JPC. When using this option output file must be specified using -o.
72+
Input file. Either this argument or the `--batch-src` argument described below is required. Valid input image extensions are J2K, JP2 and JPC. When using this option output file must be specified using -o.
7373

7474
`-o, --out-file [file]`
7575

7676
Output file. Required when using `-i` option. See above for supported file types. If a `PGX` filename is given, there will be as many output files as there are components: an index starting from 0 will then be appended to the output filename, just before the `pgx` extension. If a `PGM` filename is given and there is more than one component, then only the first component will be written to the file.
7777

7878
`-y, --batch-src [directory path]`
7979

80-
Path to the folder where the compressed images are stored. Either this argument or the `-i` argument described above is required. When image files are in the same directory as the executable, this can be indicated by a dot `.` argument. When using this option, the output format must be specified using `-out_fmt`. Output images are saved in the same folder.
80+
Path to the folder where the compressed images are stored. Either this argument or the `-i` argument described above is required. When image files are in the same directory as the executable, this can be indicated by a dot `.` argument. When using this option, the output format must be specified using `--out-fmt`. Output images are saved in the same folder.
8181

8282
`-a, --out-dir [output directory]`
8383

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

8686
`-O, --out-fmt [format]`
8787

88-
Output format used to decompress the code streams. Required when `-batch_src` option is used. See above for supported formats.
88+
Output format used to decompress the code streams. Required when `--batch-src` option is used. See above for supported formats.
8989

9090
`-r, --reduce [reduce factor]`
9191

0 commit comments

Comments
 (0)