aboutsummaryrefslogtreecommitdiff
path: root/swaylock/swaylock.1.scd
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2018-07-23 20:27:56 -0400
committerDrew DeVault <sir@cmpwn.com>2018-07-23 20:31:11 -0400
commitf4b882475eee7a81c206c7825616cc4656b2f60b (patch)
tree38e6ebf81b235424f105dcbcbb194e5e9eac70c0 /swaylock/swaylock.1.scd
parentacd79e1505c06089e4fb9fb6c0c6e1d351ba9176 (diff)
parent224ade138208e9aa525423cbfbd643aa9d9b63c3 (diff)
Merge branch 'master' into pid-workspaces
Diffstat (limited to 'swaylock/swaylock.1.scd')
-rw-r--r--swaylock/swaylock.1.scd92
1 files changed, 65 insertions, 27 deletions
diff --git a/swaylock/swaylock.1.scd b/swaylock/swaylock.1.scd
index 35d6444c..3107124f 100644
--- a/swaylock/swaylock.1.scd
+++ b/swaylock/swaylock.1.scd
@@ -12,23 +12,34 @@ Locks your Wayland session.
# OPTIONS
-*-h, --help*
- Show help message and quit.
+*-C, --config* <path>
+ The config file to use. By default, the following paths are checked:
+ _$HOME/.swaylock/config_, _$XDG\_CONFIG\_HOME/swaylock/config_, and
+ _SYSCONFDIR/swaylock/config_. All flags aside from this one are valid
+ options in the configuration file using the format _long-option=value_.
+ For options such as _ignore-empty-password_, just supply the _long-option_.
+ All leading dashes should be omitted and the equals sign is required for
+ flags that take an argument.
*-c, --color* <rrggbb[aa]>
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.
+*-e, --ignore-empty-password*
+ When an empty password is provided by the user, do not validate it.
+
*-f, --daemonize*
- Fork into the background after spawning. Note: this is the default behavior
- of i3lock.
+ Detach from the controlling terminal after locking.
+
+*-h, --help*
+ Show help message and quit.
*-i, --image* [<output>:]<path>
Display the given image, optionally only on the given output. Use -c to set
a background color.
-*--scaling*
+*-s, --scaling*
Scaling mode for images: _stretch_, _fill_, _fit_, _center_, or _tile_.
*-t, --tiling*
@@ -42,29 +53,52 @@ Locks your Wayland session.
# APPEARANCE
-*--bshlcolor* <rrggbb[aa]>
+*--bs-hl-color* <rrggbb[aa]>
Sets the color of backspace highlight segments.
*--font* <font>
Sets the font of the text inside the indicator.
-*--insidecolor* <rrggbb[aa]>
+*--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.
+
+*--inside-color* <rrggbb[aa]>
Sets the color of the inside of the indicator when typing or idle.
-*--insidevercolor* <rrggbb[aa]>
+*--inside-clear-color* <rrggbb[aa]>
+ Sets the color of the inside of the indicator when cleared.
+
+*--inside-ver-color* <rrggbb[aa]>
Sets the color of the inside of the indicator when verifying.
-*--insidewrongcolor* <rrggbb[aa]>
+*--inside-wrong-color* <rrggbb[aa]>
Sets the color of the inside of the indicator when invalid.
-*--keyhlcolor* <rrggbb[aa]>
- Sets the color of keypress highlight segments.
+*--key-hl-color* <rrggbb[aa]>
+ Sets the color of key press highlight segments.
-*--linecolor* <rrggbb[aa]>
+*--line-color* <rrggbb[aa]>
Sets the color of the lines that separate the inside and outside of the
- indicator.
+ indicator when typing or idle.
-*-s, --line-uses-inside*
+*--line-clear-color* <rrggbb[aa]>
+ Sets the color of the lines that separate the inside and outside of the
+ indicator when cleared.
+
+*--line-ver-color* <rrggbb[aa]>
+ Sets the color of the lines that separate the inside and outside of the
+ indicator when verifying.
+
+*--line-wrong-color* <rrggbb[aa]>
+ Sets the color of the lines that separate the inside and outside of the
+ indicator when invalid.
+
+*-n, --line-uses-inside*
Use the color of the inside of the indicator for the line separating the
inside and outside of the indicator.
@@ -72,28 +106,32 @@ Locks your Wayland session.
Use the outer ring's color for the line separating the inside and outside of
the indicator.
-*--ringcolor* <rrggbb[aa]>
+*--ring-color* <rrggbb[aa]>
Sets the color of the outside of the indicator when typing or idle.
-*--ringvercolor* <rrggbb[aa]>
+*--ring-clear-color* <rrggbb[aa]>
+ Sets the color of the outside of the indicator when cleared.
+
+*--ring-ver-color* <rrggbb[aa]>
Sets the color of the outside of the indicator when verifying.
-*--ringwrongcolor* <rrggbb[aa]>
+*--ring-wrong-color* <rrggbb[aa]>
Sets the color of the outside of the indicator when invalid.
-*--separatorcolor* <rrggbb[aa]>
- Sets the color of the lines that seperate highlight segments.
+*--separator-color* <rrggbb[aa]>
+ Sets the color of the lines that separate highlight segments.
-*--textcolor* <rrggbb[aa]>
- Sets the color of the text inside the indicator.
+*--text-color* <rrggbb[aa]>
+ Sets the color of the text inside the indicator when typing or idle.
-*--indicator-radius* <radius>
- Sets the radius of the indicator to _radius_ pixels. The default value is
- 50.
+*--text-clear-color* <rrggbb[aa]>
+ Sets the color of the text inside the indicator when cleared.
-*--indicator-thickness* <thickness>
- Sets the thickness of the indicator to _thickness_ pixels. The default value
- is 10.
+*--text-ver-color* <rrggbb[aa]>
+ Sets the color of the text inside the indicator when verifying.
+
+*--text-wrong-color* <rrggbb[aa]>
+ Sets the color of the text inside the indicator when invalid.
# AUTHORS