Return to rcsintro.7 CVS log

Up to [local] / src / usr.bin / rcs

Annotation of src/usr.bin/rcs/rcsintro.7, Revision 1.4

1.4     ! xsa         1: .\"     $OpenBSD: rcsintro.7,v 1.3 2005/10/26 15:15:46 xsa Exp $
1.1       xsa         2: .\"
                      3: .\" Copyright (c) 2005 Xavier Santolaria <xsa@openbsd.org>
                      4: .\" All rights reserved.
                      5: .\"
                      6: .\" Permission to use, copy, modify, and distribute this software for any
                      7: .\" purpose with or without fee is hereby granted, provided that the above
                      8: .\" copyright notice and this permission notice appear in all copies.
                      9: .\"
                     10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     17: .Dd October 19, 2005
                     18: .Dt RCSINTRO 7
                     19: .Os
                     20: .Sh NAME
                     21: .Nm rcsintro
                     22: .Nd introdution to Revision Control System
                     23: .Sh DESCRIPTION
                     24: Revision Control System (RCS) is a software tool which lets people
                     25: manage multiple revisions of text that is revised frequently, such as
                     26: source code or documentation.
                     27: .Sh USING RCS TO TRACK FILE CHANGES
                     28: One of the most common uses of
                     29: .Xr rcs 1
                     30: is to track changes to a document containing source code.
                     31: .Pp
                     32: As an example,
                     33: we'll look at a user wishing to track source changes to a file
                     34: .Ar foo.c .
                     35: .Pp
                     36: If the
                     37: .Ar RCS
                     38: directory does not exist yet, create it as follows and invoke the
                     39: check-in command:
                     40: .Bd -literal -offset indent
                     41: $ mkdir RCS
                     42: $ ci foo.c
                     43: .Ed
                     44: .Pp
                     45: This command creates an RCS file
                     46: .Ar foo.c,v
                     47: in the
                     48: .Ar RCS
                     49: directory, stores
                     50: .Ar foo.c
                     51: into it as revision 1.1, and deletes
                     52: .Ar foo.c .
                     53: .Xr ci 1
1.3       xsa        54: will prompt for a description of the file to be entered.
1.1       xsa        55: Whenever a newly created (or updated) file is checked-in,
                     56: .Xr ci 1
1.3       xsa        57: will prompt for a log message to be entered which should summarize
                     58: the changes made to the file.
                     59: That log message will be added to the RCS file along with the new revision.
1.1       xsa        60: .Pp
                     61: The
                     62: .Xr co 1
                     63: command can now be used to obtain a copy of the checked-in
                     64: .Ar foo.c,v
                     65: file:
                     66: .Pp
                     67: .Dl $ co foo.c
                     68: .Pp
                     69: This command check the file out in shared, or unlocked mode.
                     70: If a user wants to have exclusive access to the file to make changes to it,
                     71: it needs to be checked out in locked mode using the
                     72: .Fl l
                     73: option of the
                     74: .Xr co 1
                     75: command.
                     76: Only one concurrent locked checkout of a revision is permitted.
1.4     ! xsa        77: .Pp
        !            78: Once changes have been made to the
        !            79: .Pa foo.c
        !            80: file, and before checking the file in, the
        !            81: .Xr rcsdiff 1
        !            82: command can be used to view changes between the working file
        !            83: and the most recently checked-in revision:
        !            84: .Pp
        !            85: .Dl $ rcsdiff -u foo.c
        !            86: .Pp
        !            87: The
        !            88: .Fl u
        !            89: option produces a unified diff.
        !            90: See
        !            91: .Xr diff 1
        !            92: for more information.
1.1       xsa        93: .Sh SEE ALSO
                     94: .Xr ci 1 ,
                     95: .Xr co 1 ,
                     96: .Xr cvs 1 ,
                     97: .Xr ident 1 ,
                     98: .Xr rcs 1 ,
                     99: .Xr rcsclean 1 ,
                    100: .Xr rcsdiff 1 ,
                    101: .Xr rcsmerge 1 ,
                    102: .Xr rlog 1
1.2       jmc       103: .Sh HISTORY
                    104: The OpenRCS project is a BSD-licensed rewrite of the original
                    105: Revision Control System written by Jean-Francois Brousseau, Joris Vink,
                    106: Niall O'Higgins, and Xavier Santolaria.
                    107: The original RCS code was written in large parts by Walter F. Tichy,
                    108: and Paul Eggert.