Annotation of src/usr.bin/cvs/cvs.1, Revision 1.1.1.1
1.1 jfb 1: .\" $OpenBSD: pmdb.1,v 1.15 2003/08/02 17:40:51 mickey Exp $
2: .\"
3: .\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
4: .\" All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\"
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. The name of the author may not be used to endorse or promote products
13: .\" derived from this software without specific prior written permission.
14: .\"
15: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
16: .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
17: .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
18: .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19: .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20: .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21: .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22: .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23: .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24: .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25: .\"
26: .Dd May 16, 2004
27: .Dt CVS 1
28: .Os
29: .Sh NAME
30: .Nm cvs
31: .Nd OpenCVS Concurrent Versioning System client/server
32: .Sh SYNOPSIS
33: .Nm
34: .Op Fl flQqv
35: .Op Fl d Ar root
36: .Op Fl e Ar editor
37: .Ar command Op Ar ...
38: .Sh DESCRIPTION
39: The
40: .Nm
41: program acts as both client and server for the use of and administration of
42: a CVS source repository.
43: CVS is used to maintain version information on files that are kept in a
44: repository.
45: Although it is more commonly used to track changes in source code, there
46: are no real limitations to the type of files that you can store in a
47: repository.
48: .Pp
49: The following options are supported:
50: .Bl -tag -width Ds
51: .It Fl d Ar root
52: Use
53: .Ar root
54: as the path to the root directory of the CVS repository.
55: The value must specify an absolute path.
56: .It Fl e Ar editor
57: Use the program
58: .Ar editor
59: whenever editing log information.
60: This option overrides the environment variables CVSEDITOR, VISUAL and EDITOR.
61: .It Fl f
62: Do not read the contents of the user's .cvsrc file on startup.
63: .It Fl l
64: Suppress logging of history information.
65: .It Fl Q
66: Be extra quiet.
67: Only error messages will be displayed.
68: .It Fl q
69: Be quiet about reporting.
70: .It Fl v
71: Display version information and exit.
72: .El
73: .Sh COMMANDS
74: .Bl -tag -width Ds
75: .Ic add
76: .Ar file Op ...
77: Before a file is known to CVS, it must be added to the repository using
78: this command.
79: Adding a file does not actually publish the contents of the
80: file, so you must commit the first revision in order to let other users
81: see the file with the
82: .Ic update
83: command.
84: .Pp
85: .Ic commit
86: .Op Fl m Ar msg
87: The
88: .Ic commit
89: command is used to send local changes back to the server and update the
90: repository's information to reflect the changes.
91: .Pp
92: .Ic update
93: .Op Fl dP
94: .El
95: .Sh FILES
96: .Bl -tag -width Ds
97: .It Pa $HOME/.cvsrc
98: File containing a list of implicit options to pass to certain commands.
99: This file is read on startup unless the
100: .Fl f
101: option is specified.
102: .It Pa $CVSROOT/CVSROOT
103: Directory containing repository administrative files.
104: .It Pa $CVSROOT/CVSROOT/loginfo
105: File containing associations between modules and handlers for
106: post-commit logging.
107: .El
108: .Sh ENVIRONMENT
109: .Bl -tag -width CVS_CLIENT_LOG
110: .It Ev CVSROOT
111: When set, this variable should contain the string pointing to the root
112: directory of the CVS repository.
113: The contents of this variable are ignored when the
114: .Fl d
115: option is given or if `Root' files exist in the checked-out copy.
116: .It Ev CVS_RSH
117: Name of the program to use when connecting to the server through a remote
118: shell.
119: The default is to use the
120: .Xr ssh 1
121: program.
122: .It Ev CVS_SERVER
123: If set, gives the name of the program to invoke as a
124: .Nm
125: server when using remote shell.
126: The default is to use `cvs'.
127: .It Ev CVSEDITOR
128: Name of the editor to use when editing commit messages.
129: Checked before EDITOR and VISUAL.
130: .It Ev EDITOR
131: .It Ev VISUAL
132: .It Ev CVS_CLIENT_LOG
133: This variable enables logging of all communications between the client and
134: server when running in non-local mode.
135: If set, this environment variable must contain a base path from which two
136: paths will be generated by appending ".in" to the value for the server's
137: input and ".out" for the server's output.
138: .El
139: .Sh SEE ALSO
140: .Xr rcs 1 ,
141: .Xr diff 1 ,
142: .Xr patch 1 ,
143: .Xr cvsd 8
144: .Sh HISTORY
145: The OpenCVS project is a BSD-licensed rewrite of the original
146: Concurrent Versioning System written by Jean-Francois Brousseau.
147: The original CVS code was written in large parts by Dick Grune,
148: Brian Berliner and Jeff Polk.
![[BACK]](/icons/back.gif){kind=icon}
Return to cvs.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / cvs