Add manual page

3 files changed, 128 insertions, 0 deletions

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..8729fea
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,26 @@
+# Copyright (c) 2021  Teddy Wing
+#
+# This file is part of Reflectub.
+#
+# Reflectub is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Reflectub is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Reflectub. If not, see <https://www.gnu.org/licenses/>.
+
+
+MAN_PAGE := doc/reflectub.1
+
+
+.PHONY: doc
+doc: $(MAN_PAGE)
+
+$(MAN_PAGE): $(MAN_PAGE).txt
+	a2x --no-xmllint --format manpage $<
diff --git a/doc/reflectub.1 b/doc/reflectub.1
new file mode 100644
index 0000000..8a818b0
--- /dev/null
+++ b/doc/reflectub.1
@@ -0,0 +1,66 @@
+'\" t
+.\"     Title: reflectub
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 06/20/2021
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "REFLECTUB" "1" "06/20/2021" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+reflectub \- Mirror a user\*(Aqs GitHub repositories
+.SH "SYNOPSIS"
+.sp
+\fIreflectub\fR [options] \-d DATABASE <github_username> <repository_path>
+.SH "DESCRIPTION"
+.sp
+Mirror all of a user\(cqs GitHub repositories\&. This command can be run regularly to fetch updates and new repositories from GitHub\&. It\(cqs designed to support Git web hosting services like CGit\&.
+.SH "OPTIONS"
+.PP
+\-\-cgitrc CGITRC_FILE
+.RS 4
+Specify the path to a
+\fIcgitrc\fR
+file that should be copied into each mirrored repository\&.
+.RE
+.PP
+\-d,\-\-database DATABASE
+.RS 4
+Path to the SQLite database used by the program\&. This is a required argument\&.
+.RE
+.PP
+\-\-skip\-larger\-than SIZE
+.RS 4
+Don\(cqt mirror repositories that are larger than
+\fISIZE\fR\&. Specify units, as in \(oq1024K\(cq, \(oq50M\(cq\&.
+.RE
+.PP
+\-h, \-\-help
+.RS 4
+Print usage help\&.
+.RE
+.PP
+\-V, \-\-version
+.RS 4
+Print the program version\&.
+.RE
diff --git a/doc/reflectub.1.txt b/doc/reflectub.1.txt
new file mode 100644
index 0000000..201f642
--- /dev/null
+++ b/doc/reflectub.1.txt
@@ -0,0 +1,36 @@
+reflectub(1)
+============
+
+NAME
+----
+reflectub - Mirror a user's GitHub repositories
+
+SYNOPSIS
+--------
+'reflectub' [options] -d DATABASE <github_username> <repository_path>
+
+DESCRIPTION
+-----------
+Mirror all of a user's GitHub repositories. This command can be run regularly to
+fetch updates and new repositories from GitHub. It's designed to support Git web
+hosting services like CGit.
+
+OPTIONS
+-------
+--cgitrc CGITRC_FILE::
+	Specify the path to a 'cgitrc' file that should be copied into each mirrored
+	repository.
+
+-d,--database DATABASE::
+	Path to the SQLite database used by the program. This is a required
+	argument.
+
+--skip-larger-than SIZE::
+	Don't mirror repositories that are larger than 'SIZE'. Specify units, as in
+	`1024K', `50M'.
+
+-h, --help::
+	Print usage help.
+
+-V, --version::
+	Print the program version.