From 2635f3299a77a89f4c09ec36c4110b21db0ea09f Mon Sep 17 00:00:00 2001 From: Isaac Freund Date: Thu, 15 Jul 2021 13:22:37 +0200 Subject: river-layout: update to v3 - Remove advertise_view and advertise_done events. Using the information provided by these for any purpose would make the layout far less predictable. Futhermore, in the months this has been available for use, to my knowledge nobody has actually used it for anything useful. - Replace the set/mod layout value events with a single user_command event. This simplifies the protocol and is more flexible for clients. - Add a layout_name argument to the commit request. This name is an arbitrary, user-facing string that might, for example, be displayed by a status bar. This was present in early drafts of the protocol, but was removed in favor of river-options. Since river-options itself has since been removed and this feature is nice to have, re-add it. - Rename main factor to main ratio in rivertile. The "factor" name was just legacy from dwm, "ratio" is much more accurate. --- doc/riverctl.1.scd | 14 +++++--------- doc/rivertile.1.scd | 35 +++++++++++++++++++++++------------ 2 files changed, 28 insertions(+), 21 deletions(-) (limited to 'doc') diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd index a485a73..994c78d 100644 --- a/doc/riverctl.1.scd +++ b/doc/riverctl.1.scd @@ -90,15 +90,11 @@ over the Wayland protocol. Set the layout namespace of currently focused output, overriding the value set with *default-layout* if any. -*set-layout-value* _namespace_ _type_ _name_ _value_ - Set the value with name _name_ of the layout on the focused output - with matching namespace. If there is no matching layout, this command - does nothing. - -*mod-layout-value* _namespace_ _type_ _name_ _value_ - Modify the value with name _name_ of the layout on the focused - output with matching namespace. If there is no matching layout, - this command does nothing. +*send-layout-cmd* _namespace_ _command_ + Send _command_ to the layout client on the currently focused output + with the given _namespace_, if any. What commands a layout client + understands depends on the layout client. For rivertile, see the + documentation in the *rivertile*(1) man page. ## TAG MANAGEMENT diff --git a/doc/rivertile.1.scd b/doc/rivertile.1.scd index c0658c1..d12a4ce 100644 --- a/doc/rivertile.1.scd +++ b/doc/rivertile.1.scd @@ -32,22 +32,33 @@ modified while rivertile is running with the help of *riverctl*(1). Set the initial number of views in the main area of the layout. (Default: 1) -*-main-factor* _ratio_ - Set the initial ratio of main area to total layout area. (Default: 0.6) +*-main-ratio* _ratio_ + Set the initial ratio of main area to total layout area. The _ratio_ + must be between 0.1 and 0.9, inclusive. (Default: 0.6) -# VALUES +# COMMANDS -These values may be modified while rivertile is running with the help of +These commands may be sent to rivertile at runtime with the help of *riverctl*(1). -_main_location_ (string: top, bottom, left, or right) - The location of the main area in the layout. +*set-main-location* [*top*|*bottom*|*left*|*right*] + Set the location of the main area in the layout. -_main_count_ (int) - The number of views in the main area of the layout. +*set-main-count* _count_ + Set the number of views in the main area of the layout. -_main_factor_ (fixed: [0.1, 0.9]) - The ratio of main area to total layout area. +*mod-main-count* _delta_ + Modify the number of views in the main area of the layout by a + positive or negative _delta_. + +*set-main-ratio* _ratio_ + Set the ratio of main area to total layout area. The _ratio_ must + be between 0.1 and 0.9, inclusive. + +*mod-main-ratio* _delta_ + Modify the ratio of main area to total layout area by a positive or + negative _delta_. The resulting ratio will be clamped to be between + 0.1 and 0.9, inclusive. # EXAMPLES @@ -55,9 +66,9 @@ Start *rivertile* with 4 pixels outer padding and 2 main views: rivertile -outer-padding 4 -main-count 2 -Set the main location of rivertile to top at runtime: +Set the main location of rivertile to *top* at runtime: - riverctl set-layout-value rivertile string main_location top + riverctl send-layout-cmd rivertile "set-main-location top" # AUTHORS -- cgit v1.2.3