add -h flag to help dialogue

add -h flag to Use section in README

update example markdown in README
This commit is contained in:
onyx-and-iris 2024-06-28 03:04:14 +01:00
parent 49604b874b
commit 0bda368f59
2 changed files with 15 additions and 5 deletions

View File

@ -12,10 +12,13 @@
## `Use` ## `Use`
`./vmrcli.exe [-i] [-k] [-D] <api commands>` ```powershell
./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>
```
Where: Where:
- `h`: Prints the help dialogue.
- `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored. - `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored.
- `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI. - `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI.
- `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL - `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL
@ -30,17 +33,23 @@ Examples:
Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, then print its new value Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, then print its new value
`./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute` ```powershell
./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute
```
Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
`./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label` ```powershell
./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
```
## `Interactive Mode` ## `Interactive Mode`
Running the following command in Powershell: Running the following command in Powershell:
`./vmrcli.exe -i` ```powershell
./vmrcli.exe -i
```
Will open an interactive prompt: Will open an interactive prompt:

View File

@ -112,8 +112,9 @@ int main(int argc, char *argv[])
void help() void help()
{ {
puts( puts(
"Usage: ./vmrcli.exe [-i] [-k] [-D] <api commands>\n" "Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>\n"
"Where: \n" "Where: \n"
"\th: Prints the help dialogue\n"
"\ti: Enable interactive mode\n" "\ti: Enable interactive mode\n"
"\tk: The kind of Voicemeeter (basic, banana, potato)\n" "\tk: The kind of Voicemeeter (basic, banana, potato)\n"
"\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL"); "\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL");