Sync usage with man page.
[netbsd-mini2440.git] / gnu / usr.bin / rcs / rcsdiff / rcsdiff.1
blob0dc1c6d15249b1a97cf1c99379353a4504243072
1 .\"     $NetBSD: rcsdiff.1,v 1.4 1996/10/15 07:00:39 veego Exp $
2 .\"
3 .de Id
4 .ds Rv \\$3
5 .ds Dt \\$4
6 ..
7 .Id Id: rcsdiff.1,v 5.5 1993/11/03 17:42:27 eggert Exp
8 .ds r \&\s-1RCS\s0
9 .if n .ds - \%--
10 .if t .ds - \(em
11 .TH RCSDIFF 1 \*(Dt GNU
12 .SH NAME
13 rcsdiff \- compare RCS revisions
14 .SH SYNOPSIS
15 .B rcsdiff
17 .BI \-k subst
18 ] [
19 .B \-q
20 ] [
21 .BI \-r rev1
23 .BI \-r rev2
24 ] ] [
25 .B \-T
26 ] [
27 .RI "\f3\-V\fP[" n ]
28 ] [
29 .BI \-x suffixes
30 ] [
31 .BI \-z zone
32 ] [
33 .I "diff options"
35 .I "file .\|.\|."
36 .SH DESCRIPTION
37 .B rcsdiff
38 runs
39 .BR diff (1)
40 to compare two revisions of each \*r file given.
41 .PP
42 Pathnames matching an \*r suffix denote \*r files;
43 all others denote working files.
44 Names are paired as explained in
45 .BR ci (1).
46 .PP
47 The option
48 .B \-q
49 suppresses diagnostic output.
50 Zero, one, or two revisions may be specified with
51 .BR \-r .
52 The option
53 .BI \-k subst
54 affects keyword substitution when extracting
55 revisions, as described in
56 .BR co (1);
57 for example,
58 .B "\-kk\ \-r1.1\ \-r1.2"
59 ignores differences in keyword values when comparing revisions
60 .B 1.1
61 and
62 .BR 1.2 .
63 To avoid excess output from locker name substitution,
64 .B \-kkvl
65 is assumed if (1) at most one revision option is given,
66 (2) no
67 .B \-k
68 option is given, (3)
69 .B \-kkv
70 is the default keyword substitution, and
71 (4) the working file's mode would be produced by
72 .BR "co\ \-l".
73 See
74 .BR co (1)
75 for details
76 about
77 .BR \-T ,
78 .BR \-V ,
79 .B \-x
80 and
81 .BR \-z .
82 Otherwise, all options of
83 .BR diff (1)
84 that apply to regular files are accepted, with the same meaning as for
85 .BR diff .
86 .PP
87 If both
88 .I rev1
89 and
90 .I rev2
91 are omitted,
92 .B rcsdiff
93 compares the latest revision on the
94 default branch (by default the trunk)
95 with the contents of the corresponding working file.  This is useful
96 for determining what you changed since the last checkin.
97 .PP
99 .I rev1
100 is given, but
101 .I rev2
102 is omitted,
103 .B rcsdiff
104 compares revision
105 .I rev1
106 of the \*r file with
107 the contents of the corresponding working file.
109 If both
110 .I rev1
112 .I rev2
113 are given,
114 .B rcsdiff
115 compares revisions
116 .I rev1
118 .I rev2
119 of the \*r file.
121 Both
122 .I rev1
124 .I rev2
125 may be given numerically or symbolically.
126 .SH EXAMPLE
127 The command
129 .B "        rcsdiff  f.c"
131 compares the latest revision on the default branch of the \*r file
132 to the contents of the working file
133 .BR f.c .
134 .SH ENVIRONMENT
136 .B \s-1RCSINIT\s0
137 options prepended to the argument list, separated by spaces.
139 .BR ci (1)
140 for details.
141 .SH DIAGNOSTICS
142 Exit status is 0 for no differences during any comparison,
143 1 for some differences, 2 for trouble.
144 .SH IDENTIFICATION
145 Author: Walter F. Tichy.
147 Manual Page Revision: \*(Rv; Release Date: \*(Dt.
149 Copyright \(co 1982, 1988, 1989 Walter F. Tichy.
151 Copyright \(co 1990, 1991, 1992, 1993 Paul Eggert.
152 .SH "SEE ALSO"
153 ci(1), co(1), diff(1), ident(1), rcs(1), rcsintro(1), rcsmerge(1), rlog(1)
155 Walter F. Tichy,
156 \*r\*-A System for Version Control,
157 .I "Software\*-Practice \*[Am] Experience"
158 .BR 15 ,
159 7 (July 1985), 637-654.