slock

simple X display locker utility

git clone https://9o.is/git/slock.git

slock.1

(1250B)


      1 .Dd October 6, 2023
      2 .Dt SLOCK 1
      3 .Os
      4 .Sh NAME
      5 .Nm slock
      6 .Nd simple X screen locker
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Op Fl v
     10 .Op Fl t Ar seconds
     11 .Op Fl m Ar message
     12 .Op Ar cmd Op Ar arg ...
     13 .Sh DESCRIPTION
     14 .Nm
     15 is a simple X screen locker.
     16 If provided,
     17 .Ar cmd
     18 is executed after the screen has been locked.
     19 .Pp
     20 The options are as follows:
     21 .Bl -tag -width Ds
     22 .It Fl m Ar message
     23 Display custom
     24 .Ar message
     25 on the lock screen.
     26 .It Fl t Ar seconds
     27 Lock the screen for a minimum of
     28 .Ar seconds
     29 before allowing password entry. The screen will prevent unlocking until the timer expires.
     30 .It Fl v
     31 Print version information to stdout and exit.
     32 .El
     33 .Sh EXIT STATUS
     34 .Ex -std
     35 .Sh EXAMPLES
     36 $
     37 .Nm
     38 Lock the screen normally.
     39 .Pp
     40 $
     41 .Nm
     42 /usr/sbin/s2ram
     43 Lock the screen before suspending to RAM.
     44 .Sh SECURITY CONSIDERATIONS
     45 To make sure a locked screen can not be bypassed by switching VTs
     46 or killing the X server with Ctrl+Alt+Backspace, it is recommended
     47 to disable both in
     48 .Xr xorg.conf 5
     49 for maximum security:
     50 .Bd -literal
     51 Section "ServerFlags"
     52 	Option "DontVTSwitch" "True"
     53 	Option "DontZap"      "True"
     54 EndSection
     55 .Ed
     56 .Sh CUSTOMIZATION
     57 .Nm
     58 can be customized by creating a custom config.h from config.def.h and
     59 (re)compiling the source code.
     60 This keeps it fast, secure and simple.