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

45 lines
969 B
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* *left*|*right*|*top*|*bottom* [args passed by river]
# DESCRIPTION
*rivertile* is a layout generator for river. It produces tiled layouts with
command: s/master/main/g (breaking change) main is a better term to use here for several reasons: 1. It is more accurate: "master" implies that the designated views have some kind of control over the other views, which is not the case. "main" better expresses that the difference between the "main" view and others is one of importance/focus. 2. It is a shorter word. 2 whole characters saved! 3. It reduces the chance of future development time being lost to good-intentioned people complaining about usage of the word master as has recently happened with regards to the default git branch name.
2020-12-30 09:15:47 -08:00
split main/secondary stacks in four configurable orientations.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# OPTIONS
*left*
command: s/master/main/g (breaking change) main is a better term to use here for several reasons: 1. It is more accurate: "master" implies that the designated views have some kind of control over the other views, which is not the case. "main" better expresses that the difference between the "main" view and others is one of importance/focus. 2. It is a shorter word. 2 whole characters saved! 3. It reduces the chance of future development time being lost to good-intentioned people complaining about usage of the word master as has recently happened with regards to the default git branch name.
2020-12-30 09:15:47 -08:00
Place the main stack on the left side of the output.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
*right*
command: s/master/main/g (breaking change) main is a better term to use here for several reasons: 1. It is more accurate: "master" implies that the designated views have some kind of control over the other views, which is not the case. "main" better expresses that the difference between the "main" view and others is one of importance/focus. 2. It is a shorter word. 2 whole characters saved! 3. It reduces the chance of future development time being lost to good-intentioned people complaining about usage of the word master as has recently happened with regards to the default git branch name.
2020-12-30 09:15:47 -08:00
Place the main stack on the right side of the output.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
*top*
command: s/master/main/g (breaking change) main is a better term to use here for several reasons: 1. It is more accurate: "master" implies that the designated views have some kind of control over the other views, which is not the case. "main" better expresses that the difference between the "main" view and others is one of importance/focus. 2. It is a shorter word. 2 whole characters saved! 3. It reduces the chance of future development time being lost to good-intentioned people complaining about usage of the word master as has recently happened with regards to the default git branch name.
2020-12-30 09:15:47 -08:00
Place the main stack at the top of the output.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
*bottom*
command: s/master/main/g (breaking change) main is a better term to use here for several reasons: 1. It is more accurate: "master" implies that the designated views have some kind of control over the other views, which is not the case. "main" better expresses that the difference between the "main" view and others is one of importance/focus. 2. It is a shorter word. 2 whole characters saved! 3. It reduces the chance of future development time being lost to good-intentioned people complaining about usage of the word master as has recently happened with regards to the default git branch name.
2020-12-30 09:15:47 -08:00
Place the main stack at the bottom of the output.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# EXAMPLE
Set river's layout to *rivertile*'s *left* layout using riverctl
riverctl layout rivertile left
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-layouts*(7), *river*(1), *riverctl*(1)
Reference in New Issue Copy Permalink