summaryrefslogtreecommitdiff
path: root/usr.bin/cvs/cvs.1
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2006-04-19 11:00:54 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2006-04-19 11:00:54 +0000
commitf4c6d7b77be48a9e4942a16fc342916c742880bc (patch)
treed13c0de75ef3e85ffde4852d007cf52896a159bb /usr.bin/cvs/cvs.1
parent08fc13aa23cdb4361120c278a2b68cadf4452306 (diff)
move the keyword substitution section from cvs(1) to rcs(1):
this keeps the docs correct, and according to xsa is the correct place for it anyway... ok xsa niallo
Diffstat (limited to 'usr.bin/cvs/cvs.1')
-rw-r--r--usr.bin/cvs/cvs.1120
1 files changed, 8 insertions, 112 deletions
diff --git a/usr.bin/cvs/cvs.1 b/usr.bin/cvs/cvs.1
index 200b8ed0cda..5bd948329a4 100644
--- a/usr.bin/cvs/cvs.1
+++ b/usr.bin/cvs/cvs.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: cvs.1,v 1.95 2006/02/10 14:58:46 xsa Exp $
+.\" $OpenBSD: cvs.1,v 1.96 2006/04/19 11:00:53 jmc Exp $
.\"
.\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
.\" Copyright (c) 2004-2006 Xavier Santolaria <xsa@openbsd.org>
@@ -71,6 +71,13 @@ See
.Xr cvsrc 5
for further information.
.Pp
+.Nm
+also supports
+keyword substitution \(en
+see the
+.Xr rcs 1
+man page for more information.
+.Pp
The following options are supported:
.Bl -tag -width Ds
.It Fl d Ar root
@@ -130,117 +137,6 @@ with 1 being the fastest,
and 9 providing the best level of compression.
The default is 6.
.El
-.Sh KEYWORD SUBSTITUTION
-As long as you edit source files inside a working directory you
-can always find out the state of your files via the
-.Ic status
-or
-.Ic log
-commands, but as soon as files get exported from
-your local working copy, it becomes harder to identify which
-revisions they are.
-.Pp
-.Nm
-can use a mechanism known as
-.Sq keyword substitution
-to help identify the files.
-Embedded strings of the form $keyword$ and $keyword:...$ in a file
-are replaced with strings of the form $keyword: value$ whenever you
-obtain a new revision of the file.
-The possible keywords are as follows:
-.Bl -tag -width Ds
-.It $\&Author$
-The name of the user who checked in the revision.
-.It $\&Date$
-The date and hour (UTC) the revision was checked in.
-.It $\&Header$
-Standard header containing the full pathname of the RCS
-file, the revision number, the date (UTC), the author and the state.
-.It $\&Id$
-The same content as $\&Header$ but without the path
-of the RCS file.
-.It $\&Log$
-The log message supplied during commit, preceded by a header
-containing the RCS filename, the revision number, the
-author, and the date (UTC).
-.It $\&Name$
-The tag name used to check out the file.
-.It $\&RCSfile$
-The name of the RCS file, but without a path.
-.It $\&Revision$
-The revision number assigned to the revision.
-.It $\&Source$
-The full pathname of the RCS file.
-.It $\&State$
-The state assigned to the revision.
-.El
-.Pp
-Keyword substitution has its disadvantages: sometimes the
-literal text string $\&Author$ is wanted inside a file without
-.Nm
-interpreting it as a keyword and expanding it into something like
-$\&Author$.
-The
-.Fl k Ar o
-option can be used to turn off keyword substitution entirely though.
-There is unfortunately no way to selectively turn off keyword substitution.
-.Pp
-Each file and working directory copy of a file have a stored
-default substitution mode.
-Substitution modes on files are set by the
-.Fl k Ar mode
-option to the
-.Ic add
-and
-.Ic admin
-commands or by the
-.Fl k Ar mode
-or
-.Fl A
-options to the
-.Ic checkout
-or
-.Ic update
-commands.
-.Pp
-The possible substitution modes are as follows:
-.Bl -tag -width Ds -offset 3n
-.It Fl k Ar b
-Like
-.Fl k Ar o ,
-but also avoids the conversion of line endings.
-This option is used to handle binary files.
-.It Fl k Ar k
-Does not substitute the keywords.
-Useful with the
-.Ic diff
-command to avoid displaying the differences between keyword substitutions.
-.It Fl k Ar kv
-The default behaviour.
-Keywords are normally substituted i.e. $\&Revision$ becomes
-$\&Revision: 1.1 $.
-.It Fl k Ar kvl
-Like
-.Fl k Ar kv ,
-except that the locker's name is displayed along with the version
-if the given revision is currently locked.
-This option is normally not useful as
-.Nm
-does not use file locking by default.
-.It Fl k Ar o
-No substitutions are done.
-This option is often used with the
-.Ic import
-command to guarantee that files that already contain external keywords
-do not get modified.
-.It Fl k Ar v
-Substitute the value of keywords instead of keywords themselves
-e.g. instead of $\&Revision$, only insert 1.1 and not $\&Revision: 1.1 $.
-This option must be used with care, as it can only be used once.
-It is often used with the
-.Ic export
-command to freeze the values before releasing software.
-.El
.Sh COMMANDS
.Nm
supports the following commands: