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