Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
co(1)
Edit
PageHistory
Diff
Info
LikePages
CO !!!CO NAME SYNOPSIS DESCRIPTION OPTIONS KEYWORD SUBSTITUTION FILE MODES FILES ENVIRONMENT DIAGNOSTICS IDENTIFICATION SEE ALSO LIMITS ---- !!NAME co - check out RCS revisions !!SYNOPSIS __co__ [[''options''] ''file'' ... !!DESCRIPTION __co__ retrieves a revision from each RCS file and stores it into the corresponding working file. Pathnames matching an RCS suffix denote RCS files; all others denote working files. Names are paired as explained in ci(1). Revisions of an RCS file can be checked out locked or unlocked. Locking a revision prevents overlapping updates. A revision checked out for reading or processing (e.g., compiling) need not be locked. A revision checked out for editing and later checkin must normally be locked. Checkout with locking fails if the revision to be checked out is currently locked by another user. (A lock can be broken with rcs(1).) Checkout with locking also requires the caller to be on the access list of the RCS file, unless he is the owner of the file or the superuser, or the access list is empty. Checkout without locking is not subject to accesslist restrictions, and is not affected by the presence of locks. A revision is selected by options for revision or branch number, checkin date/time, author, or state. When the selection options are applied in combination, __co__ retrieves the latest revision that satisfies all of them. If none of the selection options is specified, __co__ retrieves the latest revision on the default branch (normally the trunk, see the __-b__ option of rcs(1)). A revision or branch number can be attached to any of the options __-f__, __-I__, __-l__, __-M__, __-p__, __-q__, __-r__, or __-u__. The options __-d__ (date), __-s__ (state), and __-w__ (author) retrieve from a single branch, the ''selected'' branch, which is either specified by one of __-f__, ..., __-u__, or the default branch. A __co__ command applied to an RCS file with no revisions creates a zero-length working file. __co__ always performs keyword substitution (see below). !!OPTIONS __-r__[[''rev''] retrieves the latest revision whose number is less than or equal to ''rev''. If ''rev'' indicates a branch rather than a revision, the latest revision on that branch is retrieved. If ''rev'' is omitted, the latest revision on the default branch (see the __-b__ option of rcs(1)) is retrieved. If ''rev'' is __$__, __co__ determines the revision number from keyword values in the working file. Otherwise, a revision is composed of one or more numeric or symbolic fields separated by periods. If ''rev'' begins with a period, then the default branch (normally the trunk) is prepended to it. If ''rev'' is a branch number followed by a period, then the latest revision on that branch is used. The numeric equivalent of a symbolic field is specified with the __-n__ option of the commands ci(1) and rcs(1). __-l__[[''rev''] same as __-r__, except that it also locks the retrieved revision for the caller. __-u__[[''rev''] same as __-r__, except that it unlocks the retrieved revision if it was locked by the caller. If ''rev'' is omitted, __-u__ retrieves the revision locked by the caller, if there is one; otherwise, it retrieves the latest revision on the default branch. __-f__[[''rev''] forces the overwriting of the working file; useful in connection with __-q__. See also FILE MODES below. __-kkv__ Generate keyword strings using the default form, e.g. __$Revision: 5.13 $__ for the __Revision__ keyword. A locker's name is inserted in the value of the __Header__, __Id__, and __Locker__ keyword strings only as a file is being locked, i.e. by __ci -l__ and __co -l__. This is the default. __-kkvl__ Like __-kkv__, except that a locker's name is always inserted if the given revision is currently locked. __-kk__ Generate only keyword names in keyword strings; omit their values. See KEYWORD SUBSTITUTION below. For example, for the __Revision__ keyword, generate the string __$Revision$__ instead of __$Revision: 5.13 $__. This option is useful to ignore differences due to keyword substitution when comparing different revisions of a file. Log messages are inserted after __$Log$__ keywords even if __-kk__ is specified, since this tends to be more useful when merging changes. __-ko__ Generate the old keyword string, present in the working file just before it was checked in. For example, for the __Revision__ keyword, generate the string __$Revision: 1.1 $__ instead of __$Revision: 5.13 $__ if that is how the string appeared when the file was checked in. This can be useful for file formats that cannot tolerate any changes to substrings that happen to take the form of keyword strings. __-kb__ Generate a binary image of the old keyword string. This acts like __-ko__, except it performs all working file input and output in binary mode. This makes little difference on Posix and Unix hosts, but on DOS-like hosts one should use __rcs -i -kb__ to initialize an RCS file intended to be used for binary files. Also, on all hosts, rcsmerge(1) normally refuses to merge files when __-kb__ is in effect. __-kv__ Generate only keyword values for keyword strings. For example, for the __Revision__ keyword, generate the string __5.13__ instead of __$Revision: 5.13 $__. This can help generate files in programming languages where it is hard to strip keyword delimiters like __$Revision: $__ from a string. However, further keyword substitution cannot be performed once the keyword names are removed, so this option should be used with care. Because of this danger of losing keywords, this option cannot be combined with __-l__, and the owner write permission of the working file is turned off; to edit the file later, check it out again without __-kv__. __-p__[[''rev''] prints the retrieved revision on the standard output rather than storing it in the working file. This option is useful when __co__ is part of a pipe. __-q__[[''rev''] quiet mode; diagnostics are not printed. __-I__[[''rev''] interactive mode; the user is prompted and questioned even if the standard input is not a terminal. __-d__''date'' retrieves the latest revision on the selected branch whose checkin date/time is less than or equal to ''date''. The date and time can be given in free format. The time zone __LT__ stands for local time; other common time zone names are understood. For example, the following ''date''s are equivalent if local time is January 11, 1990, 8pm Pacific Standard Time, eight hours west of Coordinated Universal Time ( UTC ): __8:00 pm lt 4:00 AM, Jan. 12, 1990__ default is UTC __1990-01-12 04:00:00+00__ ISO 8601 (UTC) __1990-01-11 20:00:00-08__ ISO 8601 (local time) __1990/01/12 04:00:00__ traditional RCS format __Thu Jan 11 20:00:00 1990 LT__ output of ctime(3) + __LT Thu Jan 11 20:00:00 PST 1990__ output of date(1) __Fri Jan 12 04:00:00 GMT 1990 Thu, 11 Jan 1990 20:00:00 -0800__ Internet RFC 822 __12-January-1990, 04:00 WET __ Most fields in the date and time can be defaulted. The default time zone is normally UTC , but this can be overridden by the __-z__ option. The other defaults are determined in the order year, month, day, hour, minute, and second (most to least significant). At least one of these fields must be provided. For omitted fields that are of higher significance than the highest provided field, the time zone's current values are assumed. For all other omitted fields, the lowest possible values are assumed. For example, without __-z__, the date __20, 10:30__ defaults to 10:30:00 UTC of the 20th of the UTC time zone's current month and year. The date/time must be quoted if it contains spaces. __-M__[[''rev''] Set the modification time on the new working file to be the date of the retrieved revision. Use this option with care; it can confuse make(1). __-s__''state'' retrieves the latest revision on the selected branch whose state is set to ''state''. __-T__ Preserve the modification time on the RCS file even if the RCS file changes because a lock is added or removed. This option can suppress extensive recompilation caused by a make(1) dependency of some other copy of the working file on the RCS file. Use this option with care; it can suppress recompilation even when it is needed, i.e. when the change of lock would mean a change to keyword strings in the other working file. __-w__[[''login''] retrieves the latest revision on the selected branch which was checked in by the user with login name ''login''. If the argument ''login'' is omitted, the caller's login is assumed. __-j__''joinlist'' generates a new revision which is the join of the revisions on ''joinlist''. This option is largely obsoleted by rcsmerge(1) but is retained for backwards compatibility. The ''joinlist'' is a comma-separated list of pairs of the form ''rev2''__:__''rev3,'' where ''rev2'' and ''rev3'' are (symbolic or numeric) revision numbers. For the initial such pair, ''rev1'' denotes the revision selected by the above options __-f__, ..., __-w__. For all other pairs, ''rev1'' denotes the revision generated by the previous pair. (Thus, the output of one join becomes the input to the next.) For each pair, __co__ joins revisions ''rev1'' and ''rev3'' with respect to ''rev2''. This means that all changes that transform ''rev2'' into ''rev1'' are applied to a copy of ''rev3''. This is particularly useful if ''rev1'' and ''rev3'' are the ends of two branches that have ''rev2'' as a common ancestor. If ''rev1''''rev2''''rev3'' on the same branch, joining generates a new revision which is like ''rev3,'' but with all changes that lead from ''rev1'' to ''rev2'' undone. If changes from ''rev2'' to ''rev1'' overlap with changes from ''rev2'' to ''rev3,'' __co__ reports overlaps as described in merge(1). For the initial pair, ''rev2'' can be omitted. The default is the common ancestor. If any of the arguments indicate branches, the latest revisions on those branches are assumed. The options __-l__ and __-u__ lock or unlock ''rev1''. __-V__ Print RCS 's version number. __-V__''n'' Emulate RCS version ''n,'' where ''n'' can be __3__, __4__, or __5__. This can be useful when interchanging RCS files with others who are running older versions of RCS . To see which version of RCS your correspondents are running, have them invoke __rcs -V__; this works with newer versions of RCS . If it doesn't work, have them invoke __rlog__ on an RCS file; if none of the first few lines of output contain the string __branch:__ it is version 3; if the dates' years have just two digits, it is version 4; otherwise, it is version 5. An RCS file generated while emulating version 3 loses its default branch. An RCS revision generated while emulating version 4 or earlier has a time stamp that is off by up to 13 hours. A revision extracted while emulating version 4 or earlier contains abbreviated dates of the form ''yy''__/__''mm''__/__''dd'' and can also contain different white space and line prefixes in the substitution for __$Log$__. __-x__''suffixes'' Use ''suffixes'' to characterize RCS files. See ci(1) for details. __-z__''zone'' specifies the date output format in keyword substitution, and specifies the default time zone for ''date'' in the __-d__''date'' option. The ''zone'' should be empty, a numeric UTC offset, or the special string __LT__ for local time. The default is an empty ''zone'', which uses the traditional RCS format of UTC without any time zone indication and with slashes separating the parts of the date; otherwise, times are output in ISO 8601 format with time zone indication. For example, if local time is January 11, 1990, 8pm Pacific Standard Time, eight hours west of UTC , then the time is output as follows: ''option time output ''__-z 1990/01/12 04:00:00__ '' (default) ''__-zLT 1990-01-11 20:00:00-08 -z+05:30 1990-01-12 09:30:00+05:30 __ The __-z__ option does not affect dates stored in RCS files, which are always UTC . !!KEYWORD SUBSTITUTION Strings of the form __$__''keyword''__$__ and __$__''keyword''__:__''...''__$__ embedded in the text are replaced with strings of the form __$__''keyword''__:__''value''__$__ where ''keyword'' and ''value'' are pairs listed below. Keywords can be embedded in literal strings or comments to identify a revision. Initially, the user enters strings of the form __$__''keyword''__$__''.'' On checkout, __co__ replaces these strings with strings of the form __$__''keyword''__:__''value''__$__''.'' If a revision containing strings of the latter form is checked back in, the value fields will be replaced during the next checkout. Thus, the keyword values are automatically updated on checkout. This automatic substitution can be modified by the __-k__ options. Keywords and their corresponding values: __$Author$__ The login name of the user who checked in the revision. __$Date$__ The date and time the revision was checked in. With __-z__''zone'' a numeric time zone offset is appended; otherwise, the date is UTC . __$Header$__ A standard header containing the full pathname of the RCS file, the revision number, the date and time, the author, the state, and the locker (if locked). With __-z__''zone'' a numeric time zone offset is appended to the date; otherwise, the date is UTC . __$Id$__ Same as __$Header$__, except that the RCS filename is without a path. __$Locker$__ The login name of the user who locked the revision (empty if not locked). __$Log$__ The log message supplied during checkin, preceded by a header containing the RCS filename, the revision number, the author, and the date and time. With __-z__''zone'' a numeric time zone offset is appended; otherwise, the date is UTC . Existing log messages are ''not'' replaced. Instead, the new log message is inserted after __$Log:__...__$__. This is useful for accumulating a complete change log in a source file. Each inserted line is prefixed by the string that prefixes the __$Log$__ line. For example, if the __$Log$__ line is ``__// $Log: tan.cc $__'', RCS prefixes each line of the log with ``__//__ ''. This is useful for languages with comments that go to the end of the line. The convention for other languages is to use a `` '' prefix inside a multiline comment. For example, the initial log comment of a C program conventionally is of the following form: __/ $Log$ / __ For backwards compatibility with older versions of RCS , if the log prefix is __/__ or __(__ surrounded by optional white space, inserted log lines contain a space instead of __/__ or __(__; however, this usage is obsolescent and should not be relied on. __$Name$__ The symbolic name used to check out the revision, if any. For example, __co -rJoe__ generates __$Name: Joe $__. Plain __co__ generates just __$Name: $__. __$RCSfile$__ The name of the RCS file without a path. __$Revision$__ The revision number assigned to the revision. __$Source$__ The full pathname of the RCS file. __$State$__ The state assigned to the revision with the __-s__ option of rcs(1) or ci(1). The following characters in keyword values are represented by escape sequences to keep keyword strings well-formed. ''char escape sequence ''tab __ t __newline __ n __space __ 040 $ 044 \ \ __ !!FILE MODES The working file inherits the read and execute permissions from the RCS file. In addition, the owner write permission is turned on, unless __-kv__ is set or the file is checked out unlocked and locking is set to strict (see rcs(1)). If a file with the name of the working file exists already and has write permission, __co__ aborts the checkout, asking beforehand if possible. If the existing working file is not writable or __-f__ is given, the working file is deleted without asking. !!FILES __co__ accesses files much as ci(1) does, except that it does not need to read the working file unless a revision number of __$__ is specified. !!ENVIRONMENT __RCSINIT__ options prepended to the argument list, separated by spaces. See ci(1) for details. !!DIAGNOSTICS The RCS pathname, the working pathname, and the revision number retrieved are written to the diagnostic output. The exit status is zero if and only if all operations were successful. !!IDENTIFICATION Author: Walter F. Tichy. Manual Page Revision: 5.13; Release Date: 1995/06/01. Copyright 1982, 1988, 1989 Walter F. Tichy. Copyright 1990, 1991, 1992, 1993, 1994, 1995 Paul Eggert. !!SEE ALSO rcsintro(1), ci(1), ctime(3), date(1), ident(1), make(1), rcs(1), rcsclean(1), rcsdiff(1), rcsmerge(1), rlog(1), rcsfile(5) Walter F. Tichy, RCS --A System for Version Control, ''Software--Practice '' __15__, 7 (July 1985), 637-654. !!LIMITS Links to the RCS and working files are not preserved. There is no way to selectively suppress the expansion of keywords, except by writing them differently. In nroff and troff, this is done by embedding the null-character ____ into the keyword. ----
12 pages link to
co(1)
:
merge(1)
rcsmerge(1)
Man1c
ci(1)
ident(1)
rcs(1)
rcsclean(1)
rcsdiff(1)
rcsfile(5)
rcsfreeze(1)
rcsintro(1)
rlog(1)
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
