PageRenderTime 44ms CodeModel.GetById 21ms RepoModel.GetById 1ms app.codeStats 1ms

Plain Text | 153 lines | 116 code | 37 blank | 0 comment | 0 complexity | 726d47a089e1fcd34ccd7c40f9cc5350 MD5 | raw file
Possible License(s): GPL-2.0
  1. Windows Explorer Integration
  2. ============================
  3. .. module:: explorer
  4. :synopsis: Windows explorer integration
  5. Context Menus
  6. -------------
  7. TortoiseHg commands may be accessed via the context menu of Explorer
  8. windows and other applications which use the standard File/Open dialogs.
  9. Here is the context menu for a revisioned folder:
  10. .. figure:: figures/cmenu-nofiles.png
  11. :alt: Context menu
  12. Context menu for a folder under Mercurial revision control
  13. And here is the context menu for selected files or folders:
  14. .. figure:: figures/cmenu-files.png
  15. :alt: Context menu
  16. Context menu for file or folder selection
  17. TortoiseHg provides dialogs for the most regularly used Mercurial
  18. commands. Less frequently used and newly added Mercurial commands
  19. may be accessed from the CLI (command line interface) through
  20. :file:`cmd.exe` on Windows.
  21. Overlay Icons
  22. -------------
  23. TortoiseHg provides visual representation of the file status via overlay
  24. icons in the MS-Explorer windows. This is similar to those that found on
  25. other Tortoise client, such as TortoiseCVS and TortoiseSVN.
  26. TortoiseHg shares the overlay icons with TortoiseSVN (version 1.5.x or
  27. later) and the other "Tortoise" projects via the use of TortoiseOverlays
  28. (another project created by TortoiseSVN team).
  29. .. figure:: figures/overlayicons.png
  30. :alt: Overlay icons
  31. Overlay icons in Icons view (XP)
  32. The context menu has an :guilabel:`Update Icons` option which forces
  33. TortoiseHg to refresh the icons in the currently browsed repository or
  34. directory of repositories. The taskbar icon will turn green and the
  35. directory icons will turn into question marks while this refresh is in
  36. progress.
  37. Shell Configuration
  38. -------------------
  39. The overlay handler and context menus are configurable. From any folder
  40. background (even the desktop), right click and select
  41. :menuselection:`TortoiseHg --> Explorer Extension Settings`. This opens the
  42. TortoiseHg Shell Configuration dialog.
  43. On the tab "Context Menu" you can promote individual menu options to the
  44. top level menu.
  45. .. figure:: figures/shell-config-cmenu.png
  46. :alt: Shell Configuration dialog, Context Menu tab
  47. Shell Configuration Dialog, Context Menu tab
  48. On the "Icons" tab you configure settings related to the overlay icons and the
  49. icon of the "Overlay Icons Server" in the taskbar (in the notification area of
  50. Windows).
  51. .. figure:: figures/shell-config-icons.png
  52. :alt: Shell Configuration dialog, Icons tab
  53. Shell Configuration Dialog, Icons tab
  54. :guilabel:`Enable overlays:`
  55. If checked, overlay icons are shown on folders and files in the
  56. working directory (woking copy) of Mercurial repositories.
  57. (Default: checked)
  58. :guilabel:`Local disks only:`
  59. If checked, overlay icons are only shown for volumes on local disks, not
  60. on network shares. Scanning for Mercurial repositories over the network
  61. may result in high latency in the user interface of explorer. Check this
  62. option if browsing network shares becomes too slow and/or you do not need
  63. overlay icons on non-local volumes.
  64. (Default: not checked)
  65. :guilabel:`Enabled Overlay Handlers:`
  66. These (per user) settings provide the possibility to disable overlay
  67. icon handlers in the shared TortoiseOverlays component.
  68. The TortoiseOverlays component is shared by all Tortoises (TortoiseHg,
  69. TortoiseSVN, etc), with the goal to avoid registering too many icon slots,
  70. by using a common set of icons slots for all Tortoises (thus using the
  71. same set of icons for all Tortoises).
  72. The total number of overlay slots available on Windows is fairly limited and
  73. depends on the exact Windows version. For example, on a pristine install
  74. of Windows 7, there are only 8 free overlay handler slots available.
  75. This section allows to disable certain non-essential overlay
  76. handlers, to reduce icon handler slot consumption by the TortoiseOverlays
  77. component. Unchecking handlers in this section increases the chances that
  78. important handlers like "Normal" (green checkmark) or "Modifed" (red
  79. exclamation mark) will still get an icon slot, even if there are too many
  80. handlers registered on a computer.
  81. Unchecking handlers that are not used by TortoiseHg (that is: Locked,
  82. Readonly, Ignored, Deleted) is highly recommended, if you know that no
  83. other Tortoises (e.g. TortoiseSVN) uses them.
  84. Make sure the "Added" and "Unversioned" handlers are enabled, as these
  85. are used by TortoiseHg.
  86. (Default: all checked)
  87. .. warning::
  88. The "Enabled Overlay Handlers" settings affect all Tortoises for a user.
  89. A logoff/login is required to make changes in that section effective.
  90. :guilabel:`Taskbar:`
  91. Checkmark "Show Icon" to show the icon of the Overlay Icon Server in the
  92. taskbar in the notification area. "Highlight Icon" highlights that icon
  93. using a light green color while the icon server is busy updating cache files
  94. in the repository (files :file:`.hg\\dirstate` and :file:`.hg\\thgstatus`).
  95. (Default: both checked)
  96. One can selectively disable overlay icons in a specific repository by
  97. editing the :file:`.hg\\thgstatus` file inside the repository and
  98. replacing it's contents with a single line containing::
  99. @@noicons
  100. Nautilus
  101. --------
  102. TortoiseHg also provides shell integration with the GNOME desktop via a
  103. nautilus-python plugin. If you have installed TortoiseHg from a
  104. distribution package, the odds are that this extension is already
  105. configured. If not, please consult our Wiki for instructions on how to
  106. enable this feature.
  107. While the nautilus extension does not have it's own GUI for managing the
  108. overlays and context menus, it does support command promotion into the
  109. top menu. It requires you to edit your :file:`~/.hgrc` file and add
  110. lines like these::
  111. [tortoisehg]
  112. promoteditems = commit, log, synch
  113. .. figure:: figures/nautilus.png
  114. :alt: Nautilus screenshot
  115. GNOME/Nautilus screenshot
  116. .. vim: noet ts=4