suckless-slock/slock.1

.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 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.
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 08:55:34 +00:00			`.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 ...`
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 00:48:48 +00:00			`is executed after the screen has been locked.`
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 08:55:34 +00:00			`.Sh OPTIONS`
			`.Bl -tag -width Ds`
			`.It Fl v`
			`Print version information to stdout and exit.`
			`.El`
			`.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.`