Annotation of 43BSD/contrib/rcs/man/rcs.1, revision 1.1.1.1

1.1       root        1: .TH RCS 1 6/29/83 "Purdue University"
                      2: .SH NAME
                      3: rcs \- change RCS file attributes
                      4: .SH SYNOPSIS
                      5: .B rcs
                      6: [ options ]
                      7: file ... 
                      8: .SH DESCRIPTION
                      9: .I Rcs
                     10: creates new RCS files or changes attributes of existing ones.
                     11: An RCS file contains multiple revisions of text,
                     12: an access list, a change log, 
                     13: descriptive text,
                     14: and some control attributes.
                     15: For \fIrcs\fR to work, the caller's login name must be on the access list,
                     16: except if the access list is empty, the caller is the owner of the file
                     17: or the superuser, or
                     18: the \fB-i\fR option is present. 
                     19: .PP
                     20: Files ending in `,v' are RCS files, all others are working files. If
                     21: a working file is given, \fIrcs\fR tries to find the corresponding
                     22: RCS file first in directory ./RCS and then in the current directory,
                     23: as explained in \fIco\fR (1).
                     24: .TP 11
                     25: .B \-i
                     26: creates and initializes a new RCS file, but does not deposit any revision.
                     27: If the RCS file has no path prefix, \fIrcs\fR tries to place it
                     28: first into the subdirectory ./RCS, and then into the current directory.
                     29: If the RCS file
                     30: already exists, an error message is printed.
                     31: .TP
                     32: .BI \-a "logins"
                     33: appends the login names appearing in the comma-separated list \fIlogins\fR
                     34: to the access list of the RCS file.
                     35: .TP
                     36: .BI \-A "oldfile"
                     37: appends the access list of \fIoldfile\fR to the access list of the RCS file. 
                     38: .TP
                     39: .B \-e\fR[\fIlogins\fR]
                     40: erases the login names appearing in the comma-separated list \fIlogins\fR
                     41: from the access list of the RCS file.
                     42: If \fIlogins\fR is omitted, the entire access list is erased.
                     43: .TP
                     44: .BI \-c "string"
                     45: sets the comment leader to \fIstring\fR. The comment leader
                     46: is printed before every log message line generated by the keyword 
                     47: $\&Log$  during checkout (see \fIco\fR). This is useful for programming 
                     48: languages without multi-line comments. During \fIrcs -i\fR or initial 
                     49: \fIci\fR, the comment leader is guessed from the suffix of the working file. 
                     50: .TP
                     51: .B \-l\fR[\fIrev\fR]
                     52: locks the revision with number \fIrev\fR.
                     53: If a branch is given, the latest revision on that branch is locked.
                     54: If \fIrev\fR is omitted, the latest revision on the trunk is locked.
                     55: Locking prevents overlapping changes.
                     56: A lock is removed with \fIci\fR or \fIrcs -u\fR (see below).
                     57: .TP
                     58: .B \-u\fR[\fIrev\fR]
                     59: unlocks the revision with number \fIrev\fR.
                     60: If a branch is given, the latest revision on that branch is unlocked.
                     61: If \fIrev\fR is omitted, the latest lock held by the caller is removed.
                     62: Normally, only the locker of a revision may unlock it.
                     63: Somebody else unlocking a revision breaks the lock. 
                     64: This causes a mail message to be sent to the original locker.
                     65: The message contains a commentary solicited from the breaker.
                     66: The commentary is terminated with a line containing a single `.' or
                     67: control-D.
                     68: .TP
                     69: .B \-L
                     70: sets locking to \fIstrict\fR. Strict locking means that the owner
                     71: of an RCS file is not exempt from locking for checkin.
                     72: This option should be used for files that are shared.
                     73: .TP
                     74: .B \-U
                     75: sets locking to non-strict. Non-strict locking means that the owner of
                     76: a file need not lock a revision for checkin. 
                     77: This option should NOT be used for files that are shared.
                     78: The default (\fB-L\fR or \fB-U\fR) is determined by your system administrator.
                     79: .TP
                     80: .B \-n\fIname\fR[:\fIrev\fR]
                     81: associates the symbolic name \fIname\fR with the branch or
                     82: revision \fIrev\fR. 
                     83: \fIRcs\fR prints an error message if \fIname\fR is already associated with
                     84: another number.
                     85: If \fIrev\fR is omitted, the symbolic name is deleted.
                     86: .TP
                     87: .B \-N\fIname\fR[:\fIrev\fR]
                     88: same as \fB-n\fR, except that it overrides a previous assignment of 
                     89: \fIname\fR.
                     90: .TP
                     91: .BI \-o "range"
                     92: deletes ("outdates") the revisions given by \fIrange\fR.
                     93: A range consisting of a single revision number means that revision.
                     94: A range consisting of a branch number means the latest revision on that
                     95: branch.
                     96: A range of the form \fIrev1\-rev2\fR means 
                     97: revisions \fIrev1\fR to \fIrev2\fR on the same branch, 
                     98: \fI\-rev\fR means from the beginning of the branch containing
                     99: \fIrev\fR up to and including \fIrev\fR, and \fIrev\-\fR means
                    100: from revision \fIrev\fR to the end of the branch containing \fIrev\fR.
                    101: None of the outdated revisions may have branches or locks.
                    102: .TP
                    103: .B \-q
                    104: quiet mode; diagnostics are not printed.
                    105: .TP
                    106: .B \-s\fIstate\fR[:\fIrev\fR]
                    107: sets the state attribute of the revision \fIrev\fR to \fIstate\fR. 
                    108: If \fIrev\fR is omitted, the latest revision on the trunk is assumed;
                    109: If \fIrev\fR is a branch number, the latest revision on that branch is
                    110: assumed.
                    111: Any identifier is acceptable for \fIstate\fR.
                    112: A useful set of states
                    113: is \fIExp\fR (for experimental), \fIStab\fR (for stable), and \fIRel\fR (for
                    114: released).
                    115: By default, \fIci\fR sets the state of a revision to \fIExp\fR.
                    116: .TP
                    117: .B \-t\fR[\fItxtfile\fR]
                    118: writes descriptive text into the RCS file (deletes the existing text).
                    119: If \fItxtfile\fR is omitted, 
                    120: \fIrcs\fR prompts the user for text supplied from the std. input,
                    121: terminated with a line containing a single `.' or control-D.
                    122: Otherwise, the descriptive text is copied from the file \fItxtfile\fR.
                    123: If the \fB-i\fR option is present, descriptive text is requested
                    124: even if \fB-t\fR is not given.
                    125: The prompt is suppressed if the std. input is not a terminal.
                    126: .SH DIAGNOSTICS
                    127: The RCS file name and the revisions outdated are written to
                    128: the diagnostic output.
                    129: The exit status always refers to the last RCS file operated upon,
                    130: and is 0 if the operation was successful, 1 otherwise.
                    131: .SH FILES
                    132: The caller of the command
                    133: must have read/write permission for the directory containing
                    134: the RCS file and read permission for the RCS file itself.
                    135: .I Rcs
                    136: creates a semaphore file in the same directory as the RCS
                    137: file to prevent simultaneous update.
                    138: For changes, \fIrcs\fR always creates a new file. On successful completion,
                    139: \fIrcs\fR deletes the old one and renames the new one.
                    140: This strategy makes links to RCS files useless.
                    141: .SH IDENTIFICATION
                    142: .de VL
                    143: \\$2
                    144: ..
                    145: Author: Walter F. Tichy,
                    146: Purdue University, West Lafayette, IN, 47907.
                    147: .sp 0
                    148: Revision Number:
                    149: .VL $Revision: 3.1 $
                    150: ; Release Date:
                    151: .VL $Date: 83/04/04 15:58:23 $
                    152: \&.
                    153: .sp 0
                    154: Copyright \(co 1982 by Walter F. Tichy.
                    155: .SH SEE ALSO
                    156: co (1), ci (1), ident(1), rcsdiff (1), rcsintro (1), rcsmerge (1), rlog (1), rcsfile (5), sccstorcs (8).
                    157: .sp 0
                    158: Walter F. Tichy, "Design, Implementation, and Evaluation of a Revision Control
                    159: System," in \fIProceedings of the 6th International Conference on Software
                    160: Engineering\fR, IEEE, Tokyo, Sept. 1982.
                    161: .SH BUGS
                    162: 
                    163: 
                    164: 
                    165: 

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.