From acbe9028157c67eb3937299ff86e5ee26816a408 Mon Sep 17 00:00:00 2001 From: Campbell Vertesi Date: Mon, 13 Jul 2020 16:47:20 +0200 Subject: [PATCH] Add note on quoting to swaymsg manpage --- swaymsg/swaymsg.1.scd | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 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. + 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_ + 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.