From 60a0986a0b4abcb611acee151f7ea14e3620803a Mon Sep 17 00:00:00 2001
From: Leon Henrik Plickat <leonhenrik.plickat@stud.uni-goettingen.de>
Date: Sat, 25 Nov 2023 16:33:19 +0100
Subject: [PATCH] add manpage

---
 README.md    | 11 +++++-----
 riverguile.1 | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+), 5 deletions(-)
 create mode 100644 riverguile.1

diff --git a/README.md b/README.md
index 500495e..6b6db48 100644
--- a/README.md
+++ b/README.md
@@ -13,11 +13,12 @@ paths for it in the given order:
 * `/etc/riverguile/layout.scm`
 
 This script must contain the definition of a function
-`(layout-demand-handler view-count usable-width usable-height)` and may contain
-any other code the user desires. The function must return a list containing
-exactly as many lists as `view-count`. Each of those sublists must contains
-exactly four numerical values for `x` and `y` position of the windows as well as
-their width and height. Window positions and dimensions get applied to rivers
+`(layout-demand-handler view-count usable-width usable-height)` and
+may contain any other code the user desires. The function must return
+a list containing exactly as many lists as `view-count`. Each of those
+sublists must contains exactly four numerical values, which are the x
+and y coordinates of the window as well as its width and height.
+Window positions and dimensions get applied to rivers
 window list top to bottom.
 
 Example of valid output:
diff --git a/riverguile.1 b/riverguile.1
new file mode 100644
index 0000000..c28ffe2
--- /dev/null
+++ b/riverguile.1
@@ -0,0 +1,62 @@
+.TH LSWT 1 2021-11-26 "git.sr.ht/~leon_plickat/lswt" "General Commands Manual"
+.
+.SH NAME
+.P
+riverguile \- scheme powered layout generator for river
+.
+.
+.SH SYNOPSIS
+.SY riverguile
+.YS
+.
+.
+.SH DESCRIPTION
+.P
+Layout generator for the
+.BR river (1)
+Wayland server which allows users to define layouts using guile scheme functions.
+.
+.P
+The layout namespace is `riverguile`.
+.
+.P
+Uppon launch, riverguile tries to eval a scheme script and checks the following
+paths for it in the given order:
+.IP  \(bu 2
+\fBlayout.scm\fR
+.IP  \(bu 2
+\fB$XDG_CONFIG_HOME/river/layout.scm\fR
+.IP  \(bu 2
+\fB$HOME/.config/river/layout.scm\fR
+.IP  \(bu 2
+\fB/etc/riverguile/layout.scm\fR
+.
+.P
+This script must contain the definition of a function
+\fB(layout-demand-handler view-count usable-width usable-height)\fR and may
+contain any other code the user desires.
+The function must return a list containing exactly as many lists as \fBview-count\fR.
+Each of those sublists must contains exactly four numerical values, which are
+the x and y coordinates of the window as well as its width and height.
+Window positions and dimensions get applied to rivers window list top to bottom.
+.
+.P
+Note that the numerical values do not need to be exact, riverguile takes care
+of rounding and casting for you.
+.
+.P
+If you send riverguile a layout-command, it will try to eval it as scheme code.
+.
+.
+.SH SEE ALSO
+.BR river (1),
+.BR riverctl (1),
+.BR rivertile (1),
+.BR guile (1)
+.
+.
+.SH AUTHOR
+.P
+.MT leonhenrik.plickat@stud.uni-goettingen.de
+Leon Henrik Plickat
+.ME