Dennis/footswitch-rs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update page 'Home'

Dennis Potter 2018-11-27 18:52:51 +01:00
parent 2e67cfb2c2
commit 9fa55426e7
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Home.md

@ -7,7 +7,7 @@
* [The `append` subcommand](#the-append-subcommand)
* [Clearing pedals](#clearing-pedals)
* [Common problems](#common-problems)
* [Invalid combination of options!](#invalid-combination-of-options)
* [Error: Invalid combination of options!](#error-invalid-combination-of-options)
---
@ -79,10 +79,7 @@ SUBCOMMANDS:
mousemovement Set X, Y, and W movement of the mouse pointer for one or more pedals
```
For every set subcommand, one or more pedals must be defined according to: `footswitch-rs set <SUBCOMMAND> -p [0 | 1 | 2]`. Furthermore, the value that should be set must be provided with the `-i` option.
For every set subcommand, one or more pedals must be defined according to: `footswitch-rs set <SUBCOMMAND> -p [0 | 1 | 2]`. Furthermore, the value that should be set must be provided with the `-i` option (in case of `key` and `mousebutton`) or the `-x`, `-y`, and `-w` options (in case of `mousemovement`). More information on the possible values in the table below:
| Subcommand | Option(s) | Possible values for option(s) |
| --------------- | -------------------- | -------------------------------------- |
@ -90,6 +87,8 @@ For every set subcommand, one or more pedals must be defined according to: `foot
| `mousebutton` | `-i` | [left \| right \| middle \| double] |
| `mousemovement` | `-x`, `-y`, and `-w` | any integer between -128 and 127 |
When using `set` on a pedal, its content will be overwritten.
Below, a few examples
```bash
@ -106,7 +105,6 @@ sudo footswitch-rs set mousebutton -p 0 -i double
sudo footswitch-rs set mousemovement -p 0 -x 100 -y 100 -w 0
```
### The `append` subcommand
The help function `footswitch-rs append --help` yields te following information (omitted redundant information):
```bash
@ -120,6 +118,16 @@ SUBCOMMANDS:
string Append a string to one or more pedals
```
For every set subcommand, one or more pedals must be defined according to: `footswitch-rs append <SUBCOMMAND> -p [0 | 1 | 2]`. Furthermore, the value that should be set must be provided with the `-i` option.
| Subcommand | Option(s) | Possible values for option(s) |
| ---------- | --------- | -------------------------------------- |
| `key` | `-i` | any key name from `footswitch-rs list` |
| `modifier` | `-i` | [ctrl \| shift \| alt \| win] |
| `string` | `-i` | any string |
When using `append` on a pedal, the value that is defined in `-i` will be appended to the pedal's existing content. However, not all combinations are possible! For example, a modifier cannot be appended to a key that is set with `footswitch-rs append key`, but only to a key that is set with `footswitch-rs set key`.
## 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):
@ -134,7 +142,7 @@ OPTIONS:
Thus, to clear pedals (e.g., 1 and 2), run: `footswitch-rs clear -p 1 2`.
## Common problems
### Invalid combination of options!
### Error: Invalid combination of options!
This error can only occur with the `append` subcommand. footswitch-rs can set the foot pedal into three different modes:
```rust