Troubleshooting issues: Difference between revisions

From Plover Wiki
(Undo revision 3436 by BTackt)
Tag: Undo
(this page is still terrible)
 
Line 1: Line 1:
Some common problems and solutions are recorded here. If you’re having a problem with Plover, see if it is described here along with a solution.
{{Incomplete}}
If you're '''having a problem with Plover''', you can:
* Check this page for common issues and solutions.
* Join the [https://discord.gg/0lQde43a6dGmAMp2 Open Steno Discord server] and search the ''plover-tech-support'' channel for others who may have had your issue.
* If you continue to be unable to solve your problem, create your own post in ''plover-tech-support''.


Also, please make sure to check the [https://github.com/openstenoproject/plover/issues Plover bug tracker] for known reported issues.<span id="running-in-debug-mode"></span>
Also, be sure to check the [https://github.com/openstenoproject/plover/issues Plover bug tracker] for known reported issues.
= Running in Debug Mode =


Google searches, AI queries, or general internet communities such as Reddit or Facebook may have limited information on Plover and be unable to give you a complete or accurate answer to your problems.
==Basic Troubleshooting Steps==
{{Incomplete|section}}
# Restart Plover, be careful, it is still running in tray.
# Reinstall Plover(?), be careful, config may persist.
# Run in debug mode(?)
=== Running in Debug Mode ===
Follow instructions in [[Invoke_Plover_from_the_Command_Line| Invoke Plover from the command line]]. You need to invoke the command
Follow instructions in [[Invoke_Plover_from_the_Command_Line| Invoke Plover from the command line]]. You need to invoke the command


Line 12: Line 24:
* <code>/Applications/Plover.app/Contents/MacOS/Plover --log-level debug</code> for macOS
* <code>/Applications/Plover.app/Contents/MacOS/Plover --log-level debug</code> for macOS
* <code>./plover.AppImage --log-level debug</code> for Linux (AppImage)<span id="issues"></span>
* <code>./plover.AppImage --log-level debug</code> for Linux (AppImage)<span id="issues"></span>
= Issues =
 
<span id="general"></span>
== General Issues ==
== General ==
<span id="plover-does-not-recognize-my-usb-keyboard-or-steno-machine"></span>
=== Plover does not recognize my USB keyboard or steno machine ===
=== Plover does not recognize my USB keyboard or steno machine ===
{{Info|text=Initially, Plover is set up to use your computer keyboard as a steno machine. If you have a steno machine, you’ll need to configure Plover to look for your machine. See the [[Supported_Hardware |Supported Hardware page]] for configuration instructions specific to your machine.}}
{{Info|text=Initially, Plover is set up to use your computer keyboard as a steno machine. If you have a steno machine, you’ll need to configure Plover to look for your machine. See the [[Supported_Hardware |Supported Hardware page]] for configuration instructions specific to your machine.}}
If you know your machine has been configured correctly, and Plover doesn’t recognize your keyboard or steno machine:
If Plover doesn’t recognize your keyboard or steno machine:


# Confirm your keyboard or steno machine is plugged into your computer.
# Confirm your keyboard or steno machine is plugged into your computer. Try different USB ports.
# On the Plover control panel, check if it states the machine is connected or disconnected.
# Check that your [[Supported hardware|writer's protocol]] is correctly selected in the Machine dropdown.
#*Certain machines require installation of a plugin and driver to work. See [[setting up your writer with Plover]].
# Under the Machine dropdown, 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).
# If Plover still doesn’t recognize your machine, try closing and relaunching Plover.<span id="strokes-no-longer-appear-when-using-keyboard"></span>
# Check Configuration -> Machine -> Options to see if the correct port is selected.
=== Strokes no longer appear when using keyboard ===
# If Plover still doesn’t recognize your machine, try closing and relaunching Plover.
 
=== The dictionary is outputting wrong ===
If two active dictionaries contain different definitions for the same outline, Plover will use the entry from the dictionary that has the highest priority.
 
By default, the highest priority dictionary is at the top (and is labeled with a star ⭐). If a definition is found, it is output, but if not, it continues checking the next dictionary. If all active dictionaries are checked but no definition is found, the raw steno is output.
 
Double check that your dictionaries are in the correct order, and the ones that you want active are checked off.
 
=== There is no output ===
Double check the following:
* Your machine is connected
* Plover’s output is set to “Enabled”
* You can see strokes in the paper tape
 
If there is still no output, something may be interfering with Plover’s ability to send keystrokes.
 
You can try:
* Running Plover as an Administrator
* Check if you have other apps that may interfere, such as Citrix.


If Plover is enabled with [[Glossary#arpeggiate|arpeggiating]] and strokes were previously registered, check that arpeggiating has not begun. Press <code>&lt;space&gt;</code> (by default) to toggle arpeggiate.
=== When using TX Bolt, any chord with <code>SW-</code> in it doesn’t come out right ===
=== When using TX Bolt, any chord with <code>SW-</code> in it doesn’t come out right ===
 
In the serial settings, uncheck “Xon/Xoff” under “Flow control”. This will solve the issue where using S and W in a chord causes Plover to ignore those keys.
Solution: in the serial settings, uncheck “Xon/Xoff” under “Flow control”. This will solve the issue where using S and W in a chord causes Plover to ignore those keys.<span id="plugins-manager"></span>


== Plugins Manager ==
== Plugins Manager ==
===Plugins manager won't load===
Some users have reported the loading bar for the plugins manager never completing. Upgrading Plover to the latest version has seemed to solve this.


===Disappearing plugins manager===
===Disappearing plugins manager===
 
When installing some plugins, the plugins manager may stop appearing.
When installing some plugins (such as the <code>plover-layout display</code> plugin), the plugins manager may stop appearing.


# In the toolbar, select <code>File → Open Config Folder</code>
# In the toolbar, select <code>File → Open Config Folder</code>
Line 42: Line 71:
# Uninstall and reinstall Plover
# Uninstall and reinstall Plover


===Plugins not showing in the plugins manager===
== Windows ==
 
===The output is incomplete or jumbled in Notepad===
Installing plugins that aren't in the plugins manager is a greater security risk, and is therefore not recommended. If you still want to proceed with this, follow the instructions for [[Plugins#Manually Installing Plugins|manually Installing Plugins]].
This is a known behavior associated with Notepad. Try [[Configuration#Output_Tab|increasing the key press delay]].
 
== Dictionary issues ==
 
By default, Plover ships with three dictionaries: <code>main.json</code>, <code>commands.json</code> and <code>user.json</code>. This can be a source of confusion to new users.<span id="dictionary-priority"></span>
=== Dictionary priority ===
 
If two dictionaries contain the same steno strokes, Plover will use the one in the dictionary that has the highest priority.
 
In Plover 3.x and below, the dictionaries in the dictionary list were prioritized from the bottom up.
 
In Plover 4 and above, the dictionaries order is configurable, but the default is to have the highest priority dictionary at the top, and it is labeled with a star ⭐.
 
By default, the <code>user.json</code> dictionary is placed at the highest priority. If you want new strokes to go to a different dictionary by default (for example, you have your own dictionary already), make sure that the target dictionary is the highest priority.<span id="if-you-have-your-own-dictionary-already"></span>
=== If you have your own dictionary already ===
 
If you have your own dictionary already, you’ll probably want to remove <code>main.json</code> and <code>custom.json</code> and add your own dictionary. This includes existing stenographers and users of another theory (Magnum, Phoenix).
 
We do not recommend you remove the <code>commands.json</code> dictionary from the dictionary list. This is because Plover has some concepts that users of other steno software will not be familiar with initially. Feel free to go through <code>commands.json</code>, and remap strokes that you want to use in your own theory.<span id="about-the-default-dictionaries"></span>
== About the default dictionaries ==


=== main.json ===
<code>main.json</code> is the core default dictionary. It is based on Mirabai Knight’s own personal dictionary, which follows a StenEd-style thoery. It contains over 140,000 entries and is adequate for anyone learning stenography. Mirabai uses this dictionary professionally for her realtime work.
=== commands.json ===
<code>commands.json</code> contains some keyboard shortcuts and Plover-specific utilities. For example, the stroke to add a new translation: <code>TKUPT</code>. It also contains arrow key movements, copy and paste, and more.
Have a look inside to see some sample keyboard commands that Plover can do.
=== user.json ===
<code>user.json</code> is a blank dictionary. By default, the <code>user.json</code> dictionary is the highest priority - it is the first dictionary Plover will use. When you define new strokes, they will get added to this dictionary. This means you can see which strokes you’ve defined yourself, instead of trying to locate them inside the default dictionaries.<span id="windows"></span>
== Windows ==
<span id="unrecognized-keystrokes-and-other-strange-behavior"></span>
=== Unrecognized keystrokes and other strange behavior ===
=== Unrecognized keystrokes and other strange behavior ===
Disable AutoKey if you’re getting strange behavior with Plover.


* Disable AutoKey if you’re getting strange behavior with Plover.<span id="no-output"></span>
=== No Output ===
Double check the following:
* Your machine is connected
* Plover’s output is set to “Enabled”
* You can see strokes in the paper tape
If nothing is “typed” when you’re focused in a program like “Notepad”, something may be interfering with Plover’s ability to send keystrokes.
You can try:
* Running Plover as an Administrator
* If you are a Citrix user, reinstall Citrix and make sure to opt-out of [https://docs.citrix.com/en-us/citrix-virtual-apps-desktops/secure/app-protection.html app protection]<span id="macos"></span>
== macOS ==
== macOS ==
=== No output despite keys showing up in the paper tape ===
=== No output despite keys showing up in the paper tape ===
# Enable Plover's output.
# Enable Plover's output.
# Open the paper tape and press some keys.
# Open the paper tape and press some keys.
Line 109: Line 89:


=== Incompatibility with Karabiner Elements ===
=== Incompatibility with Karabiner Elements ===
Plover will not work if you are using [https://github.com/tekezo/Karabiner-Elements Karabiner Elements], or generally speaking any program that allow customizing the keyboard might interfere with Plover. There is unfortunately to workaround other than to disable or uninstall these programs while using Plover.
Plover will not work if you are using [https://github.com/tekezo/Karabiner-Elements Karabiner Elements], or generally speaking any program that allow customizing the keyboard might interfere with Plover. There is no workaround other than to disable or uninstall these programs while using Plover.


=== Unrecognized keystrokes ===
=== Unrecognized keystrokes ===
macOS has a feature where holding down a key brings up an accent menu. This can sometimes drop keys when typing quickly, such as <code>TO/FPLT</code> producing <code>t.</code> instead of <code>to.</code> To disable this, follow the instructions in this article: [https://www.tekrevue.com/tip/how-to-disable-the-character-accent-menu-in-os-x-mountain-lion/ “How to Disable the Character Accent Menu in OS X Mountain Lion”].


macOS has a feature where holding down a key brings up an accent menu. This can sometimes drop keys when typing quickly, such as <code>TO/FPLT</code> producing <code>t.</code> instead of <code>to.</code> To disable this, follow the instructions in this article: [https://www.tekrevue.com/tip/how-to-disable-the-character-accent-menu-in-os-x-mountain-lion/ “How to Disable the Character Accent Menu in OS X Mountain Lion”].<span id="linux"></span>
== Linux ==
== Linux ==
=== Permission denied with Gemini PR or TX Bolt ===
=== Permission denied with Gemini PR or TX Bolt ===
''See: [[Installation Guide#Allow Access to Serial Ports|allow access to serial ports]].''
See the guide on how to [[Installation Guide#Allow Access to Serial Ports|allow access to serial ports]].


=== Missing or jumbled output ===
=== Missing or jumbled output ===
IBus does not handle the very fast simulated key presses of Plover. This can result in dropped or transposed letters (<code>HAT</code> becomes <code>AHT</code> or <code>AT</code>). The solution is to go open Plover's configuration dialog, navigate to the <code>Output</code> tab, and increase the <code>Key press delay</code>.
This is a known behavior associated with IBus. Try [[Configuration#Output_Tab|increasing the key press delay]].
[[File:Key press delay.png|alt=key press delay field in plover's configuration|thumb|Increase the key press delay to fix dropped or transposed letters.|center]]


=== Linux dynamic keyboard layout switching is not working ===
=== Linux dynamic keyboard layout switching is not working ===
Plover does not handle dynamic keyboard layout switching: see [https://github.com/openstenoproject/plover/issues/298 bug #298].
Plover does not handle dynamic keyboard layout switching: see [https://github.com/openstenoproject/plover/issues/298 bug #298].


=== Delayed/slow output when using gnome-shell and the keyboard machine ===
[[Category:Plover]]
It’s a gnome-shell [https://github.com/openstenoproject/plover/issues/1030 bug], unfortunately there’s no known workaround.
 
=== No authorization protocol error ===
If the following error occurs while trying to run Plover, your system is using Xwayland. See the wiki page on [[Wayland#Plover on Xwayland|Wayland]] for a fix.
[[File:Xwayland error.png|alt=Xwayland error that pops up when trying to run Plover|center|thumb|This error occurs on some systems running Wayland.]]
 
=== Plover not working on Wayland ===
Plover does not officially support Wayland. See the wiki page on [[Wayland]] for workarounds and alternatives to Plover.

Latest revision as of 18:14, 20 March 2026

format=frameless
format=frameless

This page is incomplete. If you know about this subject, please contribute to the wiki by adding more information.



If you're having a problem with Plover, you can:

  • Check this page for common issues and solutions.
  • Join the Open Steno Discord server and search the plover-tech-support channel for others who may have had your issue.
  • If you continue to be unable to solve your problem, create your own post in plover-tech-support.

Also, be sure to check the Plover bug tracker for known reported issues.

Google searches, AI queries, or general internet communities such as Reddit or Facebook may have limited information on Plover and be unable to give you a complete or accurate answer to your problems.

Basic Troubleshooting Steps

format=frameless
format=frameless

This section is incomplete. If you know about this subject, please contribute to the wiki by adding more information.



  1. Restart Plover, be careful, it is still running in tray.
  2. Reinstall Plover(?), be careful, config may persist.
  3. Run in debug mode(?)

Running in Debug Mode

Follow instructions in Invoke Plover from the command line. You need to invoke the command

plover --log-level debug

In particular, the exact commands are

  • 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)

General Issues

Plover does not recognize my USB keyboard or steno machine

format=frameless
format=frameless

Initially, Plover is set up to use your computer keyboard as a steno machine. If you have a steno machine, you’ll need to configure Plover to look for your machine. See the Supported Hardware page for configuration instructions specific to your machine.


If Plover doesn’t recognize your keyboard or steno machine:

  1. Confirm your keyboard or steno machine is plugged into your computer. Try different USB ports.
  2. Check that your writer's protocol is correctly selected in the Machine dropdown.
  3. Under the Machine dropdown, 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).
  4. Check Configuration -> Machine -> Options to see if the correct port is selected.
  5. If Plover still doesn’t recognize your machine, try closing and relaunching Plover.

The dictionary is outputting wrong

If two active dictionaries contain different definitions for the same outline, Plover will use the entry from the dictionary that has the highest priority.

By default, the highest priority dictionary is at the top (and is labeled with a star ⭐). If a definition is found, it is output, but if not, it continues checking the next dictionary. If all active dictionaries are checked but no definition is found, the raw steno is output.

Double check that your dictionaries are in the correct order, and the ones that you want active are checked off.

There is no output

Double check the following:

  • Your machine is connected
  • Plover’s output is set to “Enabled”
  • You can see strokes in the paper tape

If there is still no output, something may be interfering with Plover’s ability to send keystrokes.

You can try:

  • Running Plover as an Administrator
  • Check if you have other apps that may interfere, such as Citrix.

When using TX Bolt, any chord with SW- in it doesn’t come out right

In the serial settings, uncheck “Xon/Xoff” under “Flow control”. This will solve the issue where using S and W in a chord causes Plover to ignore those keys.

Plugins Manager

Plugins manager won't load

Some users have reported the loading bar for the plugins manager never completing. Upgrading Plover to the latest version has seemed to solve this.

Disappearing plugins manager

When installing some plugins, the plugins manager may stop appearing.

  1. In the toolbar, select File → Open Config Folder
  2. Delete the Plugins folder
  3. Uninstall and reinstall Plover

Windows

The output is incomplete or jumbled in Notepad

This is a known behavior associated with Notepad. Try increasing the key press delay.

Unrecognized keystrokes and other strange behavior

Disable AutoKey if you’re getting strange behavior with Plover.

macOS

No output despite keys showing up in the paper tape

  1. Enable Plover's output.
  2. Open the paper tape and press some keys.
    • If nothing shows up, you will first need to set up your machine.
    • If you see letters showing in the paper tape, follow the rest of these instructions.
  3. Open System Settings > Privacy & Security > Accessibility.
    • If Plover is already listed, remove it with the - button; do not just uncheck it!
  4. Add the Plover app with the + button.

Incompatibility with Karabiner Elements

Plover will not work if you are using Karabiner Elements, or generally speaking any program that allow customizing the keyboard might interfere with Plover. There is no workaround other than to disable or uninstall these programs while using Plover.

Unrecognized keystrokes

macOS has a feature where holding down a key brings up an accent menu. This can sometimes drop keys when typing quickly, such as TO/FPLT producing t. instead of to. To disable this, follow the instructions in this article: “How to Disable the Character Accent Menu in OS X Mountain Lion”.

Linux

Permission denied with Gemini PR or TX Bolt

See the guide on how to allow access to serial ports.

Missing or jumbled output

This is a known behavior associated with IBus. Try increasing the key press delay.

Linux dynamic keyboard layout switching is not working

Plover does not handle dynamic keyboard layout switching: see bug #298.