XMONAD(1)

πŸŽ€ NAME πŸŽ€

xmonad β€” Tiling Window Manager

okay bestie, welcome to the XMONAD(1) page from the General Commands Manual πŸ’… this is the whole vibe for xmonad, and yes it's iconic.

πŸ’– DESCRIPTION πŸ’–

okay so xmonad is a minimalist tiling window manager for X, written in Haskell. Windows are managed using automatic layout algorithms, and those algorithms can be dynamically reconfigured. At any time, windows are arranged so as to maximize the use of screen real estate. Every feature of the window manager is accessible purely from the keyboard: a mouse is entirely optional. xmonad is configured in Haskell, and custom layout algorithms may be implemented by the user in config files. A principle of xmonad is predictability: the user should know in advance precisely the window arrangement that will result from any action. no cap, that's the whole point.

By default, xmonad provides three layout algorithms: tall, wide and fullscreen. In tall or wide mode, windows are tiled and arranged to prevent overlap and maximize screen use. Sets of windows are grouped together on virtual screens, and each screen retains its own layout, which may be reconfigured dynamically. Multiple physical monitors are supported via Xinerama, allowing simultaneous display of a number of screens. obsessed.

By utilizing the expressivity of a modern functional language with a rich static type system, xmonad provides a complete, featureful window manager in less than 1200 lines of code, with an emphasis on correctness and robustness. Internal properties of the window manager are checked using a combination of static guarantees provided by the type system, and type-based automated testing. A benefit of this is that the code is simple to understand, and easy to modify. it's giving "small but actually powerful" main character energy ✨

✨ USAGE ✨

xmonad places each window into a β€œworkspace”. Each workspace can have any number of windows, which you can cycle through with mod-j and mod-k. Windows are either displayed full screen, tiled horizontally, or tiled vertically. You can toggle the layout mode with mod-space, which will cycle through the available modes. vibe check passed.

You can switch to workspace N with mod-N. For example, to switch to workspace 5, you would press mod-5. Similarly, you can move the current window to another workspace with mod-shift-N.

When running with multiple monitors (Xinerama), each screen has exactly 1 workspace visible. mod-{w,e,r} switch the focus between screens, while shift-mod-{w,e,r} move the current window to that screen. When xmonad starts, workspace 1 is on screen 1, workspace 2 is on screen 2, etc. When switching workspaces to one that is already visible, the current and visible workspaces are swapped. lowkey clever.

🚩 FLAGS 🚩

xmonad has several flags which you may pass to the executable. These flags are:

  • --recompile β€” Recompiles your xmonad.hs configuration
  • --restart β€” Causes the currently running xmonad process to restart
  • --replace β€” Replace the current window manager with xmonad
  • --version β€” Display version of xmonad
  • --verbose-version β€” Display detailed version of xmonad

⌨️ DEFAULT KEYBOARD BINDINGS ⌨️

  • mod-shift-return β€” Launch terminal
  • mod-p β€” Launch dmenu
  • mod-shift-p β€” Launch gmrun
  • mod-shift-c β€” Close the focused window
  • mod-space β€” Rotate through the available layout algorithms
  • mod-shift-space β€” Reset the layouts on the current workspace to default
  • mod-n β€” Resize viewed windows to the correct size
  • mod-tab β€” Move focus to the next window
  • mod-shift-tab β€” Move focus to the previous window
  • mod-j β€” Move focus to the next window
  • mod-k β€” Move focus to the previous window
  • mod-m β€” Move focus to the master window
  • mod-return β€” Swap the focused window and the master window
  • mod-shift-j β€” Swap the focused window with the next window
  • mod-shift-k β€” Swap the focused window with the previous window
  • mod-h β€” Shrink the master area
  • mod-l β€” Expand the master area
  • mod-t β€” Push window back into tiling
  • mod-comma β€” Increment the number of windows in the master area
  • mod-period β€” Deincrement the number of windows in the master area
  • mod-shift-q β€” Quit xmonad
  • mod-q β€” Restart xmonad
  • mod-shift-slash β€” Run xmessage with a summary of the default keybindings (useful for beginners)
  • mod-question β€” Run xmessage with a summary of the default keybindings (useful for beginners)
  • mod-[1..9] β€” Switch to workspace N
  • mod-shift-[1..9] β€” Move client to workspace N
  • mod-{w,e,r} β€” Switch to physical/Xinerama screens 1, 2, or 3
  • mod-shift-{w,e,r} β€” Move client to screen 1, 2, or 3
  • mod-button1 β€” Set the window to floating mode and move by dragging
  • mod-button2 β€” Raise the window to the top of the stack
  • mod-button3 β€” Set the window to floating mode and resize by dragging

πŸ§ͺ EXAMPLES πŸ§ͺ

To use xmonad as your window manager add to your ~/.xinitrc file:

exec xmonad

periodt. that's the whole setup moment πŸ’…

πŸ› οΈ CUSTOMIZATION πŸ› οΈ

xmonad is customized in your xmonad.hs, and then restarted with mod-q. You can choose where your configuration file lives by:

  1. Setting XMONAD_DATA_DIR, XMONAD_CONFIG_DIR, and XMONAD_CACHE_DIR; xmonad.hs is then expected to be in XMONAD_CONFIG_DIR.
  2. Creating xmonad.hs in ~/.xmonad.
  3. Creating xmonad.hs in XDG_CONFIG_HOME. Note that, in this case, xmonad will use XDG_DATA_HOME and XDG_CACHE_HOME for its data and cache directory respectively.

You can find many extensions to the core feature set in the xmonad-contrib package, available through your package manager or from xmonad.org. iykyk, that's where the extra sparkle lives πŸ¦‹

🧩 MODULAR CONFIGURATION 🧩

As of xmonad-0.9, any additional Haskell modules may be placed in ~/.xmonad/lib/ and are available in GHC’s searchpath. Hierarchical modules are supported: for example, the file ~/.xmonad/lib/XMonad/Stack/MyAdditions.hs could contain:

module XMonad.Stack.MyAdditions (function1) where
  function1 = error "function1: Not implemented yet!"

Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that module was contained within xmonad or xmonad-contrib. cute, modular, organized β€” we love to see it.

πŸ› BUGS πŸ›

Probably. If you find any, please report them to the bugtracker. not me being honest about it 😭 but fr fr, report them.


that's the whole vibe check, bestie! source/version: Tiling Window Manager, dated 27 October 2021. go forth and tile slay πŸ’–βœ¨πŸ‘‘

πŸ“¦ where this page comes from