summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
authorLars Hjemli <hjemli@gmail.com>2009-08-24 05:51:48 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2009-08-24 08:22:58 (UTC)
commit007df98d2114fac4e9134cd7bc7e2960d0d730b4 (patch) (side-by-side diff)
tree67a3669f91a69675157d631e90cdafcd4db4e554 /cgitrc.5.txt
parente01229cf80bc618a132d2154c0ebd71792d31c64 (diff)
downloadcgit-007df98d2114fac4e9134cd7bc7e2960d0d730b4.zip
cgit-007df98d2114fac4e9134cd7bc7e2960d0d730b4.tar.gz
cgit-007df98d2114fac4e9134cd7bc7e2960d0d730b4.tar.bz2
cgitrc.5.txt: fix markup errors
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt19
1 files changed, 10 insertions, 9 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index df494aa..46df291 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -191,50 +191,50 @@ noplainemail::
Default value: "0".
noheader::
Flag which, when set to "1", will make cgit omit the standard header
on all pages. Default value: none. See also: "embedded".
renamelimit::
Maximum number of files to consider when detecting renames. The value
"-1" uses the compiletime value in git (for further info, look at
`man git-diff`). Default value: "-1".
repo.group::
- Legacy alias for 'section' which will be deprecated starting with
- cgit-1.0.
+ Legacy alias for "section". This option is deprecated and will not be
+ supported in cgit-1.0.
robots::
Text used as content for the "robots" meta-tag. Default value:
"index, nofollow".
root-desc::
Text printed below the heading on the repository index page. Default
value: "a fast webinterface for the git dscm".
root-readme::
The content of the file specified with this option will be included
verbatim below the "about" link on the repository index page. Default
value: none.
root-title::
Text printed as heading on the repository index page. Default value:
"Git Repository Browser".
scan-path::
A path which will be scanned for repositories. If caching is enabled,
the result will be cached as a cgitrc include-file in the cache
directory. Default value: none. See also: cache-scanrc-ttl.
-section:
+section::
The name of the current repository section - all repositories defined
after this option will inherit the current section name. Default value:
none.
snapshots::
Text which specifies the default set of snapshot formats generated by
cgit. The value is a space-separated list of zero or more of the
values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
source-filter::
Specifies a command which will be invoked to format plaintext blobs
in the tree view. The command will get the blob content on its STDIN
@@ -307,41 +307,42 @@ repo.path::
An absolute path to the repository directory. For non-bare repositories
this is the .git-directory. Default value: none.
repo.readme::
A path (relative to <repo.path>) which specifies a file to include
verbatim as the "About" page for this repo. Default value: none.
repo.snapshots::
A mask of allowed snapshot-formats for this repo, restricted by the
"snapshots" global setting. Default value: <snapshots>.
repo.section::
- Override the current section for this repository. Default value: none.
+ Override the current section name for this repository. Default value:
+ none.
repo.source-filter::
Override the default source-filter. Default value: <source-filter>.
repo.url::
The relative url used to access the repository. This must be the first
setting specified for each repo. Default value: none.
REPOSITORY-SPECIFIC CGITRC FILE
-------------------------------
-When the option 'scan-path' is used to auto-discover git repositories, cgit
-will try to parse the file 'cgitrc' within any found repository. Such a repo-
-specific config file may contain any of the repo-specific options described
-above, except 'repo.url' and 'repo.path'. Also, in a repo-specific config
-file, the 'repo.' prefix is dropped from the config option names.
+When the option "scan-path" is used to auto-discover git repositories, cgit
+will try to parse the file "cgitrc" within any found repository. Such a
+repo-specific config file may contain any of the repo-specific options
+described above, except "repo.url" and "repo.path". Also, in a repo-specific
+config file, the "repo." prefix is dropped from the config option names.
EXAMPLE CGITRC FILE
-------------------
....
# Enable caching of up to 1000 output entriess
cache-size=1000
# Specify some default clone prefixes
clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git