docs(man): add configuration man page generated by pandoc
Diff
doc/man/rgitrc.5 | 200 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 200 insertions(+)
@@ -0,0 +1,200 @@
.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 "RGITRC" "5" "16 December 2023" "version 0.1.2" "rgit Configuration"
.hy
.SH NAME
.PP
rgitrc - runtime configuration for rgit
.SH SYNOPSIS
.PP
\f[V]rgitrc\f[R] contains all runtime settings for rgit, formatted as a
line-separated list of \f[V]NAME = VALUE\f[R] pairs.
Blank lines, and lines starting with \f[I]#\f[R], are ignored.
.SH LOCATION
.PP
The default location of \f[V]rgitrc\f[R], defined at compile time, is
\f[V]/etc/rgitrc\f[R].
At runtime, rgit will consult the \f[V]--config\f[R] option and use its
value.
.SH GLOBAL SETTINGS
.TP
\f[B]clone_prefix\f[R]
Specifies the URL to prepend to clone urls.
.RS
.PP
If unset and \f[V]enable_http_clone\f[R] is enabled, the clone url will
not be displayed.
.PP
Default value: unset
.PP
See also: \f[V]enable_http_clone\f[R], \f[V]ssh_clone_prefix\f[R]
.RE
.TP
\f[B]enable_http_clone\f[R]
If set to \f[I]true\f[R], rgit will act as a dumb HTTP endpoint for git
clones.
.RS
.PP
If unset, this will also hide clone urls from repository pages.
.PP
If the git binary is not present, this will be forced to
\f[I]false\f[R].
.PP
Default value: true
.PP
See also: \f[V]clone_prefix\f[R], \f[V]ssh_clone_prefix\f[R]
.RE
.TP
\f[B]enable_index_links\f[R]
When set to \f[I]true\f[R], rgit will display a column with extra links
for each repo in the repository index (specifically, to the
\[lq]summary\[rq], \[lq]commit\[rq], and \[lq]tree\[rq] pages).
.RS
.PP
Default value: false
.RE
.TP
\f[B]enable_index_owner\f[R]
When set to \f[I]true\f[R], rgit will display a column with the name of
each repo\[cq]s owner in the repository index.
.RS
.PP
Default value: true
.RE
.TP
\f[B]favicon\f[R]
Specifies an absolute path on the filesystem to a shortcut icon for
rgit.
.RS
.PP
This will be served as \f[I]/favicon.ico\f[R] since certain browsers
will ignore other values.
.PP
Default value: unset
.RE
.TP
\f[B]logo\f[R] \ \
Specifies an absolute path on the filesystem to a logo image which will
be used as a logo on all rgit pages.
.RS
.PP
If unset, the image will be replaced with text, and \f[V]logo_alt\f[R]
will be used instead.
.PP
Default value: unset
.PP
See also: \f[V]logo_alt\f[R], \f[V]logo_link\f[R]
.RE
.TP
\f[B]logo_alt\f[R]
Specifies \f[V]alt\f[R] for the logo image.
.RS
.PP
If \f[V]logo\f[R] is unset, this value will be printed instead of an
\f[V]<img>\f[R] attribute.
.PP
Default value: \[lq]🏡\[rq]
.PP
See also: \f[V]logo\f[R], \f[V]logo_link\f[R]
.RE
.TP
\f[B]logo_link\f[R]
Url loaded when clicking on the logo image.
.RS
.PP
If unspecified the calculated url of the repository index page will be
used.
.PP
Default value: \[lq]/\[rq]
.PP
See also: \f[V]logo\f[R], \f[V]logo_alt\f[R]
.RE
.TP
\f[B]root_description\f[R]
Text printed below the heading (\f[V]root_title\f[R]) on the repository
index page.
.RS
.PP
Default value: unset
.PP
See also: \f[V]root_title\f[R]
.RE
.TP
\f[B]root_readme\f[R]
The content of the file specified with this option will be rendered from
markdown to html below the \[lq]about\[rq] link on the repository index
page.
.RS
.PP
Default value: unset
.RE
.TP
\f[B]root_title\f[R]
Text printed as a heading on the repository index page.
.RS
.PP
Default value: \[lq]Git repository browser\[rq]
.RE
.TP
\f[B]snapshots\f[R]
Array which specifies the default set of snapshot formats that rgit
displays links for.
.RS
.PP
The value is a comma-separated array of zero or more of the following
values:
.PP
[\[lq]\f[V]tar\f[R]\[rq], \[lq]\f[V]tar.gz\f[R]\[rq],
\[lq]\f[V]tar.bz2\f[R]\[rq], \[lq]\f[V]tar.lz\f[R]\[rq],
\[lq]\f[V]tar.xz\f[R]\[rq], \[lq]\f[V]tar.zst\f[R]\[rq],
\[lq]\f[V]zip\f[R]\[rq], \[lq]\f[V]all\f[R]\[rq]]
.PP
The value \[lq]all\[rq] enables all snapshot formats.
.PP
All compressors use default settings, and some settings can be
influenced with environment variables.
Refer to the manual for \f[V]tar\f[R](1) and \f[V]zip\f[R](1L) for more
information.
.PP
Default value: [\[lq]\f[V]tar.gz\f[R]\[rq], \[lq]\f[V]tar.bz2\f[R]\[rq],
\[lq]\f[V]zip\f[R]\[rq]]
.PP
See also: \f[V]tar\f[R](1) \f[V]zip\f[R](1L)
.RE
.TP
\f[B]ssh_clone_prefix\f[R]
Specifies the URL to prepend to ssh clone urls.
.RS
.PP
If unset and \f[V]enable_http_clone\f[R] is enabled, the ssh clone url
will not be displayed.
.PP
Default value: none
.PP
See also: \f[V]clone_prefix\f[R], \f[V]enable_http_clone\f[R]
.RE
.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
