Add man pages

beansprout(1) is basically just the README and beansprout(5) is basically
just docs/CONFIGURATION.md.

By default, the man pages are generated if scdoc is availabled, but they
can also be explicitly disabled with -Dman-pages.
This commit is contained in:
Ben Buhse 2026-02-25 16:02:58 -06:00
commit 09f43674b5
No known key found for this signature in database
GPG key ID: 7916ACFCD38FD0B4
5 changed files with 451 additions and 1 deletions

60
man/beansprout.1.scd Normal file
View file

@ -0,0 +1,60 @@
BEANSPROUT(1)
# NAME
beansprout - tiling window manager for river
# SYNOPSIS
*beansprout* [_options_]
# DESCRIPTION
*beansprout* is a tiling window manager for the *river*(1) Wayland compositor.
It communicates with river using the river-window-management-v1 protocol and
other River-specific Wayland protocols.
*beansprout* uses a primary/stack tiling layout inspired by dwm with a
customizable ratio and primary count. It uses a 32-bit tag system rather than
workspaces. Each output has its own tags, primary count, and ratio.
# OPTIONS
*-h*
Print a help message and exit.
*-version*
Print the version number and exit.
*-log-level* [*error*|*warning*|*info*|*debug*]
Set the log level. (Default: *warning*)
# USAGE
You can either add *beansprout* to the river init file or directly run:
river -c beansprout
If you need to exit river, for example if *beansprout* crashes, you can use
river's hardcoded *Ctrl+Alt+Delete* keybind.
# CONFIGURATION
*beansprout* is configured with a KDL file located at
_$XDG_CONFIG_HOME/beansprout/config.kdl_. If _$XDG_CONFIG_HOME_ is not set,
this defaults to _~/.config/beansprout/config.kdl_.
See *beansprout*(5) for a full configuration reference.
If the config file is missing, *beansprout* falls back to built-in defaults
(which will be missing keybinds). If an individual node or block is invalid,
*beansprout* will try to ignore the error and continue.
# AUTHORS
Maintained by Ben Buhse <me@benbuhse.email>. For more information about
beansprout's development, see <https://codeberg.org/beansprout/beansprout>.
# SEE ALSO
*beansprout*(5), *river*(1)