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.scd167
1 files changed, 0 insertions, 167 deletions
diff --git a/swaylock/swaylock.1.scd b/swaylock/swaylock.1.scd
deleted file mode 100644
index 2c7979be..00000000
--- a/swaylock/swaylock.1.scd
+++ /dev/null
@@ -1,167 +0,0 @@
1swaylock(1)
2
3# NAME
4
5swaylock - Screen locker for Wayland
6
7# SYNOPSIS
8
9_swaylock_ [options...]
10
11Locks your Wayland session.
12
13# OPTIONS
14
15*-C, --config* <path>
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.
23
24*-e, --ignore-empty-password*
25 When an empty password is provided by the user, do not validate it.
26
27*-f, --daemonize*
28 Detach from the controlling terminal after locking.
29
30 Note: this is the default behavior of i3lock.
31
32*-h, --help*
33 Show help message and quit.
34
35*-v, --version*
36 Show the version number and quit.
37
38# APPEARANCE
39
40*-u, --no-unlock-indicator*
41 Disable the unlock indicator.
42
43*-i, --image* [<output>:]<path>
44 Display the given image, optionally only on the given output. Use -c to set
45 a background color.
46
47*-L, --disable-caps-lock-text*
48 Disable the Caps Lock Text.
49
50*-l, --indicator-caps-lock*
51 Show the current Caps Lock state also on the indicator.
52
53*-s, --scaling*
54 Scaling mode for images: _stretch_, _fill_, _fit_, _center_, or _tile_.
55
56*-t, --tiling*
57 Same as --scaling=tile.
58
59*-c, --color* <rrggbb[aa]>
60 Turn the screen into the given color. If -i is used, this sets the
61 background of the image to the given color. Defaults to white (FFFFFF), or
62 transparent (00000000) if an image is in use.
63
64*--bs-hl-color* <rrggbb[aa]>
65 Sets the color of backspace highlight segments.
66
67*--caps-lock-bs-hl-color* <rrggbb[aa]>
68 Sets the color of backspace highlight segments when Caps Lock is active.
69
70*--caps-lock-bs-hl-color* <rrggbb[aa]>
71 Sets the color of the key press highlight segments when Caps Lock is active.
72
73*--font* <font>
74 Sets the font of the text inside the indicator.
75
76*--indicator-radius* <radius>
77 Sets the radius of the indicator to _radius_ pixels. The default value is
78 50.
79
80*--indicator-thickness* <thickness>
81 Sets the thickness of the indicator to _thickness_ pixels. The default value
82 is 10.
83
84*--inside-color* <rrggbb[aa]>
85 Sets the color of the inside of the indicator when typing or idle.
86
87*--inside-clear-color* <rrggbb[aa]>
88 Sets the color of the inside of the indicator when cleared.
89
90*--inside-caps-lock-color* <rrggbb[aa]>
91 Sets the color of the inside of the indicator when Caps Lock is active.
92
93*--inside-ver-color* <rrggbb[aa]>
94 Sets the color of the inside of the indicator when verifying.
95
96*--inside-wrong-color* <rrggbb[aa]>
97 Sets the color of the inside of the indicator when invalid.
98
99*--key-hl-color* <rrggbb[aa]>
100 Sets the color of key press highlight segments.
101
102*--line-color* <rrggbb[aa]>
103 Sets the color of the lines that separate the inside and outside of the
104 indicator when typing or idle.
105
106*--line-clear-color* <rrggbb[aa]>
107 Sets the color of the lines that separate the inside and outside of the
108 indicator when cleared.
109
110*--line-caps-lock-color* <rrggbb[aa]>
111 Sets the color of the line between the inside and ring when Caps Lock
112 is active.
113
114*--line-ver-color* <rrggbb[aa]>
115 Sets the color of the lines that separate the inside and outside of the
116 indicator when verifying.
117
118*--line-wrong-color* <rrggbb[aa]>
119 Sets the color of the lines that separate the inside and outside of the
120 indicator when invalid.
121
122*-n, --line-uses-inside*
123 Use the color of the inside of the indicator for the line separating the
124 inside and outside of the indicator.
125
126*-r, --line-uses-ring*
127 Use the outer ring's color for the line separating the inside and outside of
128 the indicator.
129
130*--ring-color* <rrggbb[aa]>
131 Sets the color of the outside of the indicator when typing or idle.
132
133*--ring-clear-color* <rrggbb[aa]>
134 Sets the color of the outside of the indicator when cleared.
135
136*--ring-caps-lock-color* <rrggbb[aa]>
137 Sets the color of the ring of the indicator when Caps Lock is active.
138
139*--ring-ver-color* <rrggbb[aa]>
140 Sets the color of the outside of the indicator when verifying.
141
142*--ring-wrong-color* <rrggbb[aa]>
143 Sets the color of the outside of the indicator when invalid.
144
145*--separator-color* <rrggbb[aa]>
146 Sets the color of the lines that separate highlight segments.
147
148*--text-color* <rrggbb[aa]>
149 Sets the color of the text inside the indicator when typing or idle.
150
151*--text-clear-color* <rrggbb[aa]>
152 Sets the color of the text inside the indicator when cleared.
153
154*--text-caps-lock-color* <rrggbb[aa]>
155 Sets the color of the text when Caps Lock is active.
156
157*--text-ver-color* <rrggbb[aa]>
158 Sets the color of the text inside the indicator when verifying.
159
160*--text-wrong-color* <rrggbb[aa]>
161 Sets the color of the text inside the indicator when invalid.
162
163# AUTHORS
164
165Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
166source contributors. For more information about sway development, see
167https://github.com/swaywm/sway.