view contrib/win32/ReadMe.html @ 2307:5b3a3e35f084

Add section for configuration notes with initial note about the default editor
author Lee Cantey <>
date Thu, 18 May 2006 10:09:16 -0700
parents 766c3c852786
children d9ca698e3c5a
line wrap: on
line source

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <title>Mercurial for Windows</title>
    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" >  
    <style type="text/css">
      padding-left: 10pt;

    <h1>Mercurial version 0.9 for Windows</h1>

    <p>Welcome to Mercurial for Windows!</p>

    <p>Mercurial is a command-line application.  You must run it from
      the Windows command prompt (or if you're hard core, a <a
      href="">MinGW</a> shell).</p>
    <p><div class="indented"><i>Note: the standard <a
      href="">MinGW</a> msys startup script uses
      rxvt which has problems setting up standard input and output.
      Running bash directly works correctly.</i></div>

    <p>For documentation, please visit the <a
      href="">Mercurial web site</a>.</p>

    <p>By default, Mercurial installs to <tt>C:\Mercurial</tt>.  The
      Mercurial command is called <tt>hg.exe</tt>.  To run this
      command, the install directory must be in your search path.</p>

    <h2>Setting your search path temporarily</h2>

    <p>To set your search path temporarily, type the following into a
      command prompt window:</p>

set PATH=C:\Mercurial;%PATH%

    <h2>Setting your search path permanently</h2>

    <p>To set your search path permanently, perform the following
      steps.  These instructions are for Windows NT, 2000 and XP.</p>

      <li>Open the Control Panel.  Under Windows XP, select the
	"Classic View".</li>

      <li>Double-click on the "System" control panel.</li>

      <li>Click on the "Advanced" tab.</li>

      <li>Click on "Environment Variables".  You'll find this near the
	bottom of the window.</li>

      <li>Under "System variables", you will see "Path".  Double-click

      <li>Edit "Variable value".  Each path element is separated by a
	semicolon (";") character.  Append a semicolon to the end of the
	list, followed by the path where you installed Mercurial
	(e.g. <tt>C:\Mercurial</tt>).</li>

      <li>Click on the various "OK" buttons until you've completely
	exited from the System control panel.</li>

      <li>Log out and log back in, or restart your system.</li>

      <li>The next time you run the Windows command prompt, you will be
	able to run the <tt>hg</tt> command without any special

    <h1>Testing Mercurial after you've installed it</h1>

    <p>The easiest way to check that Mercurial is installed properly is to
      just type the following at the command prompt:</p>


    <p>This command should print a useful help message.  If it does,
      other Mercurial commands should work fine for you.</p>

    <h1>Configuration notes</h1>
    <p>The default editor is 'vi'. You can set the EDITOR environment variable
    (or HGEDITOR) to specify your preference. </p>

    <h1>Reporting problems</h1>

    <p>Before you report any problems, please consult the <a
	href="">Mercurial web site</a> and
      see if your question is already in our list of <a
	Answered Questions</a> (the "FAQ").

    <p>If you cannot find an answer to your question, please feel
      free to send mail to the Mercurial mailing list, at <a
      <b>Remember</b>, the more useful information you include in your
      report, the easier it will be for us to help you!</p>

    <p>If you are IRC-savvy, that's usually the fastest way to get
      help.  Go to <tt>#mercurial</tt> on

    <h1>Author and copyright information</h1>

    <p>Mercurial was written by <a href="">Matt
	Mackall</a>, and is maintained by Matt and a team of

    <p>The Windows installer was written by <a

    <p>Mercurial is Copyright 2005, 2006 Matt Mackall and others.  See the
      <tt>Contributors.txt</tt> file for a list of contributors.</p>

    <p>Mercurial is free software; you can redistribute it and/or
      modify it under the terms of the <a
	href="">GNU General Public
	License</a> as published by the Free Software Foundation; either
      version 2 of the License, or (at your option) any later

    <p>Mercurial is distributed in the hope that it will be useful,
      but <b>without any warranty</b>; without even the implied
      warranty of <b>merchantability</b> or <b>fitness for a
      particular purpose</b>.  See the GNU General Public License for
      more details.</p>