| 4 |
<head> |
<head> |
| 5 |
<title>ViewVC Help: General</title> |
<title>ViewVC Help: General</title> |
| 6 |
<link rel="stylesheet" href="help.css" type="text/css" /> |
<link rel="stylesheet" href="help.css" type="text/css" /> |
| 7 |
|
<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon" /> |
| 8 |
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> |
| 9 |
</head> |
</head> |
| 10 |
<body> |
<body> |
| 11 |
|
<div><a href="http://viewvc.org/index.html"><img src="images/viewvc-logo.png" alt="ViewVC logotype" /></a></div> |
| 12 |
<table> |
<table> |
| 13 |
<col class="menu" /> |
<col class="menu" /> |
| 14 |
<col /> |
<col /> |
|
<tr> |
|
|
<td><a href=".."><img |
|
|
src="images/logo.png" alt="ViewVC logotype" /></a> |
|
|
</td> |
|
|
<td> |
|
|
<h1>ViewVC Help: General</h1> |
|
|
</td> |
|
|
</tr> |
|
| 15 |
<tr><td> |
<tr><td> |
| 16 |
<h3>Help</h3> |
<h3>Help</h3> |
| 17 |
<strong>General</strong><br /> |
<strong>General</strong><br /> |
| 18 |
<a href="help_dirview.html">Directory View</a><br /> |
<a href="help_dirview.html">Directory View</a><br /> |
| 19 |
<a href="help_log.html">Log View</a><br /> |
<a href="help_log.html">Log View</a><br /> |
| 20 |
|
<a href="help_query.html">Query Database</a><br /> |
| 21 |
|
</td><td> |
| 22 |
|
|
| 23 |
<h3>Internet</h3> |
<h1>ViewVC Help: General</h1> |
|
<a href="http://viewvc.org/index.html">Home</a><br /> |
|
|
<a href="http://viewvc.org/upgrading.html">Upgrading</a><br /> |
|
|
<a href="http://viewvc.org/contributing.html">Contributing</a><br /> |
|
|
<a href="http://viewvc.org/license-1.html">License</a><br /> |
|
|
</td><td colspan="2"> |
|
|
|
|
|
<p><em>ViewVC</em> is a WWW interface for CVS and Subversion |
|
|
repositories. It allows you to browse the files and directories in a |
|
|
repository while showing you metadata from the repository history: log |
|
|
messages, modification dates, author names, revision numbers, copy |
|
|
history, and so on. It provides several different views of repository |
|
|
data to help you find the information you are looking for:</p> |
|
|
|
|
|
<ul> |
|
|
<li><a name="view-dir" href="help_dirview.html"><strong>Directory |
|
|
View</strong></a> - Shows a list of files and subdirectories in a |
|
|
directory of the repository, along with metadata like author names and |
|
|
log entries.</li> |
|
|
|
|
|
<li><a name="view-log" href="help_log.html"><strong>Log |
|
|
View</strong></a> - Shows a revision by revision list of all the |
|
|
changes that have made to a file or directory in the repository, with |
|
|
metadata and links to views of each revision.</li> |
|
|
|
|
|
<li><a name="view-markup"><strong>File Contents View (Markup |
|
|
View)</strong></a> - Shows the contents of a file at a particular |
|
|
revision, with revision information at the top of the page. File |
|
|
revisions which are GIF, PNG, or JPEG images are displayed inline on |
|
|
the page. Other file types are displayed as marked up text. The markup |
|
|
may be limited to turning URLs and email addresses into links, or |
|
|
configured to show colorized source code.</li> |
|
|
|
|
|
<li><a name="view-checkout"><strong>File Download (Checkout |
|
|
View)</strong></a> - Retrieves the unaltered contents of a file |
|
|
revision. Browsers may try to display the file, or just save it to |
|
|
disk.</li> |
|
|
|
|
|
<li><a name="view-annotate"><strong>File Annotate View</strong></a> - |
|
|
Shows the contents of a file revision and breaks it down line by line, |
|
|
showing the revision number where each one was last modified, along |
|
|
with links and other information. <em>This view is disabled in some |
|
|
ViewVC configurations</em></li> |
|
|
|
|
|
<li><a name="view-diff"><strong>File Diff View</strong></a> - Shows |
|
|
the changes made between two revisions of a file</li> |
|
|
|
|
|
<li><a name="view-tarball"><strong>Directory Tarball View</strong> - |
|
|
Retrieves a gzipped tar archive containing the contents of a |
|
|
directory.<em>This view is disabled in the default ViewVC |
|
|
configuration.</em></li> |
|
|
|
|
|
<li><a name="view-query"><strong>Directory Query View</strong></a> - |
|
|
Shows information about changes made to all subdirectories and files |
|
|
under a parent directory, sorted and filtered by criteria you specify. |
|
|
<em>This view is disabled in the default ViewVC configuration.</em> |
|
|
</li> |
|
|
|
|
|
<li><a name="view-rev"><strong>Revision View</strong> - Shows |
|
|
information about a revision including log message, author, and a list |
|
|
of changed paths. <em>For Subversion repositories only.</em></li> |
|
|
|
|
|
<li><a name="view-graph"><strong>Graph View</strong></a> - Shows a |
|
|
graphical representation of a file's revisions and branches complete |
|
|
with tag and author names and links to markup and diff pages. |
|
|
<em>For CVS repositories only, and disabled in the default |
|
|
configuration.</em></li> |
|
|
</ul> |
|
|
|
|
|
<h3><a name="multiple-repositories">Multiple Repositories</a></h3> |
|
|
|
|
|
<p>A single installation of ViewVC is often used to provide access to |
|
|
more than one repository. In these installations, ViewVC shows a |
|
|
<em>Project Root</em> drop down box in the top right corner of every |
|
|
generated page to allow for quick access to any repository.</p> |
|
|
|
|
|
<h3><a name="sticky-revision-tag">Sticky Revision and Tag</a></h3> |
|
|
|
|
|
<p>By default, ViewVC will show the files and directories and revisions |
|
|
that currently exist in the repository. But it's also possible to browse |
|
|
the contents of a repository at a point in its past history by choosing |
|
|
a "sticky tag" (in CVS) or a "sticky revision" (in Subversion) from the |
|
|
forms at the top of directory and log pages. They're called sticky |
|
|
because once they're chosen, they stick around when you navigate to |
|
|
other pages, until you reset them. When they're set, directory and log |
|
|
pages only show revisions preceding the specified point in history. In |
|
|
CVS, when a tag refers to a branch or a revision on a branch, only |
|
|
revisions from the branch history are shown, including branch points and |
|
|
their preceding revisions.</p> |
|
|
|
|
|
<h3><a name="dead-files">Dead Files</a></h3> |
|
|
|
|
|
<p>In CVS directory listings, ViewVC can optionally display dead files. |
|
|
Dead files are files which used to be in a directory but are currently |
|
|
deleted, or files which just don't exist in the currently selected |
|
|
<a href="#sticky-revision-tag">sticky tag</a>. Dead files cannot be |
|
|
shown in Subversion repositories. The only way to see a deleted file in |
|
|
a Subversion directory is to navigate to a sticky revision where the |
|
|
file previously existed.</p> |
|
|
|
|
|
<h3><a name="artificial-tags">Artificial Tags</a></h3> |
|
|
|
|
|
<p>In CVS Repositories, ViewVC adds artificial tags <em>HEAD</em> and |
|
|
<em>MAIN</em> to tag listings and accepts them in place of revision |
|
|
numbers and real tag names in all URLs. <em>MAIN</em> acts like a branch |
|
|
tag pointing at the default branch, while <em>HEAD</em> acts like a |
|
|
revision tag pointing to the latest revision on the default branch. The |
|
|
default branch is usually just the trunk, but may be set to other |
|
|
branches inside individual repository files. CVS will always check out |
|
|
revisions from a file's default branch when no other branch is specified |
|
|
on the command line.</p> |
|
|
|
|
|
<h3><a name="more-information">More Information</a></h3> |
|
|
|
|
|
<p>More information about <em>ViewVC</em> is available from |
|
|
<a href="http://viewvc.org/">viewvc.org</a>. |
|
|
See the links below for guides to CVS and Subversion</p> |
|
|
|
|
|
<h4>Documentation about CVS</h4> |
|
|
<blockquote> |
|
|
<p> |
|
|
<a href="http://cvsbook.red-bean.com/"><em>Open Source |
|
|
Development with CVS</em></a><br /> |
|
|
<a href="http://www.loria.fr/~molli/cvs/doc/cvs_toc.html">CVS |
|
|
User's Guide</a><br /> |
|
|
<a href="http://cellworks.washington.edu/pub/docs/cvs/tutorial/cvs_tutorial_1.html">Another CVS tutorial</a><br /> |
|
|
<a href="http://www.csc.calpoly.edu/~dbutler/tutorials/winter96/cvs/">Yet another CVS tutorial (a little old, but nice)</a><br /> |
|
|
<a href="http://www.cs.utah.edu/dept/old/texinfo/cvs/FAQ.txt">An old but very useful FAQ about CVS</a> |
|
|
</p> |
|
|
</blockquote> |
|
|
|
|
|
<h4>Documentation about Subversion</h3> |
|
|
<blockquote> |
|
|
<p> |
|
|
<a href="http://svnbook.red-bean.com/"><em>Version Control with |
|
|
Subversion</em></a><br /> |
|
|
</p> |
|
|
</blockquote> |
|
| 24 |
|
|
| 25 |
|
<p><em>ViewVC</em> is a WWW interface for CVS and Subversion |
| 26 |
|
repositories. It allows you to browse the files and directories in a |
| 27 |
|
repository while showing you metadata from the repository history: log |
| 28 |
|
messages, modification dates, author names, revision numbers, copy |
| 29 |
|
history, and so on. It provides several different views of repository |
| 30 |
|
data to help you find the information you are looking for:</p> |
| 31 |
|
|
| 32 |
|
<ul> |
| 33 |
|
<li><a name="multiple-repositories"><strong>Root Listing |
| 34 |
|
View</strong></a> - Show a list of repositories configured for |
| 35 |
|
display in ViewVC.</li> |
| 36 |
|
|
| 37 |
|
<li><a name="view-dir" href="help_dirview.html"><strong>Directory |
| 38 |
|
View</strong></a> - Shows a list of files and subdirectories in a |
| 39 |
|
directory of the repository, along with metadata like author names and |
| 40 |
|
log entries.</li> |
| 41 |
|
|
| 42 |
|
<li><a name="view-log" href="help_log.html"><strong>Log |
| 43 |
|
View</strong></a> - Shows a revision by revision list of all the |
| 44 |
|
changes that have made to a file or directory in the repository, with |
| 45 |
|
metadata and links to views of each revision.</li> |
| 46 |
|
|
| 47 |
|
<li><a name="view-checkout"><strong>File Download (Checkout |
| 48 |
|
View)</strong></a> - Retrieves the unaltered contents of a file |
| 49 |
|
revision. Browsers may try to display the file, or just save it |
| 50 |
|
to disk. <em>This view is disabled in the default ViewVC |
| 51 |
|
configuration.</em></li> |
| 52 |
|
|
| 53 |
|
<li><a name="view-annotate"><a name="view-markup"><strong>File |
| 54 |
|
Contents View</strong></a></a> - Shows the contents of a file at |
| 55 |
|
a particular revision, with revision information at the top of |
| 56 |
|
the page. File revisions which are GIF, PNG, or JPEG images are |
| 57 |
|
displayed inline on the page. Other file types are displayed as |
| 58 |
|
marked up text. The markup may be limited to turning URLs and |
| 59 |
|
email addresses into links, or configured to show colorized |
| 60 |
|
source code. This view can optionally show line-based |
| 61 |
|
annotation data for the file, containing the revision number |
| 62 |
|
where each line was last modified, along with links and other |
| 63 |
|
information. <em>This view is disabled in some ViewVC |
| 64 |
|
configurations.</em></li> |
| 65 |
|
|
| 66 |
|
<li><a name="view-diff"><strong>File Diff View</strong></a> - Shows |
| 67 |
|
the changes made between two revisions of a file</li> |
| 68 |
|
|
| 69 |
|
<li><a name="view-tarball"><strong>Directory Tarball View</strong> - |
| 70 |
|
Retrieves a gzipped tar archive containing the contents of a |
| 71 |
|
directory.<em>This view is disabled in the default ViewVC |
| 72 |
|
configuration.</em></li> |
| 73 |
|
|
| 74 |
|
<li><a name="view-query"><strong>Directory Query View</strong></a> - |
| 75 |
|
Shows information about changes made to all subdirectories and files |
| 76 |
|
under a parent directory, sorted and filtered by criteria you specify. |
| 77 |
|
<em>This view is disabled in the default ViewVC configuration.</em> |
| 78 |
|
</li> |
| 79 |
|
|
| 80 |
|
<li><a name="view-rev"><strong>Revision View</strong> - Shows |
| 81 |
|
information about a revision including log message, author, and a list |
| 82 |
|
of changed paths. <em>For Subversion repositories only.</em></li> |
| 83 |
|
|
| 84 |
|
<li><a name="view-graph"><strong>Graph View</strong></a> - Shows a |
| 85 |
|
graphical representation of a file's revisions and branches complete |
| 86 |
|
with tag and author names and links to markup and diff pages. |
| 87 |
|
<em>For CVS repositories only, and disabled in the default |
| 88 |
|
configuration.</em></li> |
| 89 |
|
</ul> |
| 90 |
|
|
| 91 |
|
<h3><a name="sticky-revision-tag">Sticky Revision and Tag</a></h3> |
| 92 |
|
|
| 93 |
|
<p>By default, ViewVC will show the files and directories and revisions |
| 94 |
|
that currently exist in the repository. But it's also possible to browse |
| 95 |
|
the contents of a repository at a point in its past history by choosing |
| 96 |
|
a "sticky tag" (in CVS) or a "sticky revision" (in Subversion) from the |
| 97 |
|
forms at the top of directory and log pages. They're called sticky |
| 98 |
|
because once they're chosen, they stick around when you navigate to |
| 99 |
|
other pages, until you reset them. When they're set, directory and log |
| 100 |
|
pages only show revisions preceding the specified point in history. In |
| 101 |
|
CVS, when a tag refers to a branch or a revision on a branch, only |
| 102 |
|
revisions from the branch history are shown, including branch points and |
| 103 |
|
their preceding revisions.</p> |
| 104 |
|
|
| 105 |
|
<h3><a name="dead-files">Dead Files</a></h3> |
| 106 |
|
|
| 107 |
|
<p>In CVS directory listings, ViewVC can optionally display dead files. |
| 108 |
|
Dead files are files which used to be in a directory but are currently |
| 109 |
|
deleted, or files which just don't exist in the currently selected |
| 110 |
|
<a href="#sticky-revision-tag">sticky tag</a>. Dead files cannot be |
| 111 |
|
shown in Subversion repositories. The only way to see a deleted file in |
| 112 |
|
a Subversion directory is to navigate to a sticky revision where the |
| 113 |
|
file previously existed.</p> |
| 114 |
|
|
| 115 |
|
<h3><a name="artificial-tags">Artificial Tags</a></h3> |
| 116 |
|
|
| 117 |
|
<p>In CVS Repositories, ViewVC adds artificial tags <em>HEAD</em> and |
| 118 |
|
<em>MAIN</em> to tag listings and accepts them in place of revision |
| 119 |
|
numbers and real tag names in all URLs. <em>MAIN</em> acts like a branch |
| 120 |
|
tag pointing at the default branch, while <em>HEAD</em> acts like a |
| 121 |
|
revision tag pointing to the latest revision on the default branch. The |
| 122 |
|
default branch is usually just the trunk, but may be set to other |
| 123 |
|
branches inside individual repository files. CVS will always check out |
| 124 |
|
revisions from a file's default branch when no other branch is specified |
| 125 |
|
on the command line.</p> |
| 126 |
|
|
| 127 |
|
<h3><a name="more-information">More Information</a></h3> |
| 128 |
|
|
| 129 |
|
<p>More information about <em>ViewVC</em> is available from |
| 130 |
|
<a href="http://viewvc.org/">viewvc.org</a>. |
| 131 |
|
See the links below for guides to CVS and Subversion</p> |
| 132 |
|
|
| 133 |
|
<h4>Documentation about CVS</h4> |
| 134 |
|
<blockquote> |
| 135 |
|
<p> |
| 136 |
|
<a href="http://cvsbook.red-bean.com/"><em>Open Source |
| 137 |
|
Development with CVS</em></a><br /> |
| 138 |
|
<a href="http://www.loria.fr/~molli/cvs/doc/cvs_toc.html">CVS |
| 139 |
|
User's Guide</a><br /> |
| 140 |
|
<a href="http://cellworks.washington.edu/pub/docs/cvs/tutorial/cvs_tutorial_1.html">Another CVS tutorial</a><br /> |
| 141 |
|
<a href="http://www.csc.calpoly.edu/~dbutler/tutorials/winter96/cvs/">Yet another CVS tutorial (a little old, but nice)</a><br /> |
| 142 |
|
<a href="http://www.cs.utah.edu/dept/old/texinfo/cvs/FAQ.txt">An old but very useful FAQ about CVS</a> |
| 143 |
|
</p> |
| 144 |
|
</blockquote> |
| 145 |
|
|
| 146 |
|
<h4>Documentation about Subversion</h3> |
| 147 |
|
<blockquote> |
| 148 |
|
<p> |
| 149 |
|
<a href="http://svnbook.red-bean.com/"><em>Version Control with |
| 150 |
|
Subversion</em></a><br /> |
| 151 |
|
</p> |
| 152 |
|
</blockquote> |
| 153 |
</td></tr></table> |
</td></tr></table> |
| 154 |
<hr /> |
<hr /> |
| 155 |
<address><a href="mailto:users@viewvc.tigris.org">ViewVC Users Mailinglist</a></address> |
<address><a href="mailto:users@viewvc.tigris.org">ViewVC Users Mailinglist</a></address> |
Parent Directory
| 
Revision Log
| 
Patch