-
Notifications
You must be signed in to change notification settings - Fork 0
/
catlock.xml.in
182 lines (171 loc) · 7.44 KB
/
catlock.xml.in
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE refentry PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN' 'http://www.docbook.org/xml/4.5/docbookx.dtd'
[
<!ENTITY version '@PROJECT_VERSION@'>
]>
<refentry>
<refentryinfo>
<title>catlock manual</title>
<productname>catlock</productname>
<date>2019-07-07</date>
<author>
<firstname>Fritz</firstname> <surname>Elfert</surname>
<email>[email protected]</email>
</author>
</refentryinfo>
<refmeta>
<refentrytitle>catlock</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='version'>&version;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>catlock</refname>
<refpurpose>Lock keyboard and point against cat access</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>catlock</command>
<arg choice='opt'>
<arg choice='plain'><option>--display</option></arg>
<arg choice='plain'><replaceable>display-name</replaceable></arg>
</arg>
<arg choice='opt'>
<group choice='req'>
<arg choice='plain'><option>-s</option></arg>
<arg choice='plain'><option>--shortcut</option></arg>
</group>
<arg choice='plain'><replaceable>keysym-string</replaceable></arg>
</arg>
<arg choice='opt'>
<group choice='req'>
<arg choice='plain'><option>-o</option></arg>
<arg choice='plain'><option>--oshortcut</option></arg>
</group>
<arg choice='plain'><replaceable>keysym-string</replaceable></arg>
</arg>
<arg choice='opt'>
<group choice='req'>
<arg choice='plain'><option>-p</option></arg>
<arg choice='plain'><option>--print</option></arg>
</group>
</arg>
<arg choice='opt'>
<group choice='req'>
<arg choice='plain'><option>-d</option></arg>
<arg choice='plain'><option>--debug</option></arg>
</group>
</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>catlock</command>
<group choice='req'>
<arg choice='plain'><option>--version</option></arg>
<arg choice='plain'><option>--help</option></arg>
<arg choice='plain'><option>-?</option></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
<command>catlock</command> was inspired by
<ulink url='https://manpages.debian.org/stretch/xtrlock/xtrlock.1x.en.html'>xtrlock</ulink>,
but instead of requiring a password to unlock, a simple three-key combination
<option>Ctrl+Alt+KP_Enter</option> is sufficient to terminate. Furthermore, pressing
<option>Meta+L</option> switches off the screen backlight (like xset dpms force off does).
Both shortcuts are configurable.
</para>
</refsection>
<refsection>
<title>Options</title>
<para>
<command>catlock</command> accepts the following options:
</para>
<refsection>
<title>Shortcut specification</title>
<variablelist>
<varlistentry>
<term><option>-s</option></term>
<term><option>--shortcut=<replaceable>keysym-string</replaceable></option></term>
<listitem>
<para>Specifies the shortcut for unlocking.</para>
<para>The <replaceable>keysym-string</replaceable> is a concatenation of modifiers and
the actual key name separated by <option>+</option>. Valid modifiers are
<option>Shift</option>, <option>Ctrl</option>, <option>Alt</option> and <option>Meta</option>.
The <option>--print</option> can be used to show possible keysym-strings.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option></term>
<term><option>--oshortcut=<replaceable>keysym-string</replaceable></option></term>
<listitem>
<para>Specifies the shortcut for switching off the screen.</para>
<para>In addition to specifying a valid <replaceable>keysym-string</replaceable>,
the literal string <option>none</option> can be specified to disable this feature.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Verbosity, help</title>
<variablelist>
<varlistentry>
<term><option>-p</option></term>
<term><option>--print</option></term>
<listitem>
<para>Enables output of keysym-strings</para>
<para>keysym strings are printed in the format, accepted by the shortcut options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</option></term>
<term><option>--help</option></term>
<listitem>
<para>Output a short help text and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>Output version information and exit.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Miscellaneous</title>
<variablelist>
<varlistentry>
<term><option>--display=<replaceable>display-name</replaceable></option></term>
<listitem>
<para>Overrides the <varname>DISPLAY</varname> environment variable.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
</refsection>
<refsection>
<title>Environment</title>
<para>
The following environment variables affect <command>catlock</command>:
<variablelist>
<varlistentry>
<term><varname>DISPLAY</varname></term>
<listitem>
<para>Specifies the X11 display name.</para>
<para>If both <varname>DISPLAY</varname> and the option
<option>--display=<replaceable>display-name</replaceable></option> are missing,
the the program will fail.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsection>
<refsection>
<title>Bugs</title>
<para>Additional input devices other than the keyboard and core pointer are not disabled.
The cursor bitmap and colour cannot be modifed.</para>
</refsection>
</refentry>
<!-- vim:set ts=2 sts=2 sw=2 tw=120 et: -->