Add a section on security considerations

[slock.git] / slock.1

diff --git a/slock.1 b/slock.1
index 1f946d925e75e30f7e17fa03f008ac591a7f095b..82cdcd62064166a75975997e7901f1df7e5bea97 100644 (file)
--- a/slock.1
+++ b/slock.1
@@ -1,29 +1,39 @@
-.TH SLOCK 1 slock\-VERSION
-.SH NAME
-slock \- simple X display locker
-.SH SYNOPSIS
-.B slock
-.RB [ \-v
-|
-.IR post_lock_command ]
-.SH DESCRIPTION
-.B slock
-is a screen locker for X. If provided, the
-.IR post_lock_command
-will be executed when the screen is locked.
-.SH OPTIONS
-.TP
-.B \-v
-prints version information to stdout, then exits.
-.SH EXAMPLES
-$ slock /usr/sbin/s2ram
-.SH CUSTOMIZATION
-.B slock
-can be customized by creating a custom config.h and (re)compiling the source
-code. This keeps it fast, secure and simple.
-.SH AUTHORS
-See the LICENSE file for the authors.
-.SH LICENSE
-See the LICENSE file for the terms of redistribution.
-.SH BUGS
-Please report them.
+.Dd 2016-08-23
+.Dt SLOCK 1
+.Sh NAME
+.Nm slock
+.Nd simple X screen locker
+.Sh SYNOPSIS
+.Nm
+.Op Fl v
+.Op Ar cmd Op Ar arg ...
+.Sh DESCRIPTION
+.Nm
+is a simple X screen locker. If provided,
+.Ar cmd Op Ar arg ...
+is executed after the screen has been locked.
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl v
+Print version information to stdout and exit.
+.El
+.Sh SECURITY CONSIDERATIONS
+To make sure a locked screen can not be bypassed by switching VTs
+or killing the X server with Ctrl+Alt+Backspace, it is recommended
+to disable both in
+.Xr xorg.conf 5
+for maximum security:
+.Bd -literal -offset left
+Section "ServerFlags"
+       Option "DontVTSwitch" "True"
+       Option "DontZap"      "True"
+EndSection
+.Ed
+.Sh EXAMPLES
+$
+.Nm
+/usr/sbin/s2ram
+.Sh CUSTOMIZATION
+.Nm
+can be customized by creating a custom config.h from config.def.h and
+(re)compiling the source code. This keeps it fast, secure and simple.