Table of Contents
This document describes day to day usage of the TortoiseSVN client. It is not an introduction to version control systems, and not an introduction to Subversion (SVN). It is more like a place you may turn to when you know approximately what you want to do, but don't quite remember how to do it.
If you need an introduction to version control with Subversion, then we recommend you read the fantastic book: Version Control with Subversion .
This document is also a work in progress, just as TortoiseSVN and Subversion are. If you find any mistakes, please report them to the mailing list so we can update the documentation. Some of the screenshots in the Daily Use Guide (DUG) might not reflect the current state of the software. Please forgive us. We're working on TortoiseSVN in our free time.
In order to get the most out of the Daily Use Guide:
You should have installed TortoiseSVN already.
You should be familiar with version control systems.
You should know the basics of Subversion.
You should have set up a server and/or have access to a Subversion repository.
This section describes some of the features of TortoiseSVN which apply to just about everything in the manual. Note that many of these features will only show up within a Subversion working copy.
One of the most visible features of TortoiseSVN is the icon overlays which appear on files in your working copy. These show you at a glance which of your files have been modified. Refer to the section called “Icon Overlays” to find out what the different overlays represent.
All TortoiseSVN commands are invoked from the context menu of the windows explorer. Most are directly visible, when you right click on a file or folder. The commands that are available depend on whether the file or folder or its parent folder is under version control or not. You can also see the TortoiseSVN menu as part of the Explorer file menu.
Some commands which are very rarely used are only available in the extended context menu. To bring up the extended context menu, hold down the Shift key when you right click.
In some cases you may see several TortoiseSVN entries. This is not a bug!
This example is for an unversioned shortcut within a versioned folder, and in the Explorer file menu there are three entries for TortoiseSVN. One is for the folder, one for the shortcut itself, and the third for the object the shortcut is pointing to. To help you distinguish between them, the icons have an indicator in the lower right corner to show whether the menu entry is for a file, a folder, a shortcut or for multiple selected items.
Other commands are available as drag handlers, when you right drag files or folders to a new location inside working copies or when you right drag a non-versioned file or folder into a directory which is under version control.
Some common operations have well-known Windows shortcuts, but do not appear on buttons or in menus. If you can't work out how to do something obvious, like refreshing a view, check here.
Help, of course.
Refresh the current view. This is perhaps the single most useful one-key command. For example ... In Explorer this will refresh the icon overlays on your working copy. In the commit dialog it will re-scan the working copy to see what may need to be committed. In the Revision Log dialog it will contact the repository again to check for more recent changes.
Select all. This can be used if you get an error message and want to copy and paste into an email. Use Ctrl-A to select the error message and then ...
Copy the selected text. In case no text is selected but e.g. a list entry or a message box, then the content of that list entry or the message box is copied to the clipboard.
If the repository that you are trying to access is password protected, an authentication Dialog will show up.
Enter your username and password. The checkbox will make TortoiseSVN store the credentials in Subversion's default directory:
%APPDATA%\Subversion\auth in three subdirectories:
svn.simple contains credentials
for basic authentication (username/password).
Note that passwords are stored using the WinCrypt API,
not in plain text form.
SSL server certificates.
svn.username contains credentials
for username-only authentication (no password needed).
If you want to clear the authentication cache, you can do so from the Saved Data page of TortoiseSVN's settings dialog. The button will clear the cached authentication data for all repositories. The button however will show a dialog where you can chose which cached authentication data should be deleted. Refer to the section called “Saved Data Settings”.
Some people like to have the authentication data deleted when they
log off Windows, or on shutdown. The way to do that is to use a shutdown
script to delete the
@echo off rmdir /s /q "%APPDATA%\Subversion\auth"
You can find a description of how to install such scripts at http://www.windows-help-central.com/windows-shutdown-script.html .
For more information on how to set up your server for authentication and access control, refer to the section called “Accessing the Repository”.
Many of TortoiseSVN's dialogs have a lot of information to display, but it is often useful to maximize only the height, or only the width, rather than maximizing to fill the screen. As a convenience, there are shortcuts for this on the Maximize button. Use the middle mouse button to maximize vertically, and right mouse to maximize horizontally.