From c4813b0ad3f8e0cc4f55b0f0fda8359eb9729417 Mon Sep 17 00:00:00 2001 From: BossCode45 Date: Wed, 21 Jun 2023 20:26:52 +1200 Subject: feat: Fixed fullscreen stuff after rebasing in the config refactor Also added stuff to the readme for it --- readme.html | 82 +++++++++++++++++++++++++++++++------------------------------ 1 file changed, 42 insertions(+), 40 deletions(-) (limited to 'readme.html') diff --git a/readme.html b/readme.html index 24514ae..1040470 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 \\.

    -
  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
      • @@ -338,6 +338,7 @@ The config file is a list of commands. Each command should be on a new line. For
  5. reload: Reloads YATwm, this reloads the config file and re runs the monitor detection, and will unmap and remap all windows to refresh them.
  6. nextMonitor: Focuses the next monitor, wraps around.
    7. +
  7. fullscreen: Toggles if the current window is fullscreen
  8. gaps: Sets the size of the inner gaps, margins around each window (this ends up looking doubled as each window has it)
    • Number: The size in pixels
      • @@ -367,8 +368,8 @@ The config file is a list of commands. Each command should be on a new line. For
-
-

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).
@@ -378,8 +379,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.
@@ -405,8 +406,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):
@@ -423,6 +424,7 @@ Current keybinds (these can all be edited):

  • mod + c : firefox
  • mod + x : lock
  • mod + shift + x : lock and sleep
    • +
  • 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
    • @@ -449,8 +451,8 @@ Commands are executed going down the list and multiple commands with the same ke
    -