##// END OF EJS Templates
help/hgweb: add pointer to hgrc(5) location
Martin Geisler -
r13839:8d960240 stable
parent child Browse files
Show More
@@ -1,46 +1,47 b''
1 1 Mercurial's internal web server, hgweb, can serve either a single
2 2 repository, or a collection of them. In the latter case, a special
3 3 configuration file can be used to specify the repository paths to use
4 4 and global web configuration options.
5 5
6 6 This file uses the same syntax as other Mercurial configuration files,
7 7 but only the following sections are recognized:
8 8
9 9 - web
10 10 - paths
11 11 - collections
12 12
13 13 The ``web`` section can specify all the settings described in the web
14 section of the hgrc documentation.
14 section of the hgrc(5) documentation. See :hg:`help config` for
15 information on where to find the manual page.
15 16
16 17 The ``paths`` section provides mappings of physical repository
17 18 paths to virtual ones. For instance::
18 19
19 20 [paths]
20 21 projects/a = /foo/bar
21 22 projects/b = /baz/quux
22 23 web/root = /real/root/*
23 24 / = /real/root2/*
24 25 virtual/root2 = /real/root2/**
25 26
26 27 - The first two entries make two repositories in different directories
27 28 appear under the same directory in the web interface
28 29 - The third entry maps every Mercurial repository found in '/real/root'
29 30 into 'web/root'. This format is preferred over the [collections] one,
30 31 since using absolute paths as configuration keys is not supported on every
31 32 platform (especially on Windows).
32 33 - The fourth entry is a special case mapping all repositories in
33 34 '/real/root2' in the root of the virtual directory.
34 35 - The fifth entry recursively finds all repositories under the real
35 36 root, and maps their relative paths under the virtual root.
36 37
37 38 The ``collections`` section provides mappings of trees of physical
38 39 repositories paths to virtual ones, though the paths syntax is generally
39 40 preferred. For instance::
40 41
41 42 [collections]
42 43 /foo = /foo
43 44
44 45 Here, the left side will be stripped off all repositories found in the
45 46 right side. Thus ``/foo/bar`` and ``foo/quux/baz`` will be listed as
46 47 ``bar`` and ``quux/baz`` respectively.
General Comments 0
You need to be logged in to leave comments. Login now