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

89 lines
2.4 KiB
Plaintext
Raw Normal View History

docs: update URL in man pages Also remove the redundant URL in the footer and the redundant "General Commands Manual" text (scdoc adds that by default based on the section it seems).
2024-04-15 02:23:05 -07:00
RIVERTILE(1)
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# NAME
docs: fix inconsistent capitalization
2021-07-24 10:45:25 -07: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
docs: standardize on "layout generator" This is likely more clear than "layout client" to most users.
2021-10-31 14:32:59 -07:00
*rivertile* is a layout generator for *river*(1). It provides a simple tiled
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
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
common: use -h instead of -help This doesn't really matter that much as unrecognized options will still trigger a help message to be printed, but -h is much more standard so lets make the predictable choice here while sticking to only single '-' flags.
2021-10-31 16:34:15 -07:00
*-h*
docs: add -help and -version options to man pages
2021-07-24 10:42:34 -07:00
Print a help message and exit.
*-version*
Print the version number and exit.
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
*-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_
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
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)
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).
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
*main-location* [*top*|*bottom*|*left*|*right*]
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 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
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
*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_.
rivertile: fix code to disallow 0 main count Also document this limit
2023-01-06 08:47:54 -08:00
Note that the main count cannot be decreased below 1.
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
docs: fix typo in rivertile man page
2021-07-26 16:31:34 -07:00
*main-ratio* _value_
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
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.
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
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
# EXAMPLES
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
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
Start *rivertile* with 4 pixels outer padding and the *top* main location:
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: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
rivertile -outer-padding 4 -main-location top
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
Increase the main ratio by 0.1 at runtime:
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
riverctl send-layout-cmd rivertile "main-ratio +0.1"
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
Set the main count to 3 at runtime:
rivertile: add -h/--help, improve man page
2021-05-01 03:49:49 -07:00
rivertile: simplify commands Instead of having separate commands for modifying/setting a value, use the presence of a +/- sign to indicate modification.
2021-07-15 13:57:50 -07:00
riverctl send-layout-cmd rivertile "main-count 3"
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
doc: update my (Isaac's) email address
2021-10-02 04:01:58 -07:00
Maintained by Isaac Freund <mail@isaacfreund.com> who is assisted by open
doc: add AUTHORS section to man pages
2020-11-11 11:44:41 -08:00
source contributors. For more information about river's development, see
docs: update URL in man pages Also remove the redundant URL in the footer and the redundant "General Commands Manual" text (scdoc adds that by default based on the section it seems).
2024-04-15 02:23:05 -07:00
<https://isaacfreund.com/software/river>.
doc: add AUTHORS section to man pages
2020-11-11 11:44:41 -08:00
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