sway/swaylock/swaylock.1.txt
Calvin Lee 34e2c70abc Feature for #1078: Configurable swaylock colors
Colors are configured through the command line so that swaylock conforms
to the i3lock fork 'github.com/chrjguill/i3lock-color'. Differences from
it are that one letter options '-r' and '-s' are not implimentend because
'-s' is already used by '--scaling' in swaylock.
This commit also fixed whitespace in 'include/swaylock/swaylock.h' and
changed `parse_color` in 'common/util.h' so that it can accept colors
that do not start with a hash. This was done to keep compatability with
the i3lock fork.
2017-02-21 14:12:31 -07:00

93 lines
2.2 KiB
Plaintext

/////
vim:set ts=4 sw=4 tw=82 noet:
/////
:quotes.~:
swaylock (1)
============
Name
----
swaylock - Screen locker for sway
Synopsis
--------
'swaylock' [options]
Lock the current sway session.
Options
-------
*-h, --help*::
Show help message and quit.
*-c, \--color* <rrggbb[aa]>::
Turn the screen into the given color instead of white. If an image is in use,
also enables color display.
*-i, \--image* [<output>:]<path>::
Display the given image, optionally only on the given output.
*-s, \--scaling*::
Scaling mode for images: stretch, fill, fit, center, or tile.
*-t, --tiling*::
Same as --scaling=tile.
*-u, --no-unlock-indicator*::
Disable the unlock indicator.
*-v, \--version*::
Show the version number and quit.
*--socket <path>*::
Use the specified socket path. Otherwise, swaymsg will ask sway where the
socket is (which is the value of $SWAYSOCK, then of $I3SOCK).
*--font* <font>::
Sets the font of the text inside the indicator.
*--textcolor* <rrggbb[aa]>::
Sets the color of the text inside the indicator.
*--insidevercolor* <rrggbb[aa]>::
Sets the color of the inside of the indicator when verifying.
*--insidewrongcolor* <rrggbb[aa]>::
Sets the color of the inside of the indicator when invalid.
*--insidecolor* <rrggbb[aa]>::
Sets the color of the inside of the indicator when typing or idle.
*--ringvercolor* <rrggbb[aa]>::
Sets the color of the outside of the indicator when verifying.
*--ringwrongcolor* <rrggbb[aa]>::
Sets the color of the outside of the indicator when invalid.
*--ringcolor* <rrggbb[aa]>::
Sets the color of the outside of the indicator when typing or idle.
*--linecolor* <rrggbb[aa]>::
Sets the color of the lines that separate the inside and outside of the
indicator.
*--separatorcolor* <rrggbb[aa]>::
Sets the color of the lines that seperate highlight segments.
*--keyhlcolor* <rrggbb[aa]>::
Sets the color of keypress highlight segments.
*--bshlcolor* <rrggbb[aa]>::
Sets the color of backspace highlight segments.
Authors
-------
Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
source contributors. For more information about sway development, see
<https://github.com/SirCmpwn/sway>.