contrib/win32/ReadMe.html
author Matt Mackall <mpm@selenic.com>
Wed, 03 Oct 2007 17:17:27 -0500
changeset 5369 7530334bf301
parent 5115 ea7b982b6c08
permissions -rw-r--r--
revlog: generate trivial deltas against null revision To avoid extra memory usage and performance issues with large files, generate a trivial delta header for deltas against the null revision rather than calling the usual delta generator. We append the delta header to meta rather than prepending it to data to avoid a large allocate and copy.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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>
5115
ea7b982b6c08 Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4723
diff changeset
     5
    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
2091
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>
5115
ea7b982b6c08 Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4723
diff changeset
    24
2091
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
4723
fb4b6d5fe100 Update binary installer files.
Bryan O'Sullivan <bos@serpentine.com>
parents: 4635
diff changeset
    31
      href="http://www.selenic.com/mercurial">Mercurial web site</a>.
fb4b6d5fe100 Update binary installer files.
Bryan O'Sullivan <bos@serpentine.com>
parents: 4635
diff changeset
    32
      You can also download a free book, <a
fb4b6d5fe100 Update binary installer files.
Bryan O'Sullivan <bos@serpentine.com>
parents: 4635
diff changeset
    33
      href="http://hgbook.red-bean.com/">Distributed revision control
fb4b6d5fe100 Update binary installer files.
Bryan O'Sullivan <bos@serpentine.com>
parents: 4635
diff changeset
    34
      with Mercurial</a>.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    35
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    36
    <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
    37
      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
    38
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    39
    <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
    40
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    41
    <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
    42
      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
    43
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    44
    <pre>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    45
hg
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    46
</pre>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    47
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    48
    <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
    49
      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
    50
2307
5b3a3e35f084 Add section for configuration notes with initial note about the default editor
Lee Cantey <lcantey@gmail.com>
parents: 2276
diff changeset
    51
    <h1>Configuration notes</h1>
4384
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
    52
	<h4>Default editor</h4>
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
    53
	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
    54
    (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
    55
    mercurial.ini:
2321
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
[ui]
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
    58
editor = whatever
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
    59
</pre>
d9ca698e3c5a Update configuration note with mercurial.ini change from Thomas
Lee Cantey <lcantey@gmail.com>
parents: 2307
diff changeset
    60
4384
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
    61
	<h4>Configuring a Merge program</h4>
5115
ea7b982b6c08 Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4723
diff changeset
    62
	It should be emphasized that Mercurial by itself doesn't attempt to do a
4384
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
    63
	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
    64
5115
ea7b982b6c08 Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4723
diff changeset
    65
    By default, Mercurial will use the merge program defined by the HGMERGE environment
4384
1386a9cffc88 Add notes about configuring a merge program
Lee Cantey <lcantey@gmail.com>
parents: 3863
diff changeset
    66
    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
    67
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    68
    <h1>Reporting problems</h1>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    69
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    70
    <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
    71
	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
    72
      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
    73
	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
    74
	Answered Questions</a> (the "FAQ").
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    75
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    76
    <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
    77
      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
    78
	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
    79
      <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
    80
      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
    81
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    82
    <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
    83
      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
    84
      <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
    85
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    86
    <h1>Author and copyright information</h1>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    87
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    88
    <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
    89
	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
    90
	volunteers.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    91
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    92
    <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
    93
	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
    94
	O'Sullivan</a>.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    95
4635
63b9d2deed48 Updated copyright notices and add "and others" to "hg version"
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4384
diff changeset
    96
    <p>Mercurial is Copyright 2005-2007 Matt Mackall and others.
63b9d2deed48 Updated copyright notices and add "and others" to "hg version"
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4384
diff changeset
    97
	See the <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
    98
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    99
    <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
   100
      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
   101
	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
   102
	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
   103
      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
   104
      version.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
   105
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   106
    <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
   107
      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
   108
      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
   109
      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
   110
      more details.</p>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   111
  </body>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   112
</html>