Update page 'Home'

master
Dennis Potter 4 years ago
parent 20925697b5
commit 2e67cfb2c2
  1. 37
      Home.md

@ -66,6 +66,8 @@ OPTIONS:
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
The help function `footswitch-rs set --help` yields te following information (omitted redundant information):
```bash
USAGE:
footswitch-rs set <SUBCOMMAND>
@ -76,8 +78,37 @@ SUBCOMMANDS:
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
```
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.
| Subcommand | Option(s) | Possible values for option(s) |
| --------------- | -------------------- | -------------------------------------- |
| `key` | `-i` | any key name from `footswitch-rs list` |
| `mousebutton` | `-i` | [left \| right \| middle \| double] |
| `mousemovement` | `-x`, `-y`, and `-w` | any integer between -128 and 127 |
Below, a few examples
```bash
# Set pedal 0 to 'a'
sudo footswitch-rs set key -p 0 -i a
# Set pedal 0 to 'a', pedal 1 to 'b', pedal 2 to '<esc>'
sudo footswitch-rs set key -p 0 -i a -p 1 -i b -p 2 -i esc
# Set pedal 0 to a double click
sudo footswitch-rs set mousebutton -p 0 -i double
# Set pedal 0 to a mouse movement of x=100, y=100, w=0
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
USAGE:
footswitch-rs append <SUBCOMMAND>
@ -118,4 +149,6 @@ enum Type {
When appending something to a pedal, the application checks if this is valid. Obviously, this has not been the case when this error occurs.
This error often occurs when somenone tries to add a modifier (`footswitch-rs append modifier`) to one or more keys that were added with `footswitch-rs append key` instead of `footswitch-rs set key`. In the former case, the type of the key(s) is set to `Type::String`. In the latter case it is set to `Type::Key`. However, to append a modifier, `Type::Key` is required.
This error often occurs when somenone tries to add a modifier (`footswitch-rs append modifier`) to one or more keys that were added with `footswitch-rs append key` instead of `footswitch-rs set key`. In the former case, the type of the key(s) is set to `Type::String`. In the latter case it is set to `Type::Key`. However, to append a modifier, `Type::Key` is required.
In the previously mentioned case, a solution would be to clear the pedal, set a key with `footswitch-rs set`, and subsequently append the modifier(s).
Loading…
Cancel
Save