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