tyler/suckless-slock
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b87bfa2343
suckless-slock/slock.1

30 lines
631 B
Groff
Raw Normal View History

add slock.1 man page
2016-02-11 15:49:59 +00:00
.TH SLOCK 1 slock\-VERSION
.SH NAME
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
slock \- simple X screen locker
add slock.1 man page
2016-02-11 15:49:59 +00:00
.SH SYNOPSIS
.B slock
Revert "No need for usage()" This reverts most of commit a6dc051e3744ce5b14c54d2d246d3e8258207e76 and fixes some related stuff: - keep spelling fixes from original commit - make -h and -v also work when followed by more arguments - any unknown flag prints usage - fix output of -v to display "slock: version 1.3" instead of "slock: slock-1.3"
2016-02-15 13:15:45 +00:00
.RB [ \-v
|
.IR cmd ]
add slock.1 man page
2016-02-11 15:49:59 +00:00
.SH DESCRIPTION
.B slock
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 an X screen locker. If provided,
.IR cmd
is executed after the screen has been locked.
Revert "No need for usage()" This reverts most of commit a6dc051e3744ce5b14c54d2d246d3e8258207e76 and fixes some related stuff: - keep spelling fixes from original commit - make -h and -v also work when followed by more arguments - any unknown flag prints usage - fix output of -v to display "slock: version 1.3" instead of "slock: slock-1.3"
2016-02-15 13:15:45 +00:00
.SH OPTIONS
.TP
.B \-v
prints version information to stdout, then exits.
add slock.1 man page
2016-02-11 15:49:59 +00:00
.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.
Revert "No need for usage()" This reverts most of commit a6dc051e3744ce5b14c54d2d246d3e8258207e76 and fixes some related stuff: - keep spelling fixes from original commit - make -h and -v also work when followed by more arguments - any unknown flag prints usage - fix output of -v to display "slock: version 1.3" instead of "slock: slock-1.3"
2016-02-15 13:15:45 +00:00
.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.
Reference in New Issue Copy Permalink