Merge pull request #13 from pmattern/readme

Update README.md
This commit is contained in:
zjes 2016-10-18 19:18:38 +02:00 committed by GitHub
commit b5f6340953
1 changed files with 19 additions and 32 deletions

View File

@ -2,45 +2,36 @@
## Overview
LXQt application switcher is an application switcher, hence a tool to change the active window by cycling
through the available ones, geared towards the [LXQt desktop environment](http://lxqt.org).
LXQt application switcher is an application switcher, hence a tool to change the active window by cycling through the available ones, geared towards the [LXQt desktop environment](http://lxqt.org).
![](https://raw.githubusercontent.com/wiki/zjes/lxqt-appswitcher/images/appswitcher.png)
It integrates with LXQt including theming and is meant to be more configurable and featureful than e. g.
its counterpart provided by Openbox.
(For now theme Ambiance only is supported. Other themes can still be used but make LXQt application
switcher fall back to a default theme.)
It integrates closely with LXQt including theming and is meant to be more configurable and featureful than e. g. its counterpart provided by Openbox.
(For now theme Ambiance only is supported. Other themes can still be used but make LXQt application switcher fall back to a default theme.)
## Installation
LXQt component [lxqt-globalkeys](https://github.com/lxde/lxqt-globalkeys) is the only mandatory build- and
runtime dependency as it's needed itself and pulls all other needed dependencies including Qt as well.
### Compiling source code
LXQt application switcher is relying on CMake and can hence be installed by running `cmake`, `make` and
`make install`, optionally from a dedicated build directory.
A CMake option like `-DCMAKE_INSTALL_PREFIX=/usr` will be needed most of the time to have the program installed
at paths commonly used these days.
The application's runtime dependencies are Qt Base, KWindowSystem, [liblxqt](https://github.com/lxde/liblxqt) and [lxqt-globalkeys](https://github.com/lxde/lxqt-globalkeys). To build CMake is needed, optionally Git to clone VCS code.
In Arch Linux the tool can be installed via [AUR](https://aur.archlinux.org/) package
[lxqt-appswitcher-git](https://aur.archlinux.org/packages/lxqt-appswitcher-git/).
Code configuration is handled by CMake, its variable `CMAKE_INSTALL_PREFIX` has to be set to `/usr` most of the time.
To build run `make`, to install `make install` which accepts variable `DESTDIR` as usual.
### Binary packages
These aren't exactly wide-spread so far. In Arch Linux the application can be installed via [AUR](https://aur.archlinux.org/) package [lxqt-appswitcher-git](https://aur.archlinux.org/packages/lxqt-appswitcher-git/).
## Configuration
### Keyboard shortcuts
LXQt application switcher is using the shortcuts defined by lxqt-globalkeys.
These are configured in dialogue "Global Actions Manager" (binary `lxqt-config-globalkeyshortcuts`) - topics
"[reverse] switch applications" in column "Description". Default settings are `Alt+Tab` and `Alt+Shift+Tab` to
cycle in regular and reverse order respectively.
LXQt application switcher is using the shortcuts configured by [lxqt-globalkeys](https://github.com/lxde/lxqt-globalkeys).
These are configured in dialogue "Global Actions Manager" (binary `lxqt-config-globalkeyshortcuts`) - topics "[reverse] switch applications" in column "Description". Default settings are `Alt+Tab` and `Alt+Shift+Tab` to cycle in regular and reverse order respectively.
It must be ensured that these shortcuts aren't used by the window manager. (Technically it's possible to assign
different shortcuts to LXQt application switcher and e. g. an application switcher of a window manager and hence
use the two in parallel. This will hardly ever make sense, though.)
In **Openbox** [actions](http://openbox.org/wiki/Help:Actions) `NextWindow` and/or `PreviousWindow` have to be
detached from the keyboard [bindings](http://openbox.org/wiki/Help:Bindings). This is best done by uncommenting or
removing the corresponding sections in `~/.config/openbox/rc.xml`. If the file is missing `/etc/xdg/openbox/rc.xml`
can be copied and used as template, the sections themselves will look like
It must be ensured that these shortcuts aren't used by the window manager. (Technically it's possible to assign different shortcuts to LXQt application switcher and e. g. an application switcher of a window manager and hence use the two in parallel. This will hardly ever make sense, though.)
In **Openbox** [actions](http://openbox.org/wiki/Help:Actions) `NextWindow` and/or `PreviousWindow` have to be detached from the keyboard [bindings](http://openbox.org/wiki/Help:Bindings). Unfortunately a really convenient GUI to handle this does not exist so editing the user specific configuration file is needed. As of LXQt release 0.11 this is file `~/.config/openbox/lxqt-rc.xml` as far as LXQt sessions are concerned, see section [LXQt specific configuration of window manager Openbox](https://github.com/lxde/lxqt-common#lxqt-specific-configuration-of-window-manager-openbox) in file `README.md` of [lxqt-common](https://github.com/lxde/lxqt-common) to which the configuration file's template belongs. The sections themselves are
```
<keybind key="A-Tab">
<action name="NextWindow">
@ -55,18 +46,14 @@ and
</keybind>
```
For changes to take effect either start a new session or run `openbox --reconfigure`.
In **KWin** the shortcuts can be handled from KDE's "System Settings" (binary `systemsettings[5]`) under Workspace -
Window Management - Task Switcher, using **Xfwm4** in dialogue "Window Manager" (binary `xfwm4-settings`), both
times changes take effect at once.
In **KWin** the shortcuts can be handled from KDE's "System Settings" (binary `systemsettings[5]`) under Workspace - Window Management - Task Switcher, using **Xfwm4** in dialogue "Window Manager" (binary `xfwm4-settings`), both times changes take effect at once.
### Auto start
The application itself is run as so-called LXQt Module. As such it has to be enabled from dialogue
"LXQt Session Settings" (binary `lxqt-config-session`).
The application itself is run as so-called [LXQt Module](https://github.com/lxde/lxqt-session#lxqt-modules). As such it has to be enabled from dialogue "LXQt Session Settings" (binary `lxqt-config-session`) of [lxqt-session](https://github.com/lxde/lxqt-session).
![](https://raw.githubusercontent.com/wiki/zjes/lxqt-appswitcher/images/session.png)
### Settings
The actual configuration can be tweaked by dialogue "Application switcher" which can be found in LXQt's main panel
menu as well as in the "LXQt Configuration Center".
The actual configuration can be tweaked by dialogue "Application switcher" which can be found in LXQt's main panel menu as well as in the [LXQt Configuration Center](https://github.com/lxde/lxqt-config#configuration-center).