mirror of
https://github.com/onyx-and-iris/vmrcli.git
synced 2024-11-15 17:40:56 +00:00
add -h flag to help dialogue
add -h flag to Use section in README update example markdown in README
This commit is contained in:
parent
49604b874b
commit
0bda368f59
17
README.md
17
README.md
@ -12,10 +12,13 @@
|
||||
|
||||
## `Use`
|
||||
|
||||
`./vmrcli.exe [-i] [-k] [-D] <api commands>`
|
||||
```powershell
|
||||
./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>
|
||||
```
|
||||
|
||||
Where:
|
||||
|
||||
- `h`: Prints the help dialogue.
|
||||
- `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.
|
||||
- `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
|
||||
|
||||
`./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
|
||||
|
||||
`./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`
|
||||
|
||||
Running the following command in Powershell:
|
||||
|
||||
`./vmrcli.exe -i`
|
||||
```powershell
|
||||
./vmrcli.exe -i
|
||||
```
|
||||
|
||||
Will open an interactive prompt:
|
||||
|
||||
|
@ -112,8 +112,9 @@ int main(int argc, char *argv[])
|
||||
void help()
|
||||
{
|
||||
puts(
|
||||
"Usage: ./vmrcli.exe [-i] [-k] [-D] <api commands>\n"
|
||||
"Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>\n"
|
||||
"Where: \n"
|
||||
"\th: Prints the help dialogue\n"
|
||||
"\ti: Enable interactive mode\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");
|
||||
|
Loading…
Reference in New Issue
Block a user