manpage first draft

1 files changed, 37 insertions, 0 deletions

diff --git a/doc/aurbuilder.7 b/doc/aurbuilder.7
new file mode 100644
index 0000000..dc2b6e3
--- /dev/null
+++ b/doc/aurbuilder.7
@@ -0,0 +1,37 @@
+./" vi: ft=groff
+
+.TH man 7 "26.07.2023" "0.0" "aurbuilder"
+
+.SH NAME
+aurbuilder \- Automated AUR package builder
+
+.SH SYNOPSIS
+systemctl enable aurbuilder-container.timer aurbuilder-package.timer
+
+.SH DESCRIPTION
+\fIaurbuilder\fR is a podman based automated buildsystem for packages
+from the Arch User Repository.
+It will build a package including its dependencies not found in the official repositories.
+Systemd timers are used to automatically trigger builds.
+Both \fIaurbuilder-container.timer\fR and \fIaurbuilder-package.timer\fR need to be enabled for correct operation.
+.P
+Podman is used in the backend for managingg build containers.
+It is run rootless under the aurbuilder user.
+Every explicitly configured package ist built seperately,
+while the packages dependencies are built in the same container.
+aurbuilder uses a custom container based on archlinux:base-devel
+which is rebuilt periodically by aurbuilder-container.timer.
+
+.SH CONFIGURATION
+
+.TP
+\fBOPTION\fR
+description
+
+.SH FILES
+.IP \fI/etc/aurbuilder/config\fR 25
+main configuration file
+.IP \fI/etc/aurbuilder/packages\fR 25
+list of packages to build, per line
+.IP \fI/srv/pkg/\fR 25
+package output directory