|
|
|
|
@ -7,9 +7,6 @@ Also, please make sure to check the [Plover bug tracker](https://github.com/open
|
|
|
|
|
<!-- TOC -->
|
|
|
|
|
|
|
|
|
|
- [Running in Debug Mode](#running-in-debug-mode)
|
|
|
|
|
- [Windows](#windows)
|
|
|
|
|
- [Mac](#mac)
|
|
|
|
|
- [Linux (AppImage)](#linux-appimage)
|
|
|
|
|
- [Issues](#issues)
|
|
|
|
|
- [General](#general)
|
|
|
|
|
- [Plover does not recognize my USB keyboard or steno machine](#plover-does-not-recognize-my-usb-keyboard-or-steno-machine)
|
|
|
|
|
@ -38,20 +35,17 @@ Also, please make sure to check the [Plover bug tracker](https://github.com/open
|
|
|
|
|
|
|
|
|
|
# Running in Debug Mode
|
|
|
|
|
|
|
|
|
|
## Windows
|
|
|
|
|
Follow instructions in [Invoke Plover from the command line](https://github.com/openstenoproject/plover/wiki/Invoke-Plover-from-the-command-line). You need to invoke the command
|
|
|
|
|
|
|
|
|
|
1. Open Command Prompt or Powershell
|
|
|
|
|
2. Navigate the Plover's installation folder where you can find `plover.exe` and `plover_console.exe`
|
|
|
|
|
3. Type `start plover_console.exe --log-level debug`
|
|
|
|
|
```
|
|
|
|
|
plover --log-level debug
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Mac
|
|
|
|
|
In particular, the exact commands are
|
|
|
|
|
|
|
|
|
|
1. Open Terminal
|
|
|
|
|
2. Assuming Plover in installed in your applications folder, enter this into Terminal and hit enter: `/Applications/Plover.app/Contents/MacOS/Plover --log-level debug`
|
|
|
|
|
|
|
|
|
|
## Linux (AppImage)
|
|
|
|
|
|
|
|
|
|
1. `plover.AppImage --log-level debug`
|
|
|
|
|
* `plover_console.exe --log-level debug` for Windows
|
|
|
|
|
* `/Applications/Plover.app/Contents/MacOS/Plover --log-level debug` for macOS
|
|
|
|
|
* `./plover.AppImage --log-level debug` for Linux (AppImage)
|
|
|
|
|
|
|
|
|
|
# Issues
|
|
|
|
|
|
|
|
|
|
@ -65,7 +59,7 @@ If you know your machine has been configured correctly, and Plover doesn't recog
|
|
|
|
|
|
|
|
|
|
1. Confirm your keyboard or steno machine is plugged into your computer.
|
|
|
|
|
1. On the Plover control panel, check if it states the machine is connected or disconnected.
|
|
|
|
|
* If it states the machine is disconnected, press the Reconnect button (this is to the right of "connected" or "disconnected" message).
|
|
|
|
|
* If it states the machine is disconnected, press the Reconnect button (this is to the right of "connected" or "disconnected" message).
|
|
|
|
|
1. If Plover still doesn't recognize your machine, try closing and relaunching Plover.
|
|
|
|
|
|
|
|
|
|
### Strokes no longer appear when using keyboard
|
|
|
|
|
@ -138,27 +132,48 @@ You can try:
|
|
|
|
|
|
|
|
|
|
## macOS
|
|
|
|
|
|
|
|
|
|
### Plover does not run (macOS)
|
|
|
|
|
### Plover does not run
|
|
|
|
|
|
|
|
|
|
* If you use a keyboard instead of a steno machine, Plover needs [Assistive Device Permissions](https://support.apple.com/en-ca/guide/mac-help/mh43185/mac). From the Catalina version of macOS, you may need to enable both the `Plover` app and the `env` app under Security & Privacy > Privacy > Accessibility.
|
|
|
|
|
* If Plover has Accessibility permissions, Plover output is enabled and you can see strokes in the paper tape but it still won't output anything, there may be something wrong with the permissions. There are several ways you can try to fix them, from less destructive to most destructive:
|
|
|
|
|
* If you use a keyboard instead of a steno machine, Plover needs [Assistive Device Permissions](https://support.apple.com/en-ca/guide/mac-help/mh43185/mac).
|
|
|
|
|
|
|
|
|
|
1. Removing Plover from the list of Accessibility permissions using the little `-` button below the list. After removing Plover from the list, restart Plover, enable output and start writing, it should ask again for permission and reappear in the list for you to enable.
|
|
|
|
|
* If Plover does not have the permission, you'll see this error message
|
|
|
|
|
|
|
|
|
|
2. Resetting the Accessibility permissions should clear the list and you will have to re-enable Accessibility permissions for every app that was enabled before. To reset the permissions, open a terminal (Applications > Utilities > Terminal.app), copy/paste the following command and press Enter:
|
|
|
|
|
> Exception: Enable access for assistive devices.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo tccutil reset Accessibility
|
|
|
|
|
```
|
|
|
|
|
Enter your password and press Enter again. Restart Plover, enable output, and it should ask again for permission when it tries to output text as you write.
|
|
|
|
|
* From the Catalina version of macOS, you may need to enable both the `Plover` app and the `env` app under Security & Privacy > Privacy > Accessibility.
|
|
|
|
|
|
|
|
|
|
3. Same as solution #2 but resetting all of the permissions, not just the Accessibility ones. The instructions are the same, but copy/pasting this command instead.
|
|
|
|
|
Alternatively, upgrade Plover to a newer version. See [issue 1134](https://github.com/openstenoproject/plover/issues/1134) for more details.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo tccutil reset All
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
* Plover will not work if you are using [Karabiner Elements](https://github.com/tekezo/Karabiner-Elements)
|
|
|
|
|
* If Plover is shown to have Accessibility permissions but it still won't output anything/shows the error message above, there may be something wrong with the permissions.
|
|
|
|
|
|
|
|
|
|
(some situations such as operating system upgrade/Plover version upgrade might trigger this issue.)
|
|
|
|
|
|
|
|
|
|
There are several ways you can try to fix them, from least destructive to most destructive:
|
|
|
|
|
|
|
|
|
|
1. Removing Plover from the list of Accessibility permissions using the little `-` button below the list. After removing Plover from the list, restart Plover, enable output and start writing, it should ask again for permission and reappear in the list for you to enable.
|
|
|
|
|
|
|
|
|
|
2. Resetting the Accessibility permissions should clear the list and you will have to re-enable Accessibility permissions for every app that was enabled before. To reset the permissions, open a terminal (Applications > Utilities > Terminal.app), copy/paste the following command and press Enter:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo tccutil reset Accessibility
|
|
|
|
|
```
|
|
|
|
|
Enter your password and press Enter again. Restart Plover, enable output, and it should ask again for permission when it tries to output text as you write.
|
|
|
|
|
|
|
|
|
|
3. Same as solution #2 but resetting all of the permissions, not just the Accessibility ones. The instructions are the same, but copy/pasting this command instead.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo tccutil reset All
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
4. Alternatively, as a debugging step, [invoke Plover in the terminal](https://github.com/openstenoproject/plover/wiki/Invoke-Plover-from-the-command-line) with the command
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
/Applications/Plover.app/Contents/MacOS/Plover
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
then grant Terminal assistive permission. (remember to revoke the permission after the possible is fixed to avoid potential security issues!)
|
|
|
|
|
|
|
|
|
|
* Plover will not work if you are using [Karabiner Elements](https://github.com/tekezo/Karabiner-Elements), or generally speaking any program that allow customizing the keyboard might interfere with Plover.
|
|
|
|
|
|
|
|
|
|
### Unrecognized keystrokes
|
|
|
|
|
|
|
|
|
|
@ -172,8 +187,8 @@ macOS has a feature where holding down a key brings up an accent menu. This can
|
|
|
|
|
|
|
|
|
|
### Linux dynamic keyboard layout switching is not working
|
|
|
|
|
|
|
|
|
|
* Plover does not handle dynamic keyboard layout switching: see [bug #298](https://github.com/openstenoproject/plover/issues/298)
|
|
|
|
|
* Plover does not handle dynamic keyboard layout switching: see [bug #298](https://github.com/openstenoproject/plover/issues/298).
|
|
|
|
|
|
|
|
|
|
### Delayed/slow output when using gnome-shell and the keyboard machine
|
|
|
|
|
|
|
|
|
|
* It's a gnome-shell [bug](https://github.com/openstenoproject/plover/issues/1030), unfortunately there's no known workaround.
|
|
|
|
|
* It's a gnome-shell [bug](https://github.com/openstenoproject/plover/issues/1030), unfortunately there's no known workaround.
|
|
|
|
|
|
Benoit Pierre
404
Mac Robeson
user202729