alex/swayfx
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
swayfx/swaylock/swaylock.1.txt

113 lines
2.8 KiB
Plaintext
Raw Normal View History

add a manpage for swaylock
2016-03-02 02:23:45 +11: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]>::
Correct swaylock man page description of -i and -c
2017-06-19 12:58:19 +10:00
Turn the screen into the given color. If -i is used, this sets the
background of the image to the given color. Defaults to white (ffffff), or
transparent (00000000) if an image is in use.
add a manpage for swaylock
2016-03-02 02:23:45 +11:00
Change 'display' to 'output' in swaylock docs where necessary
2016-03-25 09:49:58 +11:00
*-i, \--image* [<output>:]<path>::
Correct swaylock man page description of -i and -c
2017-06-19 12:58:19 +10:00
Display the given image, optionally only on the given output. Use -c to set
a background color.
add a manpage for swaylock
2016-03-02 02:23:45 +11:00
Documentation and style fixes for swaylock
2017-02-22 15:14:28 +11:00
*--scaling*::
add a manpage for swaylock
2016-03-02 02:23:45 +11:00
Scaling mode for images: stretch, fill, fit, center, or tile.
*-t, --tiling*::
Same as --scaling=tile.
add --no-unlock-indicator to swaylock
2016-05-27 01:16:34 +10:00
*-u, --no-unlock-indicator*::
Disable the unlock indicator.
add a manpage for swaylock
2016-03-02 02:23:45 +11: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-25 09:02:34 +11: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).
Documentation and style fixes for swaylock
2017-02-22 15:14:28 +11:00
Appearance
----------
*--bshlcolor* <rrggbb[aa]>::
Sets the color of backspace highlight segments.
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-22 06:49:22 +11:00
*--font* <font>::
Sets the font of the text inside the indicator.
Documentation and style fixes for swaylock
2017-02-22 15:14:28 +11:00
*--insidecolor* <rrggbb[aa]>::
Sets the color of the inside of the indicator when typing or idle.
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-22 06:49:22 +11:00
*--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.
Documentation and style fixes for swaylock
2017-02-22 15:14:28 +11:00
*--keyhlcolor* <rrggbb[aa]>::
Sets the color of keypress highlight segments.
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-22 06:49:22 +11:00
Documentation and style fixes for swaylock
2017-02-22 15:14:28 +11:00
*--linecolor* <rrggbb[aa]>::
Sets the color of the lines that separate the inside and outside of the
indicator.
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-22 06:49:22 +11:00
Documentation and style fixes for swaylock
2017-02-22 15:14:28 +11:00
*-s, \--line-uses-inside*::
Use the color of the inside of the indicator for the line separating the
inside and outside of the indicator.
*-r, \--line-uses-ring*::
Use the outer ring's color for the line separating the inside and outside of
the indicator.
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-22 06:49:22 +11:00
*--ringcolor* <rrggbb[aa]>::
Sets the color of the outside of the indicator when typing or idle.
Documentation and style fixes for swaylock
2017-02-22 15:14:28 +11:00
*--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.
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-22 06:49:22 +11:00
*--separatorcolor* <rrggbb[aa]>::
Sets the color of the lines that seperate highlight segments.
Documentation and style fixes for swaylock
2017-02-22 15:14:28 +11:00
*--textcolor* <rrggbb[aa]>::
Sets the color of the text inside the indicator.
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-25 09:02:34 +11:00
Allow swaylock indicator size to be configurable
2017-07-31 22:48:48 +10:00
*--indicator-radius* <radius>::
Sets the radius of the indicator to _radius_ pixels. The default value is
50.
*--indicator-thickness* <thickness>::
Sets the thickness of the indicator to _thickness_ pixels. The default value
is 10.
add a manpage for swaylock
2016-03-02 02:23:45 +11: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>.
Reference in a new issue Copy permalink