open.source/espanso
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the docs

Browse Source
This commit is contained in:
Federico Terzi 2020-05-01 19:56:03 +02:00
parent e588dc8515
commit 02fed5df25
3 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/configuration.md
View File

@ -2,7 +2,7 @@
title: Configuration
layout: docs
---
Following a Unix-like philosophy, **espanso uses files to manage it's configuration**
Following a Unix-like philosophy, **espanso uses files to manage its configuration**
instead of GUIs. This has many advantages, such as the capability to easily sync your
configurations between machines using [Git](https://git-scm.com/) or cloud services
such as [Dropbox](https://www.dropbox.com/) or [Google Drive](https://www.google.com/drive/).
@ -170,12 +170,15 @@ Here's a list of all options available for the configuration file:
Option | Description | Possible Values | Default | App-Specific
--- | --- | --- | --- | ---
`backend` | The typing engine used. `Inject` simulate keypresses, `Clipboard` simulates a copy/paste | `Clipboard` or `Inject` | `Inject` on Win and macOS, `Clipboard` on Linux | Yes
`backend` | The typing engine used. `Inject` simulate keypresses, `Clipboard` simulates a copy/paste, `Auto` is available on Linux only and combines the two previous. | `Clipboard`, `Inject` or `Auto` (Linux only) | `Inject` on Win and macOS, `Auto` on Linux | Yes
`backspace_limit` | How many backspace espanso tracks to correct misspelled keywords | int | `3` | No
`enable_active` | Disable the active mode for the current configuration | `True`/`False` | `True` | Yes
`enable_passive` | Disable the passive mode for the current configuration | `True`/`False` | `False` | Yes
`enable_active` | Disable the active mode for the current configuration | `true`/`false` | `true` | Yes
`enable_passive` | Disable the passive mode for the current configuration | `true`/`false` | `false` | Yes
`parent` | The target for the current configuration file, mainly used in packages | string | `self` | Yes
`ipc_server_port` | Windows only. Set the daemon listening port | int | `34982` | No
`exclude_default_entries` | Used in app-specific configs, avoid parent matches and global variables | `True`/`False` | `False` | Yes
`toggle_key` | Change the key used to toggle espanso active mode | `CTRL`, `ALT`, `SHIFT`, `META` | `ALT` | No
`passive_key` | Change the key used to trigger passive mode | `CTRL`, `ALT`, `SHIFT`, `META` | `OFF` | No
`exclude_default_entries` | Used in app-specific configs, avoid parent matches and global variables | `true`/`false` | `false` | Yes
`toggle_key` | Change the key used to toggle espanso active mode | `CTRL`, `ALT`, `SHIFT`, `META`, `LEFT_CTRL`, `LEFT_ALT`, `LEFT_SHIFT`, `LEFT_META`, `RIGHT_CTRL`, `RIGHT_ALT`, `RIGHT_SHIFT`, `RIGHT_META`, `OFF`| `ALT` | No
`passive_key` | Change the key used to trigger passive mode | `CTRL`, `ALT`, `SHIFT`, `META`, `LEFT_CTRL`, `LEFT_ALT`, `LEFT_SHIFT`, `LEFT_META`, `RIGHT_CTRL`, `RIGHT_ALT`, `RIGHT_SHIFT`, `RIGHT_META`, `OFF`| `OFF` | No
`secure_input_notification` | Enable/Disable the Secure Input notification on macOS | `true`/`false` | `true` | No
`show_icon` | Show/Hide the icon in the status bar on macOS and Windows | `true`/`false` | `true` | No
`show_notifications` | Show/Hide the notifications| `true`/`false` | `true` | No

2
docs/get-started.md
View File

@ -39,7 +39,7 @@ Matches are very flexible and powerful to solve many tasks. You can learn all ab
![Match](/assets/images/match2.png)
espanso ships with very few built-in Matches to give you the maximum flexibility, but you can expand it's capabilities
espanso ships with very few built-in Matches to give you the maximum flexibility, but you can expand its capabilities
in two ways: creating your own **custom matches** or **installing packages**. Both of these possibilities are introduced below.
### Configuration

10
docs/packages.md
View File

@ -27,6 +27,16 @@ Then don't forget to **restart** espanso using:
espanso restart
```
#### External Packages
Some packages (namely the bigger ones that would make the core repository too large) are now considered external, and espanso will block the installation by default, prompting the user to verify the source of the package (the repository).
In case the user wants to proceed with the installation, a the `--external` flag could be used:
```
espanso install <package> --external
```
#### From a Repository
Currently packages can only be installed from the [espanso hub](https://hub.espanso.org/), but direct