summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Vertesi <campbell@vertesi.com>2020-07-13 16:47:20 +0200
committerSimon Ser <contact@emersion.fr>2020-07-15 19:27:13 +0200
commit105c69d431389aecb908cccfce3712f77251ccde (patch)
tree3c6e165985599b3d623522c33a208fcb1ce722ed
parent28bcb1e6f259fc6b73faa7f32105779de1d4b4b2 (diff)
Add note on quoting to swaymsg manpage
(cherry picked from commit acbe9028157c67eb3937299ff86e5ee26816a408)
-rw-r--r--swaymsg/swaymsg.1.scd18
1 files changed, 12 insertions, 6 deletions
diff --git a/swaymsg/swaymsg.1.scd b/swaymsg/swaymsg.1.scd
index b8a38b544..4228a0f00 100644
--- a/swaymsg/swaymsg.1.scd
+++ b/swaymsg/swaymsg.1.scd
@@ -44,12 +44,18 @@ _swaymsg_ [options...] [message]
The message is a sway command (the same commands you can bind to keybindings
in your sway config file). It will be executed immediately.
- See **sway**(5) for a list of commands.
-
- Tip: If you are proving a command that contains a leading hyphen (_-_),
- insert two hyphens (_--_) before the command to signal to swaymsg not to
- parse anything beyond that point as an option. For example, use
- _swaymsg -- mark --add test_ instead of _swaymsg mark --add test_
+ See *sway*(5) for a list of commands.
+
+ Tips:
+ - Command expansion is performed twice: once by swaymsg, and again by sway.
+ If you have quoted multi-word strings in your command, enclose the entire
+ command in single-quotes. For example, use
+ _swaymsg 'output "Foobar Display" enable'_ instead of
+ _swaymsg output "Foobar Display" enable_.
+ - If you are proving a command that contains a leading hyphen (_-_), insert
+ two hyphens (_--_) before the command to signal to swaymsg not to parse
+ anything beyond that point as an option. For example, use
+ _swaymsg -- mark --add test_ instead of _swaymsg mark --add test_.
*get\_workspaces*
Gets a JSON-encoded list of workspaces and their status.