docs(man): add section on custom robots.txt
Diff
doc/man/rgitrc.5 | 89 +++++++++++++++++++++++-------------------------------
doc/man/rgitrc.5.md | 8 +++++-
2 files changed, 47 insertions(+), 50 deletions(-)
@@ -1,34 +1,16 @@
.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.
\f[CR]rgitrc\f[R] contains all runtime settings for rgit, formatted as a
line-separated list of \f[CR]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
The default location of \f[CR]rgitrc\f[R], defined at compile time, is
\f[CR]/etc/rgitrc\f[R].
At runtime, rgit will consult the \f[CR]--config\f[R] option and use its
value.
.SH GLOBAL SETTINGS
.TP
@@ -36,12 +18,12 @@ value.
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
If unset and \f[CR]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]
See also: \f[CR]enable_http_clone\f[R], \f[CR]ssh_clone_prefix\f[R]
.RE
.TP
\f[B]css\f[R]
@@ -66,7 +48,7 @@ If the git binary is not present, this will be forced to
.PP
Default value: true
.PP
See also: \f[V]clone_prefix\f[R], \f[V]ssh_clone_prefix\f[R]
See also: \f[CR]clone_prefix\f[R], \f[CR]ssh_clone_prefix\f[R]
.RE
.TP
\f[B]enable_index_links\f[R]
@@ -102,24 +84,24 @@ 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]
If unset, the image will be replaced with text, and \f[CR]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]
See also: \f[CR]logo_alt\f[R], \f[CR]logo_link\f[R]
.RE
.TP
\f[B]logo_alt\f[R]
Specifies \f[V]alt\f[R] for the logo image.
Specifies \f[CR]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.
If \f[CR]logo\f[R] is unset, this value will be printed instead of an
\f[CR]<img>\f[R] attribute.
.PP
Default value: \[lq]🏡\[rq]
.PP
See also: \f[V]logo\f[R], \f[V]logo_link\f[R]
See also: \f[CR]logo\f[R], \f[CR]logo_link\f[R]
.RE
.TP
\f[B]logo_link\f[R]
@@ -131,7 +113,7 @@ used.
.PP
Default value: \[lq]/\[rq]
.PP
See also: \f[V]logo\f[R], \f[V]logo_alt\f[R]
See also: \f[CR]logo\f[R], \f[CR]logo_alt\f[R]
.RE
.TP
\f[B]max_commit_message_length\f[R]
@@ -155,14 +137,24 @@ truncated.
Default value: \[lq]0\[rq]
.RE
.TP
\f[B]robots_txt\f[R]
Specifies an absolute path on the filesystem to the file to serve at
\f[CR]/robots.txt\f[R].
.RS
.PP
If set, the default \f[CR]robots.txt\f[R] will replaced with this one.
.PP
Default value: None
.RE
.TP
\f[B]root_description\f[R]
Text printed below the heading (\f[V]root_title\f[R]) on the repository
Text printed below the heading (\f[CR]root_title\f[R]) on the repository
index page.
.RS
.PP
Default value: unset
.PP
See also: \f[V]root_title\f[R]
See also: \f[CR]root_title\f[R]
.RE
.TP
\f[B]root_readme\f[R]
@@ -189,43 +181,40 @@ displays links for.
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]]
[\[lq]\f[CR]tar\f[R]\[rq], \[lq]\f[CR]tar.gz\f[R]\[rq],
\[lq]\f[CR]tar.bz2\f[R]\[rq], \[lq]\f[CR]tar.lz\f[R]\[rq],
\[lq]\f[CR]tar.xz\f[R]\[rq], \[lq]\f[CR]tar.zst\f[R]\[rq],
\[lq]\f[CR]zip\f[R]\[rq], \[lq]\f[CR]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.
Refer to the manual for \f[CR]tar\f[R](1) and \f[CR]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]]
Default value: [\[lq]\f[CR]tar.gz\f[R]\[rq],
\[lq]\f[CR]tar.bz2\f[R]\[rq], \[lq]\f[CR]zip\f[R]\[rq]]
.PP
See also: \f[V]tar\f[R](1) \f[V]zip\f[R](1L)
See also: \f[CR]tar\f[R](1) \f[CR]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
If unset and \f[CR]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]
See also: \f[CR]clone_prefix\f[R], \f[CR]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
@@ -128,6 +128,14 @@ GLOBAL SETTINGS
Default value: "0"
**robots_txt**
: Specifies an absolute path on the filesystem to the file to serve at `/robots.txt`.
If set, the default `robots.txt` will replaced with this one.
Default value: None
**root_description**
: Text printed below the heading (`root_title`) on the repository index page.
