Source / thg / manual / 2.4 / intro.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

<html xmlns="">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>2. Introduction &mdash; TortoiseHg 2.4.0 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
        URL_ROOT:    '',
        VERSION:     '2.4.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="TortoiseHg 2.4.0 documentation" href="index.html" />
    <link rel="next" title="3. What’s New" href="whatsnew.html" />
    <link rel="prev" title="1. Preface" href="preface.html" /> 
    <div class="related">
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="whatsnew.html" title="3. What’s New"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="preface.html" title="1. Preface"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">TortoiseHg 2.4.0 documentation</a> &raquo;</li> 

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
  <div class="section" id="module-introduction">
<span id="introduction"></span><h1>2. Introduction<a class="headerlink" href="#module-introduction" title="Permalink to this headline"></a></h1>
<div class="section" id="what-is-tortoisehg">
<h2>2.1. What is TortoiseHg?<a class="headerlink" href="#what-is-tortoisehg" title="Permalink to this headline"></a></h2>
<p>TortoiseHg is a set of graphical tools and a shell extension for the
<a class="reference external" href="">Mercurial</a> distributed revision control
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">hg is the symbol for the chemical element <a class="reference external" href="">Mercury</a></p>
<dl class="docutils">
<dt>On Windows,</dt>
<dd>TortoiseHg consists of the Workbench graphical application, a shell
extension which provides overlay icons and context menus in your file
explorer, and a command line program named <tt class="file docutils literal"><span class="pre">thg.exe</span></tt> which can launch
the TortoiseHg tools.  Binary packages of TortoiseHg for Windows come with
Mercurial and a merge tool and are thus completely ready for use
&#8220;Out of the Box&#8221;.</dd>
<dt>On Linux,</dt>
<dd>TortoiseHg consists of a command line thg script and a Nautilus
extension which provides overlays and context menus in your file
explorer.  You must have Mercurial installed separately in order to
run TortoiseHg on Linux.  TortoiseHg binary packages list Mercurial
as a dependency, so it is usually installed for you automatically.</dd>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">On Windows, TortoiseHg includes both thg.exe and thgw.exe.  The
latter is intended to be launched from desktop shortcuts or menu
entries as it will refuse to open a command console.  thg.exe is for
use on the console, and can provide command line help.  The thg.cmd
batch file that our installer adds into your PATH runs thg.exe.</p>
<p>TortoiseHg is primarily written in Python and PyQt (the Windows shell
extension being the notable exception).  The thg script and TortoiseHg
dialogs can be used on any platform that supports PyQt, including Mac
OS X.</p>
<div class="section" id="installing-tortoisehg">
<h2>2.2. Installing TortoiseHg<a class="headerlink" href="#installing-tortoisehg" title="Permalink to this headline"></a></h2>
<div class="section" id="on-windows">
<h3>2.2.1. On Windows<a class="headerlink" href="#on-windows" title="Permalink to this headline"></a></h3>
<p>TortoiseHg comes with an easy to use MSI installer.  You can always find
the most up to date release on our <a class="reference external" href="">website</a>.
Simply double click on the installer file and follow its instructions.</p>
<p>After a first time install, a re-login is usually required to start the
icon overlays.</p>
<p>During upgrades, the installer will ask to close or restart any
applications that have loaded the TortoiseHg shell extension.  If you
allow those applications to be closed, the upgrade will not require a
reboot or logout.  If other users are logged in, or if there are
applications which cannot be shutdown, a reboot will be required to
complete the install.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you have a legacy version of TortoiseHg installed, the
installer will require that you to remove it.  The uninstall can be
initiated from the control panel or the start menu.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Legacy uninstallers (&lt;=0.9.3) have a tendency to delete your user
Mercurial.ini file, so backup your file before uninstalling the
older TortoiseHg versions.  This is not a problem with the newer MSI
<p>Legacy TortoiseHg installers (prior to version 1.0) were built with
InnoSetup.  They installed a TortoiseOverlay package as a separate
application, so you always saw both TortoiseHg and TortoiseOverlay as
two applications in the <em>Add/Remove Programs</em> control panel program.
(On x64 platforms, there were two TortoiseOverlays, one for x86
processes and one of x64 processes).</p>
<p>The new MSI installers for TortoiseHg include the TortoiseOverlay
packages as &#8220;merge modules&#8221; so they do not appear as separate
applications anymore.  It should be safe to uninstall the older
TortoiseOverlay applications from <em>Add/Remove Programs</em> after you
uninstalled the legacy (&lt;=0.9.3) TortoiseHg installer, unless you have
other Tortoise products that still use the separate TortoiseOverlay MSI
approach (TortoiseCVS or TortoiseBZR).</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">TortoiseOverlay is a shim package that allows multiple Tortoise
style shell extension clients to share overlay slots.  This is
necessary because even modern Windows platforms only support a
limited number of overlay slots (11-14).  TortoiseOverlay
packages are created by the TortoiseSVN developers.</p>
<p>To be completely safe, there are two approaches you can take:</p>
<ol class="arabic simple">
<li>Just leave the old TortoiseOverlay packages installed.  They do not
harm anything.</li>
<li>Uninstall all the old TortoiseOverlay packages, then re-install all
of your Tortoise products until they are all functional.</li>
<p>Finally, if you have problems with the shell extension even after
re-logging in, we recommend you re-run the installer and select the
<em>Repair</em> option.  There were problems with a few versions of
TortoiseOverlay that cause upgrades to subtly fail until the <em>Repair</em>
process is run.</p>
<div class="section" id="language-settings">
<h4> Language settings<a class="headerlink" href="#language-settings" title="Permalink to this headline"></a></h4>
<p>The TortoiseHg user interface has been translated into many languages.
Language packs are not required since all available languages are
installed by default.  You can select your preferred <em class="guilabel">UI
Language</em> in the global settings tool.</p>
<p>The Windows shell extension context menus get their translations from
the Windows registry.  Translations for many locales were installed
under <tt class="file docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\TortoiseHg\i18n\cmenu</span></tt>.  Select the
locale you would like to use, double-click on it, and confirm all
<div class="section" id="on-linux-and-mac">
<h3>2.2.2. On Linux and Mac<a class="headerlink" href="#on-linux-and-mac" title="Permalink to this headline"></a></h3>
<p>The most recent Linux packages can be found on our <a class="reference external" href="">download</a> page.</p>
<p>For Mac OS X, no packages are available but you can run thg and all the
dialogs via the source install method. For details, see
<a class="reference external" href="">Mac OS X</a>.</p>

      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/thg_logo_92x50.png" alt="Logo"/>
  <h3><a href="index.html">Table Of Contents</a></h3>
