sway-patched-tray-menu/swaylock/swaylock.1.txt

/////
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>.
add a manpage for swaylock 2016-03-01 16:23:45 +01:00			`/////`
			`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]>::`
Add choice of display to --image. Additionally - Made background colors display when an image is enabled if a --color is specified. - Link CJson to swaylock. - Add the --socket option to swaylock. 2016-03-24 23:02:34 +01:00			`Turn the screen into the given color instead of white. If an image is in use,`
			`also enables color display.`
add a manpage for swaylock 2016-03-01 16:23:45 +01:00
Change 'display' to 'output' in swaylock docs where necessary 2016-03-24 23:49:58 +01:00			`-i, \--image [<output>:]<path>::`
			`Display the given image, optionally only on the given output.`
add a manpage for swaylock 2016-03-01 16:23:45 +01:00
			`-s, \--scaling::`
			`Scaling mode for images: stretch, fill, fit, center, or tile.`

			`-t, --tiling::`
			`Same as --scaling=tile.`

add --no-unlock-indicator to swaylock 2016-05-26 17:16:34 +02:00			`-u, --no-unlock-indicator::`
			`Disable the unlock indicator.`

add a manpage for swaylock 2016-03-01 16:23:45 +01:00			`-v, \--version::`
			`Show the version number and quit.`

Add choice of display to --image. Additionally - Made background colors display when an image is enabled if a --color is specified. - Link CJson to swaylock. - Add the --socket option to swaylock. 2016-03-24 23:02:34 +01:00			`--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).`

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 20:49:22 +01:00			`--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.`

Add choice of display to --image. Additionally - Made background colors display when an image is enabled if a --color is specified. - Link CJson to swaylock. - Add the --socket option to swaylock. 2016-03-24 23:02:34 +01:00
add a manpage for swaylock 2016-03-01 16:23:45 +01:00			`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>.`