From 37a2725da41e363fcdca12d0374b192cd03905d0 Mon Sep 17 00:00:00 2001 From: BossCode45 Date: Wed, 28 Jun 2023 21:24:59 +1200 Subject: feat: Added key chording Probably a hacky mess but oh well. Key chords can be done by seperating binds in string with ` `. You can set the quit bind with `quitkey`, default mod+g. (Chords also exited when pressing unbound keys). --- readme.html | 87 ++++++++++++++++++++++++++++++++----------------------------- 1 file changed, 46 insertions(+), 41 deletions(-) (limited to 'readme.html') diff --git a/readme.html b/readme.html index 1914ed8..7879e4d 100644 --- a/readme.html +++ b/readme.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + YATwm @@ -200,36 +200,36 @@

Table of Contents

-
-

1. This config is best read in Emacs!

+
+

1. This config is best read in Emacs!

-
-

2. Disclaimer: This is still very much in beta

+
+

2. Disclaimer: This is still very much in beta

This only just works, multiple monitors aren't supported and floating windows cannot move and there is no resizing. Many features are just hacked together and are likely to break. However, it is just about usable so if you really want to try then go for it! (feel free to make an issue if you have any questions).
@@ -237,16 +237,16 @@ This only just works, multiple monitors aren't supported and floating windows ca

-
-

3. Usage instructions

+
+

3. Usage instructions

-
-

3.1. Installation

+
+

3.1. Installation

-
-

3.1.1. Pre reqs

+
+

3.1.1. Pre reqs

  • Xlib and g++ and libnotify to build the program
    • @@ -258,8 +258,8 @@ This only just works, multiple monitors aren't supported and floating windows ca
-
-

3.1.2. Installing and removing

+
+

3.1.2. Installing and removing

  • make i or make install to install
    • @@ -269,23 +269,23 @@ This only just works, multiple monitors aren't supported and floating windows ca
-
-

3.2. Config

+
+

3.2. Config

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.

-
-

3.2.1. Syntax

+
+

3.2.1. 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 \\. 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").

    -
  1. Command arg types
    +
  2. Command arg types
    • String: this is just some text, this can be wrapped in quotes if you want a space in it.
      • @@ -302,7 +302,7 @@ The config file is a list of commands. Each command should be on a new line. For
    3. -
  3. List of commands
    +
  4. List of commands
    • exit: shuts down YATwm
      • @@ -359,17 +359,21 @@ The config file is a list of commands. Each command should be on a new line. For
  5. bind: Binds a key to a command
      -
    • String: The key bind, modifiers and keys are separated with +, e.g. mod+x
      • +
    • String: The key bind, modifiers and keys are separated with +, e.g. mod+x. This can also be a key chord, where you have multiple binds, where when pressed in succession will execute the command (make sure to enclose this arg in quotes, and then separate the binds with spaces)
    • String rest: The command to run
    6. +
  6. quitkey: Sets the key to exit a key chord (note: pressing an unbound key also does this)
    +
      +
    • String: The key bind, modifiers and keys are separated with +, e.g. mod+g.
      • +
  7. wsDump: This is a command for testing, you probably don't want to use it
-
-

3.2.2. General

+
+

3.2.2. General

You can change either the inner gaps (padding around each window - so double it for space between windows), or the outer gaps (padding around the display - add to inner gaps to get space between window and screen edges).
@@ -379,8 +383,8 @@ YATwm also keeps a log file, the location of this file can be changed with the c

-
-

3.2.3. Workspaces

+
+

3.2.3. Workspaces

You can add workspace with the command addworkspace in the config file.
@@ -406,8 +410,8 @@ Defaults workspace are listed below (these are the args for the addworkspace com

-
-

3.2.4. Keybinds

+
+

3.2.4. Keybinds

Current keybinds (these can all be edited):
@@ -427,6 +431,7 @@ Current keybinds (these can all be edited):

  • mod + f : toggle fullscreen
  • mod + (num) : switch to workspace (num) - currently only for 1-10 but you can add more
  • mod + shift + (num) : move window to workspace (num) - currently only for 1-10 but you can add more
    • +
  • mod + g : exit key chord

    • (mod is super, and the direction keys are h, j, k, l - left, down, up, right respectively like vim)
    @@ -451,8 +456,8 @@ Commands are executed going down the list and multiple commands with the same ke

    -