You might prefer to follow this guide if you specifically need a quick outline to get started.
As you can see, the user documentation for RapidSVN has just started. The first draft with the outline was created 2006-11-01 and it will grow in the weeks and months (and years!) to come.
Your help with the documentation is requested! If you want to proofread the texts or if you want to create whole sections of the documentation: just create an account and start working on the site.
In the past I had to disable the user account creation to the public after this was abused by wiki spammers who would come and insert invisible SPAM links in our pages (probably to get a better google pagerank). Hopefully this won't be that much of an issue anymore, since now a user has to verify her account.
There appear to be pre-built RPM-format packages of RapidSVN for most major distros of Linux. Just Google to find the appropriate one.
If you're using Debian or Ubuntu, you can easily install RapidSVN by running "aptitude install rapidsvn" (Ubuntu users may need to use sudo) or by installing it from Synaptic.
For CentOS and RHEL there are excellent pre-built binaries including dependencies available from the RPMForge. The DAG Repository has further info: http://dag.wieers.com/rpm/FAQ.php#B.
The 'Programs' tab must be filled with the paths pointing to the programs that perform Edit, Explore, Diff and Merge functions.
The suggested programs are:
/usr/bin/xdg-open (to handle other file types)
|KDiff3 Meld (to install Meld on ubuntu, aptitude install meld)
FileMerge (via opendiff) NOTE: Requires Mac OS X Developer Tools
After installing the application in the Applications folder, copy the shell script from the disk image to
/usr/bin/diffmerge.sh in RapidSVN->Preferences->Programs->"Diff tool:". For "Program arguments" use
"%2" "%1". %2 is the original file and %1 is the modified file. The quotes will properly encapsulate paths with spaces.
This is the commandline argument:
/title1="Base" /title2="Mine" /title3="Theirs" /result="%4" "%1" "%3" "%2"
This is the commandline argument:
"%2" "%4" "%3"
Note: This tutorial was written to assist a user getting started with RapidSVN. It was not written to assist an administrator starting from the beginning.
RapidSVN has the notion of a server (a repository) and a client (a working copy). Both repositories and working copies can be bookmarked. By creating a bookmark, the user has quick access to either the working copy or repository in RapidSVN. The first thing a user should do is bookmark a repository.
After bookmarking a repository the user can browse (but not view or edit) all the files on the server.
Next a user may want to work with a file in the repository; this is done by checking out a working copy. But RapidSVN does not do checkout at the file level. Instead, only directories can be checked out. The user could checkout the entire repository from the Repository menu but often times this is undesirable due to time and space requirements to checkout a large repository. So instead the user can checkout the parent directory of the file to be worked on.
If you have progressed this far then you have bookmarked a repository and a working copy. If a file is added to a directory that already has an existing “working copy bookmark,” the file will appear in the right-hand window with a status of "unversioned".
The new directory and its contents have been added to the repository. Note: It is possible to add empty directories.
Up to this point we have been working in an existing directory in the repository. One of the first things you will likely want to do is add your project directory. This can sometimes be tricky. For instance, you want to put your directory at the root of the repository but you don’t want to store the entire repository on your hard disk. There are a couple of ways to accomplish this:
This will add your directory and all the files and directories in your project. Unfortunately doing an import doesn't checkout your files. Your files are in the repository but you can't start working with them. The directory on your drive remains untouched (it doesn't contain the hidden .svn directories). The next step is to checkout what you just imported.) (Entered enhancement request)
If you are new to both Subversion and RapidSVN, probably the first thing you are trying to do is checkout a working copy of an existing repository.
If you are new to RapidSVN, but have used Subversion, probably the first thing you want to do is view an existing Subversion sandbox with RapidSVN.
When working on a project with a team, you'll want to update your working copy to receive any changes made by other developers on the project. The update command will bring your working copy into sync with the latest revision in the repository.
Copy, Branch, Tag, Move, and Rename are all the same in that the selected file is copied to its new location. Then in some instances the source file is deleted.
To Copy, Branch, and Tag: Select the file in the repository then from the Modify menu select Copy... F5 and copy the file to a new directory or filename.
To Move: Select the file in the repository then from the Modify menu select Move... F6 and move the file to a new directory or filename.
To Rename: Select the file in the repository then from the Modify menu select Rename... F6 and change the filename.
The edit field in the dialog that appears for Copy, Move, and Rename works the same even though the wording is slightly different for each. You can specify a new filename, a new relative path, or a fully qualified path to name a few of the options. For example, given the path //TagentServer/svn/RFID/Reader/src/readme.txt some possible choices for the destination edit field include:
readme.old <- Operation happens in same directory as source file.
../dst/ <- In the parent's dst directory move/copy the file.
../dst/readme2.txt <- In the parent's dst directory move/copy the file and rename it.
http://TagentServer/svn/RFID/Reader/dst/readme.txt <- Example of fully qualified path.
Merging is combining the contents of one branch with another, or combining one branch with your trunk (main) version. This is accomplished via the Repository > Merge... option. An important thing to know about merging is that you merge the versions on your local machine, not on the remote repository.
In brief, the steps are as follows. Assuming you want to merge branch1 and branch2,
If you are merging a branch with a trunk (main) version, you may wish to have "Second working copy or URL" and "Destination path" both be the path to your main version.
"Revision" cannot be left blank. You are also unable to type "head". If you wish to use your head (latest) version, you will need to type in its number. This can be discovered by selecting your remote repository in Bookmarks (you can't do this while the Merge dialog is open) and selecting "Log..." from the "Query" menu. Use the Revision number from the latest entry in the log (top of the list).
Delete (available from the context menu or from the Modify menu > Delete) will remove a file from both SVN and the local hard drive. The local file can be read-only or read-write.
RapidSVN will not let you delete modified files - files under revision control with changes that haven't been committed to the repository. The following error will appear: "Error while performing action: 'readme.txt' has local modifications". The "Force Removal" checkbox in the Delete dialog will override this probation and let you delete modified files.
If you try to delete a file not under SVN control the following error appears, "Error while performing action: 'readme.txt' is not under version control." The "Force Removal" checkbox in the Delete dialog will override this prohibition and let you delete files not under version control.
A local repository contains hidden .svn directories used by Subversion to manage the repository. The Export... command creates a local copy of the repository without the .svn directories.
To export from a repository:
As of version 0.9.4, a repository can be created only with the command svnadmin. At the command line type svnadmin create /path/to/repository.
For more information about repository administration, refer to the Repository Administration chapter of the Version Control with Subversion book.
A good place to ask questions about RapidSVN is the users' mailinglist at mailto:firstname.lastname@example.org.
The mailinglist central is at http://rapidsvn.tigris.org/servlets/ProjectMailingListList. You can use this page to search for messages that may address your problem.
The RapidSVN project uses an issue tracker to manage bugs/defects or feature requests. The URL for the issue tracker is http://rapidsvn.tigris.org/servlets/ProjectIssues. Please ask your questions / report your problem first on the mailinglist to keep duplicate entries in the issue tracker at a minimum.
You can also reset all columns to their default widths and selections from the View->Columns->Reset Columns menu pick.