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