aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--meson.build2
-rw-r--r--swaylock/swaylock.1.scd103
-rw-r--r--swaymsg/swaymsg.1.scd66
3 files changed, 171 insertions, 0 deletions
diff --git a/meson.build b/meson.build
index 1e303e72..a1f406ec 100644
--- a/meson.build
+++ b/meson.build
@@ -57,6 +57,8 @@ if scdoc.found()
57 'sway/sway.5.scd', 57 'sway/sway.5.scd',
58 'sway/sway-bar.5.scd', 58 'sway/sway-bar.5.scd',
59 'sway/sway-input.5.scd', 59 'sway/sway-input.5.scd',
60 'swaylock/swaylock.1.scd',
61 'swaymsg/swaymsg.1.scd',
60 ] 62 ]
61 foreach filename : man_files 63 foreach filename : man_files
62 topic = filename.split('.')[-3].split('/')[-1] 64 topic = filename.split('.')[-3].split('/')[-1]
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
diff --git a/swaymsg/swaymsg.1.scd b/swaymsg/swaymsg.1.scd
new file mode 100644
index 00000000..1aa6a1b0
--- /dev/null
+++ b/swaymsg/swaymsg.1.scd
@@ -0,0 +1,66 @@
1swaymsg(1)
2
3# NAME
4
5swaymsg - Send messages to a running instance of sway over the IPC socket.
6
7# SYNOPSIS
8
9_swaymsg_ [options...] [message]
10
11# OPTIONS
12
13*-h, --help*
14 Show help message and quit.
15
16*-q, --quiet*
17 Sends the IPC message but does not print the response from sway.
18
19*-r, --raw*
20 Use raw output even if using a tty.
21
22*-s, --socket* <path>
23 Use the specified socket path. Otherwise, swaymsg will ask sway where the
24 socket is (which is the value of $SWAYSOCK, then of $I3SOCK).
25
26*-t, --type* <type>
27 Specify the type of IPC message. See below.
28
29*-v, --version*
30 Print the version (of swaymsg) and quit.
31
32# IPC MESSAGE TYPES
33
34*<command>*
35 The message is a sway command (the same commands you can bind to keybindings
36 in your sway config file). It will be executed immediately.
37
38 See **sway**(5) for a list of commands.
39
40*get\_workspaces*
41 Gets a JSON-encoded list of workspaces and their status.
42
43*get\_inputs*
44 Gets a JSON-encoded list of current inputs.
45
46*get\_outputs*
47 Gets a JSON-encoded list of current outputs.
48
49*get\_tree*
50 Gets a JSON-encoded layout tree of all open windows, containers, outputs,
51 workspaces, and so on.
52
53*get\_marks*
54 Get a JSON-encoded list of marks.
55
56*get\_bar\_config*
57 Get a JSON-encoded configuration for swaybar.
58
59*get\_version*
60 Get JSON-encoded version information for the running instance of sway.
61
62*get\_clipboard*
63 Get JSON-encoded information about the clipboard.
64 Returns the current clipboard mime-types if called without
65 arguments, otherwise returns the clipboard data in the requested
66 formats. Encodes the data using base64 for non-text mime types.