summaryrefslogtreecommitdiff
path: root/readme.org
diff options
context:
space:
mode:
authorBossCode45 <human.cyborg42@gmail.com>2023-06-24 20:26:29 +1200
committerBossCode45 <human.cyborg42@gmail.com>2023-06-24 20:26:29 +1200
commit638c3ac10003f66ef4af43f50ee365c9036da0fe (patch)
treea2e17e4693761e92a6be2d84b12d763e48bb48eb /readme.org
parent87b7f6c47d8eab8bfe7f126652a88939aac58a6a (diff)
downloadYATwm-638c3ac10003f66ef4af43f50ee365c9036da0fe.tar.gz
YATwm-638c3ac10003f66ef4af43f50ee365c9036da0fe.zip
feat: Added ; as a command separator
Diffstat (limited to 'readme.org')
-rw-r--r--readme.org2
1 files changed, 1 insertions, 1 deletions
diff --git a/readme.org b/readme.org
index 9a41662..82863b9 100644
--- a/readme.org
+++ b/readme.org
@@ -20,7 +20,7 @@ This only just works, multiple monitors aren't supported and floating windows ca
You can configure YATwm with the config file in ~$HOME/.config/YATwm/config~ or ~$XDG_CONFIG_HOME/YATwm/config~ if you have that set. I have provided an example config file in the project dir that has all the variables set to their defaults (this will also be installed to ~/etc/YATwm/config~.
It should alert you with a notification if you have an error, and put the error your log file. If the whole file is missing then it will use the default in ~/etc/YATwm/config~.
*** Syntax
-The config file is a list of commands. Each command should be on a new line. For example, to set the gaps you would use the ~gaps~ command like this ~gaps 10~ (make sure this is all there is on that line). This says to call the command ~gaps~ with the arguments of ~10~. Commands can have multiple arguments and these should be separated with a space, if you want a space in one of the arguments then wrap the arg in quotes, e.g. ~addWorkspace "1: A" 1~, here the arguments are ~1: A~ and ~1~. If you want to have a quote in your argument then make sure that arg is wrapped in quotes or escape it with ~\~ (e.g. ~\'~), to insert ~\~ then use ~\\~.
+The config file is a list of commands. Each command should be on a new line. For example, to set the gaps you would use the ~gaps~ command like this ~gaps 10~ (make sure this is all there is on that line). This says to call the command ~gaps~ with the arguments of ~10~. Commands can have multiple arguments and these should be separated with a space, if you want a space in one of the arguments then wrap the arg in quotes, e.g. ~addWorkspace "1: A" 1~, here the arguments are ~1: A~ and ~1~. If you want to have a quote in your argument then make sure that arg is wrapped in quotes or escape it with ~\~ (e.g. ~\'~), to insert ~\~ then use ~\\~. If you want to have multiple commands on the same line, e.g. binding a key to multiple commands, then use ~;~ as an argument on its own to separate them (tip: if you are using this for keybinds then enclose *all* the keybind commands in quotes, e.g. ~bind mod+l "spawn i3lock ; spawn systemctl suspend"~).
**** Command arg types
- String: this is just some text, this can be wrapped in quotes if you want a space in it.
- String rest: This will only ever be the final argument. This just takes the rest of the line as a string, so you can use spaces without needing quotes.