Merge from vendor branch CVS:
[dragonfly.git] / contrib / cvs-1.12.11 / contrib / README
1 This "contrib" directory is a place holder for code/scripts sent to me
2 by contributors around the world.  This README file will be kept
3 up-to-date from release to release.  BUT, we must point out that these
4 contributions are really, REALLY UNSUPPORTED.  In fact, we probably
5 don't even know what some of them really do.  We certainly do not
6 guarantee to have tried them, or ported them to work with this CVS
7 distribution.  If you have questions, your best bet is to contact the
8 original author, but you should not necessarily expect a reply, since
9 the author may not be available at the address given.
10
11 USE AT YOUR OWN RISK -- and all that stuff.
12
13 "Unsupported" also means that no one has volunteered to accept and check
14 in changes to this directory.  So submissions for new scripts to add
15 here are unlikely to be accepted.  Suggested changes to the existing
16 scripts here conceivably might, but that isn't clear either, unless of
17 course they come from the original author of the script.
18
19 If you have some software that works with CVS that you wish to offer it
20 is suggested that you make it available by FTP or HTTP and then announce
21 it on the info-cvs mailing list.
22
23 An attempt at a table of Contents for this directory:
24
25         README          This file.
26
27         check_cvs       A perl script to check an entire repository for
28                         corruption.
29                         Contributed by Donald Sharp <sharpd@cisco.com>.
30
31         clmerge         A perl script to handle merge conflicts in GNU
32                         style ChangeLog files .
33                         Contributed by Tom Tromey <tromey@busco.lanl.gov>.
34
35         cln_hist        A perl script to compress your
36                         $CVSROOT/CVSROOT/history file, as it can grow quite
37                         large after extended use.
38                         Contributed by David G. Grubbs <dgg@ksr.com>
39
40         commit_prep     A perl script, to be combined with log_accum.pl, to
41         log_accum       provide for a way to combine the individual log
42                         messages of a multi-directory "commit" into a
43                         single log message, and mail the result somewhere.
44                         Can also do other checks for $Id and that you are
45                         committing the correct revision of the file.
46                         Read the comments carefully.
47                         Contributed by David Hampton <hampton@cisco.com>.
48
49         cvs2vendor      A shell script to move changes from a repository
50                         that was started without a vendor branch to one
51                         that has a vendor branch.
52                         Contributed by Greg A. Woods <woods@planix.com>.
53
54         cvs_acls        A perl script that implements Access Control Lists
55         cvs_acls.html   by using the "commitinfo" hook provided with the
56                         "cvs commit" command.
57                         Contributed by David G. Grubbs <dgg@ksr.com>.
58                         Enhanced by Peter Connolly <Peter.Connolly@cnet.com>.
59
60         cvscheck        Identifies files added, changed, or removed in a
61         cvscheck.man    checked out CVS tree; also notices unknown files.
62                         Contributed by Lowell Skoog <fluke!lowell@uunet.uu.net>
63
64         cvshelp.man     An introductory manual page written by Lowell Skoog
65                         <fluke!lowell@uunet.uu.net>.  It is most likely
66                         out-of-date relative to CVS 1.3, but still may be
67                         useful.
68
69         debug_check_log A shell script to help analyze sanity check failures.
70                         Contributed by Derek R. Price
71                         <derek.price@openavenue.com>
72
73         descend         A shell script that can be used to recursively
74         descend.man     descend through a directory.  In CVS 1.2, this was
75                         very useful, since many of the commands were not
76                         recursive.  In CVS 1.3 (and later), however, most of
77                         the commands are recursive.  However, this may still
78                         come in handy.
79                         Contributed by Lowell Skoog <fluke!lowell@uunet.uu.net>
80
81         dirfns          A shar file which contains some code that might
82                         help your system support opendir/readdir/closedir,
83                         if it does not already.
84                         Copied from the C-News distribution.
85
86         intro.doc       A user's view of what you need to know to get
87                         started with CVS.
88                         Contributed by <Steven.Pemberton@cwi.nl>.
89
90         log             A perl script suitable for including in your
91                         $CVSROOT/CVSROOT/loginfo file for logging commit
92                         changes.  Includes the RCS revision of the change
93                         as part of the log.
94                         Contributed by Kevin Samborn <samborn@sunrise.com>.
95
96         log_accum       See commit_prep.
97
98         mfpipe          Another perl script for logging.  Allows you to
99                         pipe the log message to a file and/or send mail
100                         to some alias.
101                         Contributed by John Clyne <clyne@niwot.scd.ucar.edu>.
102
103         pvcs2rcs        A perl script to convert a PVCS tree to an RCS tree.
104
105         rcs-to-cvs      Script to import sources that may have been under
106                         RCS control already.
107                         Contributed by Per Cederqvist <ceder@lysator.liu.se>.
108
109         rcs2log         A shell script to create a ChangeLog-format file
110                         given only a set of RCS files.
111                         Contributed by Paul Eggert <eggert@twinsun.com>.
112
113         rcs2sccs        A shell script to convert simple RCS files into
114                         SCCS files, originally gleaned off the network
115                         somewhere (originally by "kenc") and modified by
116                         Jerry Jelinek <jerry@rmtc.Central.Sun.COM> and
117                         Brian Berliner <berliner@sun.com> to increase
118                         robustness and add support for one-level of branches.
119
120         rcslock         A perl script that can be added to your commitinfo
121                         file that tries to determine if your RCS file is
122                         currently locked by someone else, as might be the
123                         case for a binary file.
124                         Contributed by John Rouillard <rouilj@cs.umb.edu>.
125
126         sccs2rcs        A C-shell script that can convert (some) SCCS files
127                         into RCS files, retaining the info contained in the
128                         SCCS file (like dates, author, and log message).
129                         Contributed by Ken Cox <kenstir@viewlogic.com>.