aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorLars Hjemli <hjemli@gmail.com>2011-06-13 22:02:02 +0000
committerLars Hjemli <hjemli@gmail.com>2011-06-13 22:02:02 +0000
commit859d106d5e8d884bf8f25b2ceea8600b2987c387 (patch)
tree6e9d5d910f175aefa1f337e431a33e7657ac4259 /cgitrc.5.txt
parentbe6991c1e42d548848bf2f51fd9910d14b5bdf40 (diff)
parentef13e5eafe16474bb5b3c3b8156bbb24a9249b2e (diff)
downloadcgit-859d106d5e8d884bf8f25b2ceea8600b2987c387.tar.gz
cgit-859d106d5e8d884bf8f25b2ceea8600b2987c387.tar.bz2
cgit-859d106d5e8d884bf8f25b2ceea8600b2987c387.zip
Merge branch 'stable'
Conflicts: cgitrc.5.txt
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt30
1 files changed, 26 insertions, 4 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 5903a93..8e31578 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -42,7 +42,7 @@ agefile::
cache-root::
Path used to store the cgit cache entries. Default value:
- "/var/cache/cgit".
+ "/var/cache/cgit". See also: "MACRO EXPANSION".
cache-dynamic-ttl::
Number which specifies the time-to-live, in minutes, for the cached
@@ -161,7 +161,7 @@ header::
include::
Name of a configfile to include before the rest of the current config-
- file is parsed. Default value: none.
+ file is parsed. Default value: none. See also: "MACRO EXPANSION".
index-header::
The content of the file specified with this option will be included
@@ -243,7 +243,8 @@ noheader::
project-list::
A list of subdirectories inside of scan-path, relative to it, that
should loaded as git repositories. This must be defined prior to
- scan-path. Default value: none. See also: scan-path.
+ scan-path. Default value: none. See also: scan-path, "MACRO
+ EXPANSION".
readme::
Text which will be used as default value for "repo.readme". Default
@@ -295,7 +296,8 @@ scan-path::
scan-path loads only the directories listed in the file pointed to by
project-list. Be advised that only the global settings taken
before the scan-path directive will be applied to each repository.
- Default value: none. See also: cache-scanrc-ttl, project-list.
+ Default value: none. See also: cache-scanrc-ttl, project-list,
+ "MACRO EXPANSION".
section::
The name of the current repository section - all repositories defined
@@ -492,6 +494,26 @@ allocated buffer within cgit then only the environment variables that fit
in the allocated buffer are handed to the filter.
+MACRO EXPANSION
+---------------
+The following cgitrc options supports a simple macro expansion feature,
+where tokens prefixed with "$" are replaced with the value of a similary
+named environment variable:
+
+- cache-root
+- include
+- project-list
+- scan-path
+
+Macro expansion will also happen on the content of $CGIT_CONFIG, if
+defined.
+
+One usage of this feature is virtual hosting, which in its simplest form
+can be accomplished by adding the following line to /etc/cgitrc:
+
+ include=/etc/cgitrc.d/$HTTP_HOST
+
+
EXAMPLE CGITRC FILE
-------------------