summaryrefslogtreecommitdiffstats
path: root/swaymsg
diff options
context:
space:
mode:
authorLibravatar Drew DeVault <sir@cmpwn.com>2015-12-05 18:16:45 -0500
committerLibravatar Drew DeVault <sir@cmpwn.com>2015-12-05 18:16:45 -0500
commit762a78be3ca22767b94adf5bba4668047aa80e4e (patch)
tree53cf05c4a723991b1da13f835297a2d1fb420d5e /swaymsg
parentFree outputs on registry teardown (diff)
parentmove manpages to subfolders (diff)
downloadsway-762a78be3ca22767b94adf5bba4668047aa80e4e.tar.gz
sway-762a78be3ca22767b94adf5bba4668047aa80e4e.tar.zst
sway-762a78be3ca22767b94adf5bba4668047aa80e4e.zip
Merge pull request #292 from christophgysin/man
move manpages to subfolders
Diffstat (limited to 'swaymsg')
-rw-r--r--swaymsg/CMakeLists.txt2
-rw-r--r--swaymsg/swaymsg.1.txt72
2 files changed, 74 insertions, 0 deletions
diff --git a/swaymsg/CMakeLists.txt b/swaymsg/CMakeLists.txt
index 2481b280..06939991 100644
--- a/swaymsg/CMakeLists.txt
+++ b/swaymsg/CMakeLists.txt
@@ -12,3 +12,5 @@ install(
12 DESTINATION bin 12 DESTINATION bin
13 COMPONENT runtime 13 COMPONENT runtime
14) 14)
15
16add_manpage(swaymsg 1)
diff --git a/swaymsg/swaymsg.1.txt b/swaymsg/swaymsg.1.txt
new file mode 100644
index 00000000..984780fa
--- /dev/null
+++ b/swaymsg/swaymsg.1.txt
@@ -0,0 +1,72 @@
1/////
2vim:set ts=4 sw=4 tw=82 noet:
3/////
4:quotes.~:
5
6swaymsg (1)
7===========
8
9Name
10----
11swaymsg - Send messages to a running instance of sway over the IPC socket.
12
13Synopsis
14--------
15'swaymsg' [options] [message]
16
17Options
18-------
19
20*-h, --help*::
21 Show help message and quit.
22
23*-q, \--quiet*::
24 Sends the IPC message but does not print the response from sway.
25
26*-v, \--version*::
27 Print the version (of swaymsg) and quit.
28
29*-s, --socket* <path>::
30 Use the specified socket path. Otherwise, swaymsg will ask sway where the
31 socket is (which is the value of $SWAYSOCK, then of $I3SOCK).
32
33*-t, \--type* <type>::
34 Specify the type of IPC message. See below.
35
36IPC Message Types
37-----------------
38
39*command*::
40 The message is a sway command (the same commands you can bind to keybindings
41 in your sway config file). It will be executed immediately.
42
43*get_workspaces*::
44 Gets a JSON-encoded list of workspaces and their status.
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
62Authors
63-------
64
65Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
66source contributors. For more information about sway development, see
67<https://github.com/SirCmpwn/sway>.
68
69See Also
70--------
71
72**sway**(5)