1
0
Fork 0

Compare commits

...

5 Commits

2 changed files with 48 additions and 33 deletions

View File

@ -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
@ -138,10 +132,23 @@ 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).
* If Plover does not have the permission, you'll see this error message
> Exception: Enable access for assistive devices.
* From the Catalina version of macOS, you may need to enable both the `Plover` app and the `env` app under Security & Privacy > Privacy > Accessibility.
Alternatively, upgrade Plover to a newer version. See [issue 1134](https://github.com/openstenoproject/plover/issues/1134) for more details.
* 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.
@ -158,7 +165,15 @@ You can try:
sudo tccutil reset All
```
* Plover will not work if you are using [Karabiner Elements](https://github.com/tekezo/Karabiner-Elements)
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,7 +187,7 @@ 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

View File

@ -4,7 +4,7 @@ If you've installed Plover version 3 but have later switched to version 4, it is
## Check your Plover version before continuing
![Plover running with the main Plover and Plover Configuration window open on the "Machine" tab.](https://i.imgur.com/BR78od8.png)
To check if you've installed Plover version 3, the main Plover window and the Plover Configuration window will look like the image above—with the main Plover window having a Configure and About button. Clicking the About button will reveal detailed information on the version of Plover you're running. If it looks like this, you'll have to [download and install the latest version of Plover](https://github.com/lampii/VideoCaptureUtility/releases/download/42/plover-4.0.0.dev11+23.g991d334-win64.zip) before continuing.
To check if you've installed Plover version 3, the main Plover window and the Plover Configuration window will look like the image above—with the main Plover window having a Configure and About button. Clicking the About button will reveal detailed information on the version of Plover you're running. If it looks like this, you'll have to [download and install the latest version of Plover](https://github.com/openstenoproject/plover/releases/latest) before continuing.
## Steps (recommended)