comparison doc/hgrc.5.txt @ 6310:1a13a5bbbbc1

make hgrc man page tell about ~/.hgrc on Windows
author Peter Arrenbrecht <peter.arrenbrecht@gmail.com>
date Fri, 07 Mar 2008 16:19:46 +0100
parents 8e3dc3de7e73
children 41c77bb8d7f3
comparison
equal deleted inserted replaced
6309:7240204121af 6310:1a13a5bbbbc1
15 FILES 15 FILES
16 ----- 16 -----
17 17
18 Mercurial reads configuration data from several files, if they exist. 18 Mercurial reads configuration data from several files, if they exist.
19 The names of these files depend on the system on which Mercurial is 19 The names of these files depend on the system on which Mercurial is
20 installed. Windows registry keys contain PATH-like strings, every 20 installed. *.rc files from a single directory are read in
21 part must reference a Mercurial.ini file or be a directory where *.rc 21 alphabetical order, later ones overriding earlier ones. Where
22 files will be read. 22 multiple paths are given below, settings from later paths override
23 23 earlier ones.
24 (Unix) <install-root>/etc/mercurial/hgrc.d/*.rc:: 24
25 (Unix) <install-root>/etc/mercurial/hgrc:: 25 (Unix) <install-root>/etc/mercurial/hgrc.d/*.rc::
26 (Unix) <install-root>/etc/mercurial/hgrc::
26 Per-installation configuration files, searched for in the 27 Per-installation configuration files, searched for in the
27 directory where Mercurial is installed. For example, if installed 28 directory where Mercurial is installed. <install-root> is the
28 in /shared/tools, Mercurial will look in 29 parent directory of the hg executable (or symlink) being run.
29 /shared/tools/etc/mercurial/hgrc. Options in these files apply to 30 For example, if installed in /shared/tools/bin/hg, Mercurial will
30 all Mercurial commands executed by any user in any directory. 31 look in /shared/tools/etc/mercurial/hgrc. Options in these files
31 32 apply to all Mercurial commands executed by any user in any
32 (Unix) /etc/mercurial/hgrc.d/*.rc:: 33 directory.
33 (Unix) /etc/mercurial/hgrc:: 34
34 (Windows) HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial:: 35 (Unix) /etc/mercurial/hgrc.d/*.rc::
35 or:: 36 (Unix) /etc/mercurial/hgrc::
36 (Windows) C:\Mercurial\Mercurial.ini::
37 Per-system configuration files, for the system on which Mercurial 37 Per-system configuration files, for the system on which Mercurial
38 is running. Options in these files apply to all Mercurial 38 is running. Options in these files apply to all Mercurial
39 commands executed by any user in any directory. Options in these 39 commands executed by any user in any directory. Options in these
40 files override per-installation options. 40 files override per-installation options.
41 41
42 (Unix) $HOME/.hgrc:: 42 (Windows) <install-dir>\Mercurial.ini::
43 (Windows) C:\Documents and Settings\USERNAME\Mercurial.ini:: 43 or else::
44 (Windows) $HOME\Mercurial.ini:: 44 (Windows) HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial::
45 Per-user configuration file, for the user running Mercurial. 45 or else::
46 Options in this file apply to all Mercurial commands executed by 46 (Windows) C:\Mercurial\Mercurial.ini::
47 any user in any directory. Options in this file override 47 Per-installation/system configuration files, for the system on
48 which Mercurial is running. Options in these files apply to all
49 Mercurial commands executed by any user in any directory.
50 Registry keys contain PATH-like strings, every part of which must
51 reference a Mercurial.ini file or be a directory where *.rc files
52 will be read.
53
54 (Unix) $HOME/.hgrc::
55 (Windows) %HOME%\Mercurial.ini::
56 (Windows) %HOME%\.hgrc::
57 (Windows) %USERPROFILE%\Mercurial.ini::
58 (Windows) %USERPROFILE%\.hgrc::
59 Per-user configuration file(s), for the user running Mercurial.
60 On Windows 9x, %HOME% is replaced by %APPDATA%.
61 Options in these files apply to all Mercurial commands executed
62 by this user in any directory. Options in thes files override
48 per-installation and per-system options. 63 per-installation and per-system options.
49 On Windows system, one of these is chosen exclusively according
50 to definition of HOME environment variable.
51 64
52 (Unix, Windows) <repo>/.hg/hgrc:: 65 (Unix, Windows) <repo>/.hg/hgrc::
53 Per-repository configuration options that only apply in a 66 Per-repository configuration options that only apply in a
54 particular repository. This file is not version-controlled, and 67 particular repository. This file is not version-controlled, and
55 will not get transferred during a "clone" operation. Options in 68 will not get transferred during a "clone" operation. Options in