/doc/source/intro.txt

https://bitbucket.org/tortoisehg/hgtk/ · Plain Text · 150 lines · 117 code · 33 blank · 0 comment · 0 complexity · df8229485b0858edbaabca56c95fac1e MD5 · raw file

  1. ************
  2. Introduction
  3. ************
  4. .. module:: introduction
  5. :synopsis: Introduce TortoiseHg and its various parts
  6. What is TortoiseHg?
  7. ===================
  8. TortoiseHg is a set of graphical tools and a shell extension for the
  9. `Mercurial <http://mercurial.selenic.com/wiki/>`_ distributed revision control
  10. system.
  11. On Windows,
  12. TortoiseHg consists of a shell extension, which provides overlay
  13. icons and context menus in your file explorer, and a command line
  14. program named :file:`thg.exe` which can launch the TortoiseHg tools.
  15. Binary packages of TortoiseHg for Windows come with Mercurial and a
  16. merge tool and are thus completely ready for use "Out of the Box".
  17. On Linux,
  18. TortoiseHg consists of a command line thg script and a Nautilus
  19. extension which provides overlays and context menus in your file
  20. explorer. You must have Mercurial installed separately in order to
  21. run TortoiseHg on Linux. TortoiseHg binary packages list Mercurial
  22. as a dependency, so it is usually installed for you automatically.
  23. .. note::
  24. On Windows, TortoiseHg includes both thg.exe and thgw.exe. The
  25. latter is intended to be launched from desktop shortcuts or menu
  26. entries as it will refuse to open a command console. thg.exe is for
  27. use on the console, and can provide command line help. The thg.cmd
  28. batch file that our installer adds into your PATH runs thg.exe.
  29. TortoiseHg is primarily written in Python and PyQt (the Windows shell
  30. extension being the notable exception). The thg script and TortoiseHg
  31. dialogs can be used on any platform that supports PyQt, including Mac
  32. OS X.
  33. Installing TortoiseHg
  34. =====================
  35. On Windows
  36. ----------
  37. TortoiseHg comes with an easy to use MSI installer. You can always find
  38. the most up to date release on our `website
  39. <http://tortoisehg.bitbucket.org/download/windows.html>`_.
  40. Simply double click on the installer file and follow its instructions.
  41. After a first time install, a re-login is usually required to start the
  42. icon overlays.
  43. During upgrades, the installer will ask to close or restart any
  44. applications that have loaded the TortoiseHg shell extension. If you
  45. allow those applications to be closed, the upgrade will not require a
  46. reboot or logout. If other users are logged in, or if there are
  47. applications which cannot be shutdown, a reboot will be required to
  48. complete the install.
  49. .. note::
  50. If you have a legacy version of TortoiseHg installed, the 1.0
  51. installer will ask that you to remove it. The uninstall can be
  52. initiated from the control panel or the start menu.
  53. .. warning::
  54. Legacy uninstallers (<=0.9.3) have a tendency to delete your user
  55. Mercurial.ini file, so backup your file before uninstalling the
  56. older TortoiseHg versions. This is not a problem with the newer MSI
  57. packages.
  58. All legacy TortoiseHg installers (before version 1.0) were built with
  59. InnoSetup. They installed a TortoiseOverlay package as a separate
  60. application, so you always saw both TortoiseHg and TortoiseOverlay as
  61. two applications in the *Add/Remove Programs* control panel program.
  62. (On X64 platforms, there were two TortoiseOverlays, one for x86
  63. processes and one of x64 processes).
  64. The new MSI installers for TortoiseHg 1.0 and later include the
  65. TortoiseOverlay packages as "merge modules" so they do not appear as
  66. separate applications anymore. It should be safe to uninstall the older
  67. TortoiseOverlay applications from *Add/Remove Programs* after you
  68. uninstall the legacy (<=0.9.3) TortoiseHg installer, unless you have
  69. other Tortoise products that still use the separate TortoiseOverlay MSI
  70. approach (TortoiseCVS or TortoiseBZR).
  71. .. note::
  72. TortoiseOverlay is a shim package that allows multiple Tortoise
  73. style shell extension clients to share overlay slots. This is
  74. necessary because even modern Windows platforms only support a
  75. limited number of overlay slots (11-14). TortoiseOverlay
  76. packages are created by the TortoiseSVN developers.
  77. To be completely safe, there are two approaches you can take:
  78. 1) Just leave the old TortoiseOverlay packages installed. They do not
  79. harm anything.
  80. 2) Uninstall all the old TortoiseOverlay packages, then re-install all
  81. of your Tortoise products until they are all functional.
  82. Finally, if you have problems with the shell extension even after
  83. re-logging in, we recommend you re-run the installer and select the
  84. *Repair* option. There were problems with a few versions of
  85. TortoiseOverlays that cause upgrades to subtly fail until the *Repair*
  86. process is run.
  87. Language settings
  88. ^^^^^^^^^^^^^^^^^
  89. The TortoiseHg user interface has been translated into many languages.
  90. Language packs are not required since all available languages are
  91. installed. Look in :file:`C:\\Program Files\\TortoiseHg\\locale` for the
  92. available languages. To enable a language just set the environment
  93. variable ``LANGUAGE`` to the desidered language, e.g. for italian
  94. ``set LANGUAGE=it``.
  95. The Windows shell extension context menus get their translations from
  96. the Windows registry. Translations for many locales were installed
  97. under :file:`C:\\Program Files\\TortoiseHg\\i18n\\cmenu`. Select the
  98. locale you would like to use, double-click on it, and confirm all
  99. requests.
  100. On Linux and Mac
  101. ----------------
  102. The most recent Linux packages can be found on our `download
  103. <http://tortoisehg.bitbucket.org/download/linux.html>`_ page.
  104. For Mac OS X, no packages are available but you can run thg and all the
  105. dialogs via the source install method. For details, see
  106. `Mac OS X <http://bitbucket.org/tortoisehg/thg/wiki/Home>`_.
  107. .. note::
  108. If you install TortoiseHg from source, you need to add our
  109. contrib/mergetools.rc file to your HGRC path in some way. One
  110. approach is to %include it from your ~/.hgrc file.
  111. Language settings
  112. ^^^^^^^^^^^^^^^^^
  113. The TortoiseHg tools use Python's
  114. `gettext <http://docs.python.org/library/gettext.html>`_ library to
  115. localize their text. To get localized dialogs, it is recommended that
  116. you set the LANGUAGE environment variable to your locale of choice.
  117. .. vim: noet ts=4