From a07d3fad444a7b283f69f0170bcbf083219bf896 Mon Sep 17 00:00:00 2001 From: ACuteWoof Date: Thu, 23 May 2024 12:42:46 +0530 Subject: [PATCH] documentation --- doc/qtile.md | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 doc/qtile.md diff --git a/doc/qtile.md b/doc/qtile.md new file mode 100644 index 0000000..6f8f715 --- /dev/null +++ b/doc/qtile.md @@ -0,0 +1,100 @@ +Woof OS Qtile Edition +===================== + +Keybinds for Woof OS Qtile edition +================================== + +Woof OS uses a tiling window manager, qtile, mainly controlled using the keyboard. +The keybinds listed here are declared in `~/.config/qtile/config.py`. + +By default, `[mod]` is the `Super`/`mod4` key, which is the `⊞ Win` key on most keyboards, and the `⌘ Command` key on Macs. + +Focus navigation +---------------- + +* `[mod]` `H` moves focus to the **left** +* `[mod]` `L` moves focus to the **right** +* `[mod]` `J` moves focus **down** +* `[mod]` `K` moves focus **up** +* `[mod]` `Space` moves focus to the **next window** +* `[mod]` `.` moves focus to the **next screen** + +The mouse can also be used to switch focus between windows by simply hovering over them. + +* `[mod]` `1`/`2`/`3`/`4`/`5`/`6`/`7`/`8`/`9` moves focus to the workspace assigned to the ID + +Window arrangement +------------------ + +* `[mod]` `Shift` `H` moves focused window to the **left** +* `[mod]` `Shift` `L` moves focused window to the **right** +* `[mod]` `Shift` `J` moves focused window **down** +* `[mod]` `Shift` `K` moves focused window **up** +* `[mod]` `Shift` `Return` toggles between split and unsplit sides of stack +* `[mod]` `Tab` toggles between layouts +* `[mod]` `Shift` `1`/`2`/`3`/`4`/`5`/`6`/`7`/`8`/`9` shifts focused window to the workspace assigned to the ID + +Window sizing +------------- + +* `[mod]` `CTRL` `H` grows window to the **left** +* `[mod]` `CTRL` `L` grows window to the **right** +* `[mod]` `CTRL` `J` grows window **down** +* `[mod]` `CTRL` `K` grows window **up** +* `[mod]` `N` resets all window sizes + +Miscellaneous and launching programs +------------------------------------ + +* `[mod]` `Return` launches the terminal (alacritty) +* `[mod]` `R` opens the Rofi run launcher +* `[mod]` `P` opens the Rofi power menu +* `[mod]` `B` launches the web browser (brave) +* `[mod]` `C` launches the file manager (vifm) +* `[mod]` `Z` opens copied PDF URL in Zathura +* `[mod]` `Y` opens copied YouTube URL in MPV (using yt-dlp) +* `[mod]` `F` opens the Flameshot GUI +* `[mod]` `S` takes a full screenshot using Scrot +* `[mod]` `T` spawns a command using a prompt +* `[mod]` `V` shows the active windows through Rofi +* `[mod]` `D` sends a notification including the current date and time +* `[mod]` `Q` kills focused window +* `[mod]` `CTRL` `R` restarts Qtile +* `[mod]` `CTRL` `Q` shuts down Qtile + +* * * + +Configs +------- + +* [archiso profile](https://github.com/woof-os/iso-profile) +* [qtile](https://github.com/woof-os/qtile) +* [rofi](https://github.com/woof-os/rofi) +* [dunst](https://github.com/woof-os/dunst) +* [calamares](https://github.com/woof-os/calamares) +* [alacritty](https://github.com/woof-os/alacritty) +* [starship](https://github.com/woof-os/starship) +* [qt5](https://github.com/woof-os/qt5) +* [zsh](https://github.com/woof-os/zshrc) +* [gtk theme](https://github.com/woof-os/tokyonight-gtk) +* [icons](https://github.com/woof-os/icon-config) +* [wallpapers](https://github.com/woof-os/wallpapers) + +* * * + +Gallery +======= + +![main image](https://os.lewoof.xyz/images/qtile/s4.png) + +![screenshot](https://os.lewoof.xyz/images/qtile/s0.png) + +![screenshot](https://os.lewoof.xyz/images/qtile/s1.png) + +![screenshot](https://os.lewoof.xyz/images/qtile/s2.png) + +![screenshot](https://os.lewoof.xyz/images/qtile/s3.png) + +![screenshot](https://os.lewoof.xyz/images/qtile/s5.png) + +![screenshot](https://os.lewoof.xyz/images/qtile/s6.png)