1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
|
.\" $OpenBSD: cvs.1,v 1.68 2005/06/09 08:38:03 joris Exp $
.\"
.\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
.\" Copyright (c) 2004, 2005 Xavier Santolaria <xsa@openbsd.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
.\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd May 16, 2004
.Dt CVS 1
.Os
.Sh NAME
.Nm cvs
.Nd OpenCVS Concurrent Versioning System
.Sh SYNOPSIS
.Nm
.Op Fl flQqtv
.Op Fl d Ar root
.Op Fl e Ar editor
.Xo
.Oo Fl s
.Ar var Ns = Ns Ar val Oc
.Xc
.Op Fl z Ar level
.Ar command Op Ar ...
.Sh DESCRIPTION
The
.Nm
program acts as both client and server for the use of and administration of
a CVS source repository.
CVS is used to maintain version information on files that are kept in a
repository.
Although it is more commonly used to track changes in source code, there
are no real limitations to the type of files that you can store in a
repository.
For a general introduction to CVS, see
.Xr cvsintro 7 .
.Pp
.Nm
reads its startup configuration file,
.Pa .cvsrc ,
from the home directory of the user who invoked it.
This file is used to specify implicit options passed to
.Nm
or one of its commands whenever it is invoked.
The defaults in the configuration file can be overridden with the
.Fl f
option (see below).
See
.Xr cvsrc 5
for further information.
.Pp
The following options are supported:
.Bl -tag -width Ds
.It Fl d Ar root
Use
.Ar root
as the path to the root directory of the CVS repository.
The value must specify an absolute path.
.It Fl e Ar editor
Use the program
.Ar editor
whenever editing log information.
This option overrides the environment variables CVSEDITOR, VISUAL, and EDITOR.
.It Fl f
Do not read the user's configuration file on startup.
.It Fl l
Suppress logging of history information.
.It Fl n
Dry-run mode.
Show which files will be used by the command issued
without really running it.
.It Fl Q
Be extra quiet.
Only error messages will be displayed.
.It Fl q
Be quiet about reporting.
.It Fl s Ar var Ns = Ns Ar val
Set the value of the internal variable
.Ar var
to the string
.Ar val .
.It Fl t
Trace program execution.
.It Fl v
Display version information and exit.
.It Fl z Ar level
Specify the compression level to
.Xr gzip 1
when transferring files.
The compression level ranges from 1 to 9,
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
The following commands are supported by
.Nm :
.Bl -tag -width Ds
.It Xo Ic add
.Op Fl k Ar mode
.Op Fl m Ar msg
.Ar file ...
.Xc
Before a file is known to
.Nm ,
it must be added to the repository using this command.
Adding a file does not actually publish the contents of the
file: the
.Ic commit
command must also be used to publish it into the repository,
and thus let others access the file.
.Pp
Note: since directories have no versioning system, it is sufficient
to add them with the
.Ic add
command alone; the
.Ic commit
command is not necessary.
.Pp
The
.Ic add
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl k Ar mode
Specify the keyword substitution mode.
.It Fl m Ar msg
Attach log message
.Ar msg .
By default, no log message is required.
.El
.Pp
Aliases:
.Ic ad ,
.Ic new .
.It Xo Ic admin
.Op Fl Iq
.Op Fl b Ar branch
.Op Fl k Ar mode
.Op Fl m Ar rev : Ns Ar msg
.Oo Fl N Ar tag Ns
.Op : Ns Ar rev Oc
.Oo Fl n Ar tag Ns
.Op : Ns Ar rev Oc
.Op Fl o Ar rev
.Oo Fl s Ar state Ns
.Op : Ns Ar rev Oc
.Oo Fl t Ar file \*(Ba
.Ar str Oc
.Xc
The
.Ic admin
command is used to directly modify the RCS files.
.Pp
The
.Ic admin
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl b Ar branch
Set the default branch to
.Ar branch .
.It Fl I
Command is interactive.
.It Fl k
Specify the keyword substitution mode.
.It Fl m Ar rev : Ns Ar msg
Change the log message of a revision.
.It Xo Fl N
.Ar tag Ns Op : Ns Ar rev
.Xc
Same as
.Fl n ,
but override tag if it already exists.
.It Xo Fl n
.Ar tag Ns Op : Ns Ar rev
.Xc
Associate the
.Ar tag
with the
.Ar rev
or the branch given as argument.
If the revision or the branch is not specified, the tag is deleted.
The
.Sq \&:
character means the association of the tag and the latest revision of
the default branch.
A branch number ending with the
.Sq \&.
character means the current latest revision in the branch.
This option is functionally the same as the
.Ic rtag
command, but it avoids the check of the tags done with the
.Pa CVSROOT/taginfo
file.
.It Fl o Ar rev
Delete one or more revisions.
The specifications of the values or revisions are as follows:
.Bl -tag -width Ds
.It rev
Specific revision.
.It rev1:rev2
Delete all revisions of a branch between
.Ar rev1
and
.Ar rev2 .
.It rev1::rev2
Delete all revisions of a branch between
.Ar rev1
and
.Ar rev2
without deleting revisions
.Ar rev1
and
.Ar rev2 .
.It :rev
Delete all revisions of the branch until revision
.Ar rev .
.It rev:
Delete all revisions of the branch from revision
.Ar rev
until the last revision of the branch.
.El
.It Fl q
Quiet mode.
.It Xo Fl s
.Ar state Ns Op : Ns Ar rev
.Xc
Change state of a revision.
If the revision is not specified, the last revision of the default
branch changes state.
The
.Ic state
is a string of characters of your choice.
The state of a revision can be modified without having to
.Ic commit
a new revision.
The default
.Ic state
is
.Sq Exp
(Experimental).
For instance, you could also use
.Sq Dev
or
.Sq Reviewed .
.It Fl t Ar file \*(Ba Ar str
Change the descriptive text.
The descriptive text is taken from the
.Ar file
specified as argument or from the string
.Ar str
given as argument if it is preceded by the
.Sq -
character.
If no argument is used, the descriptive text is taken from standard input.
.El
.Pp
Aliases:
.Ic adm ,
.Ic rcs .
.It Xo Ic annotate
.Op Fl flR
.Oo Fl D Ar date \*(Ba
.Fl r Ar rev Oc
.Op Ar file ...
.Xc
For each line of any files specified, show information about its
last revision.
The information given is the last revision when a modification occurred,
the author's name, and the date of the revision.
.Pp
The
.Ic annotate
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl D Ar date
Show the annotations as of the latest revision no later than
.Ar date .
.It Fl f
Force the use of the head revision if the specified
tag or date is not found.
This can be used in combination with
.Fl D
or
.Fl r
to ensure that there is some output from the
.Ic annotate
command, even if only to show Revision 1.1 of the file.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.It Fl r Ar rev
Show annotations as of revision
.Ar rev
(can be a revision number or a tag).
.El
.Pp
Aliases:
.Ic ann ,
.Ic blame .
.It Xo Ic checkout
.Op Fl AcflNnPpRs
.Op Fl d Ar dir
.Op Fl j Ar rev
.Op Fl k Ar mode
.Fl D Ar date \*(Ba
.Fl r Ar rev
.Ar module ...
.Xc
.Pp
The
.Ic checkout
command is used to create a local copy of one or more modules present on the
target CVS repository.
.Pp
The
.Ic checkout
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl A
Reset any sticky tags, dates, or keyword substitution modes that
have been set on the tree.
.It Fl c
Display the list of available modules.
.It Fl D Ar date
Check out as of the latest revision no later than
.Ar date
(is sticky).
.It Fl d Ar dir
Check out in directory
.Ar dir
instead of the directory bearing the same name as the
.Ar module .
.It Fl f
Force the use of the head revision if the specified
tag or date is not found.
.It Fl j Ar rev
Merge in changes made between current revision and
.Ar rev .
If two
.Fl j
options are specified, only merge the differences between the two
revisions of the branch.
This allows successive merges without having to resolve
already resolved conflicts again.
.It Fl k Ar mode
Specify the keyword substitution mode (is sticky).
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl N
If used in conjunction with the
.Fl d
option, files are placed in local directory
.Ar module ,
located in directory
.Ar dir .
.It Fl n
Do not execute programs listed in the
.Pa CVSROOT/modules
file.
.It Fl P
Prune empty directories.
.It Fl p
Check out files to standard output (avoids stickiness).
.It Fl R
Enable recursive behaviour.
This is the default.
.It Fl r Ar rev
Check out from a particular revision or branch (implies
.Fl P )
(is sticky).
.It Fl s
Like
.Fl c ,
but include module status.
.El
.Pp
Aliases:
.Ic co ,
.Ic get .
.It Xo Ic commit
.Op Fl flnR
.Oo Fl F Ar logfile \*(Ba
.Fl m Ar msg Oc
.Op Fl r Ar rev
.Op Ar file ...
.Xc
.Pp
The
.Ic commit
command is used to send local changes back to the server and update the
repository's information to reflect the changes.
.Pp
The
.Ic commit
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl F Ar logfile
Specify a
.Ar file
which contains the log message.
.It Fl f
Force a file to be committed, even though it is unchanged.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl m Ar msg
Specify a log message on the command line (suppresses the editor invocation).
.It Fl n
Do not execute programs listed in the
.Pa CVSROOT/modules
file.
.It Fl R
Enable recursive behaviour.
This is the default.
.It Fl r Ar rev
Commit to a particular symbolic or numerical revision.
.El
.Pp
Aliases:
.Ic ci ,
.Ic com .
.It Xo Ic diff
.Op Fl cilNnpRu
.Oo Oo Fl D
.Ar date1 \*(Ba
.Fl r Ar rev1 Oc
.Oo Fl D Ar date2 \*(Ba
.Fl r Ar rev2 Oc Oc
.Op Fl k Ar mode
.Op Ar file ...
.Xc
.Pp
The
.Ic diff
command is very similar to the
.Xr diff 1
program, except that the differential comparisons that it generates are
between local or remote revisions of files stored in the CVS repository.
.Pp
The
.Ic diff
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl c
Produces a diff with three lines of context.
See
.Xr diff 1
for more information.
.It Xo Fl D Ar date1
.Op Fl D Ar date2
.Xc
Differences between the revision at
.Ar date1
and the working copy or
.Ar date1
and
.Ar date2
(if specified).
.It Fl i
Ignore the case of letters.
For example,
.Sq A
will compare equal to
.Sq a .
.It Fl k Ar mode
Specify the keyword substitution mode.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl N
Include added or removed files.
.It Fl n
Produces a diff in the same format as that used by
.Xr rcsdiff 1 ,
with a count of changed lines on each insert or delete command.
.It Fl p
With unified and context diffs, show with each change the first
40 characters of the last line before the context beginning with
a letter, an underscore or a dollar sign.
See
.Xr diff 1
for more information.
.It Fl R
Enable recursive behaviour.
This is the default.
.It Xo Fl r Ar rev1
.Op Fl r Ar rev2
.Xc
Differences between revision
.Ar rev1
and the working copy or
.Ar rev1
and
.Ar rev2
(if specified).
.It Fl u
Produces a unified diff with three lines of context.
See
.Xr diff 1
for more information.
.El
.Pp
Aliases:
.Ic di ,
.Ic dif .
.It Xo Ic edit Op Fl lR
.Op Fl a Ar action
.Op Ar file ...
.Xc
.Pp
The
.Ic edit
command is used to make a file that is being watched
(and therefore read-only)
readable and writable and to inform others that you are planning to edit it.
Notifications terminate when the
.Ic commit
command is issued.
Editing rights on the file can be given up using the
.Ic unedit
command, which terminates the temporary notifications.
.Pp
The
.Ic edit
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl a Ar action
Specify the temporary notification wanted:
.Pp
.Bl -tag -width Ds -compact
.It Cm commit
Another user has committed changes to the file.
.It Cm edit
Another user has issued the
.Ic edit
command on the file.
.It Cm unedit
Another user has issued the
.Ic unedit
command on the file.
.It Cm all
All of the above.
.It Cm none
None of the above.
.El
.Pp
The
.Fl a
flag may appear more than once, or not at all.
If omitted, the action defaults to
.Cm all .
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.El
.It Xo Ic editors
.Op Fl lR
.Op Ar file ...
.Xc
.Pp
The
.Ic editors
command lists the users with edition rights on a file.
For that, pseudo-lock mode must be enabled (see the
.Ic watch
command).
The e-mail address of the user editing the file, the timestamp
when the edition first started, the host from where the edition
has been requested and the path to the edited file are listed.
.Pp
The
.Ic editors
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.El
.It Xo Ic export
.Op Fl flNnR
.Op Fl d Ar dir
.Op Fl k Ar mode
.Fl D Ar date \*(Ba
.Fl r Ar rev
.Ar module ...
.Xc
.Pp
The
.Ic export
command extracts a copy of
.Ar module
without including the directories used for management by
.Nm .
This eases production of a software release.
A date or a revision must be specified for the command to be valid,
which ensures that later extractions can be reproduced with the same
options as the release.
.Pp
The checked out module's files will be placed in a directory
bearing the same name as the checked out module, by default.
.Pp
The
.Ic export
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl D Ar date
Export as of the latest revision no later than
.Ar date .
.It Fl d Ar dir
Export in directory
.Ar dir
instead of the directory bearing the same name as the
.Ar module .
.It Fl f
Force the use of the head revision if the specified
tag or date is not found.
This can be used in combination with
.Fl D
or
.Fl r
to ensure that the
.Ic export
command is valid.
.It Fl k Ar mode
Specify the keyword substitution mode: the
.Fl k Ar v
option is often used to avoid substitution of keywords during
a release cycle.
However, be aware that it does not handle an export containing
binary files correctly.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl N
If used in conjunction with the
.Fl d
option, files are placed in local directory
.Ar module ,
located in directory
.Ar dir .
.It Fl n
Do not execute programs listed in the
.Pa CVSROOT/modules
file.
.It Fl R
Enable recursive behaviour.
This is the default.
.It Fl r Ar rev
Export from a particular symbolic or numerical revision.
.El
.Pp
Aliases:
.Ic ex ,
.Ic exp .
.It Xo Ic history
.Op Fl aceloTw
.Op Fl b Ar str
.Op Fl D Ar date
.Op Fl f Ar file
.Op Fl m Ar module
.Op Fl n Ar module
.Op Fl p Ar path
.Op Fl r Ar rev
.Op Fl t Ar tag
.Op Fl u Ar user
.Op Fl x Ar ACEFGMORTUW
.Op Fl z Ar tz
.Op Ar file ...
.Xc
.Pp
The
.Ic history
command is used to display the history of actions done in the
base repository.
This functionality is only available if the
.Pa CVSROOT/history
file has been created.
Only the
.Ic checkout ,
.Ic commit ,
.Ic export ,
.Ic release ,
.Ic rtag ,
and
.Ic update
commands are logged into this file.
.Pp
The
.Ic history
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl a
Display records for all users.
By default, only records from the user issuing the
.Ic history
command are displayed.
.It Fl b Ar str
Display everything back to a record containing the string
.Ar str
in either the module name, the file name, or the repository path.
.It Fl c
Display the archived files
.Pf ( Ic commit
command).
.It Fl D Ar date
Report no later than
.Ar date .
.It Fl e
Select all records (same as
.Fl x
with all types).
.It Fl f Ar file
Display records related to
.Ar file .
.It Fl l
Show last checkouts of modules with the
.Ic checkout
command.
.It Fl m Ar module
Look for the
.Ar module
(can be used several times).
.It Fl n Ar module
Search into the
.Ar module .
.It Fl o
Report on modules checked out by users.
.It Fl p Ar path
Display records from the base repository being in the directory
specified by the
.Ar path .
.It Fl r Ar rev
Report for a particular revision (checks in the RCS file).
.It Fl t Ar tag
Report since tag record placed in the
.Pa CVSROOT/history
file by any user.
.It Fl T
Report on all tags.
.It Fl u Ar user
Report for a specified
.Ar user .
Can be used several times to match many users.
.It Fl w
Check that records match the current working directory.
.It Fl x Ar ACEFGMORTUW
Extract by a specific record type specified by a single letter.
They can be used in combination.
The available types are as follows:
.Bl -tag -width Ds
.It A
A file has been added with the
.Ic add
command.
.It C
A merge has been done, but unresolved conflicts still remain.
.It E
Export.
.It F
Release.
.It G
A merge has been done without conflict.
.It M
A file has been modified (using the
.Ic commit
command).
.It O
Checkout.
.It R
A file has been removed with the
.Ic remove
command.
.It T
Rtag.
.It U
Normal update.
.It W
The file has been deleted from the directory because it does not
exist anymore in the base repository.
.El
.It Fl z Ar tz
Display records with time synchronized with the
.Ar timezone
passed as argument.
.El
.Pp
All records have the following five first columns:
.Pp
.Bl -dash -compact
.It
The record type (the
.Fl x
option).
.It
The date of the action.
.It
The time of the action.
.It
The time zone.
.It
The user who made the action.
.El
.Pp
The other columns vary depending on the command issued:
.Pp
For records coming from the
.Ic rtag
command, the additional columns are as follows:
.Bd -literal -offset indent
<module> [<tag>:<argument>] {<working directory>}
.Ed
.Pp
For records coming from the
.Ic checkout
and
.Ic export
commands, the additional columns are as follows:
.Bd -literal -offset indent
<request> <repository> =<module>= <working directory>
.Ed
.Pp
For records coming from the
.Ic release
command, the additional columns are as follows:
.Bd -literal -offset indent
=<module>= <working directory>
.Ed
.Pp
For records coming from the
.Ic commit
and
.Ic update
commands, the additional columns are as follows:
.Bd -literal -offset indent
<version> <file> <module> == <working directory>
.Ed
.Pp
Aliases:
.Ic hi ,
.Ic his .
.It Xo Ic import
.Op Fl b Ar branch
.Op Fl m Ar msg
.Ar repository
.Ar vendortag
.Ar releasetag
.Xc
.Pp
Import sources into CVS using vendor branches.
.Pp
At least three arguments are required:
.Ar repository
specifies the location of the sources to be imported;
.Ar vendortag
is a tag for the entire branch;
.Ar releasetag
is used to identify the files you created with
.Ic cvs import .
.Pp
The
.Ic import
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl b Ar branch
Specify the first-level branch number.
.It Fl m Ar msg
Specify the log message to send.
.El
.Pp
Aliases:
.Ic im ,
.Ic imp .
.It Ic init
Create a CVS repository if it doesn't exist.
.It Ic kserver
Start a Kerberos authentication server.
.It Xo Ic log
.Op Fl bhlNRt
.Op Fl d Ar dates
.Op Fl r Ar revs
.Op Fl s Ar state
.Op Fl w Ar users
.Op Ar file ...
.Xc
.Pp
The
.Ic log
command displays information on a
.Ar file
such as its different revisions, description, different tags,
as well as the comments, dates, and authors of these revisions.
By default, the
.Ic log
command displays all the available information; the options are only
used to restrict the displayed information.
.Pp
The
.Ic log
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl b
List revisions of the default branch only.
.It Fl d Ar dates
Specify revisions with dates matching the specification.
The specification might be as follows:
.Bl -tag -width Ds
.It D1>D2 or D2>D1
Select all revisions between
.Ar \&D1
and
.Ar D2 .
.It <D or D>
Select all revisions before
.Ar D .
.It >D or D<
Select all revisions after
.Ar D .
.It D
Select the latest revision before or equal to
.Ar D .
.El
.Pp
The
.Sq \*(Gt
and
.Sq \*(Lt
characters can be followed by the
.Sq =
character to imply an inclusive specification.
Several specifications can be used by separating them with the
.Sq \&;
character.
.It Fl h
Print header only.
.It Fl l
Limit the scope of the search to the local directory only.
.It Fl N
Do not list tags.
.It Fl R
Print name of RCS file only.
.It Fl r Ar revs
Specify revision(s) to list:
.Bl -tag -width Ds
.It REV1,REV2,...,
A list of revisions is specified by separating names or numbers
of revisions by the
.Sq \&,
character.
.It REV1:REV2
List all revisions between
.Ar REV1
and
.Ar REV2
(they must be on the same branch).
.It :REV
List all revisions since the beginning of the branch until
.Ar REV
included.
.It REV:
List all revisions of the branch beginning with
.Ar REV .
.It BRANCH
List all revisions of a branch.
.It BRANCH.
List the latest revision of the branch
.Ar BRANCH .
.It BRANCH1:BRANCH2
List all revisions of branches between
.Ar BRANCH1
and
.Ar BRANCH2 .
.El
.Pp
Without argument, the
.Fl r
option means the latest revision of the default branch.
.It Fl s Ar state
List revisions of the specified
.Ar state
only.
Several states can be listed by separating them with the
.Sq \&,
character.
.It Fl t
Print header and description only.
.It Fl w Ar users
Do not list revisions made by specified
.Ar users .
Usernames should be separated by the
.Sq \&,
character.
.El
.Pp
Aliases:
.Ic lo .
.It Ic login
Prompt for a password for an authenticating server.
.It Ic logout
Remove an entry in
.Pa .cvspass
for a remote repository.
.It Xo Ic rdiff
.Op Fl flR
.Oo Fl c \*(Ba
.Fl u Oc
.Oo Fl s \*(Ba
.Fl t Oc
.Op Fl V Ar ver
.Fl D Ar date \*(Ba
.Fl r Ar rev
.Oo Fl D Ar date2 \*(Ba
.Fl r Ar rev2 Oc
.Ar module ...
.Xc
.Pp
The
.Ic rdiff
command lists differences between two revisions in a
.Xr patch 1
compatible format.
This command does not need a local checkout of the repository
to work.
.Pp
The
.Ic rdiff
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl c
Produces a diff with three lines of context.
See
.Xr diff 1
for more information.
This is the default.
.It Xo Fl D Ar date
.Op Fl D Ar date2
.Xc
Differences between the revision at
.Ar date
and the working copy or
.Ar date
and
.Ar date2
(if specified).
.It Fl f
Force the use of the head revision if the specified
date or revision is not found.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.It Xo Fl r Ar rev
.Op Fl r Ar rev2
.Xc
Differences between revision
.Ar rev
and the working copy or
.Ar rev
and
.Ar rev2
(if specified).
.It Fl s
Create a summary change instead of a whole patch.
.It Fl t
Lists differences between the last two revisions of each file.
.It Fl u
Produces a diff in unidiff format.
.It Fl V Ar ver
Use the RCS version
.Ar ver
for keyword substitution.
.El
.Pp
Aliases:
.Ic pa ,
.Ic patch .
.It Xo Ic release
.Op Fl d
.Ar dir ...
.Xc
The
.Ic release
command indicates to
.Nm
that the working copy of a module is no longer in use and checks
that non archived modifications in the base repository do exist.
This command is not mandatory.
Local directories could always be removed without using it, but
in this case the handling of history information will no longer be
correct (see the
.Ic history
command).
.Pp
The
.Ic release
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl d Ar dir
Remove the directory
.Ar dir .
Be aware that this option silently removes any directories that have
been added to the local working copy without using the
.Ic add
command.
.El
.Pp
For each file not being synchronized with the base repository,
a single letter prefix is given to specify the state of the file.
The possible prefixes are as follows:
.Bl -tag -width Ds
.It \&?
The file is unknown to
.Nm
and is not in the list of files to ignore.
Any new directories which have not been added with the
.Ic add
command are silently ignored as well as their content.
.It A
The file has been added with the
.Ic add
command, but has not been committed to the repository with the
.Ic commit
command.
.It M
The file has been locally modified; a more recent version might
exist in the base repository.
.It R
The file has been removed with the
.Ic remove
command, but has not been committed to the repository with the
.Ic commit
command.
.It U
A more recent version of the file does exist but it is not
locally up to date.
.El
.Pp
Aliases:
.Ic re ,
.Ic rel .
.It Xo Ic remove
.Op Fl flR
.Op Ar file ...
.Xc
The
.Ic remove
command is used to inform
.Nm
that
.Ar file
is scheduled to be removed from the repository.
Files are not actually removed from the repository until the
.Ic commit
command has been run subsequently.
.Pp
The
.Ic remove
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl f
Force local file removal.
If this flag is not used, the file must be locally removed beforehand for
the command to be valid.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.El
.Pp
Aliases:
.Ic rm ,
.Ic delete .
.It Ic rlog
Print out history information for a module.
.It Xo Ic rtag
.Op Fl abdFflnR
.Oo Fl D Ar date \*(Ba
.Fl r Ar rev Oc
.Ar symbolic_tag
.Ar modules ...
.Xc
The
.Ic rtag
command adds a symbolic tag to one or more modules.
It is often used to create a new branch using the
.Fl b
option.
.Pp
The
.Ic rtag
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl a
Clear tag from files already removed with the
.Ic remove
command.
.It Fl b
Create a branch.
.It Fl D Ar date
Tag the most recent revision before
.Ar date .
.It Fl d
Delete tag.
.It Fl F
Move tag if it already exists.
If this option is not used and a tag is used a second time,
.Nm
will not execute the action.
.It Fl f
Force the use of the head revision if the specified
revision or date is not found.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl n
Do not execute programs listed in the
.Pa CVSROOT/modules
file.
.It Fl R
Enable recursive behaviour.
This is the default.
.It Fl r Ar rev
Tag at revision
.Ar rev .
.El
.Pp
Aliases:
.Ic rt ,
.Ic rfreeze .
.It Ic server
Server mode.
.It Xo Ic status
.Op Fl lRv
.Op Ar file ...
.Xc
The
.Ic status
command is used to display the state of checked out files.
.Pp
The
.Ic status
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.It Fl v
Display symbolic tags for
.Ar file .
.Pp
The state may be one of the following:
.Bl -tag -width Ds
.It Cm Locally Added
The file has been added with the
.Ic add
command, but has not been committed to the repository with the
.Ic commit
command.
.It Cm Locally Modified
The file is up to date, but has been locally modified.
.It Cm Locally Removed
The file has been removed with the
.Ic remove
command, but has not been committed to the repository with the
.Ic commit
command.
.It Cm Needs Checkout
The file has not been modified; a new version is available.
.It Cm Needs Merge
The file has been modified and a newer version is available.
.It Cm Needs Patch
Same as
.Ic Needs Checkout
but, in client-server mode, only the differences are sent to save
network resources.
.It Cm Unresolved Conflict
A merge has been done, but unresolved conflicts still remain.
.It Cm Up-to-date
The file is up to date.
.El
.El
.Pp
Aliases:
.Ic st ,
.Ic stat .
.It Xo Ic tag
.Op Fl bcdFflR
.Oo Fl D Ar date \*(Ba
.Fl r Ar rev Oc
.Op Ar symbolic_tag
.Op Ar file ...
.Xc
.Pp
The
.Ic tag
command adds a symbolic tag to a checked out version of one or more files.
.Pp
The
.Ic tag
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl b
Create a branch.
.It Fl c
Check that working files are not modified.
.It Fl D Ar date
Tag the most recent revision before
.Ar date .
.It Fl d
Delete tag.
.It Fl F
Move tag if it already exists.
If this option is not used and a tag is used a second time,
.Nm
will not execute the action.
.It Fl f
Force the use of the head revision if the specified
revision or date is not found.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.It Fl r Ar rev
Tag at revision
.Ar rev .
.El
.Pp
Aliases:
.Ic ta ,
.Ic freeze .
.It Xo Ic unedit Op Fl lR
.Op Ar file ...
.Xc
.Pp
The
.Ic unedit
command is used to give up an edition on a file and thus cancel
the wanted temporary notifications.
If the file has been modified since the
.Ic edit
command has been issued,
.Nm
will ask if you want to go back to the previous version, and lose the
modifications done on the file, or stay in edition mode on it.
.Pp
The
.Ic unedit
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.El
.It Xo Ic update
.Op Fl AdflPpR
.Oo Fl D Ar date \*(Ba
.Fl r Ar rev Oc
.Op Fl I Ar ign
.Op Fl j Ar rev
.Op Fl k Ar mode
.Op Fl W Ar spec
.Op Ar file ...
.Xc
.Pp
The
.Ic update
command is used to merge any of the changes that have occurred on the remote
repository into the local one where the command was run.
.Pp
The
.Ic update
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl A
Reset any sticky tags, dates, or keyword substitution modes that
have been set on the tree.
.It Fl D Ar date
Update as of the latest revision no later than
.Ar date
(is sticky).
.It Fl d
Create any new directories.
Without this option,
.Nm
does not create any new files sitting in these new directories
added in the base repository since the last update of the working
copy, or since the last update with the
.Fl d
option.
.It Fl f
Force the use of the head revision if the specified
tag or date is not found.
.It Fl I Ar ign
Ignore files specified by
.Ar ign .
This option can be used several times on the command line.
To see all files, use the
.Fl I Ar !\&
specification.
.It Fl j Ar rev
Merge in changes made between current revision and
.Ar rev .
If two
.Fl j
options are specified, only merge the differences between the two
revisions of the branch.
This allows successive merges without having to resolve
already resolved conflicts again.
.It Fl k Ar mode
Specify the keyword substitution mode (is sticky).
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl P
Prune any directories that have become empty as a result of the update.
.It Fl p
Send the result of the update to standard output (avoids stickiness).
.It Fl R
Enable recursive behaviour.
This is the default.
.It Fl r Ar rev
Update from a particular revision or branch (is sticky).
.It Fl W Ar spec
Wrappers specification line.
.El
.Pp
By default, the
.Ic update
command does not create new directories; the
.Fl d
option must be used for that.
.Pp
For each file updated, a single letter prefix is given to
specify the state of the file.
The possible prefixes are as follows:
.Bl -tag -width Ds
.It \&?
The file is unknown to
.Nm .
.It A
The file has been added with the
.Ic add
command, but has not been committed to the repository with the
.Ic commit
command.
.It C
A merge, with a more recent version of the file, has been done,
but unresolved conflicts still remain.
.It M
The file has been locally modified; if a more recent version
is available, the merge has been done without conflict.
.It P
The same as
.Sq U ,
but, in client-server mode, only differences are sent to save network
resources.
.It R
The file has been removed with the
.Ic remove
command, but has not been committed to the repository with the
.Ic commit
command.
.It U
The file is up to date.
.El
.Pp
Aliases:
.Ic up ,
.Ic upd .
.It Ic version
Causes
.Nm
to print its version information.
If this command is issued within a local copy of a remote repository or
if either the
.Ev CVSROOT
environment variable or the
.Fl d
flag specify a remote repository,
.Nm
will also connect to the server and ask it to print its version information.
.Pp
Aliases:
.Ic ve ,
.Ic ver .
.It Xo Ic watch
.Ar on | off | add | remove
.Op Fl lR
.Op Fl a Ar action
.Op Ar file ...
.Xc
.Pp
The
.Ic watch
command switches a file from normal mode to
pseudo-lock mode as well as handling the notifications associated
with it.
Pseudo-lock mode means knowing who is editing a file:
for that,
.Nm
extracts the file in read-only mode.
Users must use the
.Ic edit
command to get the editing rights on the file.
.Pp
One of the following arguments to the
.Ic watch
command is mandatory: on, off, add, or remove.
.Ar on
switches the file into pseudo-lock mode;
.Ar off
switches it back to normal mode;
.Ar add
adds notifications for specific actions on the file;
.Ar remove
removes those notifications.
.Pp
The notifications are permanent.
They remain in place until the
.Ic watch remove
command is issued while the temporary notifications are
made available with the
.Ic edit
command.
.Pp
The
.Ic watch
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl a Ar action
Specify the permanent notification wanted for
.Ar add | remove :
.Pp
.Bl -tag -width Ds -compact
.It Cm commit
Another user has committed changes to the file.
.It Cm edit
Another user is editing the file.
.It Cm unedit
Another user has finished editing the file.
.It Cm all
All of the above.
.It Cm none
No notification.
.El
.Pp
If no specification is requested using the
.Ar add
or
.Ar remove
arguments, it implies the
.Fl a Ar all
option.
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.El
.It Xo Ic watchers
.Op Fl lR
.Op Ar file ...
.Xc
.Pp
The
.Ic watchers
command lists the users who asked for notifications as well as the
notifications details.
The possible notifications are as follows:
.Bl -tag -width Ds
.It Cm commit
Permanent watch of a commit of a new version of a file.
.It Cm edit
Permanent watch of the start of file edition.
.It Cm tcommit
Temporary watch of a commit of new version of a file.
.It Cm tedit
Temporary watch of the start of file edition.
.It Cm tunedit
Temporary watch of the end of file edition.
.It Cm unedit
Permanent watch of the end of file edition.
.El
.Pp
The temporary watches are set using the
.Ic edit
command, until the
.Ic commit
or
.Ic unedit
command is issued on a file.
.Pp
The
.Ic watchers
command takes the following options:
.Bl -tag -width Ds -offset 3n
.It Fl l
Limit the scope of the search to the local directory
only and disable recursive behaviour.
.It Fl R
Enable recursive behaviour.
This is the default.
.El
.El
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev CVS_CLIENT_LOG
This variable enables logging of all communications between the client and
server when running in non-local mode.
If set, this environment variable must contain a base path from which two
paths will be generated by appending ".in" to the value for the server's
input and ".out" for the server's output.
.Pp
The path can contain the following substitutes:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It %c
the command being run
.It %d
the date
.It %p
the process ID
.It %u
the username of the person running it
.El
.Pp
The substitutes are only supported by OpenCVS.
.It Ev CVS_RSH
Name of the program to use when connecting to the server through a remote
shell.
The default is to use the
.Xr ssh 1
program.
.It Ev CVS_SERVER
If set, gives the name of the program to invoke as a
.Nm
server when using remote shell.
The default is to use `cvs'.
.It Ev CVSEDITOR
Name of the editor to use when editing commit messages.
Checked before
.Ev EDITOR
and
.Ev VISUAL .
.It Ev CVSROOT
When set, this variable should contain the string pointing to the root
directory of the CVS repository.
The contents of this variable are ignored when the
.Fl d
option is given or if `Root' files exist in the checked-out copy.
.It Ev EDITOR
Name of the editor to use when editing commit messages.
This is traditionally a line-oriented editor,
such as
.Xr ex 1 .
.It Ev VISUAL
Name of the editor to use when editing commit messages.
This is traditionally a screen-oriented editor,
such as
.Xr vi 1 .
.El
.Sh FILES
.Bl -tag -width Ds
.It Pa $HOME/.cvsrc
File containing a list of implicit options to pass to certain commands.
This file is read on startup unless the
.Fl f
option is specified.
.It Pa $CVSROOT/CVSROOT
Directory containing repository administrative files.
.It Pa $CVSROOT/CVSROOT/loginfo
File containing associations between modules and handlers for
post-commit logging.
.El
.Sh SEE ALSO
.Xr diff 1 ,
.Xr gzip 1 ,
.Xr patch 1 ,
.Xr rcs 1 ,
.Xr cvsrc 5 ,
.Xr cvsintro 7
.Sh HISTORY
The OpenCVS project is a BSD-licensed rewrite of the original
Concurrent Versioning System written by Jean-Francois Brousseau.
The original CVS code was written in large parts by Dick Grune,
Brian Berliner and Jeff Polk.
.Sh AUTHORS
.An Jean-Francois Brousseau
.An Vincent Labrecque
.An Joris Vink
.An Xavier Santolaria
.Sh CAVEATS
This CVS implementation does not fully conform to the GNU CVS version.
In some cases, this was done explicitly because GNU CVS has inconsistencies
or ambiguous behaviour.
Some things have also been left out or modified to enhance the overall
security of the system.
.Pp
Among other things, support for the pserver connection mechanism has been
dropped because of security issues with the authentication mechanism.
|