slock

1 files changed, 45 insertions, 0 deletions

diff --git a/slock/slock.1 b/slock/slock.1
new file mode 100644
index 0000000..40c15e1
--- /dev/null
+++ b/slock/slock.1
@@ -0,0 +1,45 @@
+.Dd October 6, 2023
+.Dt SLOCK 1
+.Os
+.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
+is executed after the screen has been locked.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl v
+Print version information to stdout and exit.
+.El
+.Sh EXIT STATUS
+.Ex -std
+.Sh EXAMPLES
+$
+.Nm
+/usr/sbin/s2ram
+.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
+Section "ServerFlags"
+	Option "DontVTSwitch" "True"
+	Option "DontZap"      "True"
+EndSection
+.Ed
+.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.