STACKTILE(1)

💅 NAME 💅

stacktile — a layout generator for the river Wayland compositor. this is the general commands manual page for it, bestie, and the manual name is folded right here at the top instead of that boring header line. 💖

🦋 DESCRIPTION 🦋

okay so stacktile is a layout generator for river. fr fr.

It divides the screen into three areas: the primary area, the secondary area, and the remainder area. The primary and secondary areas are populated by a configurable amount of windows from the top of the window stack. All remaining windows will be placed in the remainder area. The windows in these areas are arranged into a configurable sublayout.

stacktile is highly adaptable and should fit many use cases. By default, it uses the same layout values for all tag sets of an output, but per-tag values can be enabled as well. iconic. ✨

💖 OPTIONS 💖

• --per-tag-config — if this option is set, individual tag sets will have individual layout values. If any value of the layout is changed, the change will only apply to the currently focused tag set, instead of all tag sets on the output. lowkey powerful.
• --drop-empty-configs — if this option is set, stacktile will forget per-tag configuration values for empty tags. this option requires the zriver-status-unstable-v1 protocol extension to be supported and --per-tag-config to be enabled. no cap, it needs both.
• --primary-count value — set the default amount of windows in the primary area. value must be a non-negative integer.
• --limit-primary-count — restrict the number of windows in the primary area to be no more than the total number of windows.
• --primary-ratio value — set the default relative width of the primary area. value must be a floating point number between 0.1 and 0.9.
• --primary-sublayout columns|rows|stack|grid|full|dwindle — set the default sublayout of the primary area.
• --primary-position top|right|bottom|left — set the default position of the primary area.
• --secondary-count value — set the default amount of windows in the secondary area. value must be a non-negative integer.
• --secondary-ratio value — set the default relative height of the secondary area. value must be a floating point number between 0.1 and 0.9.
• --secondary-sublayout columns|rows|stack|grid|full|dwindle — set the default sublayout of the secondary area.
• --remainder-sublayout columns|rows|stack|grid|full|dwindle — set the default sublayout of the remainder area.
• --inner-padding value — set the default padding between windows. value must be a non-negative integer.
• --outer-padding value — set the default padding around the layout. value must be a non-negative integer.
• --all-primary — if this option is set, all windows will be placed in the primary area. this can be toggled at runtime. 💅

🎀 COMMANDS 🎀

these commands may be sent to stacktile at runtime with the help of riverctl(1). slide them in while it's running, bestie. 🫶

• primary_count value — set or modify the amount of windows in the primary area. value must be an integer. if value is prefixed by a + or - sign, it is added or subtracted from the current primary count. otherwise primary count will be set to value. the primary count may not be negative.
• primary_ratio value — set or modify the relative width of the primary area. value must be a floating point number. if value is prefixed by a + or - sign, it is added or subtracted from the current primary ratio. otherwise primary ratio will be set to value. the primary ratio is clamped to the range of 0.1–0.9.
• primary_sublayout columns|rows|stack|grid|full|dwindle — set the sublayout of the primary area. multiple comma-separated values can be provided to cycle through. go off.
• primary_position top|right|bottom|left — set the position of the primary area.
• secondary_count value — set or modify the amount of windows in the secondary area. value must be an integer. if value is prefixed by a + or - sign, it is added or subtracted from the current secondary count. otherwise secondary count will be set to value. the secondary count may not be negative.
• secondary_ratio value — set or modify the relative height of the secondary area. value must be a floating point number. if value is prefixed by a + or - sign, it is added or subtracted from the current secondary ratio. otherwise secondary ratio will be set to value. the secondary ratio is clamped to the range of 0.1–0.9.
• secondary_sublayout columns|rows|stack|grid|full|dwindle — set the sublayout of the secondary area. multiple comma-separated values can be provided to cycle through.
• remainder_sublayout columns|rows|stack|grid|full|dwindle — set the sublayout of the remainder area. multiple comma-separated values can be provided to cycle through.
• inner_padding value — set or modify the padding between windows. value must be an integer. if value is prefixed by a + or - sign, it is added or subtracted from the current inner padding. otherwise inner padding will be set to value. the inner padding may not be negative.
• outer_padding value — set or modify the padding around the layout. value must be an integer. if value is prefixed by a + or - sign, it is added or subtracted from the current outer padding. otherwise outer padding will be set to value. the outer padding may not be negative.
• all_padding value — set or modify both the inner and outer padding. value must be an integer. if value is prefixed by a + or - sign, it is added or subtracted from the current inner and outer padding. otherwise the inner and outer padding will be set to value. padding may not be negative.
• all_primary true|false|toggle — if this option is active, all windows will be placed in the primary area.
• reset — delete the modified layout variables for all tag sets, returning to the defaults. clean slate bestie. 🧚

👑 AUTHOR 👑

Leon Henrik Plickat. the author, the legend. 👑

🌈 SEE ALSO 🌈

• river(1)
• riverctl(1)

okay that's the whole page, bestie. this iconic source/version is git.sr.ht/~leon_plickat/stacktile, dated 2021-07-17. slay and bye 💅