docs: add rivertile man page

This commit is contained in:
Isaac Freund
2020-06-16 17:06:24 +02:00
parent e2c034b76a
commit 751760287c
3 changed files with 59 additions and 6 deletions

38
doc/rivertile.1.scd Normal file
View File

@ -0,0 +1,38 @@
RIVERTILE(1) "github.com/ifreund/river" "General Commands Manual"
# NAME
rivertile - tiled layout generator for river
# SYNOPSIS
*rivertile* *left*|*right*|*top*|*bottom* [args passed by river]
# DESCRIPTION
*rivertile* is a layout generator for river. It produces tiled layouts with
split master/secondary stacks in four configurable orientations.
# OPTIONS
*left*
Place the master stack on the left side of the output.
*right*
Place the master stack on the right side of the output.
*top*
Place the master stack at the top of the output.
*bottom*
Place the master stack at the bottom of the output.
# EXAMPLE
Set river's layout to *rivertile*'s *left* layout using riverctl
riverctl layout rivertile left
# SEE ALSO
*river-layouts*(7), *river*(1), *riverctl*(1)