RIVERCARRO(1)

✨ NAME ✨

okay bestie, this is RIVERCARRO(1), a General Commands Manual page, and it's literally the tiled-layout glow-up you've been waiting for 💅

rivercarro — tiled layout generator for river(1).

---

🎀 SYNOPSIS 🎀

rivercarro [-inner-gaps] [-outer-gaps] [-main-location] [-main-count]
           [-main-ratio] [-width-ratio]

rivercarro [-no-smart-gaps] [-per-tag] [-width-ratio-centered]

rivercarro [-h] [-version]

---

🌸 DESCRIPTION 🌸

okay so rivercarro is a fork of rivertile(1) layout generator for river(1). no cap, it's giving "simple tiled layout with split main/secondary stacks" energy ✨

The initial state may be configured with various options passed on startup. Some values may additionally be modified while rivercarro is running with the help of riverctl(1). lowkey iconic.

In addition to rivertile(1), rivercarro provides:

• Monocle layout — views will take all the usable area on the screen 👑
• Gaps instead of padding around views or the layout area 🎀
• Modify gaps size at runtime 🦋
• Smart gaps — if there is only one view, gaps get disabled 💅
• Limit the width of the usable area of the screen 🌈
• Per tag configurations 🍓
• Cycle through layout 🔥

---

💖 OPTIONS 💖

• -h — print a help message and exit. 🫶
• -version — print the version number and exit. ⭐
• -no-smart-gaps — disable smart gaps. 💀
• -inner-gaps pixels — set the initial gaps around views in pixels.
  • Default: 6
• -outer-gaps pixels — set the initial gaps around the edge of the layout area in pixels.
  • Default: 6
• -main-location top|bottom|left|right|monocle — set the initial location of the main area in the layout.
  • Default: left
• -main-count count — set the initial number of views in the main area of the layout.
  • Default: 1
• -main-ratio ratio — set the initial ratio of the main area to total layout area. The ratio must be between 0.1 and 0.9, inclusive.
  • Default: 0.6
• -width-ratio ratio — set the initial ratio of the width of the usable area of the screen. The ratio must be between 0.1 and 1.0, inclusive.
  • Default: 1.0
• -width-ratio-centered — center views if -width-ratio is used and different from 1.0. 🎯
• -per-tag — enable configuration per tag. 🏷️

---

💅 COMMANDS 💅

These commands may be sent to rivercarro at runtime with the help of riverctl(1). group-chat remote control, fr fr.

• inner-gaps pixels — set the gaps around views in pixels. If pixels is prefixed by a +/- sign, pixels is added/subtracted from the current value. If there is no sign, inner-gaps is set to pixels.
  • Default: 6
• outer-gaps pixels — set the gaps around the edge of the layout area in pixels. If pixels is prefixed by a +/- sign, pixels is added/subtracted from the current value. If there is no sign, outer-gaps is set to pixels.
  • Default: 6
• gaps pixels — set the both inner and outer gaps in pixels. If pixels is prefixed by a +/- sign, pixels is added/subtracted from the current value. If there is no sign, [iner|outer]-gaps is set to pixels.
• main-location top|bottom|left|right|monocle — set the location of the main area in the layout.
• main-location-cycle list — comma separated list of locations to cycle through. 🔁
• main-count value — set or modify the number of views in the main area of the layout. If value is prefixed by a +/- sign, value is added/subtracted from the current count. If there is no sign, the main count is set to value.
• main-ratio value — set or modify the ratio of the main area to total layout area. If value is prefixed by a +/- sign, value is added/subtracted from the current ratio. If there is no sign, the main ratio is set to value.
  • Note that the ratio will always be clamped to the range 0.1 to 0.9. no fighting the clamp, bestie.
• width-ratio value — set or modify the ratio of the width of the usable area of the screen. If value is prefixed by a +/- sign, value is added/subtracted from the current ratio. If there is no sign, the width ratio is set to value.
  • Note that the ratio will always be clamped to the range 0.1 to 1.0. same clamp energy, different numbers.

---

🌈 EXAMPLES 🌈

Start rivercarro with outer gaps of 4 pixels and the top main location:

rivercarro -outer-gaps 4 -main-location top

Increase the main ratio by 0.1 at runtime:

riverctl send-layout-cmd rivercarro "main-ratio +0.1"

Set the main count to 3 at runtime:

riverctl send-layout-cmd rivercarro "main-count 3"

Set the width ratio at 70% at runtime:

riverctl send-layout-cmd rivercarro "width-ratio 0.7"

---

🦋 SEE ALSO 🦋

river(1), riverctl(1), rivertile(1) — go read them, bestie, they're all in the family 🫶

---

mwah 💋 — this page is from sr.ht/~novakane/rivercarro and dated 2022-04-23, so that's the source/version and date wrapped up with a bow 🎀 bye bestie 🫶