Annotation of src/usr.bin/rcs/rcsintro.7, Revision 1.2
1.2 ! jmc 1: .\" $OpenBSD: rcsintro.7,v 1.1 2005/10/24 15:53:29 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
54: will prompt for a comment to be entered.
55: Whenever a newly created (or updated) file is checked-in,
56: .Xr ci 1
57: will prompt for a comment.
58: That comment will be added to the RCS file along with the new revision.
59: .Pp
60: The
61: .Xr co 1
62: command can now be used to obtain a copy of the checked-in
63: .Ar foo.c,v
64: file:
65: .Pp
66: .Dl $ co foo.c
67: .Pp
68: This command check the file out in shared, or unlocked mode.
69: If a user wants to have exclusive access to the file to make changes to it,
70: it needs to be checked out in locked mode using the
71: .Fl l
72: option of the
73: .Xr co 1
74: command.
75: Only one concurrent locked checkout of a revision is permitted.
76: .Sh SEE ALSO
77: .Xr ci 1 ,
78: .Xr co 1 ,
79: .Xr cvs 1 ,
80: .Xr ident 1 ,
81: .Xr rcs 1 ,
82: .Xr rcsclean 1 ,
83: .Xr rcsdiff 1 ,
84: .Xr rcsmerge 1 ,
85: .Xr rlog 1
1.2 ! jmc 86: .Sh HISTORY
! 87: The OpenRCS project is a BSD-licensed rewrite of the original
! 88: Revision Control System written by Jean-Francois Brousseau, Joris Vink,
! 89: Niall O'Higgins, and Xavier Santolaria.
! 90: The original RCS code was written in large parts by Walter F. Tichy,
! 91: and Paul Eggert.