diff options
author | Teddy Wing | 2021-06-20 15:24:43 +0200 |
---|---|---|
committer | Teddy Wing | 2021-06-20 15:24:43 +0200 |
commit | 4e79052816233a7ad261e76154832b89b0614c0f (patch) | |
tree | cc8992d095c3e715dde32ec125027afe90e9c3cc /doc/reflectub.1 | |
parent | 9cac11872c3b62362ac884a8ac0151581076b99a (diff) | |
download | reflectub-4e79052816233a7ad261e76154832b89b0614c0f.tar.bz2 |
Add manual page
Diffstat (limited to 'doc/reflectub.1')
-rw-r--r-- | doc/reflectub.1 | 66 |
1 files changed, 66 insertions, 0 deletions
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 |