aboutsummaryrefslogtreecommitdiff
path: root/doc/rivertile.1.scd
diff options
context:
space:
mode:
authorIsaac Freund <ifreund@ifreund.xyz>2021-04-26 21:03:04 +0200
committerIsaac Freund <ifreund@ifreund.xyz>2021-04-27 00:10:20 +0200
commit871fc7c8de172365bd18456c799ec8aacea9ee4a (patch)
tree2f3d56534f80daaf1c36fc2157b0d2aa4aad1a41 /doc/rivertile.1.scd
parenta6f908d7ebfd94c20b27b54cf3275d7a078e3cae (diff)
downloadriver-871fc7c8de172365bd18456c799ec8aacea9ee4a.tar.gz
river-871fc7c8de172365bd18456c799ec8aacea9ee4a.tar.xz
river-options: remove protocol
This protocol involves far too much accidental complexity. The original motivating use-case was to provide a convenient way to send arbitrary data to layout clients at runtime in order to avoid layout clients needing to implement their own IPC and do this over a side-channel. Instead of implementing a quite complex but still rigid options protocol and storing this state in the compositor, instead we will simply add events to the layout protocol to support this use case. Consider the status quo event sequence: 1. send get_option_handle request (riverctl) 2. roundtrip waiting for first event (riverctl) 3. send set_foo_value request (riverctl) 4. receive set_foo_value request (river) 5. send foo_value event to all current handles (river) 6. receive foo_value event (rivertile) 7. send parameters_changed request (rivertile) 8. receive parameters_changed request (river) 9. send layout_demand (river) And compare with the event sequence after the proposed change: 1. send set_foo_value request (riverctl) 2. receive set_foo_value request (river) 3. send set_foo_value event (river) 4. send layout_demand (river) This requires *much* less back and forth between the server and clients and is clearly much simpler.
Diffstat (limited to 'doc/rivertile.1.scd')
-rw-r--r--doc/rivertile.1.scd23
1 files changed, 0 insertions, 23 deletions
diff --git a/doc/rivertile.1.scd b/doc/rivertile.1.scd
index b099a21..fdab055 100644
--- a/doc/rivertile.1.scd
+++ b/doc/rivertile.1.scd
@@ -13,29 +13,6 @@ rivertile - Tiled layout generator for river
*rivertile* is a layout client for river. It provides a simple tiled layout
split main/secondary stacks.
-# OPTIONS
-
-These options may be set using *riverctl*(1) or another river-options
-wayland client. *rivertile* declares these options on startup, so setting
-these options before starting rivertile requires them to be declared manually.
-
-*main_location* (string, default "top")
- The location of the main area. Vaild locations are "top", "bottom",
- "left", and "right".
-
-*main_count* (uint, default 1)
- The number of main views.
-
-*main_factor* (fixed, default 0.6)
- The percentage of the layout area reserved for main views. *rivertle*
- clamps this to the range `[0.1, 0.9]`.
-
-*view_padding* (uint, default 6)
- Padding around every view in pixels.
-
-*outer_padding* (uint, default 6)
- Padding around the edge of the layout area in pixels.
-
# AUTHORS
Maintained by Isaac Freund <ifreund@ifreund.xyz> who is assisted by open