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

Update page 'Home'

Dennis Potter 2018-11-27 19:03:05 +01:00
parent 9fa55426e7
commit e9203a7b6a
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Home.md

@ -89,7 +89,7 @@ For every set subcommand, one or more pedals must be defined according to: `foot
When using `set` on a pedal, its content will be overwritten. When using `set` on a pedal, its content will be overwritten.
Below, a few examples #### Examples
```bash ```bash
# Set pedal 0 to 'a' # Set pedal 0 to 'a'
@ -126,7 +126,20 @@ For every set subcommand, one or more pedals must be defined according to: `foot
| `modifier` | `-i` | [ctrl \| shift \| alt \| win] | | `modifier` | `-i` | [ctrl \| shift \| alt \| win] |
| `string` | `-i` | any string | | `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`. 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` (see [Error: Invalid combination of options!](error-invalid-combination-of-options)).
#### Examples
```bash
# Set several keys to the same pedal
sudo footswitch-rs append key -p 0 -i a -p 0 -i b -p 0 -i c
# Set ctrl + alt + del to a pedal
sudo footswitch-rs set key -p 0 -i del
sudo footswitch-rs append modifier -p 0 -i ctrl -p 0 -i alt
# Append a string to a pedal
sudo footswitch-rs append string -p 0 -i 'Hello World'
```
## Clearing 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): 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):