File: xsecurelock.1.md

package info (click to toggle)
xsecurelock 1.9.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,164 kB
  • sloc: ansic: 4,522; sh: 1,645; makefile: 263
file content (51 lines) | stat: -rw-r--r-- 1,324 bytes parent folder | download | duplicates (3)
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
% XSECURELOCK(1) XSecureLock User Manual
% Rudolf Polzer
% April 15, 2019

# NAME

XSecureLock - X11 screen lock utility

# SYNPOSIS

[*options*] xsecurelock [-- *command-to-run-when-locked*]

# DESCRIPTION

XSecureLock is an X11 screen lock utility designed with the primary goal of
security.

It locks the current X11 session, and only allows unlocking if the user
authenticates to it (typically with the login password).

While locked, it can launch a screen saver process and then waits for
input events. Upon an input event, it displays a login dialog to allow
for unlocking.

# OPTIONS

Options are set as environment variables prior to invoking XSecureLock;
the following variables are available:

<!-- ENV VARIABLES HERE -->

Additionally, XSecureLock spawns the *command-to-run-when-locked* once locking
is complete; this can be used as a notification mechanism if desired.

# REPORTING BUGS

The official bug tracker is at <https://github.com/google/xsecurelock/issues/>.

# COPYRIGHT

The code is released unser the Apache 2.0 license. See the LICENSE file for more
details.

# SEE ALSO

`xss-lock` (1), `xautolock` (1).

The *README.md* file included with XSecureLock contains full documentation.

The XSecureLock source  code and all documentation may be downloaded on
<https://github.com/google/xsecurelock/>.