suckless/slock
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

slock.1: improve man page

Browse source 
* Fix all lint warnings.
* Remove "Op Ar arg..." in the description. It looks ugly.
* No need to set -offset left for .Bd literal.
This commit is contained in:
Hiltjo Posthuma 2023-10-06 11:48:40 +02:00
parent 2fec14c567
commit ca6f30f621
1 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
slock.1
View file

@ -1,5 +1,6 @@
.Dd 2016-08-23 .Dd October 6, 2023
.Dt SLOCK 1 .Dt SLOCK 1
.Os
.Sh NAME .Sh NAME
.Nm slock .Nm slock
.Nd simple X screen locker .Nd simple X screen locker
@ -9,31 +10,33 @@
.Op Ar cmd Op Ar arg ... .Op Ar cmd Op Ar arg ...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
is a simple X screen locker. If provided, is a simple X screen locker.
.Ar cmd Op Ar arg ... If provided,
.Ar cmd
is executed after the screen has been locked. is executed after the screen has been locked.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl v .It Fl v
Print version information to stdout and exit. Print version information to stdout and exit.
.El .El
.Sh EXAMPLES
$
.Nm
/usr/sbin/s2ram
.Sh SECURITY CONSIDERATIONS .Sh SECURITY CONSIDERATIONS
To make sure a locked screen can not be bypassed by switching VTs 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 or killing the X server with Ctrl+Alt+Backspace, it is recommended
to disable both in to disable both in
.Xr xorg.conf 5 .Xr xorg.conf 5
for maximum security: for maximum security:
.Bd -literal -offset left .Bd -literal
Section "ServerFlags" Section "ServerFlags"
Option "DontVTSwitch" "True" Option "DontVTSwitch" "True"
Option "DontZap" "True" Option "DontZap" "True"
EndSection EndSection
.Ed .Ed
.Sh EXAMPLES
$
.Nm
/usr/sbin/s2ram
.Sh CUSTOMIZATION .Sh CUSTOMIZATION
.Nm .Nm
can be customized by creating a custom config.h from config.def.h and 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. (re)compiling the source code.
This keeps it fast, secure and simple.