##// END OF EJS Templates
help: add some help for hgweb.config files
Matt Mackall -
r10999:38182ed0 default
parent child Browse files
Show More
@@ -0,0 +1,46 b''
1 Mercurial's internal web server, hgweb, can serve either a single
2 repository, or a collection of them. In the latter case, a special
3 configuration file can be used to specify the repository paths to use
4 and global web configuration options.
5
6 This file uses the same syntax as hgrc configuration files, but only
7 the following sections are recognized:
8
9 - web
10 - paths
11 - collections
12
13 The ``web`` section can specify all the settings described in the web
14 section of the hgrc documentation.
15
16 The ``paths`` section provides mappings of physical repository
17 paths to virtual ones. For instance::
18
19 [paths]
20 projects/a = /foo/bar
21 projects/b = /baz/quux
22 web/root = /real/root/*
23 / = /real/root2/*
24 virtual/root2 = /real/root2/**
25
26 - The first two entries make two repositories in different directories
27 appear under the same directory in the web interface
28 - The third entry maps every Mercurial repository found in '/real/root'
29 into 'web/root'. This format is preferred over the [collections] one,
30 since using absolute paths as configuration keys is not supported on every
31 platform (especially on Windows).
32 - The fourth entry is a special case mapping all repositories in
33 '/real/root2' in the root of the virtual directory.
34 - The fifth entry recursively finds all repositories under the real
35 root, and maps their relative paths under the virtual root.
36
37 The ``collections`` section provides mappings of trees of physical
38 repositories paths to virtual ones, though the paths syntax is generally
39 preferred. For instance::
40
41 [collections]
42 /foo = /foo
43
44 Here, the left side will be stripped off all repositories found in the
45 right side. Thus ``/foo/bar`` and ``foo/quux/baz`` will be listed as
46 ``bar`` and ``quux/baz`` respectively.
@@ -97,4 +97,5 b' helptable = ('
97 loaddoc('templates')),
97 loaddoc('templates')),
98 (['urls'], _('URL Paths'), loaddoc('urls')),
98 (['urls'], _('URL Paths'), loaddoc('urls')),
99 (["extensions"], _("Using additional features"), extshelp),
99 (["extensions"], _("Using additional features"), extshelp),
100 (["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')),
100 )
101 )
@@ -212,6 +212,7 b' additional help topics:'
212 templating Template Usage
212 templating Template Usage
213 urls URL Paths
213 urls URL Paths
214 extensions Using additional features
214 extensions Using additional features
215 hgweb Configuring hgweb
215
216
216 use "hg -v help" to show aliases and global options
217 use "hg -v help" to show aliases and global options
217 Mercurial Distributed SCM
218 Mercurial Distributed SCM
@@ -281,6 +282,7 b' additional help topics:'
281 templating Template Usage
282 templating Template Usage
282 urls URL Paths
283 urls URL Paths
283 extensions Using additional features
284 extensions Using additional features
285 hgweb Configuring hgweb
284
286
285 use "hg -v help" to show aliases and global options
287 use "hg -v help" to show aliases and global options
286 %% not tested: --debugger
288 %% not tested: --debugger
@@ -105,6 +105,7 b' additional help topics:'
105 templating Template Usage
105 templating Template Usage
106 urls URL Paths
106 urls URL Paths
107 extensions Using additional features
107 extensions Using additional features
108 hgweb Configuring hgweb
108
109
109 use "hg -v help" to show aliases and global options
110 use "hg -v help" to show aliases and global options
110 add add the specified files on the next commit
111 add add the specified files on the next commit
@@ -170,6 +171,7 b' additional help topics:'
170 templating Template Usage
171 templating Template Usage
171 urls URL Paths
172 urls URL Paths
172 extensions Using additional features
173 extensions Using additional features
174 hgweb Configuring hgweb
173 %% test short command list with verbose option
175 %% test short command list with verbose option
174 Mercurial Distributed SCM (version xxx)
176 Mercurial Distributed SCM (version xxx)
175
177
@@ -595,6 +597,7 b' additional help topics:'
595 templating Template Usage
597 templating Template Usage
596 urls URL Paths
598 urls URL Paths
597 extensions Using additional features
599 extensions Using additional features
600 hgweb Configuring hgweb
598
601
599 use "hg -v help" to show aliases and global options
602 use "hg -v help" to show aliases and global options
600 %% test list of commands with command with no help text
603 %% test list of commands with command with no help text
General Comments 0
You need to be logged in to leave comments. Login now