aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorGravatar Lars Hjemli <hjemli@gmail.com>2011-06-14 07:02:02 (JST)
committerGravatar Lars Hjemli <hjemli@gmail.com>2011-06-14 07:02:02 (JST)
commit859d106d5e8d884bf8f25b2ceea8600b2987c387 (patch)
tree6e9d5d910f175aefa1f337e431a33e7657ac4259 /cgitrc.5.txt
parentbe6991c1e42d548848bf2f51fd9910d14b5bdf40 (diff)
parentef13e5eafe16474bb5b3c3b8156bbb24a9249b2e (diff)
downloadcgit-859d106d5e8d884bf8f25b2ceea8600b2987c387.zip
cgit-859d106d5e8d884bf8f25b2ceea8600b2987c387.tar.gz
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::
42 42
43cache-root:: 43cache-root::
44 Path used to store the cgit cache entries. Default value: 44 Path used to store the cgit cache entries. Default value:
45 "/var/cache/cgit". 45 "/var/cache/cgit". See also: "MACRO EXPANSION".
46 46
47cache-dynamic-ttl:: 47cache-dynamic-ttl::
48 Number which specifies the time-to-live, in minutes, for the cached 48 Number which specifies the time-to-live, in minutes, for the cached
@@ -161,7 +161,7 @@ header::
161 161
162include:: 162include::
163 Name of a configfile to include before the rest of the current config- 163 Name of a configfile to include before the rest of the current config-
164 file is parsed. Default value: none. 164 file is parsed. Default value: none. See also: "MACRO EXPANSION".
165 165
166index-header:: 166index-header::
167 The content of the file specified with this option will be included 167 The content of the file specified with this option will be included
@@ -243,7 +243,8 @@ noheader::
243project-list:: 243project-list::
244 A list of subdirectories inside of scan-path, relative to it, that 244 A list of subdirectories inside of scan-path, relative to it, that
245 should loaded as git repositories. This must be defined prior to 245 should loaded as git repositories. This must be defined prior to
246 scan-path. Default value: none. See also: scan-path. 246 scan-path. Default value: none. See also: scan-path, "MACRO
247 EXPANSION".
247 248
248readme:: 249readme::
249 Text which will be used as default value for "repo.readme". Default 250 Text which will be used as default value for "repo.readme". Default
@@ -295,7 +296,8 @@ scan-path::
295 scan-path loads only the directories listed in the file pointed to by 296 scan-path loads only the directories listed in the file pointed to by
296 project-list. Be advised that only the global settings taken 297 project-list. Be advised that only the global settings taken
297 before the scan-path directive will be applied to each repository. 298 before the scan-path directive will be applied to each repository.
298 Default value: none. See also: cache-scanrc-ttl, project-list. 299 Default value: none. See also: cache-scanrc-ttl, project-list,
300 "MACRO EXPANSION".
299 301
300section:: 302section::
301 The name of the current repository section - all repositories defined 303 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
492in the allocated buffer are handed to the filter. 494in the allocated buffer are handed to the filter.
493 495
494 496
497MACRO EXPANSION
498---------------
499The following cgitrc options supports a simple macro expansion feature,
500where tokens prefixed with "$" are replaced with the value of a similary
501named environment variable:
502
503- cache-root
504- include
505- project-list
506- scan-path
507
508Macro expansion will also happen on the content of $CGIT_CONFIG, if
509defined.
510
511One usage of this feature is virtual hosting, which in its simplest form
512can be accomplished by adding the following line to /etc/cgitrc:
513
514 include=/etc/cgitrc.d/$HTTP_HOST
515
516
495EXAMPLE CGITRC FILE 517EXAMPLE CGITRC FILE
496------------------- 518-------------------
497 519