initial
[tlock.git] / tlock.1
blob8b4f29a97ca58fb7a0c91c8e6a7263927c709e6e
1 .Dd 2017-03-31
2 .Dt TLOCK 1
3 .Os
4 .Sh NAME
5 .Nm tlock
6 .Nd Lock the terminal in a manner suitable for tmux
7 .Sh SYNOPSIS
8 .Nm
9 .Sh DESCRIPTION
10 .Nm
11 Ignores signals, draws a background, and repeatedly runs a test
12 .Nm su
13 until that command succeeds. After the first failure, the screen
14 turns red, which allows you to know if someone has attempted to log
15 in while you were away.
16 .Pp
17 After a correct login is given,
18 .Nm
19 exits.
20 .Sh FILES
21 Since
22 .Nm
23 relies on
24 .Xr su 1
25 for authentication, it is recommended to adjust
26 .Pa login.defs
27 to allow only one authentication
28 .Pq otherwise things look sort of ugly .
29 .Sh EXAMPLES
30 To run from the terminal,
31 .Dl % tlock
32 .Pp
33 To use from
34 .Xr tmux 1 , 
35 ensure
36 .Pa .tmux.conf
37 contains
38 .Dl set -g lock-command tlock
39 and see the
40 .Ic lock-server
41 command.
42 .Sh SEE ALSO
43 .Xr vlock 1
44 .Xr slock 1
45 .Xr lock 1
46 .Xr tmux 1
47 .Xr su 1
48 .Xr login.defs 5
49 .Sh AUTHORS
50 .An S. Gilles Aq Mt sgilles@math.umd.edu