Skip to content

Commit ac35ade

Browse files
committed
Update list of options in README.
1 parent 227dfbd commit ac35ade

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,16 @@ kpp-tool [FLAGS] [KPP_FILE]
1717
where `KPP_FILE` is the path to a preset file. If no path is provided,
1818
the program will attempt to read a file from `stdin`.
1919

20-
There are generally two kinds of command line flags:
20+
There are generally three kinds of command line flags:
2121

22-
1. Operation flags correspond to specific actions the program can take
22+
1. Mode flags select special alternative program modes like "help
23+
mode" or "dump xml mode". Only one mode can be selected for a given
24+
program invocation.
25+
2. Operation flags correspond to specific actions the program can take
2326
with a preset, such as looking up properties or changing the
2427
preset's name. These flags are executed in the order they are
2528
provided.
26-
2. Global flags configure global program settings that affect all
29+
3. Global flags configure global program settings that affect all
2730
operations, like enabling overwrite mode. The position and order of
2831
these flags does not matter - they can appear anywhere on the
2932
command line.
@@ -69,15 +72,21 @@ $ kpp-tool --set-param CompositeOp=string:multiply \
6972
--set-param CompositeOp=string:soft_light_svg \
7073
--output preset_softlight.kpp \
7174
preset.kpp
75+
76+
# Extract the raw XML settings document from a preset file.
77+
$ kpp-tool --dump-xml preset.kpp
7278
```
7379

7480
## Options
7581

7682
The full list of supported command line flags is as follows:
7783

84+
### Modes
85+
7886
```
7987
-h --help Display help and usage information.
8088
-v --version Display version information.
89+
-d PATH --dump-xml=PATH Dump a preset's XML settings to standard output.
8190
```
8291

8392
### Global Options
@@ -98,16 +107,20 @@ The full list of supported command line flags is as follows:
98107
-S --sync-name Change a preset's metadata name to match it's filename.
99108
For example, 'kpp-tool --sync-name foobar.kpp' will change
100109
the preset's name to "foobar".
110+
-l --list-params Print a table of all parameters.
101111
-p KEY --get-param=KEY Print the value of a single parameter.
102112
-P KEY=TYPE:VALUE --set-param=KEY=TYPE:VALUE Set the value of a parameter.
103113
TYPE can be 'string', 'internal', or 'binary'.
104114
For binary parameters, VALUE should be encoded in base-64.
115+
-r --list-resources Print a table of all embedded resources.
105116
-x KEY=VALUE[,...] --extract=KEY=VALUE[,...] Extract an embedded resource.
106-
-X --extract-all Extract all embedded resources.
117+
-X[DIR] --extract-all[=DIR] Extract all embedded resources.
118+
If the optional directory path argument is provided,
119+
the extracted files will be placed in DIR.
107120
-e KEY=VALUE[,...] --embed=KEY=VALUE[,...] Insert or update a resource file.
108121
-c PATH --get-icon=PATH Extract a preset's PNG icon image.
109122
-C PATH --set-icon=PATH Change a preset's icon image.
110-
FILE must be a PNG file.
123+
FILE must be a PNG or KPP file.
111124
```
112125

113126
# Building

0 commit comments

Comments
 (0)