Go to the previous section.
Entries lines are transmitted as:
/ name / version / conflict / options / tag_or_date
tag_or_date is either `T' tag or `D' date or empty. If it is followed by a slash, anything after the slash shall be silently ignored.
version can be empty, or start with `0' or `-', for no user file, new user file, or user file to be removed, respectively.
conflict, if it starts with `+', indicates that the file had conflicts in it. The rest of conflict is `=' if the timestamp matches the file, or anything else if it doesn't. If conflict does not start with a `+', it is silently ignored.
A mode is any number of repetitions of
mode-type = data
separated by `,'.
mode-type is an identifier composed of alphanumeric characters. Currently specified: `u' for user, `g' for group, `o' for other, as specified in POSIX. If at all possible, give these their POSIX meaning and use other mode-types for other behaviors. For example, on VMS it shouldn't be hard to make the groups behave like POSIX, but you would need to use ACLs for some cases.
data consists of any data not containing `,', `\0' or `\n'. For `u', `g', and `o' mode types, data consists of alphanumeric characters, where `r' means read, `w' means write, `x' means execute, and unrecognized letters are silently ignored.
File contents (noted below as file transmission) can be sent in one of two forms. The simpler form is a number of bytes, followed by a newline, followed by the specified number of bytes of file contents. These are the entire contents of the specified file. Second, if both client and server support `gzip-file-contents', a `z' may precede the length, and the `file contents' sent are actually compressed with `gzip'. The length specified is that of the compressed version of the file.
In neither case are the file content followed by any additional data. The transmission of a file will end with a newline iff that file (or its compressed form) ends with a newline.
Root pathname \n
CVSROOT to use.
Valid-responses request-list \n
valid-requests \n
Valid-requests response.
Repository repository \n
Entry and Modified and
also for ci and the other commands; normal usage is to send a
Repository for each directory in which there will be an
Entry or Modified , and then a final Repository
for the original directory, then the command.
Directory local-directory \n
Repository,
but the local name of the directory may differ from the repository name.
If the client uses this request, it affects the way the server returns
pathnames; see section Responses. local-directory is relative to
the top level at which the command is occurring (i.e. the last
Directory or Repository which is sent before the command).
Max-dotdot level \n
Directory requests are relative to will be
needed. For example, if the client is planning to use a
Directory request for `../../foo', it must send a
Max-dotdot request with a level of at least 2.
Max-dotdot must be sent before the first Directory
request.
Static-directory \n
Repository or Directory should not have
additional files checked out unless explicitly requested. The client
sends this if the Entries.Static flag is set, which is controlled
by the Set-static-directory and Clear-static-directory
responses.
Sticky tagspec \n
Repository has a sticky tag or date tagspec.
The first character of tagspec is `T' for a tag, or `D'
for a date. The remainder of tagspec contains the actual tag or
date.
Checkin-prog program \n
Directory has a checkin program program.
Such a program would have been previously set with the
Set-checkin-prog response.
Update-prog program \n
Directory has an update program program.
Such a program would have been previously set with the
Set-update-prog response.
Entry entry-line \n
Repository. If the user
is operating on only some files in a directory, Entry requests
for only those files need be included. If an Entry request is
sent without Modified, Unchanged, or Lost for that
file the meaning depends on whether UseUnchanged has been sent;
if it has been it means the file is lost, if not it means the file is
unchanged.
Modified filename \n
Repository. If
the user is operating on only some files in a directory, only those
files need to be included. This can also be sent without Entry,
if there is no entry for the file.
Lost filename \n
Repository. This is used for any case in which Entry is
being sent but the file no longer exists. If the client has issued the
UseUnchanged request, then this request is not used.
Unchanged filename \n
Repository. This request can only be
issued if UseUnchanged has been sent.
UseUnchanged \n
Unchanged, and that files for
which no information is sent are nonexistent on the client side, not
unchanged. This is necessary for correct behavior since only the server
knows what possible files may exist, and thus what files are
nonexistent.
Argument text \n
Argumentx text \n
Global_option option \n
valid-requests, it is probably better to
make new global options separate requests, rather than trying to add
them to this request.
expand-modules \n
Module-expansion responses. Note
that the server can assume that this is checkout or export, not rtag or
rdiff; the latter do not access the working directory and thus have no
need to expand modules on the client side.
co \n
update \n
ci \n
diff \n
tag \n
status \n
log \n
add \n
remove \n
rdiff \n
rtag \n
import \n
admin \n
export \n
history \n
release \n
Argument, Repository, Entry,
Modified, or Lost requests, if they have been sent. The
last Repository sent specifies the working directory at the time
of the operation. No provision is made for any input from the user.
This means that ci must use a -m argument if it wants to
specify a log message.
update-patches \n
update
request. The client must issue the -u argument to update
in order to receive patches.
gzip-file-contents level \n
This is only a hint to the server. It may still decide (for example, in the case of very small files, or files that already appear to be compressed) not to do the compression. Compression is indicated by a `z' preceding the file length.
Availability of this request in the server indicates to the client that it may compress files sent to the server, regardless of whether the client actually uses this request.
other-request text \n
When the client is done, it drops the connection.
After a command which expects a response, the server sends however many
of the following responses are appropriate. Pathnames are of the actual
files operated on (i.e. they do not contain `,v' endings), and are
suitable for use in a subsequent Repository request. However, if
the client has used the Directory request, then it is instead a
local directory name relative to the directory in which the command was
given (i.e. the last Directory before the command). Then a
newline and a repository name (the pathname which is sent if
Directory is not used). Then the slash and the filename. For
example, for a file `i386.mh' which is in the local directory
`gas.clean/config' and for which the repository is
`/rel/cvsfiles/devo/gas/config':
gas.clean/config/ /rel/cvsfiles/devo/gas/config/i386.mh
Any response always ends with `error' or `ok'. This indicates that the response is over.
Valid-requests request-list \n
Checked-in pathname \n
New-entry pathname \n
Checked-in, but the
file is not up to date.
Updated pathname \n
Merged pathname \n
Updated and takes the same additional data,
with the one difference that after the new copy of the file is enclosed,
it will still not be up to date. Used for the results of a merge, with
or without conflicts.
Patched pathname \n
Updated and takes the same additional data,
with the one difference that instead of sending a new copy of the file,
the server sends a patch produced by `diff -u'. This client must
apply this patch, using the `patch' program, to the existing file.
This will only be used when the client has an exact copy of an earlier
revision of a file. This response is only used if the update
command is given the `-u' argument.
Checksum checksum\n
Updated, Merged, or Patched. In the case of
Patched, the checksum applies to the file after being patched,
not to the patch itself. The client should compute the checksum itself,
after receiving the file or patch, and signal an error if the checksums
do not match. The checksum is the 128 bit MD5 checksum represented as
32 hex digits. This response is optional, and is only used if the
client supports it (as judged by the Valid-responses request).
Copy-file pathname \n
CVS/Entries.
Removed pathname \n
Remove-entry pathname \n
CVS/Entries, but the file
itself is already gone (this happens in response to a ci request
which involves committing the removal of a file).
Set-static-directory pathname \n
Entries.Static flag, which
it should then send back to the server in a Static-directory
request whenever the directory is operated on. pathname ends in a
slash; its purpose is to specify a directory, not a file within a
directory.
Clear-static-directory pathname \n
Set-static-directory, but clear, not set, the flag.
Set-sticky pathname \n
Sticky request for
future operations. pathname ends in a slash; its purpose is to
specify a directory, not a file within a directory. The first character
of tagspec is `T' for a tag, or `D' for a date. The
remainder of tagspec contains the actual tag or date.
Clear-sticky pathname \n
Set-sticky.
Set-checkin-prog dir \n
Checkin-prog request
for future operations.
Set-update-prog dir \n
Update-prog request
for future operations.
Module-expansion pathname \n
M text \n
E text \n
M but send to stderr not stdout.
error errno-code ` ' text \n
ENOENT); if the server doesn't support this
feature, or if it's not appropriate for this particular message, it just
omits the errno-code (in that case there are two spaces after
`error'). Text is an error message such as that provided by
strerror(), or any other message the server wants to use.
ok \n
Lines beginning with `c>' are sent by the client; lines beginning with `s>' are sent by the server; lines beginning with `#' are not part of the actual exchange.
c> Root /rel/cvsfiles
# In actual practice the lists of valid responses and requests would
# be longer
c> Valid-responses Updated Checked-in M ok error
c> valid-requests
s> Valid-requests Root co Modified Entry Repository ci Argument Argumentx
s> ok
# cvs co devo/foo
c> Argument devo/foo
c> co
s> Updated /rel/cvsfiles/devo/foo/foo.c
s> /foo.c/1.4/Mon Apr 19 15:36:47 1993 Mon Apr 19 15:36:47 1993//
s> 26
s> int mein () { abort (); }
s> Updated /rel/cvsfiles/devo/foo/Makefile
s> /Makefile/1.2/Mon Apr 19 15:36:47 1993 Mon Apr 19 15:36:47 1993//
s> 28
s> foo: foo.c
s> $(CC) -o foo $<
s> ok
# In actual practice the next part would be a separate connection.
# Here it is shown as part of the same one.
c> Repository /rel/cvsfiles/devo/foo
# foo.c relative to devo/foo just set as Repository.
c> Entry /foo.c/1.4/Mon Apr 19 15:36:47 1993 Mon Apr 19 15:36:47 1993//
c> Entry /Makefile/1.2/Mon Apr 19 15:36:47 1993 Mon Apr 19 15:36:47 1993//
c> Modified foo.c
c> 26
c> int main () { abort (); }
# cvs ci -m <log message> foo.c
c> Argument -m
c> Argument Well, you see, it took me hours and hours to find this typo and I
c> Argumentx searched and searched and eventually had to ask John for help.
c> Argument foo.c
c> ci
s> Checked-in /rel/cvsfiles/devo/foo/foo.c
s> /foo.c/1.5/ Mon Apr 19 15:54:22 CDT 1993//
s> M Checking in foo.c;
s> M /cygint/rel/cvsfiles/devo/foo/foo.c,v <-- foo.c
s> M new revision: 1.5; previous revision: 1.4
s> M done
s> ok
Go to the previous section.