Mercurial > hg > mercurial-crew-with-dirclash

annotate contrib/win32/ReadMe.html @ 4384:1386a9cffc88

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add notes about configuring a merge program
author Lee Cantey <lcantey@gmail.com>
date Thu, 26 Apr 2007 23:58:18 -0700
parents 1ef8ada4370f
children 63b9d2deed48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
2 <html>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
3 <head>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
4 <title>Mercurial for Windows</title>
2091
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
5 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
6 <style type="text/css">
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
7 <!--
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
8 .indented
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
9 {
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
10 padding-left: 10pt;
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
11 }
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
12 -->
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
13 </style>
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
14 </head>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
15
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
16 <body>
3863
1ef8ada4370f Remove hard-coded version numbers and release notes from packaging
Matt Mackall <mpm@selenic.com>
parents: 3422
diff changeset
17 <h1>Mercurial for Windows</h1>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
18
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
19 <p>Welcome to Mercurial for Windows!</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
20
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
21 <p>Mercurial is a command-line application. You must run it from
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
22 the Windows command prompt (or if you're hard core, a <a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
23 href="http://www.mingw.org/">MinGW</a> shell).</p>
2091
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
24
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
25 <p><div class="indented"><i>Note: the standard <a
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
26 href="http://www.mingw.org/">MinGW</a> msys startup script uses
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
27 rxvt which has problems setting up standard input and output.
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
28 Running bash directly works correctly.</i></div>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
29
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
30 <p>For documentation, please visit the <a
2091
fb8b35b0def9 update windows readme to document msys/mingw rxvt problems.
Lee Cantey <lcantey@gmail.com>
parents: 1690
diff changeset
31 href="http://www.selenic.com/mercurial">Mercurial web site</a>.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
32
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
33 <p>By default, Mercurial installs to <tt>C:\Mercurial</tt>. The
2384
068b32d06873 Automatically add the path of hg to %PATH% using add_path
Marco Barisione <marco@barisione.org>
parents: 2276
diff changeset
34 Mercurial command is called <tt>hg.exe</tt>.</p>
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
35
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
36 <h1>Testing Mercurial after you've installed it</h1>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
37
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
38 <p>The easiest way to check that Mercurial is installed properly is to
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
39 just type the following at the command prompt:</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
40
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
41 <pre>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
42 hg
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
43 </pre>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
44
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
45 <p>This command should print a useful help message. If it does,
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
46 other Mercurial commands should work fine for you.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
47
2307
5b3a3e35f084 Add section for configuration notes with initial note about the default editor
Lee Cantey <lcantey@gmail.com>
parents: 2276
diff changeset
48 <h1>Configuration notes</h1>
4384
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
49 <h4>Default editor</h4>
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
50 The default editor for commit messages is 'notepad'. You can set the EDITOR
2321
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
51 (or HGEDITOR) environment variable to specify your preference or set it in
4384
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
52 mercurial.ini:
2321
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
53 <pre>
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
54 [ui]
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
55 editor = whatever
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
56 </pre>
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
57
4384
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
58 <h4>Configuring a Merge program</h4>
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
59 It should be emphasized that Mercurial by itself doesn't attempt to do a
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
60 Merge at the file level, neither does it make any attempt to Resolve the conflicts.
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
61
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
62 By default, Mercurial will use the merge program defined by the HGMERGE environment
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
63 variable, or uses the one defined in the mercurial.ini file. (see <a href="http://www.selenic.com/mercurial/wiki/index.cgi/MergeProgram">MergeProgram</a> on the Mercurial Wiki for more information)
2307
5b3a3e35f084 Add section for configuration notes with initial note about the default editor
Lee Cantey <lcantey@gmail.com>
parents: 2276
diff changeset
64
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
65 <h1>Reporting problems</h1>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
66
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
67 <p>Before you report any problems, please consult the <a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
68 href="http://www.selenic.com/mercurial">Mercurial web site</a> and
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
69 see if your question is already in our list of <a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
70 href="http://www.selenic.com/mercurial/wiki/index.cgi/FAQ">Frequently
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
71 Answered Questions</a> (the "FAQ").
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
72
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
73 <p>If you cannot find an answer to your question, please feel
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
74 free to send mail to the Mercurial mailing list, at <a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
75 href="mailto:mercurial@selenic.com">mercurial@selenic.com</a>.
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
76 <b>Remember</b>, the more useful information you include in your
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
77 report, the easier it will be for us to help you!</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
78
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
79 <p>If you are IRC-savvy, that's usually the fastest way to get
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
80 help. Go to <tt>#mercurial</tt> on
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
81 <tt>irc.freenode.net</tt>.</p>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
82
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
83 <h1>Author and copyright information</h1>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
84
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
85 <p>Mercurial was written by <a href="http://www.selenic.com">Matt
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
86 Mackall</a>, and is maintained by Matt and a team of
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
87 volunteers.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
88
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
89 <p>The Windows installer was written by <a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
90 href="http://www.serpentine.com/blog">Bryan
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
91 O'Sullivan</a>.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
92
2216
1cbd10cfcb7c Update release notes and copyright year for Windows installer.
Lee Cantey <lcantey@gmail.com>
parents: 2091
diff changeset
93 <p>Mercurial is Copyright 2005, 2006 Matt Mackall and others. See the
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
94 <tt>Contributors.txt</tt> file for a list of contributors.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
95
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
96 <p>Mercurial is free software; you can redistribute it and/or
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
97 modify it under the terms of the <a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
98 href="http://www.gnu.org/copyleft/gpl.html">GNU General Public
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
99 License</a> as published by the Free Software Foundation; either
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
100 version 2 of the License, or (at your option) any later
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
101 version.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
102
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
103 <p>Mercurial is distributed in the hope that it will be useful,
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
104 but <b>without any warranty</b>; without even the implied
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
105 warranty of <b>merchantability</b> or <b>fitness for a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
106 particular purpose</b>. See the GNU General Public License for
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
107 more details.</p>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
108 </body>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
109 </html>