index : sparkle-git.git

b4cc6df6a6f32a51caa655185d6580dbdcd2464e [patch]

dddb33e02955185d6a7fe643f45388b527f0807e

3f6854712825d1b6972a82aa7ae749fdcca2e145

b4cc6df6a6f32a51caa655185d6580dbdcd2464e.tar.gz

docs(man): add man page generated by pandoc

Diff

 doc/man/rgit.1 | 115 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 115 insertions(+)

diff --git a/doc/man/rgit.1 b/doc/man/rgit.1
new file mode 100644
index 0000000..40e8b49
--- /dev/null
+++ b/doc/man/rgit.1
@@ -0,0 +1,115 @@
.\" Automatically generated by Pandoc 3.1.6
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "RGIT" "1" "16 December 2023" "version 0.1.2" "User Commands"
.hy
.SH NAME
.PP
rgit - a gitweb interface written in rust
.SH SYNOPSIS
.PP
\f[B]rgit\f[R] [\f[I]OPTIONS\f[R]] \f[B]--db-store\f[R] \f[I]path\f[R]
\f[I]bind_address\f[R] \f[I]scan_path\f[R]
.SH DESCRIPTION
.PP
A gitweb/cgit-like interface for the modern age.
Written in Rust using Axum, git2, Askama, and Sled.
.TP
\f[I]bind_address\f[R]
Specifies the network address and port to serve the application on.
(Required)
.RS
.TP
Example:
\f[I]0.0.0.0:3333\f[R] (localhost, port 3333 on IPv4)
.RS
.PP
\f[I][::]:3333\f[R] (localhost, port 3333 on IPv6)
.RE
.RE
.TP
\f[I]scan_path\f[R]
Specifies the root directory where git repositories reside.
Scans recursively.
(Required)
.RS
.PP
For information about bare git repositories, see the manual for
\f[B]git-init\f[R](1).
.TP
Example:
\f[I]/srv/git\f[R]
.RS
.PP
\f[I]$HOME/git\f[R]
.RE
.RE
.SH OPTIONS
.TP
\f[B]-d\f[R] \f[I]path\f[R], \f[B]--db-store\f[R] \f[I]path\f[R]
Path to a directory in which the Sled database should be stored, will be
created if it doesn\[cq]t already exist.
.RS
.PP
The Sled database is very quick to generate, so this can be pointed to
temporary storage.
(Required)
.TP
Example:
\f[B]--db-store\f[R] \f[I]/tmp/rgit-cache.db\f[R]
.RE
.TP
\f[B]--refresh-interval\f[R] \f[I]interval\f[R]
Configures the metadata refresh interval.
This parameter accepts human-readable time formats.
.RS
.PP
Default: \f[I]5m\f[R]
.TP
Example:
\f[B]--refresh-interval\f[R] \f[I]60s\f[R] (refresh every 60 seconds)
.RS
.PP
\f[B]--refresh-interval\f[R] \f[I]never\f[R] (refresh only on server
start)
.RE
.TP
Documentation:
https://docs.rs/humantime/latest/humantime/
.RE
.SH EXAMPLES
.IP
.nf
\f[C]
$ rgit -d /tmp/rgit-cache.db [::]:3333 /srv/git
$ rgit --db-store /tmp/rgit-cache.db 0.0.0.0:3333 /srv/git
$ rgit -d /tmp/rgit-cache.db [::]:3333 /srv/git --refresh-interval 12h
\f[R]
.fi
.SH BUGS
.PP
https://github.com/w4/rgit/issues
.SH AUTHORS
.PP
Jordan Doyle <REDACTED>
.SH REPOSITORY
.PP
https://git.inept.dev/\[ti]doyle/rgit.git
.PP
https://github.com/w4/rgit
.SH SEE ALSO
.PP
\f[B]git\f[R](1), \f[B]git-init\f[R](1), \f[B]rgitrc\f[R](5)