<li><a class="reference internal" href="#">2. Introduction</a><ul>
<li><a class="reference internal" href="#what-is-tortoisehg">2.1. What is TortoiseHg?</a></li>
<li><a class="reference internal" href="#installing-tortoisehg">2.2. Installing TortoiseHg</a><ul>
<li><a class="reference internal" href="#on-windows">2.2.1. On Windows</a><ul>
<li><a class="reference internal" href="#language-settings"> Language settings</a></li>
<li><a class="reference internal" href="#on-linux-and-mac">2.2.2. On Linux and Mac</a></li>

  <h4>Previous topic</h4>
  <p class="topless"><a href="preface.html"
                        title="previous chapter">1. Preface</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="whatsnew.html"
                        title="next chapter">3. What&#8217;s New</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/intro.txt"
           rel="nofollow">Show Source</a></li>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
<script type="text/javascript">$('#searchbox').show(0);</script>
      <div class="clearer"></div>
    <div class="related">
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="whatsnew.html" title="3. What’s New"
             >next</a> |</li>
        <li class="right" >
          <a href="preface.html" title="1. Preface"
             >previous</a> |</li>
        <li><a href="index.html">TortoiseHg 2.4.0 documentation</a> &raquo;</li> 
    <div class="footer">
        &copy; Copyright 2012, Steve Borho and others.
      Created using <a href="">Sphinx</a> 1.1.3.