Update page 'Home'
parent
a427446333
commit
1a489e374b
41
Home.md
41
Home.md
@ -2,9 +2,9 @@
|
||||
* [Introduction](#introduction)
|
||||
* [Reading from the foot pedal](#reading-from-the-foot-pedal)
|
||||
* [Writing to the foot pedal](#writing-to-the-foot-pedal)
|
||||
* The `list` subcommand
|
||||
* The `set` subcommand
|
||||
* The `append` subcommand
|
||||
* [The `list` subcommand](#the-list-subcommand)
|
||||
* [The `set` subcommand](#the-set-subcommand)
|
||||
* [The `append` subcommand](#the-append-subcommand)
|
||||
* [Clearing pedals](#clearing-pedals)
|
||||
* [Common problems](#common-problems)
|
||||
|
||||
@ -52,10 +52,41 @@ OPTIONS:
|
||||
In other words, to acquire the settings of all pedals, run: `footswitch-rs read --all`. To acquire only information of specific pedals (e.g., 1 and 2), run: `footswitch-rs read -p 1 2`.
|
||||
## Writing to the foot pedal
|
||||
### The `list` subcommand
|
||||
The subcommand `footswitch-rs list` returns a table with all possible key names and the translated value that will be written to the foot pedal. The provided key names can be used together with `footswitch-rs set key` or `footswitch-rs append key`. The help function `footswitch-rs list --help` yields te following information (omitted redundant information):
|
||||
|
||||
```bash
|
||||
USAGE:
|
||||
footswitch-rs list --columns <columns>
|
||||
|
||||
OPTIONS:
|
||||
-c, --columns <columns> Specify the number of columns of the table
|
||||
```
|
||||
|
||||
The columns option is mandatory and sets the number of columns the table will use. That way, a user can make sure that the table fits his or her terminal.
|
||||
|
||||
### The `set` subcommand
|
||||
```bash
|
||||
USAGE:
|
||||
footswitch-rs set <SUBCOMMAND>
|
||||
|
||||
SUBCOMMANDS:
|
||||
help Prints this message or the help of the given subcommand(s)
|
||||
key Set a key value to one or more pedals
|
||||
mousebutton Set a mousebutton (left/right/middle/double) to one or more pedals
|
||||
mousemovement Set X, Y, and W movement of the mouse pointer for one or more pedals
|
||||
```
|
||||
|
||||
### The `append` subcommand
|
||||
```bash
|
||||
USAGE:
|
||||
footswitch-rs append <SUBCOMMAND>
|
||||
|
||||
SUBCOMMANDS:
|
||||
help Prints this message or the help of the given subcommand(s)
|
||||
key Append a key value to one or more pedals
|
||||
modifier Append a modifier (ctrl/shift/alt/win) to one or more pedals
|
||||
string Append a string to one or more pedals
|
||||
```
|
||||
|
||||
## Clearing pedals
|
||||
In contrast to the original implementation on [rgerganov/footswitch](https://github.com/rgerganov/footswitch), this implementation does not clear foot pedals if they are not explicitly set during a write operation. To clear the configuration of a pedal, a separate function has to be explicitly invoked. The help function `footswitch-rs clear --help` yields te following information (omitted redundant information):
|
||||
@ -69,3 +100,7 @@ OPTIONS:
|
||||
```
|
||||
|
||||
Thus, to clear pedals (e.g., 1 and 2), run: `footswitch-rs clear -p 1 2`.
|
||||
|
||||
## Common problems
|
||||
#### Invalid combination of options!
|
||||
This error can only occur with the `append` subcommand.
|
Loading…
Reference in New Issue
Block a user