Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2635f3299a
river/doc/rivertile.1.scd

82 lines
2.2 KiB
Plaintext
Raw Normal View History

docs: add rivertile man page
2020-06-16 08:06:24 -07:00
RIVERTILE(1) "github.com/ifreund/river" "General Commands Manual"
# NAME
doc: unify scdoc style This unifies the style of the man page source files. Most noticable are the now consistent line endings at 80 chars (assuming a tabwidth of 8).
2020-12-12 15:51:51 -08:00
rivertile - Tiled layout generator for river
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# SYNOPSIS
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 14:41:30 -07:00
*rivertile* [_options_]
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# DESCRIPTION
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
*rivertile* is a layout client for *river*(1). It provides a simple tiled
layout with split main/secondary stacks. The initial state may be configured
with various options passed on startup. Some values may additionally be
modified while rivertile is running with the help of *riverctl*(1).
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 14:41:30 -07:00
# OPTIONS
*-view-padding* _pixels_
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
Set the padding around views in pixels. (Default: 6)
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 14:41:30 -07:00
*-outer-padding* _pixels_
Set the padding around the edge of the layout area in pixels.
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
(Default: 6)
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 14:41:30 -07:00
*-main-location* [*top*|*bottom*|*left*|*right*]
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
Set the initial location of the main area in the layout.
(Default: *left*)
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 14:41:30 -07:00
*-main-count* _count_
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
Set the initial number of views in the main area of the
layout. (Default: 1)
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 14:41:30 -07:00
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.
2021-07-15 04:22:37 -07:00
*-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)
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 14:41:30 -07:00
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.
2021-07-15 04:22:37 -07:00
# COMMANDS
river-layout: update to v2 This implements the changes to the river-layout protocol proposed in the previous commit removing river-options.
2021-04-26 12:03:28 -07:00
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.
2021-07-15 04:22:37 -07:00
These commands may be sent to rivertile at runtime with the help of
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
*riverctl*(1).
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.
2021-07-15 04:22:37 -07:00
*set-main-location* [*top*|*bottom*|*left*|*right*]
Set the location of the main area in the layout.
river-layout: update to v2 This implements the changes to the river-layout protocol proposed in the previous commit removing river-options.
2021-04-26 12:03:28 -07:00
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.
2021-07-15 04:22:37 -07:00
*set-main-count* _count_
Set the number of views in the main area of the layout.
river-layout: update to v2 This implements the changes to the river-layout protocol proposed in the previous commit removing river-options.
2021-04-26 12:03:28 -07:00
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.
2021-07-15 04:22:37 -07:00
*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.
river-layout: update to v2 This implements the changes to the river-layout protocol proposed in the previous commit removing river-options.
2021-04-26 12:03:28 -07:00
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
# EXAMPLES
Start *rivertile* with 4 pixels outer padding and 2 main views:
rivertile -outer-padding 4 -main-count 2
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.
2021-07-15 04:22:37 -07:00
Set the main location of rivertile to *top* at runtime:
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
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.
2021-07-15 04:22:37 -07:00
riverctl send-layout-cmd rivertile "set-main-location top"
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
doc: add AUTHORS section to man pages
2020-11-11 11:44:41 -08:00
# AUTHORS
Maintained by Isaac Freund <ifreund@ifreund.xyz> who is assisted by open
source contributors. For more information about river's development, see
<https://github.com/ifreund/river>.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# SEE ALSO
river-layout: create and implement protocol Replace the current layout mechanism based on passing args to a child process and parsing it's stdout with a new wayland protocol. This much more robust and allows for more featureful layout generators. Co-authored-by: Isaac Freund <ifreund@ifreund.xyz>
2020-10-02 06:53:08 -07:00
*river*(1), *riverctl*(1)
Reference in New Issue Copy Permalink