## Screenshots
-![indicator default][sc1]
+![indicator default][sc1]
Default appearance of the indicator with Num lock on and Caps and Scroll locks
off.
-![indicator menu][sc2]
+![indicator menu][sc2]
Menu of the indicator, shown on click. The locks can be toggled by clicking
the respective item in the menu.
-![indicator short][sc3]
+![indicator short][sc3]
Alternative (short) appearance of the indicator.
-[sc1]: screenshots/sc1.png
-[sc2]: screenshots/sc2.png
-[sc3]: screenshots/sc3.png
-
## Dependencies
- Python 3 (*)
- GTK+ 3 (*)
sudo apt-get install python3-gi xdotool
+**Note**: [`gdk_keymap_get_scroll_lock_state ()`][gtkdoc-scroll] is only
+available since GTK+ 3.18. The earliest Ubuntu release that supports
+GTK+ 3.18 is 16.04 (Xenial). This means that if you use an older version
+you will have to ignore Scroll lock functionality (See [Examples](#examples)).
+
+[gtkdoc-scroll]: https://developer.gnome.org/gdk3/stable/gdk3-Keyboard-Handling.html#gdk-keymap-get-scroll-lock-state
+
## Usage
1. Install the dependencies listed above.
2. Clone this repository.
3. Add the script as a startup application. (Use option `--short` for short
- appearance if desired.)
+ appearance; use option `--order` to customize the order of the locks
+ displayed. See [Examples](#examples))
4. Run the script manually for the first time. (Alternatively, log out
and log in again.)
5. The indicator should be shown at the top right corner, with a filled circle
6. Clicking on the indicator should result in a menu with the three locks.
Clicking on the menu item would cause the corresponding lock to toggle.
+## Examples
+
+![indicator default][sc1]
+Default appearance. `python3 indicator-keyboard-led.py`
+
+![indicator short][sc3]
+Short appearance. `python3 indicator-keyboard-led.py --short`
+
+![indicator CNS][sc4]
+Order changed to Caps Num Scroll.
+`python3 indicator-keyboard-led.py --order CNS`
+
+![indicator NC][sc5]
+Hide Scroll lock. `python3 indicator-keyboard-led.py --order NC`
+
+![indicator C short][sc6]
+Show Caps lock only, short appearance.
+`python3 indicator-keyboard-led.py --short --order C`
+
+![indicator default, French locale][sc7]
+Default appearance in a French locale.
+`LANGUAGE=fr_FR python3 indicator-keyboard-led.py`
+
+[sc1]: screenshots/sc1.png
+[sc2]: screenshots/sc2.png
+[sc3]: screenshots/sc3.png
+[sc4]: screenshots/sc4.png
+[sc5]: screenshots/sc5.png
+[sc6]: screenshots/sc6.png
+[sc7]: screenshots/sc7.png
+
+## Known bugs
+
+### Pressing Scroll Lock does nothing
+
+It seems to be a common problem that Scroll Lock is not usable in Ubuntu.
+To solve this, do the following (assuming US keyboard):
+
+ > # backup your symbols file
+ > sudo cp /usr/share/X11/xkb/symbols/us{,.distribution}
+ >
+ > Add the following line in the `xkb_symbols "basic" {` section. Do not worry
+ > if that second line is not there, it is only there for some languages and
+ > was not there for us on my system.
+ >
+ > ...
+ > modifier_map Mod3 { Scroll_Lock }; <==<< Add this line
+ >
+ > include "level3(ralt_switch)" <==<< before this line
+ > };
+ >
+ >
+ > You may have to do the same in your other layouts if you switch between
+ > languages.
+ >
+ > Also, there is a cache where xkb layouts live. You should clear it before
+ > restarting your X server to check the new keyboard symbol file(s).
+ >
+ > sudo dpkg-reconfigure xkb-data
+
+*By Pykler and Giovanni Toraldo on AskUbuntu.* [Source][quotesrc]. Slightly
+modified. [Original source][origsrc] by dm+ on PCLinuxOS-Forums.
+
+[origsrc]: http://www.pclinuxos.com/forum/index.php/topic,125690.msg1052201.html?PHPSESSID=2qsv83lve6dgd0ivq14bfcjc30#msg1052201
+[quotesrc]: http://askubuntu.com/a/597757/274080
+
+### X11Keymap has no attribute 'get_scroll_lock_state'
+
+If running the script gives the error message
+
+ AttributeError: 'gtk.gdk.X11Keymap' object has no attribute 'get_scroll_lock_state'
+
+then your installed GTK+ version is probably older than 3.18, which
+does not support `get_scroll_lock_state`. Either hide all Scroll Lock
+functionality (See [Examples](#examples)), or upgrade your system.
+
+## Localization
+
+As motivated by Issue #1, this script has been localized to French (with
+the assistance of Wikipedia and Google Translate). Corrections to the
+translation, as well as translations to other languages, are welcome.
+Feel free to create a pull request or open an issue.
+
## License
The program "indicator-keyboard-led.py" is released under the MIT License.
projects / indicator-keyboard-led.git / blobdiff