Add documentation for skein(7) and skein-infra(8)0.1.0

1 files changed, 56 insertions, 0 deletions

diff --git a/skein-infra.8 b/skein-infra.8
new file mode 100644
index 0000000..5c7c400
--- /dev/null
+++ b/skein-infra.8
@@ -0,0 +1,56 @@
+.Dd May 28, 2020
+.Dt SKEIN-INFRA 8
+.Os
+.Sh NAME
+.Nm skein-infra
+.Nd set up devices and bind mounts for
+.Xr skein 7
+.Sh SYNOPSIS
+.Nm
+.Ar setup
+.Nm
+.Ar teardown
+.Sh DESCRIPTION
+.Nm
+is a utility which sets up all necessary devices and bind mounts for the
+.Xr skein 7
+cgit infrastructure.
+.Pp
+The commands are as follows:
+.Bl -tag -width Ds
+.It Sy setup
+Creates
+.Pa /dev/null
+under
+.Ev SKEIN_CGIT_ROOT
+and sets up all necessary bind mounts.
+.Pp
+Each user's git directory under
+.Ev SKEIN_GIT_ROOT
+is mounted on the corresponding
+.Pa repos.avail/
+mount point in their cgit home directory.
+.It Sy teardown
+Deletes
+.Pa /dev/null
+and all existing bind mounts under
+.Ev SKEIN_CGIT_ROOT .
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width Ds
+.It Ev SKEIN_CGIT_ROOT
+The
+.Xr skein 7
+cgit infrastructure.
+Defaults to
+.Pa /srv/cgit .
+.It Ev SKEIN_GIT_ROOT
+The
+.Xr skein 7
+repository infrastructure.
+Defaults to
+.Pa /srv/git .
+.El
+.Sh SEE ALSO
+.Xr skein 7 ,
+.Xr mount 8