crtxcr/cgitsb
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

cgitrc.5: information on directory traversal and multiple readme files

Browse Source 
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
This commit is contained in:
Jason A. Donenfeld 2013-05-25 20:30:57 +02:00
parent cd4c77d989
commit 2a1ead3efb
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
cgitrc.5.txt
View File

@ -29,9 +29,10 @@ GLOBAL SETTINGS
about-filter:: about-filter::
Specifies a command which will be invoked to format the content of Specifies a command which will be invoked to format the content of
about pages (both top-level and for each repository). The command will about pages (both top-level and for each repository). The command will
get the content of the about-file on its STDIN, and the STDOUT from the get the content of the about-file on its STDIN, the name of the file
command will be included verbatim on the about page. Default value: as the first argument, and the STDOUT from the command will be
none. See also: "FILTER API". included verbatim on the about page. Default value: none. See
also: "FILTER API".
agefile:: agefile::
Specifies a path, relative to each repository path, which can be used Specifies a path, relative to each repository path, which can be used
@ -288,8 +289,9 @@ project-list::
EXPANSION". EXPANSION".
readme:: readme::
Text which will be used as default value for "repo.readme". Default Text which will be used as default value for "repo.readme". Multiple
value: none. files may be specified, separated by a space, and cgit will use the
first found file in this list. Default value: none.
remove-suffix:: remove-suffix::
If set to "1" and scan-path is enabled, if any repositories are found If set to "1" and scan-path is enabled, if any repositories are found
@ -507,7 +509,10 @@ repo.readme::
git refspec by head or by hash by prepending the refspec followed by git refspec by head or by hash by prepending the refspec followed by
a colon. For example, "master:docs/readme.mkd". If the value begins a colon. For example, "master:docs/readme.mkd". If the value begins
with a colon, i.e. ":docs/readme.rst", the default branch of the with a colon, i.e. ":docs/readme.rst", the default branch of the
repository will be used. Default value: <readme>. repository will be used. Sharing any file will expose that entire
directory tree to the "/about/PATH" endpoints, so be sure that there
are no non-public files located in the same directory as the readme
file. Default value: <readme>.
repo.snapshots:: repo.snapshots::
A mask of allowed snapshot-formats for this repo, restricted by the A mask of allowed snapshot-formats for this repo, restricted by the