##// END OF EJS Templates
Add section for configuration notes with initial note about the default editor
Lee Cantey -
r2307:5b3a3e35 default
parent child Browse files
Show More
@@ -1,136 +1,140 b''
1 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2 <html>
3 3 <head>
4 4 <title>Mercurial for Windows</title>
5 5 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
6 6 <style type="text/css">
7 7 <!--
8 8 .indented
9 9 {
10 10 padding-left: 10pt;
11 11 }
12 12 -->
13 13 </style>
14 14 </head>
15 15
16 16 <body>
17 17 <h1>Mercurial version 0.9 for Windows</h1>
18 18
19 19 <p>Welcome to Mercurial for Windows!</p>
20 20
21 21 <p>Mercurial is a command-line application. You must run it from
22 22 the Windows command prompt (or if you're hard core, a <a
23 23 href="http://www.mingw.org/">MinGW</a> shell).</p>
24 24
25 25 <p><div class="indented"><i>Note: the standard <a
26 26 href="http://www.mingw.org/">MinGW</a> msys startup script uses
27 27 rxvt which has problems setting up standard input and output.
28 28 Running bash directly works correctly.</i></div>
29 29
30 30 <p>For documentation, please visit the <a
31 31 href="http://www.selenic.com/mercurial">Mercurial web site</a>.</p>
32 32
33 33 <p>By default, Mercurial installs to <tt>C:\Mercurial</tt>. The
34 34 Mercurial command is called <tt>hg.exe</tt>. To run this
35 35 command, the install directory must be in your search path.</p>
36 36
37 37 <h2>Setting your search path temporarily</h2>
38 38
39 39 <p>To set your search path temporarily, type the following into a
40 40 command prompt window:</p>
41 41
42 42 <pre>
43 43 set PATH=C:\Mercurial;%PATH%
44 44 </pre>
45 45
46 46 <h2>Setting your search path permanently</h2>
47 47
48 48 <p>To set your search path permanently, perform the following
49 49 steps. These instructions are for Windows NT, 2000 and XP.</p>
50 50
51 51 <ol>
52 52 <li>Open the Control Panel. Under Windows XP, select the
53 53 "Classic View".</li>
54 54
55 55 <li>Double-click on the "System" control panel.</li>
56 56
57 57 <li>Click on the "Advanced" tab.</li>
58 58
59 59 <li>Click on "Environment Variables". You'll find this near the
60 60 bottom of the window.</li>
61 61
62 62 <li>Under "System variables", you will see "Path". Double-click
63 63 it.</li>
64 64
65 65 <li>Edit "Variable value". Each path element is separated by a
66 66 semicolon (";") character. Append a semicolon to the end of the
67 67 list, followed by the path where you installed Mercurial
68 68 (e.g. <tt>C:\Mercurial</tt>).</li>
69 69
70 70 <li>Click on the various "OK" buttons until you've completely
71 71 exited from the System control panel.</li>
72 72
73 73 <li>Log out and log back in, or restart your system.</li>
74 74
75 75 <li>The next time you run the Windows command prompt, you will be
76 76 able to run the <tt>hg</tt> command without any special
77 77 help.</li>
78 78 </ol>
79 79
80 80 <h1>Testing Mercurial after you've installed it</h1>
81 81
82 82 <p>The easiest way to check that Mercurial is installed properly is to
83 83 just type the following at the command prompt:</p>
84 84
85 85 <pre>
86 86 hg
87 87 </pre>
88 88
89 89 <p>This command should print a useful help message. If it does,
90 90 other Mercurial commands should work fine for you.</p>
91 91
92 <h1>Configuration notes</h1>
93 <p>The default editor is 'vi'. You can set the EDITOR environment variable
94 (or HGEDITOR) to specify your preference. </p>
95
92 96 <h1>Reporting problems</h1>
93 97
94 98 <p>Before you report any problems, please consult the <a
95 99 href="http://www.selenic.com/mercurial">Mercurial web site</a> and
96 100 see if your question is already in our list of <a
97 101 href="http://www.selenic.com/mercurial/wiki/index.cgi/FAQ">Frequently
98 102 Answered Questions</a> (the "FAQ").
99 103
100 104 <p>If you cannot find an answer to your question, please feel
101 105 free to send mail to the Mercurial mailing list, at <a
102 106 href="mailto:mercurial@selenic.com">mercurial@selenic.com</a>.
103 107 <b>Remember</b>, the more useful information you include in your
104 108 report, the easier it will be for us to help you!</p>
105 109
106 110 <p>If you are IRC-savvy, that's usually the fastest way to get
107 111 help. Go to <tt>#mercurial</tt> on
108 112 <tt>irc.freenode.net</tt>.</p>
109 113
110 114 <h1>Author and copyright information</h1>
111 115
112 116 <p>Mercurial was written by <a href="http://www.selenic.com">Matt
113 117 Mackall</a>, and is maintained by Matt and a team of
114 118 volunteers.</p>
115 119
116 120 <p>The Windows installer was written by <a
117 121 href="http://www.serpentine.com/blog">Bryan
118 122 O'Sullivan</a>.</p>
119 123
120 124 <p>Mercurial is Copyright 2005, 2006 Matt Mackall and others. See the
121 125 <tt>Contributors.txt</tt> file for a list of contributors.</p>
122 126
123 127 <p>Mercurial is free software; you can redistribute it and/or
124 128 modify it under the terms of the <a
125 129 href="http://www.gnu.org/copyleft/gpl.html">GNU General Public
126 130 License</a> as published by the Free Software Foundation; either
127 131 version 2 of the License, or (at your option) any later
128 132 version.</p>
129 133
130 134 <p>Mercurial is distributed in the hope that it will be useful,
131 135 but <b>without any warranty</b>; without even the implied
132 136 warranty of <b>merchantability</b> or <b>fitness for a
133 137 particular purpose</b>. See the GNU General Public License for
134 138 more details.</p>
135 139 </body>
136 140 </html>
General Comments 0
You need to be logged in to leave comments. Login now