diff options
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt17
1 file changed, 14 insertions, 3 deletions
diff --git a/README.txt b/README.txt
index 63fb6c9..13b0971 100644
--- a/README.txt
+++ b/README.txt
@@ -147,6 +147,11 @@ src/main.c. A repository whose name contains a character that is special in a
url has it percent-encoded, and a plus sign has to be written %2b because a bare
plus decodes to a space.
+A page of the site itself has no repository in front of it, so p names it
+instead, as in ?p=about. These pages are about, which shows root-readme,
+repolist, the index under its own name, login, which an auth filter answers, and
+ls_cache, which lists the cache when enable-cache-list allows it.
+
Every parameter is optional. The pages column names the pages that read each
one, where a value of all marks the few not tied to particular pages.
@@ -154,17 +159,20 @@ one, where a value of all marks the few not tied to particular pages.
| param | pages | description |
+----------+----------------------+--------------------------------------------+
| url | all | repository, page and path in one value |
+| r | all | the repository on its own, in place of url |
+| p | all | the page on its own, in place of url |
| h | all | the branch or ref to read |
| id | all | pin the page to one commit or object |
| id2 | diff patch rawdiff | second object of a diff, paired with id |
-| ofs | index log refs stats | offset into a paged listing |
+| ofs | index log refs | offset into a paged listing |
+| ofs | stats | authors to show, -1 for all of them |
| path | all | restrict the page to one path |
-| q | log | the search term, matched literally |
+| q | index log | the search term, matched literally |
| qt | log | one of grep, author, committer or range |
| s | index | sort key for the listing |
| showmsg | log | show full commit messages |
| period | stats | the statistics window, one of w, m, q or y |
-| dt | diff commit | diff type, unified, side by side or raw |
+| dt | diff commit | 0 unified, 1 side by side or 2 stat only |
| ss | diff commit | shorthand for the side by side diff |
| all | atom | include every ref rather than one branch |
| context | diff commit | lines of context around a diff hunk |
@@ -172,6 +180,9 @@ one, where a value of all marks the few not tied to particular pages.
| follow | log | follow a single path across renames |
+----------+----------------------+--------------------------------------------+
+A number out of range is clamped rather than refused, ofs to 100000 and context
+to 40 lines, and q is cut at 512 characters.
+
A few endpoints are not ordinary pages. The snapshot page takes a filename
rather than a ref, so /demo/snapshot/demo-1.0.tar.gz names both the ref and the
archive format through the suffix, and the formats on offer are set by the