X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=README.md;h=c7f7e56452160e5be95e049d6b93fa57dacf251f;hb=e21d3d387d6139424953a41140c3384945689829;hp=2d107d8447f8ee81279bb9593a54b444e3a996b2;hpb=a4c6e3870ccb5886f66bd047c8e406b00645ddef;p=indicator-keyboard-led.git diff --git a/README.md b/README.md index 2d107d8..c7f7e56 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,13 @@ distributions. To install the rest, run: 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, +scroll lock functionality will be disabled. + +[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. @@ -59,20 +66,27 @@ 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` +Hide Scroll lock, also the default appearance if Scroll lock is not supported. `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 +## Known bugs / Troubleshooting + +### 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): @@ -104,7 +118,27 @@ 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 - + +### Scroll lock does not appear on indicator + +Your installed GTK+ version is probably older than 3.18, which +does not support `get_scroll_lock_state`. Please consider upgrading +your system if you really want Scroll lock functionality. + +If your installed GTK+ is 3.18+ then please file a bug report. + +### Drop-down menu only has "Quit", the clickable locks do not appear + +Please verify that xdotool is installed in your PATH with the executable +bit set. If you provided a custom path to xdotool please verify that it +is correct and is an executable regular file. + +## 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