Source / thg / manual / 2.4 / preface.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>1. Preface &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="2. Introduction" href="intro.html" />
    <link rel="prev" title="Welcome to TortoiseHg’s documentation!" href="index.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="intro.html" title="2. Introduction"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to TortoiseHg’s documentation!"
             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-preface">
<span id="preface"></span><h1>1. Preface<a class="headerlink" href="#module-preface" title="Permalink to this headline"></a></h1>
<div class="section" id="audience">
<h2>1.1. Audience<a class="headerlink" href="#audience" title="Permalink to this headline"></a></h2>
<p>This book is written for computer literate folk who want to use
Mercurial to manage their data, but are uncomfortable using the command
line client to do so. Since TortoiseHg is a Windows shell extension it&#8217;s
assumed that the user is familiar with the Windows explorer and knows
how to use it.</p>
<p>You can find the most up to date version of this documentation at our
<a class="reference external" href="">web</a> site.</p>
<div class="section" id="reading-guide">
<h2>1.2. Reading guide<a class="headerlink" href="#reading-guide" title="Permalink to this headline"></a></h2>
<p>This Preface explains a little about the TortoiseHg project, the
community of people who work on it, and the licensing conditions for
using it and distributing it.</p>
<p>The <a class="reference internal" href="intro.html"><em>Introduction</em></a> explains what TortoiseHg is, what it does, where it
comes from and the basics for installing it on your PC.</p>
<p><a class="reference internal" href="quick.html"><em>A Quick Start Guide to TortoiseHg</em></a> is a quick tutorial on how to start with TortoiseHg.</p>
<p><a class="reference internal" href="daily.html"><em>TortoiseHg in daily use</em></a> is the main chapter, it describes the frequently used
components of TortoiseHg.</p>
<p><a class="reference internal" href="settings.html"><em>Settings</em></a> describes how to configure TortoiseHg.</p>
<p><a class="reference internal" href="nonhg.html"><em>Use with other VCS systems</em></a> describes how to use TortoiseHg as a client for
non-Mercurial servers.</p>
<p><a class="reference internal" href="faq.html"><em>Frequently Asked Questions</em></a> has a list of common questions and their answers.</p>
<p><a class="reference internal" href="debugging.html"><em>Debugging</em></a> describes how to debug any problems that you find.</p>
<div class="section" id="tortoisehg-is-free">
<h2>1.3. TortoiseHg is free!<a class="headerlink" href="#tortoisehg-is-free" title="Permalink to this headline"></a></h2>
<p>TortoiseHg is released under
<a class="reference external" href="">GPLv2</a>.  You are free to
install it on as many computers as you like, and to redistribute it
according to the GPLv2 license.</p>
<div class="section" id="community">
<h2>1.4. Community<a class="headerlink" href="#community" title="Permalink to this headline"></a></h2>
<p>Mailing Lists:</p>
<ul class="simple">
<li><a class="reference external" href="">Users</a> - Announcements, user Q&amp;A, and feature discussions.</li>
<li><a class="reference external" href="mailto:thg-dev&#37;&#52;&#48;googlegroups&#46;com">Developers</a> - Patches, bug reports, development discussions.</li>
<li><a class="reference external" href="">Issues</a> - Notifications from the issue tracker.</li>
<p>And our <a class="reference external" href="">wiki</a> on Bitbucket.</p>
<div class="section" id="acknowledgements">
<h2>1.5. Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this headline"></a></h2>
<p>Thanks to the many people who contribute to the TortoiseHg project.  It
takes a community of developers, translators, and users to build a
truly useful tool (especially users who care enough to report bugs and
file feature requests).</p>
<p>The TortoiseHg installer for Windows includes the TortoiseOverlays handler,
as provided by the <a class="reference external" href="">TortoiseSVN</a> project.</p>
<p>The history viewer of TortoiseHg is based on
<a class="reference external" href="">hgview</a>, a tool developed by
<a class="reference external" href="mailto:david&#46;douard&#37;&#52;&#48;logilab&#46;fr">David Douard</a> and others, with the financial
support of <a class="reference external" href="">Logilab</a>.</p>
<div class="section" id="conventions-used-in-this-manual">
<h2>1.6. Conventions used in this manual<a class="headerlink" href="#conventions-used-in-this-manual" title="Permalink to this headline"></a></h2>
<p>The following typographical conventions are used in this manual:</p>
<dl class="docutils">
<dt><tt class="kbd docutils literal"><span class="pre">Ctrl-A</span></tt></dt>
<dd>Indicates a key, or combination of keys, to press.</dd>
<dt><em class="guilabel">Commit</em></dt>
<dd>Indicates a label, button or anything that appears in user interfaces.</dd>
<dt><em class="menuselection">TortoiseHg... ‣ About</em></dt>
<dd>Indicates a menu choice, or a combination of menu choice, tab
selection and GUI label.  For example
<em class="menuselection">TortoiseHg...  ‣ Global settings ‣ Commit ‣ User name</em>
means do something in <em class="guilabel">User name</em> label under
<em class="guilabel">Commit</em> tab selectable from the menu choice
<em class="menuselection">TortoiseHg... ‣ Global settings</em>.</dd>
<dt><tt class="file docutils literal"><span class="pre">.hg/hgrc</span></tt></dt>
<dd>Indicates a filename or directory name.</dd>
<dt><strong class="command">thg log</strong></dt>
<dd>Indicates a command to enter into command window.</dd>
<dt><tt class="docutils literal"><span class="pre">myproxy:8000</span></tt></dt>
<dd>Indicates a text to enter into a text input field in the GUI.</dd>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This is a note.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">An important note. Pay attention.</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="#">1. Preface</a><ul>
<li><a class="reference internal" href="#audience">1.1. Audience</a></li>
<li><a class="reference internal" href="#reading-guide">1.2. Reading guide</a></li>
<li><a class="reference internal" href="#tortoisehg-is-free">1.3. TortoiseHg is free!</a></li>
<li><a class="reference internal" href="#community">1.4. Community</a></li>
<li><a class="reference internal" href="#acknowledgements">1.5. Acknowledgements</a></li>
<li><a class="reference internal" href="#conventions-used-in-this-manual">1.6. Conventions used in this manual</a></li>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Welcome to TortoiseHg&#8217;s documentation!</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="intro.html"
                        title="next chapter">2. Introduction</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/preface.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="intro.html" title="2. Introduction"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to TortoiseHg’s documentation!"
             >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.