plasma/wacomtablet/README.md

0001 KDE Wacom support
0002 =================
0003
0004 This module implements a GUI for the Wacom Linux Drivers and extends it
0005 with profile support to handle different button / pen layouts per profile.
0006
0007 For hardware support have a look at https://linuxwacom.github.io/
0008
0009 Configuration can be located in System Settings → Input devices → Tablets
0010
0011 Easy profile switching is supported via hotkeys or a small plasma applet in tray notification area.
0012 In addition, a daemon running in the background helps with hotplug support.
0013
0014 Hardware support
0015 ----------------
0016
0017 All tablets can be set up as long as they are found with the wacom kernel module.
0018
0019 Check with
0020
0021     $ xsetwacom list devices
0022
0023 if your device is correctly recognized first. If it doesn't show up there, we can't configure it.
0024
0025 Installation
0026 ------------
0027
0028 Wacom support in KDE is a separate component and might be not installed by default.
0029 Package usually goes by name `wacomtablet` or `kcm-wacomtablet`.
0030
0031 More or less full list of distributions including the package should be avaliable at:
0032
0033 * https://repology.org/metapackage/kcm-wacomtablet/versions
0034
0035 Staring the module
0036 ------------------
0037
0038 Background daemon should be started automatically each time you log in.
0039
0040 You can enable or manually start the service via System Settings → Startup and Shutdown → Background services.
0041
0042 Adding missing tablet devices
0043 -----------------------------
0044
0045 If your device is not recognized by this program, but you can set it up via the xsetwacom driver,
0046 run Wacom Tablet Finder (`kde_wacom_tabletfinder`), describe your device and click `Save`, and restart Wacom tablet service (see above).
0047
0048 Please send your device description (file `~/.config/tabletdblocalrc`) to the bugtracker, so it will be added in future versions.
0049
0050 Reporting bugs
0051 --------------
0052
0053 Please report bugs here: https://bugs.kde.org/enter_bug.cgi?product=wacomtablet
0054
0055 Building & manual installation
0056 ==============================
0057
0058 This is *not* a recommended way to use this application. Installing it manually creates files untracked by your package manager.
0059 This can cause everyone problems later on. Please contact your distribution's maintainers to package it instead.
0060
0061 Run-time dependencies:
0062 * X11 wacom tablet driver (xserver-xorg-input-wacom), including the xsetwacom tool, version 0.20 or higher
0063 * libwacom. Highly recommended to have version 0.29 or higher for support of consumer-grade tablets with quirky buttons.
0064
0065 Build dependencies on Debian/Ubuntu:
0066 * g++
0067 * cmake
0068 * extra-cmake-modules
0069 * gettext
0070 * libqt5x11extras5-dev
0071 * qtdeclarative5-dev
0072 * libkf5coreaddons-dev
0073 * libkf5i18n-dev
0074 * libkf5dbusaddons-dev
0075 * libkf5globalaccel-dev
0076 * libkf5config-dev
0077 * libkf5xmlgui-dev
0078 * libkf5notifications-dev
0079 * plasma-framework-dev
0080 * kdoctools-dev
0081 * libxi-dev
0082 * libxcb-xinput-dev
0083 * libwacom-dev
0084
0085 You can install them by running:
0086
0087     $ apt install g++ cmake extra-cmake-modules gettext libqt5x11extras5-dev qtdeclarative5-dev libkf5coreaddons-dev libkf5i18n-dev libkf5dbusaddons-dev libkf5globalaccel-dev libkf5config-dev libkf5xmlgui-dev libkf5notifications-dev plasma-framework-dev kdoctools-dev libxi-dev libwacom-dev
0088
0089 Building from source
0090 --------------------
0091
0092     $ mkdir build
0093     $ cd build
0094     $ cmake ../ -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DKDE_INSTALL_USE_QT_SYS_PATHS=ON
0095     $ make
0096
0097 Manual installation (this *will* litter in your system):
0098
0099     $ make install
0100
0101 Running without installing
0102 --------------------------
0103
0104 This is not intended for daily use, but for people who want to test developer builds.
0105
0106 Running KCM component:
0107
0108     $ QT_PLUGIN_PATH=src/kcmodule/ kcmshell5 wacomtablet
0109
0110 Running KDED component:
0111
0112     $ ln -s kf5 src/
0113     $ kquitapp5 kded5 && QT_PLUGIN_PATH=$PWD kded5
0114
0115 Running tablet finder:
0116
0117     $ src/tabletfinder/kde_wacom_tabletfinder
0118
0119 Running unit tests
0120 ==================
0121
0122 First, configure the build to include tests by enabling BUILD_TESTING:
0123
0124     $ mkdir build
0125     $ cd build
0126     $ cmake ../ -DBUILD_TESTING=ON
0127     $ make
0128
0129 Then, run the tests with:
0130
0131     $ ctest
0132
0133 or a single one via
0134
0135     $ cd autotests/common/property
0136     $ ./Test.Common.Property
0137
0138 you can find the test results in `Testing/Temporary/LastTest.log`
0139
0140 Releasing new version
0141 =====================
0142
0143 Checklist for developers:
0144
0145 * Bump main package version in: `CMakeLists.txt`
0146 * Bump applet version in: `src/applet/package/metadata.desktop`
0147 * Follow https://community.kde.org/ReleasingSoftware