History

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

Jason A. Donenfeld committed 13 years ago

Commit 2a1ead31 parent cd4c77d1 file · +11 −6Browse files

Unified · Split

cgitrc.5.txt+11−6
@@ -29,9 +29,10 @@ GLOBAL SETTINGS · 28 unmodified lines
29about-filter::29about-filter::
30 Specifies a command which will be invoked to format the content of30 Specifies a command which will be invoked to format the content of
31 about pages (both top-level and for each repository). The command will31 about pages (both top-level and for each repository). The command will
32 get the content of the about-file on its STDIN, and the STDOUT from the32 get the content of the about-file on its STDIN, the name of the file
33 command will be included verbatim on the about page. Default value:33 as the first argument, and the STDOUT from the command will be
34 none. See also: "FILTER API".34 included verbatim on the about page. Default value: none. See
35 also: "FILTER API".
35 36
36agefile::37agefile::
37 Specifies a path, relative to each repository path, which can be used38 Specifies a path, relative to each repository path, which can be used
@@ -288,8 +289,9 @@ project-list:: · 250 unmodified lines
288 EXPANSION".289 EXPANSION".
289 290
290readme::291readme::
291 Text which will be used as default value for "repo.readme". Default292 Text which will be used as default value for "repo.readme". Multiple
292 value: none.293 files may be specified, separated by a space, and cgit will use the
294 first found file in this list. Default value: none.
293 295
294remove-suffix::296remove-suffix::
295 If set to "1" and scan-path is enabled, if any repositories are found297 If set to "1" and scan-path is enabled, if any repositories are found
@@ -507,7 +509,10 @@ repo.readme:: · 211 unmodified lines
507 git refspec by head or by hash by prepending the refspec followed by509 git refspec by head or by hash by prepending the refspec followed by
508 a colon. For example, "master:docs/readme.mkd". If the value begins510 a colon. For example, "master:docs/readme.mkd". If the value begins
509 with a colon, i.e. ":docs/readme.rst", the default branch of the511 with a colon, i.e. ":docs/readme.rst", the default branch of the
510 repository will be used. Default value: <readme>.512 repository will be used. Sharing any file will expose that entire
513 directory tree to the "/about/PATH" endpoints, so be sure that there
514 are no non-public files located in the same directory as the readme
515 file. Default value: <readme>.
511 516
512repo.snapshots::517repo.snapshots::
513 A mask of allowed snapshot-formats for this repo, restricted by the518 A mask of allowed snapshot-formats for this repo, restricted by the