ui-tree: unify with ui-view, use path to select tree/blob

[cgit.git] / cgitrc

diff --git a/cgitrc b/cgitrc
index 7e7fae53d817fc5956d160a2e8e223423ee3ebc8..0f602e471a73e177d2a15643fd539f5204ad773a 100644 (file)
--- a/cgitrc
+++ b/cgitrc
@@ -3,61 +3,114 @@
 ##
 
 
-## root folder for git repos
-#root=/usr/src/git
+## Uncomment and set to 1 to deactivate caching of generated pages. Mostly
+## usefull for testing.
+#nocache=0
+
+
+## Enable/disable snapshots by default. This can be overridden per repo
+#snapshots=0
+
+
+## Enable/disable display of 'number of files changed' in log view
+#enable-log-filecount=0
+
 
+## Enable/disable display of 'number of lines changed' in log view
+#enable-log-linecount=0
 
-## base for virtual urls. If specified, rewrite rules must be added to 
-## httpd.conf. Possible rules for /git/ when cgit.cgi is accessed as /cgit.cgi:
+
+## Enable/disable display of HEAD shortlog in summary view. Set it to maximum
+## number of commits that should be displayed
+#summary-log=0
+
+
+## Specify a root for virtual urls. This makes cgit generate urls like
+##
+##    http://localhost/git/repo/log/?id=master
+##
+## instead of
 ##
-##   RewriteRule ^/git/$ /cgit.cgi                            [L,QSA]
-##   RewriteRule ^/git/([^/]+)/$ /cgit.cgi?r=$1               [L,QSA]
-##   RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit.cgi?r=$1&p=$2  [L,QSA]
+##    http://localhost/cgit/cgit.cgi?r=repo&p=log&id=master
 ##
+## For this to work with apache, rewrite rules must be added to httpd.conf,
+## possibly looking something like this:
+##
+##   RewriteRule ^/git/$ /cgit/cgit.cgi                            [L,QSA]
+##   RewriteRule ^/git/([^/]+)/$ /cgit/cgit.cgi?r=$1               [L,QSA]
+##   RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit/cgit.cgi?r=$1&p=$2  [L,QSA]
+##
+## This setting is disabled by default.
 #virtual-root=/git
 
 
-## page title for the root page (repo listing)
+## Set the title printed on the root page
 #root-title=Git repository browser
 
 
-## link to css file
-#css=/cgit.css
+## Link to css file
+#css=/cgit/cgit.css
 
 
-## link to logo file
-#logo=/git-logo.png
+## Link to logo file
+#logo=/cgit/git-logo.png
 
 
-## url loaded when clicking the logo
+## Url loaded when clicking the logo
 #logo-link=http://www.kernel.org/pub/software/scm/git/docs/
 
 
-## set number of initial chars to show of commit subject message in log views
+## Url loaded when clicking a submodule link
+#module-link=./?repo=%s&page=commit&id=%s
+
+
+## Number of chars shown of repo description (in repolist view)
+#max-repodesc-length=60
+
+
+## Number of chars shown of commit subject message (in log view)
 #max-message-length=60
 
 
-## Set to 1 to deactivate caching of generated pages
-#nocache=0
+## Number of commits per page in log view
+#max-commit-count=50
 
 
-## root path for cached output
+## Root of cached output
 #cache-root=/var/cache/cgit
 
 
+## Include another config-file
+#include=/var/cgit/repolist
+
 ##
-## Time-To-Live settings: specify how long (in minutes) different pages should
-## be cached. Specify 0 for instant expiration and -1 for immortal pages
+## Time-To-Live settings: specifies how long (in minutes) different pages
+## should be cached (0 for instant expiration, -1 for immortal pages)
 ##
 
-## ttl for root page (repo listing)
+## ttl for root page
 #cache-root-ttl=5
 
 ## ttl for repo summary page
 #cache-repo-ttl=5
 
-## ttl for other dynamic pages 
+## ttl for other dynamic pages
 #cache-dynamic-ttl=5
 
 ## ttl for static pages (addressed by SHA-1)
 #cache-static-ttl=-1
+
+
+
+## Example repository entry. Required values are repo.url and repo.path (each
+## repository section must start with repo.url).
+#repo.url=cgit
+#repo.name=cgit
+#repo.desc=the caching cgi for git
+#repo.path=/pub/git/cgit
+#repo.owner=Lars Hjemli
+#repo.snapshots=1                              # override a sitewide snapshot-setting
+#repo.enable-log-filecount=0                   # override the default filecount setting
+#repo.enable-log-linecount=0                   # override the default linecount setting
+#repo.module-link=/git/%s/commit/?id=%s                # override the standard module-link
+#repo.readme=info/web/readme                   # specify a file to include on summary page