Add preliminary manual page for gitano-setupliw/gitano-setup-manpage

1 files changed, 47 insertions, 0 deletions

diff --git a/doc/gitano-setup.1 b/doc/gitano-setup.1
new file mode 100644
index 0000000..7577be3
--- /dev/null
+++ b/doc/gitano-setup.1
@@ -0,0 +1,47 @@
+.\" =*= License: BSD =*=
+.TH GITANO-SETUP 1
+.SH NAME
+gitano\-setup \- set up a Gitano instance
+.SH SYNOPSIS
+.B gitano\-setup
+.RB [ -h ]
+.RB [ --help ]
+.RB [ --usage ]
+.RB [ ANSWER-FILE ...]
+.SH DESCRIPTION
+.B gitano-setup
+creates the basic repository setup for a Gitano instance.
+Gitano is a git repository management system.
+It provides repository creation, user administration, and access control.
+.PP
+.B gitano-setup
+is an interactive tool where if it has any questions for you, it will
+visit each answers file in turn until it finds the answer.
+This means that for automation purposes you can specify multiple answers
+files with the earlier ones overriding the later ones.
+.PP
+In summary, the behaviour is as follows:
+.PP
+The repository root is created if it does not exist, and a
+.I gitano-admin.git
+repository is created within it.
+Said repository is populated with the example administration repository
+rules and an admin user and group.
+.SS "Answer files"
+FIXME add the answer file format here.
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help ", " \-\-usage
+Print out a usage summary for the program.
+.SH EXAMPLE
+To set up a new Gitano instance:
+.PP
+.nf
+.RS
+sudo adduser git
+sudo su - git
+gitano-setup
+.RE
+.fi
+.PP
+There you go.