contrib/win32/ReadMe.html
author lcantey@gmail.com
Fri, 03 Feb 2006 11:29:39 +0100
changeset 1690 58894621c87a
parent 1288 9a625fbfa220
child 2091 fb8b35b0def9
permissions -rw-r--r--
Update version strings and add release notes to Windows specific files
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>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
     5
  </head>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     6
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
     7
  <body>
1690
58894621c87a Update version strings and add release notes to Windows specific files
lcantey@gmail.com
parents: 1288
diff changeset
     8
    <h1>Mercurial version 0.8 for Windows</h1>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     9
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    10
    <p>Welcome to Mercurial for Windows!</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    11
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    12
    <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
    13
      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
    14
      href="http://www.mingw.org/">MinGW</a> shell).</p>
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
    <p>For documentation, please visit the <a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    17
	href="http://www.selenic.com/mercurial">Mercurial web
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    18
	site</a>.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    19
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    20
    <p>By default, Mercurial installs to <tt>C:\Mercurial</tt>.  The
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    21
      Mercurial command is called <tt>hg.exe</tt>.  To run this
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    22
      command, the install directory must be in your search path.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    23
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    24
    <h2>Setting your search path temporarily</h2>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    25
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    26
    <p>To set your search path temporarily, type the following into a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    27
      command prompt window:</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    28
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    29
    <pre>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    30
set PATH=C:\Mercurial;%PATH%
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    31
</pre>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    32
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    33
    <h2>Setting your search path permanently</h2>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    34
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    35
    <p>To set your search path permanently, perform the following
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    36
      steps.  These instructions are for Windows NT, 2000 and XP.</p>
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
    <ol>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    39
      <li>Open the Control Panel.  Under Windows XP, select the
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    40
	"Classic View".</li>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    41
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    42
      <li>Double-click on the "System" control panel.</li>
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
      <li>Click on the "Advanced" tab.</li>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    45
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    46
      <li>Click on "Environment Variables".  You'll find this near the
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    47
	bottom of the window.</li>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    48
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    49
      <li>Under "System variables", you will see "Path".  Double-click
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    50
	it.</li>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    51
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    52
      <li>Edit "Variable value".  Each path element is separated by a
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    53
	semicolon (";") character.  Append a semicolon to the end of the
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    54
	list, followed by the path where you installed Mercurial
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    55
	(e.g. <tt>C:\Mercurial</tt>).</li>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    56
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    57
      <li>Click on the various "OK" buttons until you've completely
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    58
	exited from the System control panel.</li>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    59
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    60
      <li>Log out and log back in, or restart your system.</li>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    61
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    62
      <li>The next time you run the Windows command prompt, you will be
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    63
	able to run the <tt>hg</tt> command without any special
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    64
	help.</li>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    65
    </ol>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    66
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    67
    <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
    68
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    69
    <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
    70
      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
    71
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    72
    <pre>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    73
hg
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    74
</pre>
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>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
    77
      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
    78
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    79
    <h1>Reporting problems</h1>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    80
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    81
    <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
    82
	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
    83
      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
    84
	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
    85
	Answered Questions</a> (the "FAQ").
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    86
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    87
    <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
    88
      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
    89
	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
    90
      <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
    91
      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
    92
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    93
    <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
    94
      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
    95
      <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
    96
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
    97
    <h1>Author and copyright information</h1>
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 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
   100
	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
   101
	volunteers.</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>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
   104
	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
   105
	O'Sullivan</a>.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
   106
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   107
    <p>Mercurial is Copyright 2005 Matt Mackall and others.  See the
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   108
      <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
   109
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   110
    <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
   111
      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
   112
	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
   113
	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
   114
      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
   115
      version.</p>
1287
40ccb87dac71 Add win32 README for standalone installer.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
   116
1288
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   117
    <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
   118
      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
   119
      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
   120
      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
   121
      more details.</p>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   122
  </body>
9a625fbfa220 Turn the win32 README into a HTML file for now.
Bryan O'Sullivan <bos@serpentine.com>
parents: 1287
diff changeset
   123
</html>