diff --git a/README.md b/README.md index 870b51fe..d4dfb49d 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,55 @@ -**Solaar** is a Linux device manager for Logitech's -[Unifying Receiver](http://logitech.com/en-us/66/6079) peripherals. It is able -to pair/unpair devices to the receiver, and for some devices read battery -status. +**Solaar** is a Linux device manager for Logitech's [Unifying Receiver][unifying] +peripherals. It is able to pair/unpair devices to the receiver, and for most +devices read battery status. It comes in two flavors, command-line and GUI. Both are able to list the devices paired to a Unifying Receiver, show detailed info for each device, and also pair/unpair supported devices with the receiver. + ## Supported Devices **Solaar** will detect all devices paired with your Unifying Receiver, and at -the very least display some basic information about them. Depending on the -device, it may be able to read its battery status. +the very least display some basic information about them. -A few devices also have extended support, mostly because I was able to directly -test on them: +For some devices, extra settings (usually not available through the standard +Linux system configuration) are supported: -* The [K750 Solar Keyboard](http://logitech.com/keyboards/keyboard/devices/7454) - is also queried for its solar charge status. Pressing the Solar key on the - keyboard will pop-up the application window and display the current lighting - value (Lux) as reported by the keyboard, similar to Logitech's *Solar.app* for - Windows. +* The [K750 Solar Keyboard][K750] is also queried for its solar charge status. + Pressing the `Solar` key on the keyboard will pop-up the application window + and display the current lighting value (Lux) as reported by the keyboard, + similar to Logitech's *Solar.app* for Windows. - Also, you can change the way the function keys (`F1`..`F12`) work, i.e. - whether holding `FN` while pressing the function keys will generate the - standard keycodes or the special function (yellow icons) keycodes. +* The state of the `FN` key can be toggled on some keyboards ([K750][K750], + [K800][K800] and [K360][K360]). It changes the way the function keys + (`F1`..`F12`) work, i.e. whether holding `FN` while pressing the function keys + will generate the standard `Fx` keycodes or the special function (yellow + icons) keycodes. -* The [M705 Marathon Mouse](http://logitech.com/product/marathon-mouse-m705) - and [Anywhere MX Mouse](http://logitech.com/product/anywhere-mouse-mx) support - turning on/off Smooth Scrolling (higher sensitivity on vertical scrolling with - the wheel). +* The DPI can be changed on the [Performance MX Mouse][P_MX]. + +* Smooth scrolling (higher sensitivity on vertical scrolling with the wheel) can + be toggled on the [M705 Marathon Mouse][M705] and [Anywhere MX Mouse][A_MX]. Extended support for other devices may be added in the future, depending on the documentation available, but the K750 keyboard and M705 mouse are the only -devices I have and can test on right now. +devices I have and can directly test on right now. -## Requirements + +## Pre-built packages + +* Ubuntu 12.04+ packages are available in my PPA: [ppa:daniel.pavel/Solaar][ppa] +* A downloadable Debian package for sid/unstable: [.deb][debian] +* A [Gentoo overlay][gentoo] is available courtesy of Carlos Silva + +[ppa]: http://launchpad.net/~daniel.pavel/+archive/solaar +[debian]: http://pwr.github.com/Solaar/packages/solaar_0.8.6.2-1_all.deb +[gentoo]: http://code.r3pek.org/gentoo-overlay/src + + +## Manual instalation + +### Requirements You should have a reasonably new kernel (3.2+), with the `logitech-djreceiver` driver enabled and loaded; also, the `udev` package must be installed and the @@ -52,7 +66,7 @@ distribution the required packages are most likely named something similar. If the desktop notifications bindings are also installed (`gir1.2-notify-0.7`), you will also get desktop notifications when devices come online/go offline. -## Installation +### Installation Normally USB devices are not accessible for r/w by regular users, so you will need to do a one-time udev rule installation to allow access to the Logitech @@ -76,18 +90,28 @@ required steps by hand, as the root user: 3. physically remove the Unifying Receiver, wait 10 seconds and re-insert it + ## Known Issues - Ubuntu's Unity indicators are not supported at this time. However, if you whitelist 'Solaar' in the systray, you will get an icon (see -[How do I access and enable more icons to be in the system tray?](http://askubuntu.com/questions/30742/how-do-i-access-and-enable-more-icons-to-be-in-the-system-tray) -) + [Enable more icons to be in the system tray?][ubuntu_systray] for details). + +[ubuntu_systray]: http://askubuntu.com/questions/30742 + +- The application only looks at the first Unifying Receiver it finds, even if + there's more than one plugged in. Support for multiple receivers is in + progress. + +- Devices connected throught a [Nano Receiver][nano] (which is very similar to + the Unifying Receiver) are not supported at this time. - Running the command-line application (`bin/solaar-cli`) while the GUI application is also running *may* occasionally cause either of them to become confused about the state of the devices. I haven't encountered this often enough to be able to be able to diagnose it properly yet. + ## Thanks This project began as a third-hand clone of [Noah K. Tilton](https://github.com/noah)'s @@ -104,3 +128,14 @@ who also provided some internal Also thanks to Douglas Wagner and Julien Gascard for helping with application testing and supporting new devices. + +-- + +[unifying]: http://logitech.com/en-us/66/6079 +[nano]: http://logitech.com/mice-pointers/articles/5926 +[K750]: http://logitech.com/product/k750-keyboard +[K800]: http://logitech.com/product/wireless-illuminated-keyboard-k800 +[K360]: http://logitech.com/product/keyboard-k360 +[M705]: http://logitech.com/product/marathon-mouse-m705 +[P_MX]: http://logitech.com/product/performance-mouse-mx +[A_MX]: http://logitech.com/product/anywhere-mouse-mx