Files
i3lock-fancy/doc/i3lock-fancy.1
Henry Nelson b77540eb2b Remove unnecessary mkdir and rename manpage
@install's -D flag will create any necessary parent directories.
Explicitly using mkdir leads to errors in the PKGBUILD because
$pkgdir/usr/share does not exist.
2018-08-07 22:10:11 -04:00

68 lines
1.3 KiB
Groff

.TH I3LOCK-FANCY 1 2017-06-26
.SH NAME
.B i3lock-fancy
- Bash script around i3lock for fancy effect
.SH DESCRIPTION
Takes a screenshot of the desktop, blurs the background and adds a lock icon and
text. This blurred image is then given to \fBi3lock\fR as the lockscreen
background.
.SH SYNOPSIS
.B i3lock-fancy [options]
.SH OPTIONS
.TP
\fB-h, --help\fP
Display a help screen and exit.
.TP
\fB-d, --desktop\fP
Attempt to minimize all windows before locking.
.TP
\fB-g, --greyscale\fP
Set background to greyscale instead of color.
.TP
\fB-p, --pixelate\fP
Pixelate the background instead of blur, runs faster.
.TP
\fB-f <fontname>, --font <fontname>\fP
Set a custom font.
.TP
\fB-t <text>, --text <text>\fP
Set a custom text prompt.
.TP
\fB-l, --listfonts\fP
Display a list of possible fonts for use with -f/--font.
.IP
Note: this option will not lock the screen, it displays the list and exits
immediately.
.TP
\fB-n, --nofork\fP
Do not fork i3lock after starting.
.TP
\fB--\fP
Must be last option. Set command to use for taking a screenshot. Default is
\'import -window root\'. Using \'scrot\' or \'maim\' will increase script speed and
allow setting custom flags like having a delay.
.SH SEE ALSO
\fBi3lock\fR(1)
.SH AUTHORS
Dolores Portalatin <hello@doloresportalatin.info>