summaryrefslogtreecommitdiffstats
path: root/swaylock
diff options
context:
space:
mode:
authorLibravatar Drew DeVault <sir@cmpwn.com>2018-05-11 21:39:47 -0400
committerLibravatar Drew DeVault <sir@cmpwn.com>2018-05-11 21:39:47 -0400
commit22f52b91ed178cf402fe3fc857bbfd351a753b1d (patch)
tree3326aa8312c4033b6dcec5a4201213d2e93d7528 /swaylock
parentRemove sway-security(7) (diff)
downloadsway-22f52b91ed178cf402fe3fc857bbfd351a753b1d.tar.gz
sway-22f52b91ed178cf402fe3fc857bbfd351a753b1d.tar.zst
sway-22f52b91ed178cf402fe3fc857bbfd351a753b1d.zip
Add swaylock(1) and swaymsg(1)
Diffstat (limited to 'swaylock')
-rw-r--r--swaylock/swaylock.1.scd103
1 files changed, 103 insertions, 0 deletions
diff --git a/swaylock/swaylock.1.scd b/swaylock/swaylock.1.scd
new file mode 100644
index 00000000..2580bff9
--- /dev/null
+++ b/swaylock/swaylock.1.scd
@@ -0,0 +1,103 @@
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*-h, --help*
16 Show help message and quit.
17
18*-c, --color* <rrggbb[aa]>
19 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
21 transparent (00000000) if an image is in use.
22
23*-f, --daemonize*
24 Fork into the background after spawning. Note: this is the default behavior
25 of i3lock.
26
27*-i, --image* [<output>:]<path>
28 Display the given image, optionally only on the given output. Use -c to set
29 a background color.
30
31*--scaling*
32 Scaling mode for images: _stretch_, _fill_, _fit_, _center_, or _tile_.
33
34*-t, --tiling*
35 Same as --scaling=tile.
36
37*-u, --no-unlock-indicator*
38 Disable the unlock indicator.
39
40*-v, --version*
41 Show the version number and quit.
42
43# APPEARANCE
44
45*--bshlcolor* <rrggbb[aa]>
46 Sets the color of backspace highlight segments.
47
48*--font* <font>
49 Sets the font of the text inside the indicator.
50
51*--insidecolor* <rrggbb[aa]>
52 Sets the color of the inside of the indicator when typing or idle.
53
54*--insidevercolor* <rrggbb[aa]>
55 Sets the color of the inside of the indicator when verifying.
56
57*--insidewrongcolor* <rrggbb[aa]>
58 Sets the color of the inside of the indicator when invalid.
59
60*--keyhlcolor* <rrggbb[aa]>
61 Sets the color of keypress highlight segments.
62
63*--linecolor* <rrggbb[aa]>
64 Sets the color of the lines that separate the inside and outside of the
65 indicator.
66
67*-s, --line-uses-inside*
68 Use the color of the inside of the indicator for the line separating the
69 inside and outside of the indicator.
70
71*-r, --line-uses-ring*
72 Use the outer ring's color for the line separating the inside and outside of
73 the indicator.
74
75*--ringcolor* <rrggbb[aa]>
76 Sets the color of the outside of the indicator when typing or idle.
77
78*--ringvercolor* <rrggbb[aa]>
79 Sets the color of the outside of the indicator when verifying.
80
81*--ringwrongcolor* <rrggbb[aa]>
82 Sets the color of the outside of the indicator when invalid.
83
84*--separatorcolor* <rrggbb[aa]>
85 Sets the color of the lines that seperate highlight segments.
86
87*--textcolor* <rrggbb[aa]>
88 Sets the color of the text inside the indicator.
89
90*--indicator-radius* <radius>
91 Sets the radius of the indicator to _radius_ pixels. The default value is
92 50.
93
94*--indicator-thickness* <thickness>
95 Sets the thickness of the indicator to _thickness_ pixels. The default value
96 is 10.
97
98# AUTHORS
99
100Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
101source contributors. For more information about sway development, see
102https://github.com/swaywm/sway.
103