aboutsummaryrefslogtreecommitdiff
path: root/swaymsg/swaymsg.1.scd
diff options
context:
space:
mode:
authorFurkan Sahin <furkan-dev@proton.me>2019-08-04 02:02:13 -0400
committerFurkan Sahin <furkan-dev@proton.me>2019-08-04 02:02:13 -0400
commit3d674b4af1a0188ec78d693d46ce0ca017b995a9 (patch)
tree31206baa6238542c53d6c6b51e08d572caea8fed /swaymsg/swaymsg.1.scd
parent0476a41022814cc9fa310cc1ae5bb3a0f0f99424 (diff)
swaymsg: return 2 for sway errors
This mirrors a change in i3 4.17 that returns 2 for errors from sway, including invalid command, command failed, and invalid subscription requests
Diffstat (limited to 'swaymsg/swaymsg.1.scd')
-rw-r--r--swaymsg/swaymsg.1.scd13
1 files changed, 13 insertions, 0 deletions
diff --git a/swaymsg/swaymsg.1.scd b/swaymsg/swaymsg.1.scd
index 1bcf956a..bcddf35b 100644
--- a/swaymsg/swaymsg.1.scd
+++ b/swaymsg/swaymsg.1.scd
@@ -86,6 +86,19 @@ _swaymsg_ [options...] [message]
provided in the form of a valid JSON array. If any of the types are invalid
or if an valid JSON array is not provided, this will result in an failure.
+# RETURN CODES
+
+*0*
+ Success
+
+*1*
+ swaymsg errors such as invalid syntax, unable to connect to the ipc socket
+ or unable to parse sway's reply
+
+*2*
+ Sway returned an error when processing the command (ex. invalid command,
+ command failed, and invalid subscription request)
+
# SEE ALSO
*sway*(5) *sway-bar*(5) *sway-input*(5) *sway-output*(5) *sway-ipc*(7)