(frame-update-faces): Fix obsolescence declaration.
[emacs.git] / man / pcl-cvs.texi
blob9c3706622655f2e7fe19d6e0597e77a9c27fd55c
1 \input texinfo  @c -*-texinfo-*-
3 @c "@(#)$Name:  $:$Id: pcl-cvs.texi,v 1.14 2002/02/13 22:30:34 monnier Exp $"
5 @c Documentation for the GNU Emacs CVS mode.
6 @c Copyright (C) 1991,92,93,94,95,96,97,98,99,2000, 2001  Free Software Foundation, Inc.
8 @c This file is part of GNU Emacs
10 @c GNU Emacs is free software; you can redistribute it and/or modify
11 @c it under the terms of the GNU General Public License as published by
12 @c the Free Software Foundation; either version 2 of the License,
13 @c or (at your option) any later version.
15 @c GNU Emacs is distributed in the hope that it will be useful,
16 @c but WITHOUT ANY WARRANTY; without even the implied warranty of
17 @c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 @c GNU General Public License for more details.
20 @c You should have received a copy of the GNU General Public License
21 @c along with pcl-cvs; see the file COPYING.  If not, write to
22 @c the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 @c %**start of header
25 @setfilename ../info/pcl-cvs
26 @settitle PCL-CVS --- Emacs Front-End to CVS
27 @c %**end of header
29 @c 
31 @dircategory Emacs
32 @direntry
33 * PCL-CVS: (pcl-cvs).   Emacs front-end to CVS.
34 @end direntry
35 @setchapternewpage on
37 @ifinfo
38 Copyright @copyright{} 1991,92,93,94,95,96,97,98,99,2000  Free Software Foundation, Inc.
40 Permission is granted to copy, distribute and/or modify this document
41 under the terms of the GNU Free Documentation License, Version 1.1 or
42 any later version published by the Free Software Foundation; with the
43 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
44 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
45 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
46 license is included in the section entitled ``GNU Free Documentation
47 License'' in the Emacs manual.
49 This document is part of a collection distributed under the GNU Free
50 Documentation License.  If you want to distribute this document
51 separately from the collection, you can do so by adding a copy of the
52 license to the document, as described in section 6 of the license.
54 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
55 this GNU Manual, like GNU software.  Copies published by the Free
56 Software Foundation raise funds for GNU development.''
57 @end ifinfo
59 @syncodeindex vr fn
60 @c The titlepage section does not appear in the Info file.
61 @titlepage
62 @sp 4
63 @c The title is printed in a large font.
64 @center @titlefont{User's Guide}
65 @sp
66 @center @titlefont{to}
67 @sp
68 @center @titlefont{PCL-CVS --- The Emacs Front-End to CVS}
69 @ignore
70 @sp 2
71 @center release 2.9
72 @c -release-
73 @end ignore
74 @sp 3
75 @center Per Cederqvist
76 @center Stefan Monnier
77 @c -date-
79 @c  The following two commands start the copyright page
80 @c  for the printed manual.  This will not appear in the Info file.
81 @page
82 @vskip 0pt plus 1filll
83 Copyright @copyright{} 1991,92,93,94,95,96,97,98,99,2000  Free Software Foundation, Inc.
85 Permission is granted to copy, distribute and/or modify this document
86 under the terms of the GNU Free Documentation License, Version 1.1 or
87 any later version published by the Free Software Foundation; with the
88 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
89 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
90 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
91 license is included in the section entitled ``GNU Free Documentation
92 License'' in the Emacs manual.
94 This document is part of a collection distributed under the GNU Free
95 Documentation License.  If you want to distribute this document
96 separately from the collection, you can do so by adding a copy of the
97 license to the document, as described in section 6 of the license.
99 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
100 this GNU Manual, like GNU software.  Copies published by the Free
101 Software Foundation raise funds for GNU development.''
102 @end titlepage
104 @c ================================================================
105 @c                   The real text starts here
106 @c ================================================================
108 @node Top, About PCL-CVS, (dir), (dir)
109 @ifinfo
110 @top PCL-CVS
112 This manual describes PCL-CVS, the GNU Emacs front-end to CVS.  It
113 is nowhere near complete, so you are advised to use @kbd{M-x
114 customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings
115 of the various commands and major modes for further information.
116 @c This manual is updated to release 2.5 of PCL-CVS.
117 @end ifinfo
119 @menu
120 * About PCL-CVS::               Installation, credits, history, @dots{}
122 * Getting started::             An introduction with a walk-through example.
123 * Buffer contents::             An explanation of the buffer contents.
124 * Selected files::              To which files are commands applied.
125 * Commands::                    All commands, grouped by type.
127 * Log Edit Mode::               Major mode to edit log messages.
128 * Log View Mode::               Major mode to browse log changes.
129 @c * CVS Status Mode::             Major mode to view CVS' status output.
130 * Customization::               How you can tailor PCL-CVS to suit your needs.
131 * Bugs::                        Bugs (known and unknown).
133 * Function and Variable Index::  List of functions and variables.
134 * Concept Index::               List of concepts.
135 * Key Index::                   List of keystrokes.
137 @detailmenu
138  --- The Detailed Node Listing ---
140 About PCL-CVS
142 * Contributors::                Contributors to PCL-CVS.
143 * Installation::                
145 Commands
147 * Entering PCL-CVS::            Commands to invoke PCL-CVS
148 * Setting flags::               Setting flags for CVS commands
149 * Updating the buffer::         
150 * Movement commands::           How to move up and down in the buffer
151 * Marking files::               How to mark files that other commands
152                                 will later operate on.
153 * Committing changes::          Checking in your modifications to the
154                                 CVS repository. 
155 * Editing files::               Loading files into Emacs.
156 * Getting info about files::    Display the log and status of files.
157 * Adding and removing files::   Adding and removing files
158 * Undoing changes::             Undoing changes
159 * Removing handled entries::    Uninteresting lines can easily be removed.
160 * Ignoring files::              Telling CVS to ignore generated files.
161 * Viewing differences::         Commands to @samp{diff} different versions.
162 * Invoking Ediff::              Running @samp{ediff} from @samp{*cvs*} buffer.
163 * Updating files::              Updating files that Need-update.
164 * Tagging files::               Tagging files.
165 * Miscellaneous commands::      Miscellaneous commands.
167 Customization
169 * Customizing Faces::           
171 @end detailmenu
172 @end menu
174 @node     About PCL-CVS, Getting started, Top, Top
175 @chapter About PCL-CVS
176 @cindex About PCL-CVS
178 PCL-CVS is a front-end to CVS versions 1.9 and later.
179 It concisely shows the present status of a checked out module in an
180 Emacs buffer and provides single-key access to the most frequently used CVS
181 commands.
182 For Emacs users accustomed to VC, PCL-CVS can be thought of as a replacement
183 for VC-dired (@pxref{VC Dired Mode, , Dired under VC, emacs, The GNU
184 Emacs Manual}) specifically designed for CVS.
186 PCL-CVS was originally written many years ago by Per Cederqvist who
187 proudly maintained it until January 1996, at which point he released the
188 beta version 2.0b2 and passed on the maintainership to Greg A Woods.
189 Development stayed mostly dormant for a few years during which
190 version 2.0 never seemed to be able to leave the ``beta'' stage while a
191 separate XEmacs version was slowly splitting away.  In late 1998,
192 Stefan Monnier picked up development again, adding some major new
193 functionality and taking over the maintenance.
195 As of Emacs 21, PCL-CVS is part of the standard Emacs distribution.
197 @menu
198 * Contributors::                Contributors to PCL-CVS.
199 * Installation::                
200 @end menu
202 @node     Contributors, Installation, About PCL-CVS, About PCL-CVS
203 @section Contributors to PCL-CVS
204 @cindex Contributors
205 @cindex Authors
207 Contributions to the package are welcome.  I have limited time to work
208 on this project, but I will gladly add any code that you contribute to
209 me to this package (@pxref{Bugs}).
211 The following persons have made contributions to PCL-CVS.
213 @itemize @bullet
214 @item
215 Brian Berliner wrote CVS, together with some other contributors.
216 Without his work on CVS this package would be useless@dots{}
218 @item
219 Per Cederqvist wrote most of the otherwise unattributed functions in
220 PCL-CVS as well as all the documentation.
222 @item
223 @email{inge@@lysator.liu.se, Inge Wallin} wrote the skeleton of
224 @file{pcl-cvs.texi}, and gave useful comments on it.  He also wrote
225 the files @file{elib-node.el} and @file{compile-all.el}.  The file
226 @file{cookie.el} was inspired by Inge.@refill
228 @item
229 @email{linus@@lysator.liu.se, Linus Tolke} contributed useful comments
230 on both the functionality and the documentation.@refill
232 @item
233 @email{jwz@@jwz.com, Jamie Zawinski} contributed
234 @file{pcl-cvs-lucid.el}, which was later renamed to
235 @file{pcl-cvs-xemacs.el}.@refill
237 @item
238 Leif Lonnblad contributed RCVS support (since superceded by the new
239 remote CVS support).
241 @item
242 @email{jimb@@cyclic.com, Jim Blandy} contributed hooks to automatically
243 guess CVS log entries from @file{ChangeLog} contents, and initial support of
244 the new Cygnus / Cyclic remote CVS, as well as various sundry bug fixes
245 and cleanups.
247 @item
248 @email{kingdon@@cyclic.com, Jim Kingdon} contributed lots of fixes to
249 the build and installation procedure.
251 @item
252 @email{woods@@weird.com, Greg A.@: Woods} contributed code to implement
253 the use of per-file diff buffers, and vendor join diffs with emerge and
254 ediff, as well as various and sundry bug fixes and cleanups.
256 @item
257 @email{greg.klanderman@@alum.mit.edu, Greg Klanderman} implemented
258 toggling of marked files, setting of CVS command flags via prefix
259 arguments, updated the XEmacs support, updated the manual, and fixed
260 numerous bugs.
262 @item
263 @email{monnier@@cs.yale.edu, Stefan Monnier} added a slew of other
264 features and introduced even more new bugs.  If there's any bug left,
265 you can be sure it's his.
267 @item
268 @c wordy to avoid an underfull hbox
269 @email{masata-y@@is.aist-nara.ac.jp, Masatake YAMATO} made a gracious
270 contribution of his cvstree code to display a tree of tags which was later
271 superseded by the new @code{cvs-status-mode}.
272 @end itemize
274 Apart from these, a lot of people have sent us suggestions, ideas,
275 requests, bug reports and encouragement.  Thanks a lot!  Without you
276 there would be no new releases of PCL-CVS.
279 @node   Installation,  , Contributors, About PCL-CVS
280 @section Installation
281 @cindex Installation
283 As mentioned above, PCL-CVS comes bundled with Emacs version 21.1 and
284 later.  If you're using Emacs 20, you can download an older version of
285 PCL-CVS from @uref{ftp://flint.cs.yale.edu/pub/monnier/pcl-cvs}.  That
286 version also works on XEmacs.
288 If you are running XEmacs 21.0 or later, PCL-CVS is available in
289 pre-compiled package form.  Please refer to the XEmacs manual for
290 instructions regarding package selection and installation.  Currently,
291 that PCL-CVS package also requires you to have installed the
292 @file{xemacs-base}, @file{elib}, and @file{dired} packages. 
294 If you have @TeX{} installed at your site, you can make a typeset manual
295 from @file{pcl-cvs.texi}.
297 @enumerate
298 @item
299 If PCL-CVS came with the Emacs distribution, type @kbd{make pcl-cvs.dvi}
300 in the @file{man} subdirectory of the Emacs source tree.
301 @item
302 Alternatively, run @TeX{} by typing @kbd{texi2dvi pcl-cvs.texi}.
303 @item
304 Convert the resulting device independent file @file{pcl-cvs.dvi} to a
305 form which your printer can output and print it.  If you have a
306 PostScript printer, there is a program, @code{dvi2ps}, which does.  There
307 is also a program which comes together with @TeX{}, @code{dvips}, which
308 you can use.
309 @end enumerate
312 @node Getting started, Buffer contents, About PCL-CVS, Top
313 @chapter Getting started
314 @cindex Introduction
315 @cindex Example run
316 @cindex Sample session
318 This document assumes that you know what CVS is, and that you at least
319 know the fundamental concepts of CVS.  If that is not the case, you
320 should read the CVS documentation.  Type @kbd{info -f cvs} or @kbd{man
321 cvs}.
323 PCL-CVS is only useful once you have checked out a module.  So before
324 you invoke it, you must have a copy of a module somewhere in the file
325 system.
327 You can invoke PCL-CVS by typing @kbd{M-x cvs-examine @key{RET}}.
328 You can also invoke it via the menu bar, under @samp{Tools}.
329 Or, if you prefer, you can also invoke PCL-CVS by simply visiting the
330 CVS administrative subdirectory of your module, with a prefix argument.
331 For example, to invoke PCL-CVS in a separate frame, type @kbd{C-u C-x 5
332 f ~/my/project/CVS @key{RET}}.
334 The function @code{cvs-examine} will ask for a directory.  The command
335 @samp{cvs -n update} will be run in that directory.  (It should contain
336 files that have been checked out from a CVS archive.)  The output from
337 @code{cvs} will be parsed and presented in a table in a buffer called
338 @samp{*cvs*}.  It might look something like this:
340 @example
341 Repository : /usr/CVSroot
342 Module     : test
343 Working dir: /users/ceder/FOO/test
346 In directory .:
347            Need-Update            bar
348            Need-Update            file.txt
349            Modified               namechange
350            Need-Update            newer
351 In directory sub:
352            Modified               ChangeLog
354 --------------------- End ---------------------
355 -- last cmd: cvs -f -z6 -n update -d -P --
356 @end example
358 In this example, your repository is in @file{/usr/CVSroot} and CVS has
359 been run in the directory @file{/users/ceder/FOO/test}.  The three files
360 (@file{bar}, @file{file.txt} and 
361 @file{newer}) that are marked with @samp{Need-Update} have been changed
362 by someone else in the CVS repository.  Two files (@file{namechange}
363 and @file{sub/ChangeLog}) have been modified locally, and need to be
364 checked in.
366 You can move the cursor up and down in the buffer with @kbd{C-n} and
367 @kbd{C-p} or @kbd{n} and @kbd{p}.  If you press @kbd{c} on one of the
368 @samp{Modified} files, that file will be checked in to the CVS
369 repository. @xref{Committing changes}.  You can also press @kbd{O} to
370 update any of the files that are marked @samp{Need-Update}.  You can
371 also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the
372 @samp{*cvs*} buffer) to update all the files.@refill
374 You can then press @kbd{=} to easily get a @samp{diff} between your
375 modified file and the base version that you started from, or you can
376 press @kbd{l} to get the output from @samp{cvs log}.  Many more such
377 commands are available simply by pressing a key (@pxref{Getting info
378 about files}).
380 @node Buffer contents, Selected files, Getting started, Top
381 @chapter Buffer contents
382 @cindex Buffer contents
383 @cindex @code{*cvs*} buffer contents
385 The display contains several columns, some of which are optional.
386 These columns are, from left to right:
388 @itemize @bullet
390 @item
391 Optionally, the head revision of the file.  This is the latest version
392 found in the repository.  It might also contain (instead of the head
393 revision) a sub status which typically gives further information about
394 how we got to the current state, for example @samp{patched},
395 @samp{merged}, @dots{}
397 @item
398 An asterisk when the file is @dfn{marked} (@pxref{Selected
399 files}).@refill
401 @item
402 The actual status of the file wrt the repository.  See below.
404 @item
405 Optionally, the base revision of the file.  This is the version
406 which the copy in your working directory is based upon.
408 @item
409 The file name.
411 @end itemize
413 The @samp{file status} field can have the following values:
415 @table @samp
416 @item Modified
417 The file is modified in your working directory, and there was no
418 modification to the same file in the repository.  This status can have
419 the following substatus:
421 @table @samp
422 @item merged
423 The file was modified in your working directory, and there were
424 modifications in the repository as well, but they were merged
425 successfully, without conflict, in your working directory.@refill
426 @end table
428 @item Conflict
429 A conflict was detected while trying to merge your changes to @var{file}
430 with changes from the repository.  @var{file} (the copy in your
431 working directory) is now the output of the @code{rcsmerge} command on
432 the two versions; an unmodified copy of your file is also in your
433 working directory, with the name @file{.#@var{file}.@var{version}},
434 where @var{version} is the RCS revision that your modified file started
435 from.  @xref{Viewing differences}, for more details.@refill
437 A conflict can also come from a disagreement on the existence of the file
438 rather than on its content.  This case is indicated by the following
439 possible substatus:
441 @table @samp
442 @item removed
443 The file is locally removed but a new revision has been committed to
444 the repository by someone else.
446 @item added
447 The file is locally added and has also been added to the repository
448 by someone else.
450 @item modified
451 The file is locally modified but someone else has removed it from the
452 repository.
453 @end table
455 @item Added
456 The file has been added by you, but it still needs to be checked in to
457 the repository.@refill
459 @item Removed
460 The file has been removed by you, but it still needs to be checked in to
461 the repository.  You can resurrect it by typing @kbd{a} (@pxref{Adding
462 and removing files}).@refill
464 @item Unknown
465 A file that was detected in your directory, but that neither appears in
466 the repository, nor is present on the list of files that CVS should
467 ignore.@refill
469 @item Up-to-date
470 The file is up to date with respect to the version in the repository.
471 This status can have a substatus of:
473 @table @samp
474 @item added
475 You have just added the file to the repository.@refill
477 @item updated
478 The file was brought up to date with respect to the repository.  This is
479 done for any file that exists in the repository but not in your source,
480 and for files that you haven't changed but are not the most recent
481 versions available in the repository.@refill
483 @item patched
484 The file was brought up to date with respect to the remote repository by
485 way of fetching and applying a patch to the file in your source.  This
486 is equivalent to @samp{updated} except that CVS decided to use a hopefully
487 more efficient method.@refill
489 @item committed
490 You just committed the file.@refill
491 @end table
493 @item Need-Update
494 Either a newer version than the one in your source is available in the
495 repository and you have not modified your checked out version, or the
496 file exists in the repository but not in your source.  Use
497 @samp{cvs-mode-update} bound to @kbd{O} to update the file.@refill
499 @item Need-Merge
500 You have modified the checked out version of the file, and a newer
501 version is available in the repository.  A merge will take place when
502 you run a @samp{cvs-update}.
504 @item Missing
505 The file has been unexpectedly removed from your working directory
506 although it has not been @samp{cvs remove}d.
507 @end table
509 @node Selected files, Commands, Buffer contents, Top
510 @chapter Selected files
511 @cindex Selected files
512 @cindex Marked files
513 @cindex File selection
514 @cindex Active files
515 @cindex Applicable
517 Many of the commands work on the current set of @dfn{selected} files
518 which can be either the set of marked files (if any file is marked and
519 marks are no ignored) or whichever file or directory the cursor is on.
521 If a directory is selected but the command cannot be applied to a
522 directory, then it will be applied to the set of files under this
523 directory which are in the @samp{*cvs*} buffer.
525 @findex cvs-mode-force-command
526 @findex cvs-allow-dir-commit
527 Furthermore, each command only operates on a subset of the selected
528 files, depending on whether or not the command is @dfn{applicable} to
529 each file (based on the file's status).  For example,
530 @code{cvs-mode-commit} is not applicable to a file whose status is
531 @samp{Need-Update}.  If it should happen that PCL-CVS guesses the
532 applicability wrong, you can override it with the special prefix
533 @code{cvs-mode-force-command} normally bound to @kbd{M-f} (and file a
534 bug report).  The applicability rule can be slightly changed with
535 @code{cvs-allow-dir-commit} and @code{cvs-force-dir-tag}.
537 By default, marks are always in effect (you may change this, however, by
538 setting the variable @code{cvs-default-ignore-marks}) except for the
539 commands that @samp{tag} or @samp{diff} a file (which can be changed
540 with the variable @code{cvs-invert-ignore-marks}).
542 In addition, you may use the special prefix @code{cvs-mode-toggle-marks}
543 normally bound to @key{T} to toggle the use of marks for the following
544 command.
546 This scheme might seem a little complicated, but once one gets used to
547 it, it is quite powerful.
549 For commands to mark and unmark files, see @ref{Marking files}.
551 @node Commands, Log Edit Mode, Selected files, Top
552 @chapter Commands
554 @iftex
555 This chapter describes all the commands that you can use in PCL-CVS.
556 @end iftex
557 @ifnottex
558 The nodes in this menu contains explanations about all the commands that
559 you can use in PCL-CVS.  They are grouped together by type.
560 @end ifnottex
562 @menu
563 * Entering PCL-CVS::            Commands to invoke PCL-CVS
564 * Setting flags::               Setting flags for CVS commands
565 * Updating the buffer::         
566 * Movement commands::           How to move up and down in the buffer
567 * Marking files::               How to mark files that other commands
568                                 will later operate on.
569 * Committing changes::          Checking in your modifications to the
570                                 CVS repository. 
571 * Editing files::               Loading files into Emacs.
572 * Getting info about files::    Display the log and status of files.
573 * Adding and removing files::   Adding and removing files
574 * Undoing changes::             Undoing changes
575 * Removing handled entries::    Uninteresting lines can easily be removed.
576 * Ignoring files::              Telling CVS to ignore generated files.
577 * Viewing differences::         Commands to @samp{diff} different versions.
578 * Invoking Ediff::              Running @samp{ediff} from @samp{*cvs*} buffer.
579 * Updating files::              Updating files that Need-update.
580 * Tagging files::               Tagging files.
581 * Miscellaneous commands::      Miscellaneous commands.
582 @end menu
585 @node Entering PCL-CVS, Setting flags, Commands, Commands
586 @section Entering PCL-CVS
587 @findex cvs-update
588 @findex cvs-examine
589 @findex cvs-status
590 @findex cvs-checkout
591 @findex cvs-quickdir
592 @cindex Creating the *cvs* buffer
594 Most commands in PCL-CVS require that you have a @samp{*cvs*}
595 buffer.  The commands that you use to get one are listed below.
596 For each, a @samp{cvs} process will be run, the output will be parsed by 
597 PCL-CVS, and the result will be printed in the @samp{*cvs*} buffer (see
598 @ref{Buffer contents}, for a description of the buffer's contents).
600 @table @kbd
601 @item M-x cvs-update
602 Run a @samp{cvs update} command.  You will be asked for the directory 
603 in which the @samp{cvs update} will be run.
605 @item M-x cvs-examine
606 Run a @samp{cvs -n update} command.  This is identical to the previous
607 command, except that it will only check what needs to be done but will
608 not change anything.  You will be asked for the directory in
609 which the @samp{cvs -n update} will be run.
611 @item M-x cvs-status
612 Run a @samp{cvs status} command.  You will be asked for the directory 
613 in which the @samp{cvs status} will be run.
615 @item M-x cvs-checkout
616 Run a @samp{cvs checkout} command.  You will be asked for the directory
617 in which the @samp{cvs update} will be run and the module to be checked
618 out.
620 @item M-x cvs-quickdir
621 Populate the @samp{*cvs*} buffer by just looking at the @file{CVS/Entries}
622 files.  This is very much like @code{cvs-examine} except that it does
623 not access the CVS repository, which is a major advantage when the
624 repository is far away.  But of course, it will not be able to detect
625 when a file needs to be updated or merged.
626 @end table
628 @findex cvs-dired-action
629 @findex cvs-dired-use-hook
630 The first four of
631 those commands are also reachable from the menu bar
632 under @samp{Tools->PCL-CVS}.  Finally, an alternative way is to visit
633 the CVS administrative subdirectory in your work area with a simple
634 prefix argument.  For example @kbd{C-u C-x C-f ~/my/work/CVS @key{RET}}.  This
635 by default runs @code{cvs-quickdir} but the specific behavior can be
636 changed with @code{cvs-dired-action} and @code{cvs-dired-use-hook}.
638 By default, the commands above will descend recursively into
639 subdirectories.  You can avoid that behavior by including @samp{-l} in
640 the flags for the command.  These flags can be set by giving a prefix
641 argument to the command (e.g., by typing
642 @kbd{C-u M-x cvs-update @key{RET} -l @key{RET}}).
645 @node Setting flags, Updating the buffer, Entering PCL-CVS, Commands
646 @section Setting flags for CVS commands
647 @cindex Optional switches to CVS
648 @cindex Command-line options to CVS
650 This section describes the convention used by nearly all PCL-CVS
651 commands for setting optional flags sent to CVS.  A single @kbd{C-u}
652 prefix argument is used to cause the command to prompt for flags to be
653 used for the current invocation of the command only.  Two @kbd{C-u} prefix
654 arguments are used to prompt for flags which will be set permanently, for the
655 current invocation and all that follow, until the flags are changed, or
656 unless temporary flags are set which override them.
658 Perhaps an example or two is in order.  Say you are about to add a
659 binary file to the repository, and want to specify the flags @samp{-kb}
660 to @samp{cvs add}.  You can type @kbd{C-u a -kb @key{RET}},
661 and the file will be added.  Subsequent @samp{cvs add}
662 commands will use the previously prevailing flags.
664 As a second example, say you are about to perform a diff and want to see
665 the result in unified diff format, i.e. you'd like to pass the flag
666 @samp{-u} to both @samp{cvs diff} and @samp{diff}.  You'd also like all
667 subsequent diffs to use this flag.  You can type @kbd{C-u C-u = -u @key{RET}}
668 and the diff will be performed, and the default flags will be set to
669 @code{("-u")}.  You can of course override this flag for a single diff
670 by using a single @kbd{C-u} prefix argument.
672 @cindex Special prefix
673 In addition to this, some commands can take @dfn{special prefix} arguments.
674 These work as follows: When called with a @kbd{C-u} prefix, the user is
675 prompted for a new value of the special prefix and the special prefix is
676 activated for the next command.  When called without the @kbd{C-u}
677 prefix, the special prefix is re-activated (with the same value as last
678 time) for the next command.  Calling the prefix command again when it's
679 already activated deactivates it.  Calling it with the @kbd{C-u C-u}
680 prefix activates it for all subsequent commands until you deactivate it
681 explicitly.  The special prefixes are:
683 @table @kbd
684 @item T
685 Toggles whether or not marks will be active in the next command.@refill
687 @item b
688 Provide the next command with a branch (can be any version
689 specifier) to work on.@refill
691 @item B
692 Secondary branch argument.  Only meaningful if @kbd{b} is also used.
693 It can be used to provide a second branch argument to
694 @code{cvs-mode-diff} or to @code{cvs-mode-update}.
696 @item M-f
697 Forces the next command to apply to every selected file rather than only
698 to the ones PCL-CVS thinks are relevant.
699 @end table
701 @node Updating the buffer, Movement commands, Setting flags, Commands
702 @section Updating the @samp{*cvs*} buffer
703 @findex cvs-update
704 @findex cvs-examine
705 @findex cvs-status
706 @findex cvs-mode-update
707 @findex cvs-mode-examine
708 @findex cvs-mode-status
710 The following commands can be used from within the @samp{*cvs*} buffer
711 to update the display:
713 @table @kbd
714 @item M-u
715 Runs the command @samp{cvs-update}.@refill
717 @item M-e
718 Runs the command @samp{cvs-examine}.@refill
720 @item M-s
721 Runs the command @samp{cvs-status}.@refill
722 @end table
724 In addition to the above commands which operate on the whole module,
725 you can run the equivalent CVS command on just a subset of the
726 files/directories with these keys:
728 @table @kbd
729 @item O
730 Runs @code{cvs-mode-update} on the selected files.  When run on the
731 top-level directory, this is equivalent to @kbd{M-u}.@refill
733 @item e
734 Runs @code{cvs-mode-examine} on the selected files.  When run on the
735 top-level directory, this is equivalent to @kbd{M-e}.@refill
737 @findex cvs-status-mode
738 @item s
739 Runs @code{cvs-mode-status} on the selected files.  When run on the
740 top-level directory, this is equivalent to @kbd{M-s}, except that
741 CVS output will be shown in a @samp{*cvs-info*} buffer that will be
742 put in @samp{cvs-status-mode}.@refill
743 @end table
746 @node Movement commands, Marking files, Updating the buffer, Commands
747 @section Movement Commands
748 @cindex Movement Commands
749 @findex cvs-mode-next-line
750 @findex cvs-mode-previous-line
751 @kindex SPC@r{--Move down one file}
752 @kindex n@r{--Move down one file}
753 @kindex p@r{--Move up one file}
755 You can use most normal Emacs commands to move forward and backward in
756 the buffer.  Some keys are rebound to functions that take advantage of
757 the fact that the buffer is a PCL-CVS buffer:
760 @table @kbd
761 @item @key{SPC}
762 @itemx n
763 These keys move the cursor one file forward, towards the end of the
764 buffer (@code{cvs-mode-next-line}).@refill
766 @itemx p
767 This key moves one file backward, towards the beginning of the buffer
768 (@code{cvs-mode-previous-line}).
769 @end table
772 @node Marking files, Committing changes, Movement commands, Commands
773 @section Marking files
774 @cindex Selecting files (commands to mark files)
775 @cindex Marking files
776 @kindex m@r{--marking a file}
777 @kindex M@r{--marking all files}
778 @kindex u@r{--unmark a file}
779 @kindex ESC DEL@r{--unmark all files}
780 @kindex DEL@r{--unmark previous file}
781 @kindex %@r{--mark files matching regexp}
782 @kindex S@r{--mark files in a particular state}
783 @kindex T@r{--toggle marks}
784 @findex cvs-mode-mark
785 @findex cvs-mode-unmark
786 @findex cvs-mode-mark-all-files
787 @findex cvs-mode-unmark-all-files
788 @findex cvs-mode-unmark-up
789 @findex cvs-mode-mark-matching-files
790 @findex cvs-mode-mark-on-state
791 @findex cvs-mode-toggle-marks
793 PCL-CVS works on a set of @dfn{selected files} (@pxref{Selected files}).
794 You can mark and unmark files with these commands:
796 @table @kbd
797 @item m
798 This marks the file that the cursor is positioned on.  If the cursor is
799 positioned on a directory all files in that directory are marked.
800 (@code{cvs-mode-mark}).@refill
802 @item u
803 Unmark the file that the cursor is positioned on. If the cursor is on a
804 directory, all files in that directory are unmarked.
805 (@code{cvs-mode-unmark}).@refill
807 @item M
808 Mark @emph{all} files in the buffer (@code{cvs-mode-mark-all-files}).
810 @item M-@key{DEL}
811 Unmark @emph{all} files (@code{cvs-mode-unmark-all-files}).
813 @item @key{DEL}
814 Unmark the file on the previous line, and move point to that line
815 (@code{cvs-mode-unmark-up}).
817 @item %
818 Mark all files matching a regular expression
819 (@code{cvs-mode-mark-matching-files}).
821 @item S
822 Mark all files in a particular state, such as ``Modified'' or
823 ``Removed''.  (@code{cvs-mode-mark-on-state}).
825 @item T
826 Toggle use of marks for the next command (@code{cvs-mode-toggle-marks}).
827 @end table
830 @node Committing changes, Editing files, Marking files, Commands
831 @section Committing changes
832 @cindex Committing changes
833 @findex cvs-mode-commit
834 @findex cvs-mode-commit-setup
835 @kindex c@r{--commit files}
836 @kindex C@r{--commit files with @file{ChangeLog} message}
837 @vindex cvs-auto-revert@r{ (variable)}
838 @cindex Commit buffer
839 @cindex Edit buffer
840 @cindex Erasing commit message
841 @cindex Reverting buffers after commit
843 Committing changes basically works as follows:
845 @enumerate
846 @item
847 After having selected the files you want to commit, you type either
848 @kbd{c} or @kbd{C} which brings up a special buffer
849 @samp{*cvs-commit*}.@refill
851 @item
852 You type in the log message describing the changes you're about to
853 commit (@pxref{Log Edit Mode}).
855 @item
856 When you're happy with it, you type @kbd{C-c C-c} to do the actual
857 commit.@refill
858 @end enumerate
860 There's no hidden state, so you can abort the process or pick it up
861 again at any time.
863 @vindex log-edit-confirm@r{ (variable)}
864 The set of files actually committed is really decided only during the
865 very last step, which is a mixed blessing.  It allows you to go back and
866 change your mind about which files to commit, but it also means that you
867 might inadvertently change the set of selected files.  To reduce the
868 risk of error, @kbd{C-c C-c} will ask for confirmation if the set of
869 selected files has changed between the first step and the last.  You can
870 change this last detail with @code{log-edit-confirm}.
872 As for the difference between @kbd{c} (i.e. @code{cvs-mode-commit}) and
873 @kbd{C} (i.e. @code{cvs-mode-commit-setup}) is that the first gets you
874 straight to @samp{*cvs-commit*} without erasing it or changing anything
875 to its content, while the second first erases @samp{*cvs-commit*}
876 and tries to initialize it with a sane default (it does that by either
877 using a template provided by the CVS administrator or by extracting a
878 relevant log message from a @file{ChangeLog} file).
880 If you are editing the files in your Emacs, an automatic
881 @samp{revert-buffer} will be performed.  (If the file contains
882 @samp{$@asis{Id}$} keywords, @samp{cvs commit} will write a new file with
883 the new values substituted.  The auto-revert makes sure that you get
884 them into your buffer).  The revert will not occur if you have modified
885 your buffer, or if @samp{cvs-auto-revert} is set to
886 @samp{nil}.
889 @node Editing files, Getting info about files, Committing changes, Commands
890 @section Editing files
891 @cindex Editing files
892 @cindex Finding files
893 @cindex Loading files
894 @cindex Dired
895 @cindex Invoking dired
896 @findex cvs-mode-find-file
897 @findex cvs-mode-find-file-other-window
898 @findex cvs-mode-add-change-log-entry-other-window
899 @kindex f@r{--find file or directory}
900 @kindex o@r{--find file in other window}
901 @kindex A@r{--add @file{ChangeLog} entry}
903 There are currently three commands that can be used to find a file (that
904 is, load it into a buffer and start editing it there).  These commands
905 work on the line that the cursor is situated at.  They always ignore any marked
906 files.
908 @table @kbd
909 @item f
910 Find the file that the cursor points to (@code{cvs-mode-find-file}).  If
911 the cursor points to a directory, run @code{dired} on that directory;
912 @inforef{Dired, , emacs}.
914 @item o
915 Like @kbd{f}, but use another window
916 (@code{cvs-mode-find-file-other-window}).@refill
918 @item A
919 Invoke @samp{add-change-log-entry-other-window} to edit a
920 @file{ChangeLog} file.  The @file{ChangeLog} file will be found in the
921 directory of the file the cursor points to, or in a parent of that
922 directory.  (@code{cvs-mode-add-change-log-entry-other-window}).@refill
923 @end table
926 @node Getting info about files, Adding and removing files, Editing files, Commands
927 @section Getting info about files
928 @cindex Status (cvs command)
929 @cindex Log (RCS/cvs command)
930 @cindex Getting status
931 @kindex l@r{--run @samp{cvs log}}
932 @kindex s@r{--run @samp{cvs status}}
933 @findex cvs-mode-log
934 @findex cvs-mode-status
936 @table @kbd
937 @item l
938 Call the command @code{cvs-mode-log} which runs @samp{cvs log} on all
939 selected files, and show the result in a temporary buffer
940 @samp{*cvs-info*} (@pxref{Log View Mode}).
942 @item s
943 Call the command @code{cvs-mode-status} which runs @samp{cvs status} on
944 all selected files, and show the result in a temporary buffer
945 @samp{*cvs-info*}.
946 @c Fixme: reinstate when node is written:
947 @c (@pxref{CVS Status Mode}).
948 @end table
951 @node Adding and removing files, Undoing changes, Getting info about files, Commands
952 @section Adding and removing files
953 @cindex Adding files
954 @cindex Removing files
955 @cindex Resurrecting files
956 @cindex Deleting files
957 @cindex Putting files under CVS control
958 @kindex a@r{--add a file}
959 @kindex r@r{--remove a file}
960 @findex cvs-mode-add
961 @findex cvs-mode-remove-file
963 The following commands are available to make it easy to add fuiles to
964 and remove them from the CVS repository.
966 @table @kbd
967 @item a
968 Add all selected files.  This command can be used on @samp{Unknown}
969 files (@pxref{Buffer contents}).  The status of the file will change to
970 @samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit}
971 @pxref{Committing changes}), to really add the file to the
972 repository.@refill
974 This command can also be used on @samp{Removed} files (before you commit
975 them) to resurrect them.
977 The command that is run is @code{cvs-mode-add}.
979 @item r
980 This command removes the selected files (after prompting for
981 confirmation).  The files are deleted from your directory and
982 (unless the status was @samp{Unknown}; @pxref{Buffer contents}) they will
983 also be @samp{cvs remove}d.  If the files' status was @samp{Unknown}
984 they will disappear from the buffer.  Otherwise their status will change to
985 @samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit},
986 @pxref{Committing changes}) to commit the removal.@refill
988 The command that is run is @code{cvs-mode-remove-file}.
989 @end table
992 @node Undoing changes, Removing handled entries, Adding and removing files, Commands
993 @section Undoing changes
994 @cindex Undo changes
995 @cindex Flush changes
996 @kindex U@r{--undo changes}
997 @findex cvs-mode-undo-local-changes
999 @table @kbd
1000 @item U
1001 If you have modified a file, and for some reason decide that you don't
1002 want to keep the changes, you can undo them with this command.  It works
1003 by removing your working copy of the file and then getting the latest
1004 version from the repository (@code{cvs-mode-undo-local-changes}.
1005 @end table
1008 @node Removing handled entries, Ignoring files, Undoing changes, Commands
1009 @section Removing handled entries
1010 @cindex Expunging uninteresting entries
1011 @cindex Uninteresting entries, getting rid of them
1012 @cindex Getting rid of uninteresting lines
1013 @cindex Removing uninteresting (processed) lines
1014 @cindex Handled lines, removing them
1015 @kindex x@r{--remove processed entries}
1016 @kindex C-k@r{--remove selected entries}
1017 @findex cvs-mode-remove-handled
1018 @findex cvs-mode-acknowledge
1019 @findex cvs-mode-ignore
1021 @table @kbd
1022 @item x
1023 This command allows you to remove all entries that you have processed.
1024 More specifically, the lines for @samp{Up-to-date} files (@pxref{Buffer
1025 contents}) are removed from the buffer.  If a directory becomes empty
1026 the heading for that directory is also removed.  This makes it easier to
1027 get an overview of what needs to be done.
1029 @vindex cvs-mode-remove-handled@r{ (variable)}
1030 @kbd{x} invokes @code{cvs-mode-remove-handled}.  If
1031 @samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will
1032 automatically be performed after every commit.@refill
1034 @item C-k
1035 This command can be used for lines that @samp{cvs-mode-remove-handled} would
1036 not delete, but that you want to delete (@code{cvs-mode-acknowledge}).
1037 @end table
1040 @node Ignoring files, Viewing differences, Removing handled entries, Commands
1041 @section Ignoring files
1042 @cindex Ignoring files
1043 @kindex i@r{--ignoring files}
1044 @findex cvs-mode-ignore
1046 @table @kbd
1047 @item i
1048 Arrange so that CVS will ignore the selected files.  The file names are
1049 added to the @file{.cvsignore} file in the corresponding directory.  If
1050 the @file{.cvsignore} file doesn't exist, it will be created.
1052 The @file{.cvsignore} file should normally be added to the repository,
1053 but you could ignore it as well, if you like it better that way.
1055 This runs @code{cvs-mode-ignore}.
1056 @end table
1058 @node Viewing differences, Invoking Ediff, Ignoring files, Commands
1059 @section Viewing differences
1060 @cindex Diff
1061 @cindex Invoking @code{diff}
1062 @cindex Conflicts, how to resolve them
1063 @cindex Viewing differences
1064 @kindex d=@r{--run @samp{cvs diff}}
1065 @kindex =@r{--run @samp{cvs diff}}
1066 @kindex db@r{--diff against base version}
1067 @kindex dh@r{--diff against head of repository}
1068 @kindex dv@r{--diff against vendor branch}
1069 @findex cvs-mode-diff
1070 @findex cvs-mode-diff-backup
1071 @findex cvs-mode-diff-head
1072 @findex cvs-mode-diff-vendor
1073 @vindex cvs-invert-ignore-marks@r{ (variable)}
1075 @table @kbd
1076 @item =
1077 @itemx d =
1078 Display a @samp{cvs diff} between the selected files and the version
1079 that they are based on. (@code{cvs-mode-diff}).@refill
1081 @item d b
1082 If CVS finds a conflict while merging two versions of a file (during a
1083 @samp{cvs update}, @pxref{Updating the buffer}) it will save the
1084 original file in a file called @file{.#@var{file}.@var{version}} where
1085 @var{file} is the name of the file, and @var{version} is the revision
1086 number that @var{file} was based on.@refill
1088 With the @kbd{d b} command you can run a @samp{diff} on the files
1089 @file{.#@var{file}.@var{version}} and @file{@var{file}}.@refill
1091 @item d h
1092 Display a @samp{cvs diff} between the selected files and the head
1093 revision in the repository (the most recent version on the current
1094 branch) (@code{cvs-mode-diff-head}).@refill
1096 @item d v
1097 Display a @samp{cvs diff} between the selected files and the head
1098 revision of the vendor branch in the repository.
1099 (@code{cvs-mode-diff-vendor}).@refill
1100 @end table
1102 By default, @samp{diff} commands ignore the marks.  This can be changed
1103 with @code{cvs-invert-ignore-marks}.
1105 @node Invoking Ediff, Updating files, Viewing differences, Commands
1106 @section Running ediff
1107 @cindex Ediff
1108 @cindex Invoking ediff
1109 @cindex Viewing differences
1110 @cindex Conflicts, how to resolve them
1111 @cindex Resolving conflicts
1112 @kindex e@r{--invoke @samp{ediff}}
1113 @findex cvs-mode-idiff
1114 @findex cvs-mode-imerge
1116 @table @kbd
1117 @vindex cvs-idiff-imerge-handlers@r{ (variable)}
1118 @item d e
1119 This uses @code{ediff} (or @code{emerge}, depending on
1120 @samp{cvs-idiff-imerge-handlers}) to allow you to view diffs.
1121 If a prefix argument is given, PCL-CVS will prompt for a revision against
1122 which the diff should be made, else the default will be to use the BASE
1123 revision.
1125 @cindex Merging with @code{ediff} and @code{emerge}
1126 @item d E
1127 This command use @code{ediff} (or @code{emerge}, see above) to allow you
1128 to do an interactive 3-way merge.
1130 @strong{Note:}  When the file status is @samp{Conflict},
1131 CVS has already performed a merge.  The resulting file is not used in
1132 any way if you use this command.  If you use the @kbd{q} command inside
1133 @samp{ediff} (to successfully terminate a merge) the file that CVS
1134 created will be overwritten.@refill
1135 @end table
1137 @node Updating files, Tagging files, Invoking Ediff, Commands
1138 @section Updating files
1139 @findex cvs-mode-update
1140 @cindex Updating files
1141 @kindex O@r{--update files}
1143 @table @kbd
1144 @item O
1145 Update all selected files with status @samp{Need-update} by running
1146 @samp{cvs update} on them.  (@code{cvs-mode-update}).
1147 @end table
1150 @node Tagging files, Miscellaneous commands, Updating files, Commands
1151 @section Tagging files
1152 @findex cvs-mode-tag
1153 @findex cvs-mode-untag
1154 @findex cvs-rtag
1155 @cindex Tagging files
1156 @kindex M-t@r{--repository tag files}
1157 @kindex t@r{--tag files}
1158 @vindex cvs-invert-ignore-marks@r{ (variable)}
1159 @vindex cvs-force-dir-tag@r{ (variable)}
1161 @table @kbd
1162 @item t
1163 Tag all selected files by running @samp{cvs tag} on
1164 them (@code{cvs-mode-tag}).  It's usually preferable to tag a directory
1165 at a time.  Rather than selecting all files (which too often doesn't
1166 select all files but only the few that are displayed), clear the
1167 selection with @kbd{M-DEL} (@code{cvs-mode-unmark-all-files}), position
1168 the cursor on the directory you want to tag and hit @kbd{t}.
1169 @end table
1171 By default, @samp{tag} commands ignore the marks.  This can be changed
1172 with @code{cvs-invert-ignore-marks}.  Also, by default @samp{tag} can
1173 only be applied to directories, see @code{cvs-force-dir-tag} if you want
1174 to change this behavior.
1177 @node Miscellaneous commands,  , Tagging files, Commands
1178 @section Miscellaneous commands
1179 @findex cvs-mode-byte-compile-files
1180 @cindex Recompiling elisp files
1181 @cindex Byte compilation
1182 @findex cvs-mode-delete-lock
1183 @cindex Getting rid of lock files
1184 @cindex Lock files
1185 @kindex q@r{--quit PCL-CVS}
1186 @findex cvs-mode-quit
1187 @cindex Quitting
1188 @kindex h@r{--help}
1189 @kindex ?@r{--help}
1190 @findex cvs-help
1191 @cindex Help
1193 @table @kbd
1194 @item M-x cvs-mode-byte-compile-files
1195 Byte compile all selected files that end in @file{.el}.
1197 @item M-x cvs-mode-delete-lock
1198 This command deletes the lock files that
1199 the @samp{*cvs*} buffer informs you about.  You should normally never have to
1200 use this command, since CVS tries very carefully to always remove the
1201 lock files itself.
1203 You can only use this command when a message in the @samp{*cvs*} buffer tells
1204 you so.  You should wait a while before using this command in case
1205 someone else is running a @code{cvs} command.
1207 Also note that this only works if the repository is local.
1209 @item ?
1210 @itemx h
1211 Show a summary of common command key bindings in the echo
1212 area (@code{cvs-help}).
1214 @item q
1215 Quit PCL-CVS, killing the @samp{*cvs*} buffer (@code{cvs-mode-quit}).
1216 @end table
1218 @node Log Edit Mode, Log View Mode, Commands, Top
1219 @chapter Editing a Log Message
1221 @cindex Log Edit mode
1222 @cindex mode, Log Edit
1223 Buffers for entering/editing log messages for changes which are about
1224 to be committed are put into Log Edit mode.
1226 Sometimes the log buffer contains default text when you enter it,
1227 typically the last log message entered.  If it does, mark and point
1228 are set around the entire contents of the buffer so that it is easy to
1229 kill the contents of the buffer with @kbd{C-w}.
1231 @findex log-edit-insert-changelog
1232 If you work by writing entries in the @file{ChangeLog}
1233 (@pxref{(emacs)Change Log}) and then commit the change under revision
1234 control, you can generate the Log Edit text from the ChangeLog using
1235 @kbd{C-a C-a} (@kbd{log-edit-insert-changelog}).  This looks for
1236 entries for the file(s) concerned in the top entry in the ChangeLog
1237 and uses those paragraphs as the log text.  This text is only inserted
1238 if the top entry was made under your user name on the current date.
1239 @xref{(emacs)Change Logs and VC}, for the opposite way of
1240 working---generating ChangeLog entries from the revision control log.
1242 In the Log Edit buffer, @kbd{C-c C-f} (@kbd{M-x log-edit-show-files})
1243 shows the list of files to be committed in case you need to check
1244 that.
1246 When you have finished editing the log message, type @kbd{C-c C-c} to
1247 exit the buffer and commit the change.
1249 @c Fixme: customization variables
1251 @node Log View Mode, Customization, Log Edit Mode, Top
1252 @chapter Browsing a Log of Changes
1254 @cindex Log View mode
1255 @cindex mode, Log View
1256 @cindex output, logs
1258 @findex cvs-mode-log
1259 @findex vc-print-log
1260 Log View mode provides a few useful commands for navigating revision
1261 control log output.  It is used for the output buffers of both
1262 @code{cvs-mode-log} and @code{vc-print-log}.
1264 In this mode, @kbd{n} goes to the next message and @kbd{p} goes to the
1265 previous message and @kbd{N} and @kbd{P} go to the next and previous
1266 files, respectively, in multi-file output.  With a numeric prefix
1267 argument, these commands move that many messages of files.
1269 @c @node CVS Status Mode
1270 @c @chapter Viewing CVS' Status output
1272 @node Customization, Bugs, Log View Mode, Top
1273 @chapter Customization
1274 @vindex log-edit-changelog-full-paragraphs@r{ (variable)}
1275 @vindex cvs-auto-remove-handled@r{ (variable)}
1276 @vindex cvs-auto-remove-directories@r{ (variable)}
1277 @vindex cvs-update-prog-output-skip-regexp@r{ (variable)}
1278 @vindex cvs-cvsroot@r{ (variable)}
1279 @vindex cvs-auto-revert@r{ (variable)}
1280 @vindex log-edit-require-final-newline@r{ (variable)}
1281 @vindex cvs-sort-ignore-file@r{ (variable)}
1282 @cindex Customization
1283 @cindex Variables, list of all
1284 @cindex Erasing input buffer
1285 @cindex Context diff, how to get
1286 @cindex Unidiff, how to get
1287 @cindex Automatically remove handled files
1288 @cindex @samp{-u} option in modules file
1289 @cindex Modules file (@samp{-u} option)
1290 @cindex Update program (@samp{-u} option in modules file)
1291 @cindex Reverting buffers after commit
1292 @cindex Require final newline
1293 @cindex Automatically inserting newline
1294 @cindex Commit message, inserting newline
1295 @cindex Sorting @file{.cvsignore} file
1296 @cindex @file{.cvsignore} file, sorting
1297 @cindex Automatically sorting @file{.cvsignore}
1298 @cindex @samp{CVSROOT}, overriding
1300 If you have an idea about any customization that would be handy but
1301 isn't present in this list, please tell me!
1302 For info on how to reach me, see @ref{Bugs}.@refill
1304 @table @samp
1305 @item cvs-auto-remove-handled
1306 If this variable is set to any non-@code{nil} value,
1307 @samp{cvs-mode-remove-handled} will be called every time you check in
1308 files, after the check-in is ready.  @xref{Removing handled
1309 entries}.@refill
1311 @item cvs-auto-remove-directories
1312 If this variable is set to any non-@code{nil} value, directories that do
1313 not contain any files to be checked in will not be listed in the
1314 @samp{*cvs*} buffer.@refill
1316 @item cvs-auto-revert
1317 If this variable is set to any non-@samp{nil} value any buffers you have
1318 that visit a file that is committed will be automatically reverted.
1319 This variable defaults to @samp{t}. @xref{Committing changes}.@refill
1321 @item cvs-update-prog-output-skip-regexp
1322 The @samp{-u} flag in the @file{modules} file can be used to run a command
1323 whenever a @samp{cvs update} is performed (see @code{cvs(5)}).  This regexp
1324 is used to search for the last line in that output.  It is normally set
1325 to @samp{$}.  That setting is only correct if the command outputs
1326 nothing.  Note that PCL-CVS will get very confused if the command
1327 outputs @emph{anything} to @code{stderr}.
1329 @item cvs-cvsroot
1330 This variable can be set to override @samp{CVSROOT}.  It should be a
1331 string.  If it is set, then every time a @code{cvs} command is run, it
1332 will be called as @samp{cvs -d @var{cvs-cvsroot}@dots{}}.  This can be
1333 useful if your site has several repositories.
1335 @item log-edit-require-final-newline
1336 @c wordy to avoid unhderfull hbox
1337 When you enter a log message by typing into the
1338 @samp{*cvs-commit-message*} buffer, PCL-CVS normally automatically
1339 inserts a trailing newline, unless there already is one.  This behavior
1340 can be controlled via @samp{cvs-commit-buffer-require-final-newline}.
1341 If it is @samp{t} (the default behavior), a newline will always be
1342 appended.  If it is @samp{nil}, newlines will never be appended.  Any
1343 other value causes PCL-CVS to ask the user whenever there is no trailing
1344 newline in the commit message buffer.
1346 @findex cvs-mode-changelog-commit
1347 @item log-edit-changelog-full-paragraphs
1348 If this variable is non-@code{nil}, include full @file{ChangeLog}
1349 paragraphs in the CVS log created by @samp{cvs-mode-changelog-commit}. 
1350 This may be set in the local variables section of a @file{ChangeLog}
1351 file, to indicate the policy for that @file{ChangeLog}.
1353 @cindex @file{ChangeLog} paragraphs
1354 A @dfn{@file{ChangeLog} paragraph} is a bunch of log text containing no
1355 blank lines; a paragraph usually describes a set of changes with a
1356 single purpose, but perhaps spanning several functions in several files.
1357 Changes in different paragraphs are unrelated.
1359 You could argue that the CVS log entry for a file should contain the
1360 full @file{ChangeLog} paragraph mentioning the change to the file, even though
1361 it may mention other files, because that gives you the full context you
1362 need to understand the change.  This is the behavior you get when this
1363 variable is set to @code{t}, the default.
1365 On the other hand, you could argue that the CVS log entry for a change
1366 should contain only the text for the changes which occurred in that
1367 file, because the CVS log is per-file.  This is the behavior you get
1368 when this variable is set to @code{nil}.
1370 @findex cvs-mode-ignore@r{, and @file{.cvsignore} sorting}
1371 @item cvs-sort-ignore-file
1372 If this variable is set to any non-@samp{nil} value, the
1373 @file{.cvsignore} file will always be sorted whenever you use
1374 @samp{cvs-mode-ignore} to add a file to it.  This option is on by
1375 default.
1376 @end table
1379 @menu
1380 * Customizing Faces::           
1381 @end menu
1383 @node Customizing Faces,  , Customization, Customization
1384 @section Customizing Faces
1385 @vindex cvs-header-face (face)
1386 @vindex cvs-filename-face (face)
1387 @vindex cvs-unknown-face (face)
1388 @vindex cvs-handled-face (face)
1389 @vindex cvs-need-action-face (face)
1390 @vindex cvs-marked-face (face)
1392 PCL-CVS adds a few extra features, including menus, mouse bindings, and
1393 fontification the @samp{*cvs*} buffer.  The faces defined for
1394 fontification are listed below:
1396 @table @samp
1397 @item cvs-header-face
1398 used to highlight directory changes.
1400 @item cvs-filename-face
1401 used to highlight file names.
1403 @item cvs-unknown-face
1404 used to highlight the status of files which are @samp{Unknown}.
1406 @item cvs-handled-face
1407 used to highlight the status of files which are handled and 
1408 need no further action.
1410 @item cvs-need-action-face
1411 used to highlight the status of files which still need action.
1413 @item cvs-marked-face
1414 used to highlight the marked file indicator (@samp{*}).
1415 @end table
1418 @node   Bugs, Function and Variable Index, Customization, Top
1419 @chapter Bugs (known and unknown)
1420 @cindex Reporting bugs and ideas
1421 @cindex Bugs, how to report them
1422 @cindex Author, how to reach
1423 @cindex Email to the author
1424 @cindex Known bugs
1425 @cindex Bugs, known
1426 @cindex FAQ
1427 @cindex Problems, list of common
1429 If you find a bug or misfeature, don't hesitate to tell us!  Send email
1430 to @email{bug-gnu-emacs@@gnu.org} which is gatewayed to the newsgroup
1431 @samp{gnu.emacs.bugs}.  Feature requests should also be sent there.  We
1432 prefer discussing one thing at a time.  If you find several unrelated
1433 bugs, please report them separately.  If you are running PCL-CVS under
1434 XEmacs, you should also send a copy of bug reports to
1435 @email{xemacs-beta@@xemacs.org}.
1437 If you have problems using PCL-CVS or other questions, send them to
1438 @email{help-gnu-emacs@@gnu.org}, which is gatewayed to the
1439 @samp{gnu.emacs.help} newsgroup.  This is a good place to get help, as
1440 is @email{cvs-info@@gnu.org}, gatewayed to @samp{gnu.cvs.help}.
1442 If you have ideas for improvements, or if you have written some
1443 extensions to this package, we would like to hear from you.  We hope that
1444 you find this package useful!
1446 Below is a partial list of currently known problems with PCL-CVS.
1448 @table @asis
1449 @item Unexpected output from CVS
1450 Unexpected output from CVS may confuse PCL-CVS.  It will create
1451 warning messages in the @samp{*cvs*} buffer alerting you to any parse errors.
1452 If you get these messages, please send a bug report to the email
1453 addresses listed above.  Include the contents of the @samp{*cvs*} buffer, the
1454 output of the CVS process (which should be found in the @samp{ *cvs-tmp*}
1455 buffer), and the versions of Emacs, PCL-CVS and CVS you are using.
1456 @end table
1458 @node Function and Variable Index, Concept Index, Bugs, Top
1459 @unnumbered Function and Variable Index
1461 This is an index of all the functions and variables documented in this
1462 manual.
1464 @printindex fn
1466 @node     Concept Index, Key Index, Function and Variable Index, Top
1467 @unnumbered Concept Index
1469 This is an index of concepts discussed in this manual.
1471 @printindex cp
1473 @node     Key Index,  , Concept Index, Top
1474 @unnumbered Key Index
1476 This index includes an entry for each PCL-CVS key sequence documented in
1477 this manual.
1479 @printindex ky
1481 @setchapternewpage odd
1482 @summarycontents
1483 @contents
1484 @bye