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

46 lines
909 B
Groff
Raw Permalink Normal View History

slock.1: improve man page * Fix all lint warnings. * Remove "Op Ar arg..." in the description. It looks ugly. * No need to set -offset left for .Bd literal.
2023-10-06 12:48:40 +03:00
.Dd October 6, 2023
Convert manpage to mandoc and fix usage In all honor, the previous usage was formally more correct, but for the sake of consistency across all the tools having the v-flag, I separated it from the command-string. Also, make use of the mandoc macros for the manpage. This makes it easier to maintain, extend and change in the future.
2016-08-23 11:55:34 +03:00
.Dt SLOCK 1
slock.1: improve man page * Fix all lint warnings. * Remove "Op Ar arg..." in the description. It looks ugly. * No need to set -offset left for .Bd literal.
2023-10-06 12:48:40 +03:00
.Os
Convert manpage to mandoc and fix usage In all honor, the previous usage was formally more correct, but for the sake of consistency across all the tools having the v-flag, I separated it from the command-string. Also, make use of the mandoc macros for the manpage. This makes it easier to maintain, extend and change in the future.
2016-08-23 11:55:34 +03:00
.Sh NAME
.Nm slock
.Nd simple X screen locker
.Sh SYNOPSIS
.Nm
.Op Fl v
.Op Ar cmd Op Ar arg ...
.Sh DESCRIPTION
.Nm
slock.1: improve man page * Fix all lint warnings. * Remove "Op Ar arg..." in the description. It looks ugly. * No need to set -offset left for .Bd literal.
2023-10-06 12:48:40 +03:00
is a simple X screen locker.
If provided,
.Ar cmd
No need for usage() There are 2 arguments why -v and -h are broken: 1) if you are running off git, -v will show the last stable release, effectively making this option useless. people running stable versions leave open an attack surface this way in case there are vulnerabilities found. 99% of the people are also using package managers to keep their software up to date, instead of running $TOOL -v to check how old it is. 2) -h is a sad excuse for not just looking at the manual page (man 1 slock). Given we accept a post_lock_command, we can't be as liberal and just intercept certain flags. I changed the manpage to reflect this change.
2016-02-14 02:48:48 +02:00
is executed after the screen has been locked.
slock.1: use standard wording for options Remove the OPTIONS section and add an EXIT STATUS section.
2023-10-06 12:57:31 +03:00
.Pp
The options are as follows:
Convert manpage to mandoc and fix usage In all honor, the previous usage was formally more correct, but for the sake of consistency across all the tools having the v-flag, I separated it from the command-string. Also, make use of the mandoc macros for the manpage. This makes it easier to maintain, extend and change in the future.
2016-08-23 11:55:34 +03:00
.Bl -tag -width Ds
.It Fl v
Print version information to stdout and exit.
.El
slock.1: use standard wording for options Remove the OPTIONS section and add an EXIT STATUS section.
2023-10-06 12:57:31 +03:00
.Sh EXIT STATUS
.Ex -std
slock.1: improve man page * Fix all lint warnings. * Remove "Op Ar arg..." in the description. It looks ugly. * No need to set -offset left for .Bd literal.
2023-10-06 12:48:40 +03:00
.Sh EXAMPLES
$
.Nm
/usr/sbin/s2ram
Add a section on security considerations The section on security considerations sheds some light on the problems that we can't solve within slock but which the user has to solve in his X configuration.
2016-09-28 21:20:51 +03:00
.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:
slock.1: improve man page * Fix all lint warnings. * Remove "Op Ar arg..." in the description. It looks ugly. * No need to set -offset left for .Bd literal.
2023-10-06 12:48:40 +03:00
.Bd -literal
Add a section on security considerations The section on security considerations sheds some light on the problems that we can't solve within slock but which the user has to solve in his X configuration.
2016-09-28 21:20:51 +03:00
Section "ServerFlags"
Option "DontVTSwitch" "True"
Option "DontZap" "True"
EndSection
.Ed
Convert manpage to mandoc and fix usage In all honor, the previous usage was formally more correct, but for the sake of consistency across all the tools having the v-flag, I separated it from the command-string. Also, make use of the mandoc macros for the manpage. This makes it easier to maintain, extend and change in the future.
2016-08-23 11:55:34 +03:00
.Sh CUSTOMIZATION
.Nm
can be customized by creating a custom config.h from config.def.h and
slock.1: improve man page * Fix all lint warnings. * Remove "Op Ar arg..." in the description. It looks ugly. * No need to set -offset left for .Bd literal.
2023-10-06 12:48:40 +03:00
(re)compiling the source code.
This keeps it fast, secure and simple.
Reference in a new issue Copy permalink