spatial(5)

📦
version 7 · 2 versions
, in nixos 26.05

🦋 NAME 🦋

spatial — configuration file and commands. Bestie, that’s the whole vibe: it’s the config-file-and-commands era. 💅

🌸 DESCRIPTION 🌸

Okay so a Spatial Shell configuration file is literally a list of commands that Spatial Shell executes on startup. These commands usually consist of setting your preferences, either globally or per workspace. No cap. ✨

💅 COMMANDS 💅

This section lists the commands supported by Spatial Shell, which can be used in the config file, via spatialmsg(1) or via spatial-ipc(7) directly. Group-chat access, basically. 🫶

  • window <n> — Focus the *n*th window of the current workspace (starting from 0). Zero-indexed, iconic behavior. 🎀
  • focus left|right|up|down|workspace <n> — Change the focus of sway to a new container, following the gride maintained by Spatial Shell. focus right and focus left move the focus horizontally, within a given workspace, while focus up and focus down move the focus vertically, from one workspace to the other. Finally, focus workspace n move the focus to the workspace n. Directional slay. 🦋
  • move left|right|up|down|workspace <n> — Move the focused window within Spatial Shell gride, that is within its current ribbon (left or right) or to a different workspace (up or down). This command will change the current workspace in the latter case, inserting the window on the right of the previously focused one. Finally, move workspace n move the window to the workspace n. In these two cases, the current workspace is updated accordingly, and the moved window retains the focus. Main-character window energy, fr fr. 👑
  • default layout maximize|column / [workspace=<n>] default layout maximize|column — Set the default layout used by workspaces when they are first visited. Using the [workspace=<n>] prefix, limit the scope of the command to workspace n. See spatial(1) for a description of each layout. Layout prefs: handled. 🌈
  • toggle layout — Change the layout of the current workspace. If the workspace was using the layout Maximize, then it switches to Column. On the contrary, if it was using the layout Column, then it switches to Maximize. The flip-flop is the moment. 💀
  • default column count <m> / [workspace=<n>] default column count <m> — Set the default number of windows displayed at most when a workspace uses the Column layout. Using the [workspace=<n>] prefix, limit the scope of the command to workspace n. Column-count boundaries, set. 🍓
  • column count increment|decrement — Increase (resp. decrease) the maximum number of windows Spatial Shell shows in the current workspace, when the latter uses the Column layout. Default is 2, but this can be changed using the default column count command (either globally or per workspace). Two is the starting point, not the limit. 🔥
  • status_bar_name "<name>" — Set the name of the status bar (quotes are mandatory). This is used by spatial(1) to send it a signal (SIGMIN+8) to update it (for instance, when windows are moved around or the focus changes). Quotes are not optional, bestie — mandatory means mandatory. 💖

👑 AUTHOR 👑

Developed by Thomas Letan <lthms@soap.coffee>. Fore more information about Spatial Shell development, see <https://github.com/lthms/spatial-shell>. Author info: delivered. 🎀

🫶 ACKNOWLEDGMENT 🫶

Spatial Shell could not have been possible without sway, which remains a reference and a significant source of inspiration for the software architecture of this project, including for the wording of several man pages. Respect where respect is due. 🌸

💖 That’s the spatial(5) page from the File Formats Manual, dated 1980-01-01 — periodt, bestie. 🎀

📦 where this page comes from