AWESOME(1)

📦
version 4.3 · 10 versions
, in opensuse-leap 16.0

💖 AWESOME(1) — the awesome window manager, bestie 💖

✨ NAME ✨

awesome — the awesome window manager. That’s the name, that’s the vibe. 💅

📜 SYNOPSIS 📜

awesome [-v | --version] [-h | --help] [-c | --config FILE] [-k |
       --check] [--search DIRECTORY] [-a | --no-argb] [-r | *--replace]

🌸 DESCRIPTION 🌸

okay so awesome is a window manager for X. It manages windows in different layouts, like floating or tiled. Any layout can be applied dynamically, optimizing the environment for the application in use and the task currently being performed. That’s the whole assignment. 🦋

In a tiled layout, windows are managed in a master area and a stacking area. The master area contains the windows which currently need the most attention, whereas the stacking area contains all other windows. In a floating layout windows can be resized and moved freely. Dialog windows are always managed as floating, regardless of the layout currently applied. The spiral and dwindle layouts are special cases of the tiled layout where the stacking area is arranged in a spiral for the former or as a rectangular fractal for the later. Spiral? Fractal? She contains multitudes. 😭

Windows are grouped by tags in awesome. Each window can be tagged with one or more tags. Selecting certain tags displays all windows with these tags. Tag girl summer, honestly. ✨

awesome can contain small wiboxes which can display anything you want: all available tags, the current layout, the title of the visible windows, text, etc. Wiboxes are the main character energy here, no cap. 👑

⚙️ OPTIONS ⚙️

  • -v, --version — print version information to standard output, then exit.
  • -h, --help — print help information, then exit.
  • -c, --config FILE — use an alternate configuration file instead of $XDG_CONFIG_HOME/awesome/rc.lua.
  • -k, --check — check configuration file syntax.
  • --search — add a directory to the library search path. (The synopsis has DIRECTORY right there, bestie.)
  • -a, --no-argb — don’t use ARGB visuals.
  • -r, --replace — replace an existing window manager.

🖱️ DEFAULT MOUSE BINDINGS 🖱️

  • Button1 on tag name — view tag.
  • Button4, Button5 on tag name — switch to previous or next tag.
  • Button4, Button5 on root window — switch to previous or next tag.
  • Button1, Button3, Button4, Button5 on layout symbol — switch to previous or next layout.

🛠️ Layout modification

  • Mod4 + Button1 on tag name — tag current client with this tag only.
  • Mod4 + Button3 on tag name — toggle this tag for client.
  • Button3 on tag name — add this tag to current view.
  • Mod4 + Button1 on client window — move window.
  • Mod4 + Button3 on client window — resize window.

⌨️ DEFAULT KEY BINDINGS ⌨️

🆘 Help

  • Mod4 + s — show currently assigned key bindings.

🎛️ Window manager control

  • Mod4 + Control + r — restart awesome.
  • Mod4 + Shift + q — quit awesome.
  • Mod4 + r — run prompt.
  • Mod4 + x — run Lua code prompt.
  • Mod4 + Return — spawn terminal emulator.
  • Mod4 + w — open main menu.

🪟 Clients

  • Mod4 + m — maximize client.
  • Mod4 + n — minimize client.
  • Mod4 + Control + n — restore client.
  • Mod4 + f — set client fullscreen.
  • Mod4 + Shift + c — kill focused client.
  • Mod4 + t — set client on-top.
  • Mod4 + j — focus next client.
  • Mod4 + k — focus previous client.
  • Mod4 + u — focus first urgent client.
  • Mod4 + Left — view previous tag.
  • Mod4 + Right — view next tag.
  • Mod4 + 1-9 — switch to tag 1-9.
  • Mod4 + Control + j — focus next screen.
  • Mod4 + Control + k — focus previous screen.
  • Mod4 + Escape — focus previously selected tag set.

🛠️ Layout modification

  • Mod4 + Shift + j — switch client with next client.
  • Mod4 + Shift + k — switch client with previous client.
  • Mod4 + o — send client to next screen.
  • Mod4 + h — decrease master width factor by 5%.
  • Mod4 + l — increase master width factor by 5%.
  • Mod4 + Shift + h — increase number of master windows by 1.
  • Mod4 + Shift + l — decrease number of master windows by 1.
  • Mod4 + Control + h — increase number of columns for non-master windows by 1.
  • Mod4 + Control + l — decrease number of columns for non-master windows by 1.
  • Mod4 + space — switch to next layout.
  • Mod4 + Shift + space — switch to previous layout.
  • Mod4 + Control + space — toggle client floating status.
  • Mod4 + Control + Return — swap focused client with master.
  • Mod4 + Control + 1-9 — toggle tag view.
  • Mod4 + Shift + 1-9 — tag client with tag.
  • Mod4 + Shift + Control + 1-9 — toggle tag on client.

🎀 CUSTOMIZATION 🎀

awesome is customized by creating a custom $XDG_CONFIG_HOME/awesome/rc.lua file. That’s the move, bestie. 🫶

🚨 SIGNALS 🚨

awesome can be restarted by sending it a SIGHUP. Slay, but carefully. 💀

👀 SEE ALSO 👀

💀 BUGS 💀

okay so the page literally says: “Of course there’s no bug in awesome. But there may be unexpected behaviors.” Not me making this up. 🙈

👑 AUTHORS 👑

Julien Danjou julien@danjou.info and others. Iconic behavior, honestly. 💜

🌈 WWW 🌈

https://awesomewm.org

okay bye bestie 💖 this page is dated 2024-02-20, and the manual name in the footer is AWESOME(1) — periodt. 🫶

📦 where this page comes from