@c The real text starts here
@c ================================================================
-@node Top, About PCL-CVS, (dir), (dir)
@ifnottex
+@node Top
@top PCL-CVS
This manual describes PCL-CVS, the GNU Emacs front-end to CVS@. It
@end detailmenu
@end menu
-@node About PCL-CVS, Getting started, Top, Top
+@node About PCL-CVS
@chapter About PCL-CVS
@cindex About PCL-CVS
* Contributors:: Contributors to PCL-CVS.
@end menu
-@node Contributors,, About PCL-CVS, About PCL-CVS
+@node Contributors
@section Contributors to PCL-CVS
@cindex Contributors
@cindex Authors
PCL-CVS as well as all the documentation.
@item
-@email{inge@@lysator.liu.se, Inge Wallin} wrote the skeleton of
+@c inge@@lysator.liu.se
+Inge Wallin wrote the skeleton of
@file{pcl-cvs.texi}, and gave useful comments on it. He also wrote
the files @file{elib-node.el} and @file{compile-all.el}. The file
-@file{cookie.el} was inspired by Inge.@refill
+@file{cookie.el} was inspired by Inge.
@item
-@email{linus@@lysator.liu.se, Linus Tolke} contributed useful comments
-on both the functionality and the documentation.@refill
+@c linus@@lysator.liu.se
+Linus Tolke contributed useful comments
+on both the functionality and the documentation.
@item
-@email{jwz@@jwz.com, Jamie Zawinski} contributed
+@c jwz@@jwz.com
+Jamie Zawinski contributed
@file{pcl-cvs-lucid.el}, which was later renamed to
-@file{pcl-cvs-xemacs.el}.@refill
+@file{pcl-cvs-xemacs.el}.
@item
Leif Lonnblad contributed RCVS support (since superseded by the new
remote CVS support).
@item
-@email{jimb@@cyclic.com, Jim Blandy} contributed hooks to automatically
+@c jimb@@cyclic.com
+Jim Blandy contributed hooks to automatically
guess CVS log entries from @file{ChangeLog} contents, and initial support of
the new Cygnus / Cyclic remote CVS, as well as various sundry bug fixes
and cleanups.
@item
-@email{kingdon@@cyclic.com, Jim Kingdon} contributed lots of fixes to
+@c kingdon@@cyclic.com
+Jim Kingdon contributed lots of fixes to
the build and installation procedure.
@item
-@email{woods@@weird.com, Greg A. Woods} contributed code to implement
+@c woods@@weird.com
+Greg A. Woods contributed code to implement
the use of per-file diff buffers, and vendor join diffs with emerge and
ediff, as well as various and sundry bug fixes and cleanups.
@item
-@email{greg.klanderman@@alum.mit.edu, Greg Klanderman} implemented
+@c greg.klanderman@@alum.mit.edu
+Greg Klanderman implemented
toggling of marked files, setting of CVS command flags via prefix
arguments, updated the XEmacs support, updated the manual, and fixed
numerous bugs.
@item
-@email{monnier@@gnu.org, Stefan Monnier} added a slew of other
+@c monnier@@gnu.org
+Stefan Monnier added a slew of other
features and introduced even more new bugs. If there's any bug left,
you can be sure it's his.
@item
@c wordy to avoid an underfull hbox
-@email{masata-y@@is.aist-nara.ac.jp, Masatake YAMATO} made a gracious
+@c masata-y@@is.aist-nara.ac.jp
+Masatake YAMATO made a gracious
contribution of his cvstree code to display a tree of tags which was later
superseded by the new @code{cvs-status-mode}.
@end itemize
there would be no new releases of PCL-CVS.
-@node Getting started, Buffer contents, About PCL-CVS, Top
+@node Getting started
@chapter Getting started
@cindex Introduction
@cindex Example run
repository. @xref{Committing changes}. You can also press @kbd{O} to
update any of the files that are marked @samp{Need-Update}. You can
also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the
-@samp{*cvs*} buffer) to update all the files.@refill
+@samp{*cvs*} buffer) to update all the files.
You can then press @kbd{=} to easily get a @samp{diff} between your
modified file and the base version that you started from, or you can
commands are available simply by pressing a key (@pxref{Getting info
about files}).
-@node Buffer contents, Selected files, Getting started, Top
+@node Buffer contents
@chapter Buffer contents
@cindex Buffer contents
@cindex @code{*cvs*} buffer contents
@item
An asterisk when the file is @dfn{marked} (@pxref{Selected
-files}).@refill
+files}).
@item
The actual status of the file wrt the repository. See below.
@item merged
The file was modified in your working directory, and there were
modifications in the repository as well, but they were merged
-successfully, without conflict, in your working directory.@refill
+successfully, without conflict, in your working directory.
@end table
@item Conflict
the two versions; an unmodified copy of your file is also in your
working directory, with the name @file{.#@var{file}.@var{version}},
where @var{version} is the RCS revision that your modified file started
-from. @xref{Viewing differences}, for more details.@refill
+from. @xref{Viewing differences}, for more details.
A conflict can also come from a disagreement on the existence of the file
rather than on its content. This case is indicated by the following
@item Added
The file has been added by you, but it still needs to be checked in to
-the repository.@refill
+the repository.
@item Removed
The file has been removed by you, but it still needs to be checked in to
the repository. You can resurrect it by typing @kbd{a} (@pxref{Adding
-and removing files}).@refill
+and removing files}).
@item Unknown
A file that was detected in your directory, but that neither appears in
the repository, nor is present on the list of files that CVS should
-ignore.@refill
+ignore.
@item Up-to-date
The file is up to date with respect to the version in the repository.
@table @samp
@item added
-You have just added the file to the repository.@refill
+You have just added the file to the repository.
@item updated
The file was brought up to date with respect to the repository. This is
done for any file that exists in the repository but not in your source,
and for files that you haven't changed but are not the most recent
-versions available in the repository.@refill
+versions available in the repository.
@item patched
The file was brought up to date with respect to the remote repository by
way of fetching and applying a patch to the file in your source. This
is equivalent to @samp{updated} except that CVS decided to use a hopefully
-more efficient method.@refill
+more efficient method.
@item committed
-You just committed the file.@refill
+You just committed the file.
@end table
@item Need-Update
Either a newer version than the one in your source is available in the
repository and you have not modified your checked out version, or the
file exists in the repository but not in your source. Use
-@samp{cvs-mode-update} bound to @kbd{O} to update the file.@refill
+@samp{cvs-mode-update} bound to @kbd{O} to update the file.
@item Need-Merge
You have modified the checked out version of the file, and a newer
although it has not been @samp{cvs remove}d.
@end table
-@node Selected files, Commands, Buffer contents, Top
+@node Selected files
@chapter Selected files
@cindex Selected files
@cindex Marked files
For commands to mark and unmark files, see @ref{Marking files}.
-@node Commands, Log Edit Mode, Selected files, Top
+@node Commands
@chapter Commands
@iftex
@end menu
-@node Entering PCL-CVS, Setting flags, Commands, Commands
+@node Entering PCL-CVS
@section Entering PCL-CVS
@findex cvs-update
@findex cvs-examine
@kbd{C-u M-x cvs-update @key{RET} -l @key{RET}}).
-@node Setting flags, Updating the buffer, Entering PCL-CVS, Commands
+@node Setting flags
@section Setting flags for CVS commands
@cindex Optional switches to CVS
@cindex Command-line options to CVS
@table @kbd
@item T
-Toggles whether or not marks will be active in the next command.@refill
+Toggles whether or not marks will be active in the next command.
@item b
Provide the next command with a branch (can be any version
-specifier) to work on.@refill
+specifier) to work on.
@item B
Secondary branch argument. Only meaningful if @kbd{b} is also used.
to the ones PCL-CVS thinks are relevant.
@end table
-@node Updating the buffer, Movement commands, Setting flags, Commands
+@node Updating the buffer
@section Updating the @samp{*cvs*} buffer
@findex cvs-update
@findex cvs-examine
@table @kbd
@item M-u
-Runs the command @samp{cvs-update}.@refill
+Runs the command @samp{cvs-update}.
@item M-e
-Runs the command @samp{cvs-examine}.@refill
+Runs the command @samp{cvs-examine}.
@item M-s
-Runs the command @samp{cvs-status}.@refill
+Runs the command @samp{cvs-status}.
@end table
In addition to the above commands which operate on the whole module,
@table @kbd
@item O
Runs @code{cvs-mode-update} on the selected files. When run on the
-top-level directory, this is equivalent to @kbd{M-u}.@refill
+top-level directory, this is equivalent to @kbd{M-u}.
@item e
Runs @code{cvs-mode-examine} on the selected files. When run on the
-top-level directory, this is equivalent to @kbd{M-e}.@refill
+top-level directory, this is equivalent to @kbd{M-e}.
@findex cvs-status-mode
@item s
Runs @code{cvs-mode-status} on the selected files. When run on the
top-level directory, this is equivalent to @kbd{M-s}, except that
CVS output will be shown in a @samp{*cvs-info*} buffer that will be
-put in @samp{cvs-status-mode}.@refill
+put in @samp{cvs-status-mode}.
@end table
-@node Movement commands, Marking files, Updating the buffer, Commands
+@node Movement commands
@section Movement Commands
@cindex Movement Commands
@findex cvs-mode-next-line
@item @key{SPC}
@itemx n
These keys move the cursor one file forward, towards the end of the
-buffer (@code{cvs-mode-next-line}).@refill
+buffer (@code{cvs-mode-next-line}).
@item p
This key moves one file backward, towards the beginning of the buffer
@end table
-@node Marking files, Committing changes, Movement commands, Commands
+@node Marking files
@section Marking files
@cindex Selecting files (commands to mark files)
@cindex Marking files
@item m
This marks the file that the cursor is positioned on. If the cursor is
positioned on a directory all files in that directory are marked
-(@code{cvs-mode-mark}).@refill
+(@code{cvs-mode-mark}).
@item u
Unmark the file that the cursor is positioned on. If the cursor is on a
directory, all files in that directory are unmarked
-(@code{cvs-mode-unmark}).@refill
+(@code{cvs-mode-unmark}).
@item M
Mark @emph{all} files in the buffer (@code{cvs-mode-mark-all-files}).
@end table
-@node Committing changes, Editing files, Marking files, Commands
+@node Committing changes
@section Committing changes
@cindex Committing changes
@findex cvs-mode-commit
@item
After having selected the files you want to commit, you type either
@kbd{c} or @kbd{C} which brings up a special buffer
-@samp{*cvs-commit*}.@refill
+@samp{*cvs-commit*}.
@item
You type in the log message describing the changes you're about to
@item
When you're happy with it, you type @kbd{C-c C-c} to do the actual
-commit.@refill
+commit.
@end enumerate
There's no hidden state, so you can abort the process or pick it up
@samp{nil}.
-@node Editing files, Getting info about files, Committing changes, Commands
+@node Editing files
@section Editing files
@cindex Editing files
@cindex Finding files
@item o
Like @kbd{f}, but use another window
-(@code{cvs-mode-find-file-other-window}).@refill
+(@code{cvs-mode-find-file-other-window}).
@item A
Invoke @samp{add-change-log-entry-other-window} to edit a
@file{ChangeLog} file. The @file{ChangeLog} file will be found in the
directory of the file the cursor points to, or in a parent of that
-directory (@code{cvs-mode-add-change-log-entry-other-window}).@refill
+directory (@code{cvs-mode-add-change-log-entry-other-window}).
@end table
-@node Getting info about files, Adding and removing files, Editing files, Commands
+@node Getting info about files
@section Getting info about files
@cindex Status (cvs command)
@cindex Log (RCS/cvs command)
@end table
-@node Adding and removing files, Undoing changes, Getting info about files, Commands
+@node Adding and removing files
@section Adding and removing files
@cindex Adding files
@cindex Removing files
files (@pxref{Buffer contents}). The status of the file will change to
@samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit}
@pxref{Committing changes}), to really add the file to the
-repository.@refill
+repository.
This command can also be used on @samp{Removed} files (before you commit
them) to resurrect them.
also be @samp{cvs remove}d. If the files' status was @samp{Unknown}
they will disappear from the buffer. Otherwise their status will change to
@samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit},
-@pxref{Committing changes}) to commit the removal.@refill
+@pxref{Committing changes}) to commit the removal.
The command that is run is @code{cvs-mode-remove-file}.
@end table
-@node Undoing changes, Removing handled entries, Adding and removing files, Commands
+@node Undoing changes
@section Undoing changes
@cindex Undo changes
@cindex Flush changes
@end table
-@node Removing handled entries, Ignoring files, Undoing changes, Commands
+@node Removing handled entries
@section Removing handled entries
@cindex Expunging uninteresting entries
@cindex Uninteresting entries, getting rid of them
@vindex cvs-mode-remove-handled@r{ (variable)}
@kbd{x} invokes @code{cvs-mode-remove-handled}. If
@samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will
-automatically be performed after every commit.@refill
+automatically be performed after every commit.
@item C-k
This command can be used for lines that @samp{cvs-mode-remove-handled} would
@end table
-@node Ignoring files, Viewing differences, Removing handled entries, Commands
+@node Ignoring files
@section Ignoring files
@cindex Ignoring files
@kindex i@r{--ignoring files}
This runs @code{cvs-mode-ignore}.
@end table
-@node Viewing differences, Invoking Ediff, Ignoring files, Commands
+@node Viewing differences
@section Viewing differences
@cindex Diff
@cindex Invoking @code{diff}
@item =
@itemx d =
Display a @samp{cvs diff} between the selected files and the version
-that they are based on (@code{cvs-mode-diff}).@refill
+that they are based on (@code{cvs-mode-diff}).
@item d b
If CVS finds a conflict while merging two versions of a file (during a
@samp{cvs update}, @pxref{Updating the buffer}) it will save the
original file in a file called @file{.#@var{file}.@var{version}} where
@var{file} is the name of the file, and @var{version} is the revision
-number that @var{file} was based on.@refill
+number that @var{file} was based on.
With the @kbd{d b} command you can run a @samp{diff} on the files
-@file{.#@var{file}.@var{version}} and @file{@var{file}}.@refill
+@file{.#@var{file}.@var{version}} and @file{@var{file}}.
@item d h
Display a @samp{cvs diff} between the selected files and the head
revision (the most recent version on the current
-branch) in the repository (@code{cvs-mode-diff-head}).@refill
+branch) in the repository (@code{cvs-mode-diff-head}).
@item d r
Display a @samp{cvs diff} between the base revision of the selected
@item d v
Display a @samp{cvs diff} between the selected files and the head
revision of the vendor branch in the repository
-(@code{cvs-mode-diff-vendor}).@refill
+(@code{cvs-mode-diff-vendor}).
@item d y
Display a @samp{cvs diff} between the selected files and yesterday's
head revision in the repository
-(@code{cvs-mode-diff-yesterday}).@refill
+(@code{cvs-mode-diff-yesterday}).
@end table
By default, @samp{diff} commands ignore the marks. This can be changed
with @code{cvs-invert-ignore-marks}.
-@node Invoking Ediff, Updating files, Viewing differences, Commands
+@node Invoking Ediff
@section Running ediff
@cindex Ediff
@cindex Invoking ediff
CVS has already performed a merge. The resulting file is not used in
any way if you use this command. If you use the @kbd{q} command inside
@samp{ediff} (to successfully terminate a merge) the file that CVS
-created will be overwritten.@refill
+created will be overwritten.
@end table
-@node Updating files, Tagging files, Invoking Ediff, Commands
+@node Updating files
@section Updating files
@findex cvs-mode-update
@cindex Updating files
@end table
-@node Tagging files, Miscellaneous commands, Updating files, Commands
+@node Tagging files
@section Tagging files
@findex cvs-mode-tag
@findex cvs-mode-untag
to change this behavior.
-@node Miscellaneous commands, , Tagging files, Commands
+@node Miscellaneous commands
@section Miscellaneous commands
@findex cvs-mode-byte-compile-files
@cindex Recompiling elisp files
Quit PCL-CVS, killing the @samp{*cvs*} buffer.
@end table
-@node Log Edit Mode, Log View Mode, Commands, Top
+@node Log Edit Mode
@chapter Editing a Log Message
@cindex Log Edit mode
@c Fixme: customization variables
-@node Log View Mode, Customization, Log Edit Mode, Top
+@node Log View Mode
@chapter Browsing a Log of Changes
@cindex Log View mode
@c @node CVS Status Mode
@c @chapter Viewing CVS' Status output
-@node Customization, Bugs, Log View Mode, Top
+@node Customization
@chapter Customization
@vindex log-edit-changelog-full-paragraphs@r{ (variable)}
@vindex cvs-auto-remove-handled@r{ (variable)}
If you have an idea about any customization that would be handy but
isn't present in this list, please tell us!
-For info on how to reach us, see @ref{Bugs}.@refill
+For info on how to reach us, see @ref{Bugs}.
@table @samp
@item cvs-auto-remove-handled
If this variable is set to any non-@code{nil} value,
@samp{cvs-mode-remove-handled} will be called every time you check in
files, after the check-in is ready. @xref{Removing handled
-entries}.@refill
+entries}.
@item cvs-auto-remove-directories
If this variable is set to any non-@code{nil} value, directories that do
not contain any files to be checked in will not be listed in the
-@samp{*cvs*} buffer.@refill
+@samp{*cvs*} buffer.
@item cvs-auto-revert
If this variable is set to any non-@samp{nil} value any buffers you have
that visit a file that is committed will be automatically reverted.
-This variable defaults to @samp{t}. @xref{Committing changes}.@refill
+This variable defaults to @samp{t}. @xref{Committing changes}.
@item cvs-update-prog-output-skip-regexp
The @samp{-u} flag in the @file{modules} file can be used to run a command
* Customizing Faces::
@end menu
-@node Customizing Faces, , Customization, Customization
+@node Customizing Faces
@section Customizing Faces
@vindex cvs-header (face)
@vindex cvs-filename (face)
@end table
-@node Bugs, GNU Free Documentation License, Customization, Top
+@node Bugs
@chapter Bugs (known and unknown)
@cindex Reporting bugs and ideas
@cindex Bugs, how to report them
@cindex FAQ
@cindex Problems, list of common
-If you find a bug or misfeature, don't hesitate to tell us! Send email
-to @email{bug-gnu-emacs@@gnu.org} which is gatewayed to the newsgroup
-@samp{gnu.emacs.bugs}. Feature requests should also be sent there. We
-prefer discussing one thing at a time. If you find several unrelated
+If you find a bug or misfeature, don't hesitate to tell us!
+Use @kbd{M-x report-emacs-bug} to send us a report.
+You can follow the same process for feature requests.
+We prefer discussing one thing at a time. If you find several unrelated
bugs, please report them separately. If you are running PCL-CVS under
XEmacs, you should also send a copy of bug reports to
-@email{xemacs-beta@@xemacs.org}.
+the @url{http://lists.xemacs.org/mailman/listinfo/xemacs-beta,
+XEmacs mailing list}.
If you have problems using PCL-CVS or other questions, send them to
-@email{help-gnu-emacs@@gnu.org}, which is gatewayed to the
-@samp{gnu.emacs.help} newsgroup. This is a good place to get help, as
-is @email{cvs-info@@gnu.org}, gatewayed to @samp{gnu.cvs.help}.
+the @url{http://lists.gnu.org/mailman/listinfo/help-gnu-emacs,
+help-gnu-emacs mailing list}. This is a good place to get help, as is
+the @url{http://lists.nongnu.org/mailman/listinfo/info-cvs, info-cvs list}.
If you have ideas for improvements, or if you have written some
extensions to this package, we would like to hear from you. We hope that
buffer), and the versions of Emacs, PCL-CVS and CVS you are using.
@end table
-@node GNU Free Documentation License, Function and Variable Index, Bugs, Top
+@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include doclicense.texi
-@node Function and Variable Index, Concept Index, GNU Free Documentation License, Top
+@node Function and Variable Index
@unnumbered Function and Variable Index
This is an index of all the functions and variables documented in this
@printindex fn
-@node Concept Index, Key Index, Function and Variable Index, Top
+@node Concept Index
@unnumbered Concept Index
This is an index of concepts discussed in this manual.
@printindex cp
-@node Key Index, , Concept Index, Top
+@node Key Index
@unnumbered Key Index
This index includes an entry for each PCL-CVS key sequence documented in