PageRenderTime 22ms CodeModel.GetById 12ms app.highlight 3ms RepoModel.GetById 2ms app.codeStats 0ms

/doc/source/explorer.txt

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