aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reflectub.1.txt
diff options
context:
space:
mode:
authorTeddy Wing2021-06-20 15:24:43 +0200
committerTeddy Wing2021-06-20 15:24:43 +0200
commit4e79052816233a7ad261e76154832b89b0614c0f (patch)
treecc8992d095c3e715dde32ec125027afe90e9c3cc /doc/reflectub.1.txt
parent9cac11872c3b62362ac884a8ac0151581076b99a (diff)
downloadreflectub-4e79052816233a7ad261e76154832b89b0614c0f.tar.bz2
Add manual page
Diffstat (limited to 'doc/reflectub.1.txt')
-rw-r--r--doc/reflectub.1.txt36
1 files changed, 36 insertions, 0 deletions
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.