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

Fix #75 and Fix #73

Browse Source
This commit is contained in:
Federico Terzi 2019-10-12 14:22:08 +02:00
parent 43c7ef6d3b
commit bc90f742c3
2 changed files with 24 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/configuration.md
View File

@ -9,18 +9,22 @@ such as [Dropbox](https://www.dropbox.com/) or [Google Drive](https://www.google
### Structure
All espanso configurations reside in a folder called `.espanso`, located in the user home directory.
The path of the home directory depends on the Operating System, here's a few examples:
* Windows: `C:\Users\Federico\.espanso\`
* Mac: `/Users/Federico/.espanso/`
* Linux: `/home/federico/.espanso/`
All espanso configurations reside in a folder called `espanso`, whose location varies between Operating Systems:
* Linux: `$XDG_CONFIG_HOME/espanso` (e.g. `/home/user/.config/espanso`)
* macOS: `$HOME/Library/Preferences/espanso` (e.g. `/Users/user/Library/Preferences/espanso`)
* Windows: `{FOLDERID_RoamingAppData}\espanso` (e.g. `C:\Users\user\AppData\Roaming\espanso`)
After installing espanso, the `.espanso` directory will contain the following file structure:
A quick way to find the path of your configuration folder is by using the following command:
```
espanso path
```
The `espanso` directory will contain the following file structure:
```
- default.yml
- user/
- packages/
```
The `default.yml` file contains the **main configurations** and for a basic usage, this is the only file
@ -28,9 +32,6 @@ you will be working with. You can find a list of all the possible options in the
The `user` folder is used to store more advanced user configurations, such as [Application-specific](#application-specific-configurations) configs.
The `packages` folder stores packages installed using the *package manager* and should not be directly modified
by the user. For more information, check out the [Packages](/docs/packages) section of the documentation.
### Application-Specific Configurations
Sometimes you may need to make espanso behave **differently** with some applications. For example, you may want to have
@ -42,7 +43,7 @@ only for some applications which match specific **filters**.
Let's say you want to add some Matches for emojis, but only when using the Telegram desktop app.
You can create a `telegram.yml` file in the `.espanso/user` folder, with the following content:
You can create a `telegram.yml` file in the `espanso/user` folder, with the following content:
```yml
filter_title: "Telegram"
@ -101,7 +102,7 @@ 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` | Yes
`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
`backspace_limit` | How many backspace espanso tracks to correct misspelled keywords | int | `3` | No
`disabled` | Set the current configuration as disabled | `True`/`False` | `False` | Yes
`parent` | The target for the current configuration file, mainly used in packages | string | `self` | Yes

16
docs/get-started.md
View File

@ -45,10 +45,16 @@ in two ways: creating your own **custom matches** or **installing packages**. Bo
### Configuration
espanso uses a **file-based configuration** approach, following the Unix philosophy. All configuration files
reside in the `.espanso` directory, located in **user's home** directory. The path depends on the current OS, for example:
* Windows: `C:\Users\Federico\.espanso\`
* Mac: `/Users/Federico/.espanso/`
* Linux: `/home/federico/.espanso/`
reside in the `espanso` directory, whose location depends on the current OS:
* Linux: `$XDG_CONFIG_HOME/espanso` (e.g. `/home/user/.config/espanso`)
* macOS: `$HOME/Library/Preferences/espanso` (e.g. `/Users/user/Library/Preferences/espanso`)
* Windows: `{FOLDERID_RoamingAppData}\espanso` (e.g. `C:\Users\user\AppData\Roaming\espanso`)
A quick way to find the path of your configuration folder is by using the following command:
```
espanso path
```
While this folder may contain many different files, let's focus on the most important one: `default.yml`.
@ -123,7 +129,7 @@ We're almost there! After every configuration change, **espanso must be restarte
espanso restart
```
Now try to type `:bs` anywhere. If you did everything correctly, you should see `Best Regards` appear!
Now try to type `:br` anywhere. If you did everything correctly, you should see `Best Regards` appear!
### Understanding Packages