From 91951afb0d43f41d904621d00bcb9b75b6bf6704 Mon Sep 17 00:00:00 2001 From: Peter Stuifzand Date: Wed, 5 Aug 2020 19:20:24 +0200 Subject: [PATCH 1/5] Add documentation for auto_restart --- docs/configuration.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/configuration.md b/docs/configuration.md index 67b92e3..302d61f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -171,6 +171,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, `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 +`auto_restart` | Restart when the configuration changes | `true`/`false` | `true` | No `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 From a8a3496ab759c00462d1e3923a18142ce9c8eba5 Mon Sep 17 00:00:00 2001 From: Brady Joslin Date: Fri, 7 Aug 2020 00:00:59 -0500 Subject: [PATCH 2/5] Update mac.md --- install/mac.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/install/mac.md b/install/mac.md index 9051ae5..4a2661a 100644 --- a/install/mac.md +++ b/install/mac.md @@ -28,6 +28,41 @@ espanso --version At this point, you have to [Enable Accessibility](#enabling-accessibility) to use espanso. +### Manually + +Download `espanso-mac.tar.gz` from the [Releases page](https://github.com/federico-terzi/espanso/releases): + +``` +curl -sOL https://github.com/federico-terzi/espanso/releases/latest/download/espanso-mac.tar.gz +``` + +Extract the binary: + +``` +tar -xzf espanso-mac.tar.gz +``` + +Create a folder to house the binary: + +``` +sudo mkdir -p /usr/local/espanso/bin +sudo cp espanso /usr/local/espanso/bin/espanso +``` + +Create a symbolic link in your `/usr/local/bin` folder: + +``` +sudo ln -s /usr/local/espanso/bin/espanso /usr/local/bin +``` + +To make sure that espanso was correctly installed, you can open a terminal and type: + +``` +espanso --version +``` + +At this point, you have to [Enable Accessibility](#enabling-accessibility) to use espanso. + ### Enabling Accessibility Because espanso uses the macOS [Accessibility API](https://developer.apple.com/library/archive/documentation/Accessibility/Conceptual/AccessibilityMacOSX/) @@ -60,4 +95,4 @@ If everything goes well, you should see the espanso icon appear in the status ba If you now type `:espanso` in any text field, you should see "Hi there!" appear! -At this point, you are ready to read the [Getting Started](/docs/get-started/) tutorial. \ No newline at end of file +At this point, you are ready to read the [Getting Started](/docs/get-started/) tutorial. From 32aa2a205b35d7ad28e6ec04ee9bc04370da91c4 Mon Sep 17 00:00:00 2001 From: Brady Joslin Date: Sat, 8 Aug 2020 17:24:41 -0500 Subject: [PATCH 3/5] Remove espanso-bin from the list of AUR packages --- install/linux.md | 1 - 1 file changed, 1 deletion(-) diff --git a/install/linux.md b/install/linux.md index d59f99d..5aa6524 100644 --- a/install/linux.md +++ b/install/linux.md @@ -121,7 +121,6 @@ but you can also install it manually from the [prebuilt executables](#installing The official way to install espanso on Arch-based systems is by using one of the AUR packages, currently maintained by [Scrumplex](https://scrumplex.net/). There are multiple options available: * [espanso](https://aur.archlinux.org/packages/espanso/) - Builds from the latest (stable) release. -* [espanso-bin](https://aur.archlinux.org/packages/espanso-bin/) - Pre-compiled version for x64 systems. * [espanso-git](https://aur.archlinux.org/packages/espanso-git/) - Builds from latest commit ( in master branch ). When you are ready, you can install espanso with: From 55734296a386bd45057caed35d503a3329596008 Mon Sep 17 00:00:00 2001 From: Brady Joslin Date: Sat, 8 Aug 2020 17:43:08 -0500 Subject: [PATCH 4/5] Document SecureInput notification on macOS --- docs/configuration.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index 302d61f..0dcd821 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -164,6 +164,14 @@ Detected change, current window has properties: These are the parameters espanso detected for your target application, so you can now use them to create the perfect filter. +### macOS Notification for SecureInput + +On macOS there is a security feature known as `SecureInput`, which blocks text expanders from detecting input when entering text in sensitive areas, such as password fields (but also other apps, even the Terminal if configured). + +As a result, espanso will not work in those situations, and espanso will trigger a notification (as well as logging it) to warn the user if an app triggers SecureInput. If you want to disable the notification, just add the following line in your config file: + +`secure_input_notification: false` + ### Options Here's a list of all options available for the configuration file: @@ -182,4 +190,4 @@ Option | Description | Possible Values | Default | App-Specific `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 \ No newline at end of file +`show_notifications` | Show/Hide the notifications| `true`/`false` | `true` | No From a8f474af4ed4632634144e2153311eb1c4f55821 Mon Sep 17 00:00:00 2001 From: Brady Joslin Date: Sat, 8 Aug 2020 18:01:48 -0500 Subject: [PATCH 5/5] Update trimming the output documentation --- docs/matches.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/matches.md b/docs/matches.md index f88eac4..7575ca6 100644 --- a/docs/matches.md +++ b/docs/matches.md @@ -405,8 +405,8 @@ This extension also supports bash **pipes** as your shell, such as: #### Trimming the output -When working with commands, it's very common to have outputs that also spawn a newline at the end. If you want to remove any -excess spaces/newlines, you can use the `trim` option: +It's very common for commands to have outputs that also spawn a newline at the end. By default a trim option is enabled to remove any +excess spaces/newlines. You can optionally disable the `trim` option: {% raw %} ```yml @@ -417,7 +417,7 @@ excess spaces/newlines, you can use the `trim` option: type: shell params: cmd: "ip a | grep 'inet 192' | awk '{ print $2 }'" - trim: true + trim: false ``` {% endraw %}