summaryrefslogtreecommitdiff
path: root/x11-drivers/OpenTabletDriver-bin/files/opentabletdriver.8
blob: 278f5faf0ffe9de9c7e8b1cc39e98c6661a069de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
.TH OpenTabletDriver 8

.Sh NAME

.B opentabletdriver

Open source, cross platform, user mode tablet driver.

.SY
.SH SYNOPSIS

.B opentabletdriver
.RB [OPTIONS]

.YS

.SH DESCRIPTION

OpenTabletDriver is a cross platform, open source, user mode graphics
tablet driver aiming for the highest compatibility in an easily
configurable graphical user interface.

.SH OPTIONS


.SS Daemon Options

(Relevant to the portable tarball installation - OpenTabletDriver daemon when
installed via package manager is launched by systemd or equivalent)

.OP "-a, --appdata <directory>"

Manually specify application data directory, defaults to
~/.config/OpenTabletDriver/

.OP "-c, --config <directory>"

Manually specify configuration directory (location of JSON files used
to recognize tablets)

.OP "--version"

Show version information

.OP "-?, -h, --help"

Show help and usage information

.SS Graphical Front-end Options

(Relevant to the package manager installation, opentabletdriver
command will take these arguments for manipulating the GUI)

.OP "-m, --minimized"

Start OpenTabletDriver minimized, if possible in the desktop environment installed

.OP "--version"

Show version information

.OP "-?, -h, --help"

Show help and usage information for the GUI


.SH DIAGNOSTICS

The daemon log is created in the application data directory, at

~/.config/OpenTabletDriver/daemon.log

by default.


.SH FREQUENT ISSUES AND QUESTIONS

.SS Failed to open device streams

This occurs due to a lack of permissions to open a device stream. It
is resolved by creating udev rules that give these permissions. If you
installed OpenTabletDriver via your package manager, you may need to
run the following command then replug your tablet.

.EX
sudo udevadm control --reload-rules
.EE

.SS Poor performance with NVIDIA

Disable "Force full composition pipeline" in the NVIDIA settings panel.


.SS X11/Wayland Session not detected

Your .xinitrc is likely configured improperly and the DISPLAY
environment variable isn't set for systemd. Proper configuration for
the .xinitrc file can be found at:

.UR https://wiki.archlinux.org/index.php/Xinit#Configuration
.UE

.B For X11:

1. Create an override file

.EX
# Opens with whatever program is set to $EDITOR
systemctl --user edit opentabletdriver.service
.EE

2. Add this block below the first 2 lines of the file, then save and exit

.EX
[Service]
Environment=DISPLAY=:0
.EE

3. Finally, run the following commands to reload the system user
daemon and start the OpenTabletDriver daemon service, or restart it if it's already
running:

.EX
systemctl --user daemon-reload
systemctl --user restart opentabletdriver.service
.EE

.B For Wayland:

1. Create an override file:

.EX
systemctl --user edit opentabletdriver.service
.EE

2. Add this block below the first 2 lines of the file, then save and exit

.EX
[Service]
Environment=WAYLAND_DISPLAY=:0
.EE

3. Finally, run the following commands to reload the system user
daemon and start the OpenTabletDriver daemon service, or restart it if it's already
running:

.EX
systemctl --user daemon-reload
systemctl --user restart opentabletdriver.service
.EE

.SS Failed to initialize virtual device

.B EACCESS

Run the following command:

.EX
sudo chmod 0666 /dev/uinput
.EE

.B ENODEV

Rebooting is the only option here. Your kernel was very likely
updated, or some component of uinput was modified which requires a
reboot to resolve.