Use example.com in documentation, per RFC 2606

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index c643fae9f99497306a6ddbafc8fbed68d5a71cf2..ea1b18ac71e064ebc3247b633d5b64efc32bced1 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -234,6 +234,10 @@ project-list::
        should loaded as git repositories. This must be defined prior to
        scan-path. Default value: none. See also: scan-path.
 
+readme::
+       Text which will be used as default value for "repo.readme". Default
+       value: none.
+
 remove-suffix::
        If set to "1" and scan-path is enabled, if any repositories are found
        with a suffix of ".git", this suffix will be removed for the url and
@@ -278,6 +282,12 @@ section::
        after this option will inherit the current section name. Default value:
        none.
 
+section-from-path::
+       A number which, if specified before scan-path, specifies how many
+       path elements from each repo path to use as a default section name.
+       If negative, cgit will discard the specified number of path elements
+       above the repo directory. Default value: 0.
+
 side-by-side-diffs::
        If set to "1" shows side-by-side diffs instead of unidiffs per
        default. Default value: "0".
@@ -373,7 +383,7 @@ repo.readme::
        A path (relative to <repo.path>) which specifies a file to include
        verbatim as the "About" page for this repo. You may also specify a
        git refspec by head or by hash by prepending the refspec followed by
-       a colon. For example, "master:docs/readme.mkd" Default value: none.
+       a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the
@@ -414,7 +424,7 @@ cache-size=1000
 
 
 # Specify some default clone prefixes
-clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
+clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
 
 # Specify the css url
 css=/css/cgit.css
@@ -445,14 +455,14 @@ max-stats=quarter
 
 
 # Set the title and heading of the repository index page
-root-title=foobar.com git repositories
+root-title=example.com git repositories
 
 
 # Set a subheading for the repository index page
 root-desc=tracking the foobar development
 
 
-# Include some more info about foobar.com on the index page
+# Include some more info about example.com on the index page
 root-readme=/var/www/htdocs/about.html
 
 
@@ -486,14 +496,14 @@ mimetype.svg=image/svg+xml
 repo.url=foo
 repo.path=/pub/git/foo.git
 repo.desc=the master foo repository
-repo.owner=fooman@foobar.com
+repo.owner=fooman@example.com
 repo.readme=info/web/about.html
 
 
 repo.url=bar
 repo.path=/pub/git/bar.git
 repo.desc=the bars for your foo
-repo.owner=barman@foobar.com
+repo.owner=barman@example.com
 repo.readme=info/web/about.html