aboutsummaryrefslogtreecommitdiffstats
path: root/swaylock/swaylock.1.scd
diff options
context:
space:
mode:
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.
12 12
13# OPTIONS 13# OPTIONS
14 14
15*-h, --help* 15*-C, --config* <path>
16 Show help message and quit. 16 The config file to use. By default, the following paths are checked:
17 _$HOME/.swaylock/config_, _$XDG\_CONFIG\_HOME/swaylock/config_, and
18 _SYSCONFDIR/swaylock/config_. All flags aside from this one are valid
19 options in the configuration file using the format _long-option=value_.
20 For options such as _ignore-empty-password_, just supply the _long-option_.
21 All leading dashes should be omitted and the equals sign is required for
22 flags that take an argument.
17 23
18*-c, --color* <rrggbb[aa]> 24*-c, --color* <rrggbb[aa]>
19 Turn the screen into the given color. If -i is used, this sets the 25 Turn the screen into the given color. If -i is used, this sets the
20 background of the image to the given color. Defaults to white (FFFFFF), or 26 background of the image to the given color. Defaults to white (FFFFFF), or
21 transparent (00000000) if an image is in use. 27 transparent (00000000) if an image is in use.
22 28
29*-e, --ignore-empty-password*
30 When an empty password is provided by the user, do not validate it.
31
23*-f, --daemonize* 32*-f, --daemonize*
24 Fork into the background after spawning. Note: this is the default behavior 33 Detach from the controlling terminal after locking.
25 of i3lock. 34
35*-h, --help*
36 Show help message and quit.
26 37
27*-i, --image* [<output>:]<path> 38*-i, --image* [<output>:]<path>
28 Display the given image, optionally only on the given output. Use -c to set 39 Display the given image, optionally only on the given output. Use -c to set
29 a background color. 40 a background color.
30 41
31*--scaling* 42*-s, --scaling*
32 Scaling mode for images: _stretch_, _fill_, _fit_, _center_, or _tile_. 43 Scaling mode for images: _stretch_, _fill_, _fit_, _center_, or _tile_.
33 44
34*-t, --tiling* 45*-t, --tiling*
@@ -42,29 +53,52 @@ Locks your Wayland session.
42 53
43# APPEARANCE 54# APPEARANCE
44 55
45*--bshlcolor* <rrggbb[aa]> 56*--bs-hl-color* <rrggbb[aa]>
46 Sets the color of backspace highlight segments. 57 Sets the color of backspace highlight segments.
47 58
48*--font* <font> 59*--font* <font>
49 Sets the font of the text inside the indicator. 60 Sets the font of the text inside the indicator.
50 61
51*--insidecolor* <rrggbb[aa]> 62*--indicator-radius* <radius>
63 Sets the radius of the indicator to _radius_ pixels. The default value is
64 50.
65
66*--indicator-thickness* <thickness>
67 Sets the thickness of the indicator to _thickness_ pixels. The default value
68 is 10.
69
70*--inside-color* <rrggbb[aa]>
52 Sets the color of the inside of the indicator when typing or idle. 71 Sets the color of the inside of the indicator when typing or idle.
53 72
54*--insidevercolor* <rrggbb[aa]> 73*--inside-clear-color* <rrggbb[aa]>
74 Sets the color of the inside of the indicator when cleared.
75
76*--inside-ver-color* <rrggbb[aa]>
55 Sets the color of the inside of the indicator when verifying. 77 Sets the color of the inside of the indicator when verifying.
56 78
57*--insidewrongcolor* <rrggbb[aa]> 79*--inside-wrong-color* <rrggbb[aa]>
58 Sets the color of the inside of the indicator when invalid. 80 Sets the color of the inside of the indicator when invalid.
59 81
60*--keyhlcolor* <rrggbb[aa]> 82*--key-hl-color* <rrggbb[aa]>
61 Sets the color of keypress highlight segments. 83 Sets the color of key press highlight segments.
62 84
63*--linecolor* <rrggbb[aa]> 85*--line-color* <rrggbb[aa]>
64 Sets the color of the lines that separate the inside and outside of the 86 Sets the color of the lines that separate the inside and outside of the
65 indicator. 87 indicator when typing or idle.
66 88
67*-s, --line-uses-inside* 89*--line-clear-color* <rrggbb[aa]>
90 Sets the color of the lines that separate the inside and outside of the
91 indicator when cleared.
92
93*--line-ver-color* <rrggbb[aa]>
94 Sets the color of the lines that separate the inside and outside of the
95 indicator when verifying.
96
97*--line-wrong-color* <rrggbb[aa]>
98 Sets the color of the lines that separate the inside and outside of the
99 indicator when invalid.
100
101*-n, --line-uses-inside*
68 Use the color of the inside of the indicator for the line separating the 102 Use the color of the inside of the indicator for the line separating the
69 inside and outside of the indicator. 103 inside and outside of the indicator.
70 104
@@ -72,28 +106,32 @@ Locks your Wayland session.
72 Use the outer ring's color for the line separating the inside and outside of 106 Use the outer ring's color for the line separating the inside and outside of
73 the indicator. 107 the indicator.
74 108
75*--ringcolor* <rrggbb[aa]> 109*--ring-color* <rrggbb[aa]>
76 Sets the color of the outside of the indicator when typing or idle. 110 Sets the color of the outside of the indicator when typing or idle.
77 111
78*--ringvercolor* <rrggbb[aa]> 112*--ring-clear-color* <rrggbb[aa]>
113 Sets the color of the outside of the indicator when cleared.
114
115*--ring-ver-color* <rrggbb[aa]>
79 Sets the color of the outside of the indicator when verifying. 116 Sets the color of the outside of the indicator when verifying.
80 117
81*--ringwrongcolor* <rrggbb[aa]> 118*--ring-wrong-color* <rrggbb[aa]>
82 Sets the color of the outside of the indicator when invalid. 119 Sets the color of the outside of the indicator when invalid.
83 120
84*--separatorcolor* <rrggbb[aa]> 121*--separator-color* <rrggbb[aa]>
85 Sets the color of the lines that seperate highlight segments. 122 Sets the color of the lines that separate highlight segments.
86 123
87*--textcolor* <rrggbb[aa]> 124*--text-color* <rrggbb[aa]>
88 Sets the color of the text inside the indicator. 125 Sets the color of the text inside the indicator when typing or idle.
89 126
90*--indicator-radius* <radius> 127*--text-clear-color* <rrggbb[aa]>
91 Sets the radius of the indicator to _radius_ pixels. The default value is 128 Sets the color of the text inside the indicator when cleared.
92 50.
93 129
94*--indicator-thickness* <thickness> 130*--text-ver-color* <rrggbb[aa]>
95 Sets the thickness of the indicator to _thickness_ pixels. The default value 131 Sets the color of the text inside the indicator when verifying.
96 is 10. 132
133*--text-wrong-color* <rrggbb[aa]>
134 Sets the color of the text inside the indicator when invalid.
97 135
98# AUTHORS 136# AUTHORS
99 137