doc/hgrc.5.txt
changeset 8333 89c80c3dc584
parent 8024 9a1b86cfd29e
child 8341 493d23d923ea
--- a/doc/hgrc.5.txt	Fri May 08 18:30:44 2009 +0200
+++ b/doc/hgrc.5.txt	Mon May 04 20:26:27 2009 +0200
@@ -100,6 +100,45 @@
 Mercurial "hgrc" file, the purpose of each section, its possible
 keys, and their possible values.
 
+[[auth]]
+auth:
+  Authentication credentials for HTTP authentication.
+  Each line has the following format:
+
+    <name>.<argument> = <value>
+
+  where <name> is used to group arguments into authentication entries.
+  Example:
+
+    foo.prefix = hg.intevation.org/mercurial
+    foo.username = foo
+    foo.password = bar
+    foo.schemes = http https
+
+  Supported arguments:
+
+  prefix;;
+    Either '*' or a URI prefix with or without the scheme part. The
+    authentication entry with the longest matching prefix is used
+    (where '*' matches everything and counts as a match of length 1).
+    If the prefix doesn't include a scheme, the match is performed against
+    the URI with its scheme stripped as well, and the schemes argument,
+    q.v., is then subsequently consulted.
+  username;;
+    Username to authenticate with.
+  password;;
+    Optional. Password to authenticate with. If not given the user will be
+    prompted for it.
+  schemes;;
+    Optional. Space separated list of URI schemes to use this authentication
+    entry with. Only used if the prefix doesn't include a scheme. Supported
+    schemes are http and https. They will match static-http and static-https
+    respectively, as well.
+    Default: https.
+
+  If no suitable authentication entry is found, the user is prompted for
+  credentials as usual if required by the remote.
+
 [[decode]]
 decode/encode::
   Filters for transforming files on checkout/checkin. This would