summaryrefslogtreecommitdiffstats
path: root/tde-i18n-en_GB/docs/kdesdk/cervisia/index.docbook
blob: 689d12faf9cb0fad82932602e7dc7cfa541428cc (plain)
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
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&cervisia;">
  <!ENTITY package "kdesdk">
  <!ENTITY ssh "<command
>ssh</command
>">
  <!ENTITY rsh "<command
>rsh</command
>">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % British-English "INCLUDE"
> <!-- Change language only here -->
  <!ENTITY CVS "<application
>CVS</application
>">
]>

<book lang="&language;">

<bookinfo>
<title
>&cervisia; Manual</title>
<authorgroup>
<author
><firstname
>Bernd</firstname
><surname
>Gehrmann</surname
> <affiliation
><address
><email
>bernd@mail.berlios.de</email
></address
></affiliation>
</author
> 
<author
><firstname
>Carlos</firstname
><surname
>Woelz</surname
> <affiliation
><address
><email
>carloswoelz@imap-mail.com</email
></address
></affiliation>
</author
> 


<othercredit role="translator"
><firstname
>Alex</firstname
><surname
>Walker</surname
><affiliation
><address
><email
>alex@x3ja.co.uk</email
></address
></affiliation
><contrib
>Conversion to British English</contrib
></othercredit
> 

</authorgroup>

<copyright>
<year
>1999</year>
<year
>2000</year>
<year
>2001</year>
<year
>2002</year>
<holder
>Bernd Gehrmann</holder>
</copyright>

<copyright>
<year
>2004</year>
<holder
>Carlos Woelz</holder>
</copyright>


<legalnotice>
 
<para
>This program may be distributed under the terms of the Q Public License as defined by Trolltech AS of Norway and appearing in the file LICENSE.QPL included in the packaging of this file.</para>

<para
>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</para>
</legalnotice>

<legalnotice
>&FDLNotice;</legalnotice>

<date
>2004-06-06</date>
<releaseinfo
>2.01.90</releaseinfo>

<abstract>
<para
>&cervisia; provides a graphical view of &CVS;.</para>
</abstract>

<keywordset>
<keyword
>KDE</keyword>
<keyword
>kdesdk</keyword>
<keyword
>Cervisia</keyword>
<keyword
>CVS</keyword>
<keyword
>version control</keyword>
<keyword
>revision control</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title
>Introduction</title>

<para
><ulink url="http://www.kde.org/apps/cervisia/"
>&cervisia;</ulink
> is a user friendly version control system front-end. The aim is to support &CVS; and other version control system programs in a unified interface, featuring conflict resolution, difference and history viewers, status for the working copy files and support for most version control functions. You can get &cervisia; by building the kdesdk module or installing the kdesdk package provided by your distribution. Currently, only &CVS; is supported, but other version control systems may be integrated in the future. </para>

<para
>A version control system is a tool to record, manage and distribute different versions of files. &CVS; is a version control system. It allows you to share your modifications easily, as each of the contributors can work on their local copy at the same time, without fear of overwriting each others' modifications. It allows the recovery of past versions (useful for tracking bugs), the creation of branches (for experimental development or for releases of code) and more. </para>

<para
>The main <firstterm
>repository</firstterm
> usually holds a collaborative project (commercial or not), but you can take advantage of the nice revision control features offered by &CVS; even for a project developed exclusively by you. It is easy to set up a local repository, and you will gain the ability to track changes that caused bugs, revert changes, avoid accidental loss of information &etc;. </para>

<para
>The repository holds the project files, and every contributor keeps their own local copy, named <firstterm
>working copy</firstterm
> or <firstterm
>sandbox</firstterm
>; one can then add their modifications to the main repository (a process called &quot;committing&quot;) and/or update their own copy to reflect recent changes made by other contributors. </para>

</chapter>
   
<chapter id="getting-started">
<title
>Getting Started</title>

<sect1 id="accessing-repository">
<title
>Accessing The Repository</title>
    
<para
>In this section, we show how to use the basic version control system functionality using &cervisia; to checkout modules from the repository and work with them. To do that, you must have access to the repository as a client, meaning that someone (probably the administrator of the &CVS; repository) gave you an account on the server machine. Alternatively, you can easily create a local repository for your own project. </para>

<tip
><para
>If you plan to develop a complex project, it is a good idea to use the &CVS; features, even if you are the only developer. You can make all changes in the working copy, and use &cervisia; (or any other &CVS; tool) to update and commit. This way, you will gain the ability to track changes that caused bugs, revert changes, avoid accidental loss of information &etc;. Using &cervisia;, it is simple to create a local repository. </para>

<procedure>
<title
>Creating a Local Repository</title>

<step
><para
>Open the <guilabel
>Create New Repository (cvs init)</guilabel
> dialogue by choosing <menuchoice
><guimenu
>Repository</guimenu
> <guimenuitem
>Create...</guimenuitem
></menuchoice
>. </para
></step>

<step
><para
>Press the <guilabel
>...</guilabel
> button to select the folder where you want to create the repository, or enter its location in the edit box. For instance, if you want to place the repository in the <filename
>/home/user</filename
> folder, and to name it <filename
>cvsroot</filename
>, you should type <filename
>/home/user/cvsroot</filename
> in the edit box, or select the <filename
>/home/user</filename
> folder using the file picker and add <filename
>cvsroot</filename
>. </para
></step>

<step
><para
>Confirm by pressing the <guibutton
>OK</guibutton
> button. &cervisia; will create and initialise the new repository folder. </para
></step>

<step
><para
>Now you can import your current work to the repository, or simply create a folder in the repository to start a new module from scratch. </para
></step>

</procedure>

</tip>


<para
>&cervisia; offers an integrated front-end to manage all your repository locations, the <guilabel
>Configure Access to Repositories</guilabel
> dialogue. To display it, select the <menuchoice
><guimenu
>Repository</guimenu
> <guimenuitem
>Repositories...</guimenuitem
></menuchoice
> menu item. </para>

<figure id="screenshot-repositories" float="1">
<title
>A screenshot of &cervisia;'s Configure Access to Repositories dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="repositories.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s Configure Access to Repositories dialogue</phrase
></textobject>
</mediaobject>
</figure>

<para
>There are several methods to access a CVS repository. It may be reached via password authentication (:pserver:), secure shell (using :ext:), local repository (:local:) &etc;. The format for the repository location is (optional items appear between square brackets): </para>

<para>
<filename
>[:method:][[user][:password]@]hostname[:[port]]/path/to/repository</filename>
</para>

<para
>Not all these items (user, password, hostname, port) are always necessary to access the repository. The required information depends on the access method used, which can be categorised as follows: </para>

<variablelist>

<varlistentry>
<term
>Local</term>

<listitem>
<para
>The local access method is the default method used by &CVS;. Therefore, it is optional to add the :local: method to the repository location: you can enter simply the path to the folder which stores the &CVS; repository, and is accessible from your computer, like <filename class="directory"
>/path/to/repository</filename
> or to give a real life example, <filename class="directory"
>/home/cvs</filename
>.</para>

<para
>It may physically be on a disk which is mounted via <acronym
>NFS</acronym
>, but this is an irrelevant detail. If you created a local repository, the location will be simple the path to it. </para>
</listitem>
</varlistentry>

<varlistentry id="rsh">
<term
>rsh</term>

<listitem>
<para
>The repository location is something like <filename
>:ext:username@host.url.org:/path/to/repository</filename
>. </para>

<para
>This method requires that you have a user account on the server machine (in this example, <systemitem class="systemname"
>host.url.org</systemitem
>) and use a remote shell for communication. By default, &CVS; uses &rsh; for this purpose; however, &rsh; has long considered to be insecure, and is widely replaced by &ssh;. </para>

<para
>If you wish to use &ssh;, you must set the environment variable $<envar
>CVS_RSH</envar
> to &ssh; when using the <command
>cvs</command
> client. &cervisia; supports this easily. </para>

<!-- TODO: verify if the above still apply -->

<para
>Note that &cervisia; cannot answer possible password requests from the server machine. You must make sure that a remote login works without requiring you to enter the password. With plain vanilla &rsh;, this can be achieved for example by creating a <filename
>.rhosts</filename
> file in your home folder with a list of trusted hosts (see the &rsh; manpage). </para>

<para
>With &ssh;, it can be achieved by copying your public key located in the file <filename
>identity.pub</filename
>, located in the <filename
>$<envar
>HOME</envar
>/.ssh/</filename
> folder to the server. In this case, the key must not be encrypted with a passphrase see the &ssh; manpage and the &CVS;/<acronym
>SSH</acronym
> <acronym
>FAQ</acronym
> on SourceForge). If you are unsure about these issues, ask your system administrator. </para>

</listitem>
</varlistentry>

<varlistentry>
<term
>pserver</term>

<listitem>
<para
>The repository location looks like <filename
>:pserver:username@host.url.org:/path/to/repository</filename
> </para>

<para
>This method accesses the server via a special protocol with a relatively weak authentication (<literal
>pserver</literal
> stands for password authentication). Before you can use such a server, you need a username and password given by the &CVS; server administrator, and you have to login. Note that your &CVS; password authentication username does not necessarily match the system's username. Before accessing the &CVS; server, you will need to login. </para>

<para
>Open-source projects typically offer Anonymous CVS access to their sources. This means you can easily grab the latest sources, modify, and create patches (differences) against the repository without asking for a CVS account. As a general rule, Anonymous CVS uses password authentication (:pserver:), and is a read-only repository, not allowing you to upload your changes directly. </para>

</listitem>
</varlistentry>
</variablelist>

<para
>Knowing the access method and location to the repository, you can add it to &cervisia;'s repositories list: </para>

<procedure>
<title
>Adding a New Repository</title>

<step
><para
>Open the <guilabel
>Configure Access to Repositories</guilabel
> dialogue by choosing the <menuchoice
><guimenu
>Repository</guimenu
> <guimenuitem
>Repositories...</guimenuitem
> </menuchoice
>menu item. </para
></step>

<step
><para
>Press the <guilabel
>Add...</guilabel
> button to open the <guilabel
>Add Repository</guilabel
> dialogue. </para
></step>

<step
><para
>Enter the repository location in the <guilabel
>Repository:</guilabel
> edit box. &cervisia; will automatically disable the areas of the dialogue that are not relevant to the access method you entered. </para
></step>

<step
><para
>If you are using the ext method to access the repository, enter the remote shell you wish to use (&eg; &ssh;) in the <guilabel
>Use remote shell</guilabel
> edit box. </para
></step>

<step
><para
>Press <guibutton
>OK</guibutton
>. You will see the repository you just entered on the repositories list. </para
></step>

<step
><para
>If the access method to the repository you just entered is password authentication (pserver), you will need to login before connecting the server. Click the repository on the list to select it, and press the <guilabel
>Login...</guilabel
> button. Enter your password in the pop-up dialogue. </para>
<para
>If you successfully enter your password, the <guilabel
>Status</guilabel
> column entry of the pserver repository will change from <guilabel
>Not logged in</guilabel
> to <guilabel
>Logged in</guilabel
>. </para
></step>

<step
><para
>Press <guibutton
>OK</guibutton
> to apply your modifications, or add another location to the list. &cervisia; will store as many locations as you like. </para
></step>

</procedure>

</sect1>


<sect1 id="importing">
<title
>Importing a Module Into the Repository</title>

<para
>In this section, we discuss how you can put a new project into the &CVS; repository. If you just want to work with an existing project which is already in a repository, you may skip this section. </para>

<para
>There are two ways to put a project into the &CVS;: </para>

<itemizedlist>

<listitem
><para
>Import the files and folders to a new <firstterm
>module</firstterm
>, using &cervisia;'s import dialogue. Modules are the top folders in the &CVS; repository folder tree, and are used to separate and organise the different software projects inside the repository. </para
></listitem>

<listitem
><para
>Create an empty module and add the new files and folders manually. You will have more control, but it will probably take a little more time. </para
></listitem>

</itemizedlist>

<important>
<para
>Keep in mind that &CVS; was initially designed to handle text files. Many features, like revision merging, creating differences in a readable form &etc; are only performed to text files. This does not mean you cannot use CVS to keep binary files, it just means you have to <emphasis
>explicitly tell CVS if it is a text or binary file</emphasis
>. If you declare the wrong file type, you will experience problems with the &CVS; functionality for these files, and they may get corrupted. </para>
</important>


<para
>Importing a project (as a new module) has some advantages: you will import all files and folders recursively, and the module will automatically be created for you. This makes importing large existing projects to the repository easier. However, there are some disadvantages: you cannot use &cervisia;'s import dialogue to add files to existing modules, and you can either import the files as text or binary files. You can work around this limitation by creating a folder with files of only one of the types, or by informing the patterns of the files that should be ignored during the import process. </para>

<para
>For instance, suppose your project contains text files and some PNG images (binary files) only. You can tell &CVS; to ignore all files with the pattern <filename class="extension"
>*.png</filename
> while importing the other files as text, or you can move the images to a separate folder, and then import the remaining files (as text files). Either way, you will have to <link linkend="checkingout"
>checkout</link
> the newly imported module to a new working copy, copy the the missing files and folders to it, <link linkend="addingfiles"
>add</link
> and <link linkend="committingfiles"
>commit</link
> them to the repository to complete the import process. </para>

<para
>As an alternative, you can add the files and folders manually, creating an empty module for them. To add an empty module to a repository, just create a new folder in the &CVS; repository root folder. The name of this new folder will be the name of the module. <link linkend="checkingout"
>Checkout</link
> the new empty module. Then copy the the files and folders to the working copy, <link linkend="addingfiles"
>add</link
> and <link linkend="committingfiles"
>commit</link
> to upload them to the &CVS; repository. </para>


<figure id="screenshot-import" float="1">
<title
>A screenshot of &cervisia;'s import dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="import.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s import dialogue</phrase
></textobject>
</mediaobject>
</figure>

<para
>In <xref linkend="screenshot-import"/> you can see the dialogue which helps you to <emphasis
>import</emphasis
> a project as a module. To access &cervisia;'s import dialogue, choose the <menuchoice
><guimenu
>Repository</guimenu
> <guimenuitem
>Import...</guimenuitem
></menuchoice
> menu item. </para>

<variablelist>

<varlistentry>
<term
><guilabel
>Repository:</guilabel
> <xref linkend="co-repository"/></term>
<listitem
><para
>Enter or select on the dropdown list the name of the &CVS; repository, also known as $<envar
>CVSROOT</envar
>. You must have write access to it, and the repository must be properly initialised. If the repository does not yet exist, you can create one choosing the <menuchoice
> <guimenu
>Repository</guimenu
> <guimenuitem
>Create...</guimenuitem
> </menuchoice
> menu item. </para>
<para
>The drop down box shows a list of the repositories you previously entered using the <guilabel
>Configure Access to Repositories</guilabel
> dialogue box. If the repository is remote, make sure that authentication works. See <xref linkend="accessing-repository"/> for more information. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Module:</guilabel
> <xref linkend="co-module"/></term>
<listitem
><para
>The name of the module under which the project will be stored. After the import, the project can be checked out under this name. See <xref linkend="checkingout"/> for more information. This is also the name of the corresponding folder in the repository. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Working Folder:</guilabel
></term>
<listitem
><para
>The toplevel folder of the project you want to import. The import starts from this folder and goes down recursively. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Vendor tag:</guilabel
> <xref linkend="co-vendortag"/></term>
<listitem
><para
>The vendor tag is historically used for tracking third-party sources. Just use your user name if you have no better idea. It does not matter much what you enter here. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Release tag:</guilabel
> <xref linkend="co-releasetag"/></term>
<listitem
><para
>This tag is also historically used for importing different versions of third-party software. If you are not doing this, use the word <literal
>start</literal
> or a string <literal
>FOO_1_0</literal
> where <literal
>FOO</literal
> is the name of your project and <literal
>1.0</literal
> is the version number of the imported release. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Ignore files:</guilabel
></term>
<listitem
><para
>If you fill out this field, an additional <option
>-I <replaceable
>file names</replaceable
></option
> option is given go the <command
>cvs import</command
> command. This entry is interpreted as a whitespace-separated list of file name patterns which are ignored. In general, a cleaner and less error-prone way to control which files go into the repository is to create a folder with only the files which you want to import and start from that. Nevertheless, this entry may be useful if the project contains files which are by default ignored by &CVS;, &eg; files with the name <filename
>core</filename
>. In such a case, simply enter the character <literal
>!</literal
> in this field: this overrules &CVS;'s scheme of ignored files, see <xref linkend="ignoredfiles"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Comment:</guilabel
> <xref linkend="co-comment"/></term>
<listitem
><para
>Use this field to record the comments you might have about the origin, use, development &etc; of the files you are importing. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Import as binaries</guilabel
></term>
<listitem
><para
>If you check this box, all files are imported in binary mode, i.e. an argument <option
>-kb</option
> is given to <command
>cvs import</command
>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Use file's modification as time of import</guilabel
></term>
<listitem
><para
>If you check this box, the time of import will be the file's modification time instead of the import time. </para
></listitem>
</varlistentry>

</variablelist>


<para
>After you have filled out this form and confirmed by pressing <guibutton
>OK</guibutton
>, the following &CVS; command is used:</para>

<screen
><command
>cvs</command
> -d <co id="co-repository"
></co
><replaceable
>repository</replaceable
> import -m "<co id="co-comment"
></co
>" <co id="co-module"
></co
><replaceable
>module</replaceable
> <co id="co-vendortag"
></co
><replaceable
>vendortag</replaceable
> <co id="co-releasetag"
></co
><replaceable
>releasetag</replaceable
></screen>

</sect1>


<sect1 id="checkingout">
<title
>Checkout a Module From the Repository</title>
<para
>Now that you successfully defined your repository location, and imported the initial files to the repository, it is time to retrieve the module from the &CVS; repository, creating your working copy. </para>

<para
>You should also know the name of the <firstterm
>branch</firstterm
> or <firstterm
>tag</firstterm
> you want to use. </para>

<para
>Branches of a module are parallel versions of this module. A good real-life example of the use of this feature is the release of a software project. After a major release, there are bugs in the code that should be fixed, but people want to add new features to the application too. It is very hard to do both at the same time because new features usually introduce new bugs, making it hard to track down the old ones. To solve this dilemma, &CVS; lets you create a parallel version, that we will call the &quot;stable release branch&quot;, where you can only add bugfixes, leaving the main branch (HEAD) open for adding new features. </para>

<para
>Tags are used to mark a version of a project. &CVS; stamps one version of each file with the tag, so when you checkout or update to a specific tag, you will get always the same file versions. Therefore, in opposition to branches, tags are not dynamic: you cannot develop a tag. Tags are useful to mark releases, big changes in the code &etc;. Using tags, you can easily return the project to a previous state, to reproduce and track bugs, generate the release code again &etc;. </para>

<figure id="screenshot-checkout" float="1">
<title
>A screenshot of &cervisia;'s checkout dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="checkout.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s checkout dialogue</phrase
></textobject>
</mediaobject>
</figure>

<variablelist>

<varlistentry>
<term
><guilabel
>Repository:</guilabel
></term>
<listitem
><para
>The name of the &CVS; repository, also known as <filename
><envar
>$CVSROOT</envar
></filename
>. The drop-down box shows a list of the repositories you previously entered using the <guilabel
>Configure Access to Repositories</guilabel
> dialogue box. If the repository is remote, make sure that authentication works. See <xref linkend="accessing-repository"/> for more information. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Module:</guilabel
></term>
<listitem
><para
>The name of the module to be checked out. If you are working with an existing repository, you can probably get this name from the system administrator; or, if it is an open-source repository, you can get the module names from the project web pages. If you want to create a new module from scratch using a local repository, just create a new folder in the local repository root folder. The name of the folder will be the same as the name of the empty module. </para>
<para
>Alternatively, if the repository has a <filename
><envar
>$CVSROOT</envar
>/modules</filename
> file, you can retrieve a list of available modules by pressing the <guibutton
>Fetch list</guibutton
> button. </para>
<para
>Note that it is possible to checkout any existing subfolder of the module, without retrieving the rest of the module. Just enter the path to the subfolder as well. For instance, if you want to get only the <filename class="directory"
>doc/cervisia</filename
> subfolder of the kdesdk module, enter <filename class="directory"
>kdesdk/doc/cervisia</filename
> in this field. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Branch tag:</guilabel
></term>
<listitem
><para
>The name of the branch or tag you want to check out. If you leave this field empty, &cervisia; will retrieve the main (HEAD) branch. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Working folder:</guilabel
></term>
<listitem
><para
>The folder under which the module should be checked out. Note that the the working copy toplevel folder is named after the module you are retrieving, unless you give it an alternative name in the <guilabel
>Check out as:</guilabel
> field. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Check out as:</guilabel
></term>
<listitem
><para
>This results in the working copy files being checked out to an alternative folder under the working folder rather than a folder named after the module. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Export only</guilabel
></term>
<listitem
><para
>If you check this box, the files will be exported rather than checked out. Exporting obtains a copy of the source for the module without the CVS administrative folders. For example, export may be used to prepare the source code for a release. </para
></listitem>
</varlistentry>

</variablelist>

</sect1>


<sect1 id="mainscreen">
<title
>The Main Screen, Viewing File Status and Updating</title>
<para
>When you start &cervisia;, and open a working copy by choosing <menuchoice
> <guimenu
>File</guimenu
> <guimenuitem
>Open Sandbox...</guimenuitem
> </menuchoice
>, you can see two main areas in &cervisia;'s main window: the top one is a hierarchical (tree) view of the current working copy; the bottom area is used to display the &CVS; commands &cervisia; issues to perform its tasks, as well as the output generated by these commands. </para>

<para
>By default, &cervisia; does not display the files contained by the sub-folders, so you will have to click the folders you want to see. To display all files of the working copy, select <menuchoice
> <guimenu
>View</guimenu
> <guimenuitem
>Unfold File Tree</guimenuitem
> </menuchoice
>. To close back all folders from the working copy, choose <menuchoice
> <guimenu
>View</guimenu
> <guimenuitem
>Fold File Tree</guimenuitem
> </menuchoice
>. </para>

<para
>According to the settings in your <filename
>.cvsignore</filename
> files, the files you usually do not want to include into the repository - such as object files - are not shown in the tree view. For each file, you see its corresponding status. In the default setting, after opening the sandbox, this is "Unknown" because &cervisia; delays the fetching of information until you select the files and folders whose status you want to update or view and choose <menuchoice
> <guimenu
>File</guimenu
> <guimenuitem
>Update</guimenuitem
> </menuchoice
> or <menuchoice
> <guimenu
>File</guimenu
> <guimenuitem
>Status</guimenuitem
> </menuchoice
>. With this approach, you have a minimal amount of functionality available even if you do not have a permanent connection to the &CVS; server. </para>

<figure id="screenshot-mainview" float="1">
<title
>A screenshot of &cervisia;'s main view</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="mainview.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s main view</phrase
></textobject>
</mediaobject>
</figure>

<para
>The commands in the File menu usually act only on the files which you have marked. You may also mark folders. Now choose <guimenuitem
>Status</guimenuitem
> from the <guimenu
>File</guimenu
> menu, press <keycap
>F5</keycap
> or right click the marked files and choose the <menuchoice
> <guisubmenu
>Status</guisubmenu
> </menuchoice
> menu item from the pop-up menu. &cervisia; issues a</para>

<para>
<screen
><command
>cvs update -n <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>command to get status information for the marked files. Note that &cervisia; goes recursively into subfolders only if you have the according option in the <guimenu
>Settings</guimenu
> menu set. According to the respective file's status, you now see an entry in the <guilabel
>Status</guilabel
> column: </para>

<variablelist>

<varlistentry>
<term
><guilabel
>Locally Modified</guilabel
></term>
<listitem
><para
>This means you have modified the file compared to the version in the repository. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><guilabel
>Locally Added</guilabel
></term>
<listitem
><para
>This means the file does not exist in the repository, but in your working copy and you have scheduled it for addition. The actual insertion into the repository only happens after a commit. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Locally Removed</guilabel
></term>
<listitem
><para
>This means you have scheduled the file for removal, but it still exists in the repository. The actual removal happens only after a commit. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Needs Update</guilabel
></term>
<listitem
><para
>This is shown if a newer version of the file exists in the repository, e.g. because someone committed a modification. Normally, you want to update this file so you have an up-to-date version in your folder. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Needs Patch</guilabel
></term>
<listitem
><para
>This is essentially the same as before; the difference is that in case of an update, the &CVS; server transfers only a patch instead of the whole file to you. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Needs Merge</guilabel
></term>
<listitem
><para
>Indicates that a merge of the revision of this file in your working copy with the version in the repository is necessary. This typically happens if you have made modifications to the file while someone else has committed his modifications. If you choose to update, the modifications in the repository are merged into your file. In case of a conflict (i.e. if someone else has changed some of the same lines like you) the new status is then "Conflict". </para
></listitem>
</varlistentry>
       
<varlistentry>
<term
><guilabel
>Up to Date</guilabel
></term>
<listitem
><para
>Indicates that the file is identical with the version in the repository. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Conflict</guilabel
></term>
<listitem
><para
>This is shown if this file still has conflict markers in it. Maybe you have previously updated the file and not resolved the conflicts. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Not In CVS</guilabel
></term>
<listitem
><para
>Indicates that the file is not registered in the &CVS; repository. If you want it to available for others, you should add it to the repository. If not, you may consider adding it to your <filename
>.cvsignore</filename
> file. </para
></listitem>
</varlistentry>

</variablelist>
      
<para
>Now that you have got an overview of the current status of the CVS, you may want to do an update. Mark some files (or the root of the folder tree which is equivalent to marking all files in this folder). Now choose <guimenuitem
>Update</guimenuitem
> from the <guimenu
>File</guimenu
> menu, or right-click the marked files and choose the <menuchoice
> <guisubmenu
>Status</guisubmenu
></menuchoice
> menu item from the pop-up menu. (Of course, you could have chosen this at the beginning of the session). For some of the files the status may change now. Typically, files which had "Needs Patch" or "Needs Update" are updated. So the following new items are possible in the status column: </para>
      
<variablelist>

<varlistentry>
<term
><guilabel
>Updated</guilabel
></term>
<listitem
><para
>Shown if the file was updated from the repository. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Patched</guilabel
></term>
<listitem
><para
>Indicates that the &CVS; server has sent a patch for this file and the patch has been successfully applied. If the patch was not successful because there was a conflict between your modifications and those someone else committed to the repository, the status is now <guilabel
>Conflict</guilabel
>. </para
></listitem>
</varlistentry>

</variablelist>
      
<para
>You may have noticed that according to the status of the file, its row has a different colour. The colours are chosen to somehow reflect the priority of the status. For example, a file with a conflict is marked red to show you that you have to resolve a conflict before you can continue working with the file. If your folder contains a high number of files, you may nevertheless lose the overview. To get more concise information about which files have an unusual status, simply click on the header of the <guilabel
>Status</guilabel
> column. The file list is then sorted by priority, so you have all important information at the top of the list. To get back to the alphabetically sorted view, click on the header of the <guilabel
>File name</guilabel
> column. </para>

</sect1>

</chapter>

   
<chapter id="workingwithfiles">
<title
>Working With Files</title>

<para
>All commonly used &CVS; functionality is directly available in &cervisia;'s main view. Commands usually act on several files at once, namely all which currently selected. If the selection includes folders, its interpretation depends on the settings made under the <guimenu
>Settings</guimenu
> menu. For example, if <menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Commit and Remove Recursively</guimenuitem
></menuchoice
> is checked and you choose <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Commit...</guimenuitem
></menuchoice
> while a folder is selected, then all files in the tree under that folder are committed. Otherwise, only the regular files in the folder itself are affected. </para>

<figure id="screenshot-popup" float="1">
<title
>A screenshot of &cervisia;'s pop-up menu</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="popup.png"/></imageobject>
</mediaobject>
</figure>

<para
>The most used actions are also available by right-clicking the files in the tree view, through the pop-up menu. <xref linkend="screenshot-popup"/> shows &cervisia;'s main window pop-up menu. </para>

<para
>You can simply edit a file by double-clicking on it or selecting it and pressing <keycap
>Return</keycap
>. This starts the default application that handles that file type (the default application for each file type is a KDE wide setting). If the default application is not the one you want to use, you can right click the file and choose the <menuchoice
> <guisubmenu
>Edit With</guisubmenu
> </menuchoice
> submenu, and select one of the other applications that handle that file type. </para>

<sect1 id="addingfiles">
<title
>Adding Files</title>

<para
>Adding files to a project requires two steps: first, the files must be registered with &CVS;, or in other words, <emphasis
>added to the repository</emphasis
>. This is necessary, but not sufficient. In order to actually put the files into the repository, you must <emphasis
>commit</emphasis
> them. This procedure has an important advantage: you can commit the files together with modifications to other parts of the project. When doing this, one can easily see (&eg; in commit emails) that all these changes are part of a whole. </para>

<para
>To this end, mark all files to be added in &cervisia;'s main view. Then, choose <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Add to Repository...</guimenuitem
></menuchoice
>, or right click the marked files and choose <guimenuitem
>Add to Repository...</guimenuitem
>. The <guilabel
>CVS Add</guilabel
> dialogue will appear, listing the files you marked, and asks for confirmation. Press <guibutton
>OK</guibutton
>. </para>

<para
>&cervisia; issues a command</para>

<para>
<screen
><command
>cvs add <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>If the operation was successful, the status column should have "Added to repository" for the added files. </para>

<warning
><para
>&CVS; is not designed to provide meaningful revision control for binary files. For example, merging binary files normally does not make sense. Furthermore, by default &CVS; performs keyword expansion (&eg; on the string <literal
>&dollar;Revision: 1.6 &dollar;</literal
>) when a file is committed. In binary files, such replacements may corrupt the file and make it completely unusable. </para
></warning>

<para
>In order to switch the above behaviour off, you should commit binary files (or other files, like Postscript or PNG images) by choosing <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Add Binary...</guimenuitem
></menuchoice
>. The <guilabel
>CVS Add</guilabel
> dialogue will appear, listing the binary files you marked, and asks for confirmation. Press <guibutton
>OK</guibutton
>. </para>

<para
>&cervisia; issues a command </para>

<para>
<screen
><command
>cvs add -kb <replaceable
>file names</replaceable
></command
></screen>
</para>

</sect1>


<sect1 id="removingfiles">
<title
>Removing Files</title>

<para
>Like adding files, removing files is done in two steps: First, the files have to be registered as removed by choosing <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Remove From Repository...</guimenuitem
></menuchoice
> or right clicking the marked files and choosing <guimenuitem
>Remove From Repository...</guimenuitem
> from the pop-up menu. The <guilabel
>CVS Remove</guilabel
> dialogue will appear, listing the files you marked, and asking for confirmation. Press <guibutton
>OK</guibutton
>. &cervisia; issues the command </para>
<para>
<screen
><command
>cvs remove -f <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>After that, this modification to the sandbox has to be committed, possibly together with other modifications to the project. </para>

<note
><para
>The above command only works if the file is up-to-date. Otherwise, you get an error message. This behaviour is sensible: If you have modified the file compared to the version in the repository, or if someone else has made any modifications, you will first want to check if you really want to discard them. </para
></note>

</sect1>
   
   
<sect1 id="addingremovingdirs">
<title
>Adding and Removing Folders</title>

<para
>Folders are handled fundamentally different from ordinary files by &CVS;. They are not under revision control, i.e. you cannot tell which folders existed in the project at a certain time. Furthermore, folders can never be explicitly removed (expect by removing them directly in the repository). </para>

<para
>As a substitute, &CVS; follows the convention that a folder is "non-existent" in a version of the project if it is empty. This convention can be enforced by using the option <option
>-P</option
> to <command
>cvs update</command
> and <command
>cvs checkout</command
>. This option can be set in the menu <menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Prune Empty Folders on Update</guimenuitem
></menuchoice
>. </para>

<para
>A folder can be added to the repository choosing <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Add to Repository...</guimenuitem
></menuchoice
> or right clicking the marked folder and choosing <guimenuitem
>Add to Repository...</guimenuitem
> from the pop-up menu. Note that in contrast to adding files, adding folders does not require a commit afterwards. &cervisia; issues the command </para>


<para>
<screen
><command
>cvs add <replaceable
>dirname</replaceable
></command
></screen>
</para>

</sect1>


<sect1 id="committingfiles">
<title
>Committing Files</title>

<para
>When you have made a certain number of changes to your working copy, and you want other developers to have access to them, you <emphasis
>commit</emphasis
> them. With a commit, you place your versions of the modified files as new revisions into the repository. A subsequent update by another developer will bring your modifications into their working copy. </para>

<para
>In order to commit a couple of files, select them in &cervisia;'s main view and choose <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Commit...</guimenuitem
></menuchoice
> or right click the marked files and choose <guimenuitem
>Commit...</guimenuitem
> from the pop-up menu. </para>

<figure id="screenshot-commit" float="1">
<title
>A screenshot of &cervisia;'s commit dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="commit.png"/></imageobject>
</mediaobject>
</figure>

<para
>You get a dialogue that shows you a list of the selected files on the top section and a log message for your changes below. &cervisia; helps you in several ways to find a meaningful log message: first, in the file list you can double-click a file or press <keycap
>Return</keycap
> in order to see the changes you have made to the file. Second, it gives you a list of log messages you have previously used in a combo box. Third, this dialogue is integrated with &cervisia;'s changelog editor described below. When you have finished the dialogue, the command </para>

<para>
<screen
><command
>cvs commit -m <replaceable
>message</replaceable
> <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>is used. </para>


<note
><para
>A common error you may encounter when committing is <errorname
>Up-to-date check failed</errorname
>. This indicates that someone has committed changes to the repository since you last updated; or, more technically, that your <literal
>BASE</literal
> revision is not the newest on its branch. In such a case, &CVS; refuses to merge your modifications into the repository. The solution is to update, resolve any conflicts and commit again. Of course, if you are working on a software project, it is normally good style to check if the program still works after you have updated - after all, there could be bad interactions between your modifications and the other modifications which break the code. </para
></note>

<note>
<para
>Another popular mistake results in the error message <errorname
>Sticky tag 'X' for file 'X' is not a branch</errorname
>. This happens if you try to commit a file which you have previously brought to a certain revision or tag with the command </para>
<para>
<screen
><prompt
>%</prompt
><userinput
>cvs update -r X</userinput
></screen>
</para>
<para
>(which is &eg; used by the menu item <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Update to Tag/Date...</guimenuitem
></menuchoice
>). In such a case, the tag on the file gets sticky, i.e. further updates do not bring you to the newest revision on the branch. If you want to commit further revisions to the branch, you have to update to the branch tag before you do further commits. </para>
</note>

<para
>With &cervisia;, it is quite easy to maintain a ChangeLog file that is compliant with the format laid out in the GNU coding guidelines. To use it, choose <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Insert ChangeLog Entry...</guimenuitem
></menuchoice
>. If a file with the name <filename
>ChangeLog</filename
> exists in the toplevel folder of your sandbox, this file will be loaded and you have the possibility to edit it. To this end, at the top of the file, an entry with the current date and your user name (which can be configured as described in <xref linkend="customize-general"/>) is inserted. When you finish the dialogue this dialogue by clicking <guibutton
>OK</guibutton
>, the next commit dialogue you open will have the log message set to the message you last entered in the ChangeLog. </para>

</sect1>


<sect1 id="resolvingconflicts">
<title
>Resolving Conflicts</title>

<para
>Conflicts may occur whenever you have made changes to a file which was also modified by another developer. The conflict is detected by &CVS; when you update the modified file; &CVS; then tries to merge the modifications committed by the other developer into your working copy. The merge fails if both your and his modifications are in overlapping parts of the file, and the &CVS; server issues an error message. </para>

<para
>In &cervisia;'s main view, files with conflicts are indicated with "Conflict" in the status column and with a red colour. It is your job now to resolve these conflicts before you commit the file. &CVS; will refuse to commit any files with conflicts until they have been edited. From the main view, you can of course resolve conflicts the traditional way: just double-click the file in question and edit it with your favourite editor.</para>

<para
>&CVS; marks the conflicting changes by placing marks in the middle of the files, in the following manner:</para>

<screen
>&lt;&lt;&lt;&lt;&lt;&lt;&lt;
Changes in your working copy
=======
Changes in the repository
&gt;&gt;&gt;&gt;&gt;&gt;&gt; revision_number
</screen>

<para
>You should replace this whole block with the new merged version. Of course, you have a great amount of freedom when resolving a set of conflicts: you can for each conflict decide to take one of the two alternative versions. You can also decide that both approaches are are broken and rewrite a whole routine or the complete file from scratch. </para>

<para
>Fortunately, &cervisia; offers a nicer interface for handling these conflicts. This does not mean that you will never need to manually edit the files, but at least can eliminate the need to do so for the trivial conflict resolution. To use &cervisia;'s <guilabel
>CVS Resolve</guilabel
> dialogue choose <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Resolve...</guimenuitem
></menuchoice
> or right click the marked file and choose <guimenuitem
>Resolve...</guimenuitem
> from the pop-up menu. </para>

<figure id="screenshot-resolve" float="1">
<title
>A screenshot of &cervisia;'s resolve dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="resolve.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s resolve dialogue</phrase
></textobject>
</mediaobject>
</figure>

<para
>On the top of the dialogue, you see <guilabel
>Your version (A)</guilabel
> of the file on the left hand side and the version in the repository, <guilabel
>Other version (B)</guilabel
>, on the right hand side. The differences between them are marked in red colour. Below these two versions, you can see the <guilabel
>Merged version</guilabel
>. The merged version reflects what that section will be in your working copy if you press the <guibutton
>Save</guibutton
> button. </para>

<para
>You can go back and forward between the conflicting sections by pressing <guibutton
>&lt;&lt;</guibutton
> and <guibutton
>&gt;&gt;</guibutton
>. In the lower middle of the dialogue you can see which section is currently marked. For example, <literal
>2 of 3</literal
> means that you are currently at the second differing section of 3 total. </para>

<para
>Now can can decide section by section which version you want to have in the merged file. By pressing <guibutton
>A</guibutton
>, you take over the version you edited. By pressing <guibutton
>B</guibutton
>, you take over the version from the repository. By pressing <guibutton
>A+B</guibutton
>, both versions will be added, and your version will come first. <guibutton
>B+A</guibutton
> yields the same result, but the order will be different: first the repository version, then yours. </para>

<para
>If you are not happy with any of these versions, press <guibutton
>Edit</guibutton
> to open a simple text editor where you can edit the section. When you are finished editing, press <guibutton
>OK</guibutton
> to return to the <guilabel
>CVS Resolve</guilabel
> dialogue and resume solving conflicts. You will see the section you just edited in the <guilabel
>Merged version</guilabel
>, with your modifications. </para>

<para
>To save your modifications, overwriting the working copy version, press <guibutton
>Save</guibutton
>. Note that this will save the choices not only the section you are currently viewing, but all sections in the file. If you want to save it to another file, press <guibutton
>Save As...</guibutton
>. Press <guibutton
>Close</guibutton
> to exit the dialogue. If you close the dialogue without saving, the changes you made will be lost. </para>

</sect1>

</chapter>


<chapter id="obtaininginformation">
<title
>Obtaining Information About Files and Creating Patches</title>

<sect1 id="diff">
<title
>Watching Differences Between Revisions</title>

<para
>There are several places in &cervisia; where you can ask for a window showing the differences between revisions of a file: </para>

<itemizedlist>

<listitem
><para
>In the main view, you can choose <menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Difference to Repository (BASE)...</guimenuitem
></menuchoice
>. This is based on the command <command
>cvs diff</command
> and shows you the differences between the version in your sandbox and the version to which you last updated (also known as <literal
>BASE</literal
>). This is in particular useful just before you commit a file, so you can find an appropriate log message. </para
></listitem>

<listitem
><para
>You can view the differences between the version in your sandbox and the version in the main development branch (also called <literal
>HEAD</literal
>) by choosing <menuchoice
><guimenu
>View</guimenu
> <guimenuitem
>Difference to Repository (HEAD)...</guimenuitem
></menuchoice
>. </para
></listitem>

<listitem
><para
>You can view the differences between the last two revisions of the selected file choosing <menuchoice
><guimenu
>View</guimenu
> <guimenuitem
>Last Change...</guimenuitem
></menuchoice
>. </para
></listitem>

<listitem
><para
>You can access the <guimenuitem
>Difference to Repository (BASE)...</guimenuitem
>, <guimenuitem
>Difference to Repository (HEAD)...</guimenuitem
> and <guimenuitem
>Last Change...</guimenuitem
> menu items from the main view pop-up menu, by right-clicking the file you want to view. </para
></listitem>

<listitem
><para
>In the dialogue that is shown when a you commit a set of files, you can request a difference window by selecting a file name in the selection list, either by double-clicking it or by pressing <keycap
>Return</keycap
>. This is quite similar to using <menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Difference to Repository (BASE)...</guimenuitem
></menuchoice
> with the respective file in the main view. </para
></listitem>

<listitem
><para
>In the Browse Logs dialogue, you can mark two revisions of a file and request a dialogue showing the differences between them (see <xref linkend="browsinglogs"/>). </para
></listitem>

</itemizedlist>

<para
>As you may have expected, &cervisia; does not just dump the output of the <command
>diff</command
> command into your terminal, but shows you a graphical view as seen in <xref linkend="screenshot-log"/>. </para>

<figure id="screenshot-log" float="1">
<title
>A screenshot of &cervisia;'s diff dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="diff.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s diff dialogue</phrase
></textobject>
</mediaobject>
</figure>

<para
>The text in the dialogue is an improved variant of the text given by the diff command with the <option
>-u</option
> option. You can see the differing versions in two windows, with lines arranged such that you can do a side-by-side comparison. That means, where text has been added or deleted, the respective window shows empty lines with the marker <literal
>+++++</literal
> at the left hand side. Elsewhere, you can see the running number of each line in the left column. </para>

<para
>In the second column in the right window, you can see which kind of change has been made. Possible types are <literal
>Add</literal
>, <literal
>Delete</literal
> and <literal
>Change</literal
>. The respective lines are marked in blue, green and red colour. In the middle of the dialogue a compressed image of the colour markers is shown. In this way, you can get a quick overview of the overall changes to the file. You can also use the position of the coloured regions in the compressed image as an orientation when you using the scroll bars. </para>

<para
>Normally, the scrollbars at the left and the right window are synchronised, i.e. if you scroll on the left hand side, the right hand side is scrolled by the same amount. You can change this by checking the box <guibutton
>Synchronise scroll bars</guibutton
>. </para>

<para
>For information about how to customise the diff dialogue, see <xref linkend="customize-diff"/>. </para>

</sect1>

<sect1 id="creatingpatches">
<title
>Creating Patches</title>

<para
>Sometimes you want to offer your modifications for review, before committing them, or you do not have write access to the repository (therefore you cannot commit). &CVS; offers standard formats to share the modifications in your working copy, so other people can review your changes, test them in their working copy and apply them to the &CVS; repository. A file containing these differences is called a <firstterm
>patch</firstterm
>, and is generated by the <command
>cvs diff</command
> command, in the same way as the differences in <xref linkend="diff"/>. Sharing patches instead of sets of files requires less bandwidth, and patches are easier to handle, as you can send only one patch file containing all the differences from many source files. </para>

<para
>&cervisia; gives you to access to this feature by choosing <menuchoice
><guimenu
>Advanced</guimenu
> <guimenuitem
>Create Patch Against Repository</guimenuitem
></menuchoice
>. </para>

<important
><para
>The <guimenuitem
>Create Patch Against Repository</guimenuitem
> action creates a patch with all modifications in all files in your working copy (sandbox) against the <literal
>BASE</literal
> repository. Therefore, the selection of files in the main view does not affect the patch that will be generated. </para
></important>

<para
>Another possibility is to select one file in the main view and choose <guimenuitem
>Browse Log...</guimenuitem
> from the <guimenu
>View</guimenu
> menu or right click the marked file and choose <guimenuitem
>Browse Log...</guimenuitem
> from the pop-up menu, in order to open the <link linkend="browsinglogs"
>Browse log dialogue</link
>. Now, select the version you want to create a patch against, as revision &quot;A&quot; and press the button <guilabel
>Create Patch...</guilabel
>. This will generate a patch with the differences between the <emphasis
>marked file</emphasis
> in your working copy and the version selected as revision &quot;A&quot;. </para>

<para
>Before generating the patch, &cervisia; displays a dialogue allowing you to configure the output format. </para>

<figure id="screenshot-patch" float="1">
<title
>A screenshot of &cervisia;'s patch dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="patch.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s patch dialogue</phrase
></textobject>
</mediaobject>
</figure>

<variablelist>

<varlistentry>
<term
><guilabel
>Output Format</guilabel
></term>
<listitem
><para
>There are three output formats available: </para>
<para
><guilabel
>Normal</guilabel
>: a format that can be used to cause the ed editor to automatically make another copy of the old file match the new file. In the normal output format, the characters &lt; and &gt; mark the changes, and there is no context information. </para>
<para
><guilabel
>Unified</guilabel
>: the most used format for exchanging patches. The unified format uses context lines in addition to line numbers to record the differences. This makes the process of applying patches more robust. This format displays the differences in a compact and readable form, with a header for each file involved, and separate sections (chunks) for each difference. The context lines available for each difference make reading the modifications easier. In the unified output format, the characters + and - mark the changes. </para>
<para
><guilabel
>Context</guilabel
>, which presents the same information as the unified format, but in a less compact way. In the context output format, the character ! marks the changes. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Number of context lines:</guilabel
></term>
<listitem
><para
>Set here the number of context lines for the unified or context output formats. This option is not available for the normal output format, as in this format no context information is recorded. More context information makes reading the raw output easier, and applying the patch more precise, but increases the patch size. It is recommended to use at least two context lines for proper patch operation. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Ignore Options</guilabel
></term>
<listitem
><para
>Check here the changes that should not be considered as differences when generating the patch. </para
></listitem>
</varlistentry>

</variablelist>


<para
>After setting the output format, &cervisia; generates the patch and displays the <guilabel
>Save As</guilabel
> dialogue. Enter in this dialogue the file name and location of the patch file. </para>


</sect1>

<sect1 id="annotate">
<title
>Watching an Annotated View of a File</title>

<para
>With the command <command
>cvs annotate</command
>, &CVS; offers the possibility to see - for each line in a file - who has modified a line the most recently. This view may be helpful in order to find out who has introduced a change in the behavior of a program or who should be asked about some change or bug in the code. </para>

<para
>&cervisia; gives you to access to this feature, but it further enriches the information in an interactive way. You obtain an annotate view by choosing <menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Annotate...</guimenuitem
></menuchoice
>. Another possibility is to press the button <guilabel
>Annotate</guilabel
> in the <link linkend="browsinglogs"
>Browse log dialogue</link
>, in which you can select which version of the file you want to display. In <xref linkend="screenshot-annotate"/> you can see a screenshot of the dialogue. </para>

<figure id="screenshot-annotate" float="1">
<title
>A screenshot of &cervisia;'s annotate dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="annotate.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s annotate dialogue</phrase
></textobject>
</mediaobject>
</figure>

<para
>In the annotate dialogue, you see in a window the latest version of the selected file (or the revision &quot;A&quot; version, in case you launched the annotate dialogue from the the <link linkend="browsinglogs"
>Browse log dialogue</link
>). In the columns before the text, you get some information related to the latest change in each line. In the first column the line number is displayed. In the second column you see the name of the author and revision number. Finally, in the third column you see the actual content of that line. </para>

<para
>Consequently, when a certain line appears strange to you or you assume a bug there, you can immediately see who is responsible for that line. But not only that, you can also find out <emphasis
>why</emphasis
> that line was changed. To this end, move the mouse cursor over the respective revision number. Then a tooltip appears that shows the log message and the date of the change. </para>

</sect1>


<sect1 id="browsinglogs">
<title
>Browsing &CVS; Logs</title>

<para
>When you mark one file in the main view and choose <guimenuitem
>Browse Log...</guimenuitem
> from the <guimenu
>View</guimenu
> menu or right click the marked file and choose <guimenuitem
>Browse Log...</guimenuitem
> from the pop-up menu, the <guilabel
>CVS Log</guilabel
> dialogue is shown (if you mark more than one, nothing happens, as &cervisia; can only generate and parse the log for one file at a time). This dialogue offers functionality that is beyond viewing the file's history. Using it as a version browser you can: </para>

<itemizedlist>

<listitem
><para
>View the revision, author, date, branch, commit message and tags for each version of the marked file. </para
></listitem>

<listitem
><para
>View a graphical tree representation showing the branching and tagging of the marked file. </para
></listitem>

<listitem
><para
>View any version of the marked file (with the default application). </para
></listitem>

<listitem
><para
>Watch an annotated view of any version of the marked file </para
></listitem>

<listitem
><para
>View the differences between any pair of versions of the marked file, including pairs with the current working copy version of the marked file. </para
></listitem>

<listitem
><para
>Create patches containing the differences between any pair of versions of the marked file, including pairs with the current working copy version of the marked file. </para
></listitem>

</itemizedlist>

<figure float="1">
<title
>A screenshot of &cervisia;'s browse logs dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="logtree.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s browse logs dialogue</phrase
></textobject>
</mediaobject>
</figure>

<para
>You can choose to see the history as provided by the <command
>cvs log</command
> command (<guilabel
>CVS Output</guilabel
>), as a <guilabel
>Tree</guilabel
>, or in <guilabel
>List</guilabel
> form. What you prefer is of course a matter of taste and it depends on what information you are interested in. The tree is an intuitive representation of what has been done on different branches by which authors. As tooltips, you can see the corresponding log messages. The list is by its nature linear and, therefore, does not give an immediate view of branches; on the other hand, it concentrates more otherwise relevant information on less screen estate, namely the time of each change of the file and the first part of the log message. The CVS output information is complete, but long, and difficult to read. To alleviate these problems, you have the ability to search the text of the CVS output, by pressing the <guibutton
>Find...</guibutton
> button. </para>

<para
>To obtain more information about a certain revision, you can click on it either in the list or the tree view. The fields in the middle of the dialogue are then filled with the complete information provided by <command
>cvs log</command
>. You can mark two revisions, called &quot;A&quot; and &quot;B&quot;, which are relevant if you make use of further features provided by the buttons. Revision &quot;A&quot; can be chosen with the left mouse button, revision &quot;B&quot; with the middle one. In the list view, you can also navigate with with your cursor keys. In order to mark revisions &quot;A&quot; and &quot;B&quot;, use the keybindings <keycombo
><keycap
>Ctrl</keycap
><keycap
>A</keycap
></keycombo
>, <keycombo
><keycap
>Ctrl</keycap
><keycap
>B</keycap
></keycombo
>, respectively. Using the <guilabel
>CVS Output</guilabel
> view, you can click on the <guilabel
>Select for revision A</guilabel
> and <guilabel
>Select for revision B</guilabel
> to mark the revisions. </para>

<para
>If you press the <guibutton
>Annotate</guibutton
> button, you get a dialogue showing the text of file belonging to the revision marked as &quot;A&quot;. Every line is prefixed with the information about who edited this last time, and at which revision this happened. You can get more information about viewing annotated versions in <xref linkend="annotate"/>. </para>

<para
>If you press the <guibutton
>Diff</guibutton
> button, a <command
>cvs diff</command
> call is issued and you get a dialogue in which all the modifications between the two marked revisions are shown. If you mark revision &quot;A&quot;, but not revision &quot;B&quot;, &cervisia; will generate the modifications between the file version marked as revision &quot;A&quot; and the working copy version of the file. This allows you to view the differences between your version of the file and any version available in &CVS;. To make it easy to see the changes, different colours are used to mark lines which have been added, removed or simply changed. You can get more information about viewing differences in <xref linkend="diff"/>. </para>

<para
>If you press the <guibutton
>Create Patch...</guibutton
> button, you get a dialogue in which you can set the format options for generating a file containing all the modifications between the two marked revisions which are shown. If you mark revision &quot;A&quot;, but not revision &quot;B&quot;, &cervisia; will generate the modifications between the file version marked as revision &quot;A&quot; and the working copy version of the file. This allows you to generate a patch, or difference file, between your version of the file and any version available in &CVS;. After configuring the format of the patch in the dialogue, and pressing <guibutton
>OK</guibutton
>, a <command
>cvs diff</command
> command is issued to generate the difference file. A <guilabel
>Save As</guilabel
> dialogue will pop up. Enter the file name and location of the patch file &cervisia; generated, in order to save it. You can get more information about creating patches, and the patch format options in <xref linkend="creatingpatches"/>. </para>

<para
>If you press the <guibutton
>View</guibutton
> button, &cervisia; will retrieve the revision marked as &quot;A&quot; and display it using the default application for its file type. </para>

<para
>Press the <guibutton
>Close</guibutton
> button to leave the dialogue and return to the main view. </para>


<para
>To generate the log that is the base for the <guilabel
>CVS Log</guilabel
> dialogue, &cervisia; issues the following command: </para>


<para>
<screen
><command
>cvs log <replaceable
>file name</replaceable
></command
></screen>
</para>

</sect1>

<sect1 id="browsinghistory">
<title
>Browsing the History</title>

<para
>If the used repository has logging enabled, &cervisia; can present you a history of certain events like checkouts, commits, rtags, updates and releases. Choose <guimenuitem
>History</guimenuitem
> from the <guimenu
>View</guimenu
> menu, and &cervisia; will issue the command </para>

<para>
<screen
><command
>cvs history -e -a</command
></screen>
</para>

<note
><para
>This fetches the complete logging file from the server, i.e. a list of the events for all users and all modules. This can be a huge amount of data. </para
></note>

<para
>Now you can see the list of events, sorted by date. In the second column, the type of the event is shown: </para>

<itemizedlist>

<listitem
><para
>Checkout - The user who is displayed in the 'Author' column has checked out a module </para
></listitem>

<listitem
><para
>Tag - A user has used the command <command
>cvs rtag</command
>. Note that the usage of <command
>cvs tag</command
> (as done by &cervisia;'s <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Tag/Branch...</guimenuitem
></menuchoice
> command) is not recorded in the history database. This has historical reasons (see the &CVS; <acronym
>FAQ</acronym
>). </para
></listitem>

<listitem
><para
>Release - A user has released a module. Actually, this command is rarely used and not of much value. </para
></listitem>

<listitem
><para
>Update, Deleted - A user has made an update on a file which was deleted in the repository. As a consequence, the file was deleted in his working copy. </para
></listitem>

<listitem
><para
>Update, Copied - A user has made an update on a file. A new version was copied into working copy. </para
></listitem>

<listitem
><para
>Update, Merged - A user has made an update on a file. The modifications in the repository version on the file were merged into his working copy. </para
></listitem>

<listitem
><para
>Update, Conflict - A user has made an update on a file, and a conflict with his own modifications was detected. </para
></listitem>

<listitem
><para
>Commit, Modified - A user committed a modified file. </para
></listitem>

<listitem
><para
>Commit, Added - A user added a file and committed it. </para
></listitem>

<listitem
><para
>Commit, Removed - A user removed a file and committed it. </para
></listitem>

</itemizedlist>

<figure id="screenshot-history" float="1">
<title
>A screenshot of &cervisia;'s history dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="history.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s history dialogue</phrase
></textobject>
</mediaobject>
</figure>

<para
>You can sort the list by other criteria simply by clicking on the respective column header. In order to sort out the history entries you are interested in, there are various filter options activated by check boxes: </para>

<itemizedlist>
<listitem
><para
>Show commit events - shows commits</para
></listitem>
<listitem
><para
>Show checkout events - shows checkouts</para
></listitem>
<listitem
><para
>Show tag events - shows taggings</para
></listitem>
<listitem
><para
>Show other events - shows events not included in the above</para
></listitem>
<listitem
><para
>Only user - shows only events caused by a certain user</para
></listitem>
<listitem
><para
>Only file names matching - filters file names by a regular expression</para
></listitem>
<listitem
><para
>Only dirnames matching - filters folder names by a regular expression</para
></listitem>
</itemizedlist>

<para
>Special characters recognised by the regular expression matcher are: </para>

<itemizedlist>

<listitem
><para
><literal
>x*</literal
> matches any number of occurrences of the character <literal
>x</literal
>. </para
></listitem>

<listitem
><para
><literal
>x+</literal
> matches one or more of occurrences of the character <literal
>x</literal
>. </para
></listitem>

<listitem
><para
><literal
>x?</literal
> matches zero or one occurrences of the character <literal
>x</literal
>. </para
></listitem>

<listitem
><para
><literal
>^</literal
> matches the start of the string. </para
></listitem>

<listitem
><para
><literal
>$</literal
> matches the end of the string. </para
></listitem>

<listitem
><para
><literal
>[a-cx-z]</literal
> matches a set of characters, &eg; here the set consisting of a,b,c,x,y,z. </para
></listitem>

</itemizedlist>

</sect1>


</chapter>

<chapter id="advancedusage">
<title
>Advanced Usage</title>

<sect1 id="updatingto">
<title
>Updating to Tag, Branch or Date</title>

<para
>Branches of a module are parallel versions of this module. A good real life example of the use of this feature is the release of a software project. After a major release, there are bugs in the code that should be fixed, but people want to add new features to the application too. It is very hard to do both at the same time because new features usually introduce new bugs, making it hard to track down the old ones. To solve this dilemma, &CVS; lets you create a parallel version, that we will call the &quot;stable release branch&quot;, where you can only add bugfixes, leaving the main branch (HEAD) open for adding new features. </para>

<para
>Tags are used to mark a version of a project. &CVS; stamps one version of each file with the tag, so when you checkout or update to a specific tag, you will get always the same file versions; therefore, as opposed to branches, tags are not dynamic: you cannot develop a tag. Tags are useful to mark releases, big changes in the code &etc; </para>

<para
>When you are developing or following the development of a software project, you do not necessarily work with the main branch all the time. After a release, you may want to stay with the released branch for a while, to enjoy its relative stability, fix bugs, translate the sources &etc; To do all that, you have to update to the released branch. All your files will be updated to the latest version of the files in that branch. After updating, all your new commits will be uploaded to the new branch as well. </para>

<para
>Also, if you want to track a bug that was reported against a past tagged release, &CVS; offers you the possibility to retrieve the software as it was released, by updating to that tag. Besides, if you want to fetch a past version of your project, you can update your working copy to a specific date. This may be useful if an error was introduced in the project between two releases, and you have an opinion on when that was. When you update to a date or tag, the versions of your files will be the same as the versions in that specific date or the versions stamped by that tag. </para>

<warning
><para
>Before updating to a different branch or tag, make sure you committed all your changes to the branch you are working with. If your are not ready to commit your changes, but do not want to discard them, do not update to the new branch, as you may lose your changes. As an alternative, you can do a new <link linkend="checkingout"
>checkout</link
>, to work in parallel with both versions. </para
></warning>

<figure id="screenshot-updatetag" float="1">
<title
>A screenshot of &cervisia;'s update to tag dialogue</title>
<mediaobject>
<imageobject
><imagedata format="PNG" fileref="updatetag.png"/></imageobject>
<textobject
><phrase
>A screenshot of &cervisia;'s update to tag dialogue</phrase
></textobject>
</mediaobject>
</figure>

<variablelist>
<varlistentry>
<term
><guilabel
>Update to branch</guilabel
></term>
<listitem
><para
>Select this option to update to a branch. Enter the name of the branch in the drop down edit box (or press the <guilabel
>Fetch List</guilabel
> button to retrieve the list of branches from the &CVS; server, and select the one you want in the drop down list). </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Update to tag</guilabel
></term>
<listitem
><para
>Select this option to update to a tag. Enter the name of the tag in the drop down edit box (or press the <guilabel
>Fetch List</guilabel
> button to retrieve the list of tags from the &CVS; server, and select the one you want in the drop down list). </para
></listitem>
</varlistentry>

<varlistentry>
<term
><guilabel
>Update to date</guilabel
></term>
<listitem
><para
>Select this option to update to a date. In the field below, you can enter a wide variety of date formats. One possible format is <literal
>yyyy-mm-dd</literal
> where <literal
>yyyy</literal
> is the year, <literal
>mm</literal
> is the month (numerically) and <literal
>dd</literal
> is the day. Alternatives are some English phrases like <literal
>yesterday</literal
> or <literal
>2 weeks ago</literal
>. </para
></listitem>
</varlistentry>

</variablelist>

<note
><para
>Updating to a tag or date make them 'sticky', &ie; you can not commit further modifications on that files (unless the tag is a branch tag). In order to get back to the main branch, use the menu item <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Update to HEAD</guimenuitem
></menuchoice
>. </para
></note>

<para
>The comand issued to update to a branch or tag is: <screen
><command
>cvs update -r <replaceable
>tag</replaceable
></command
></screen>
</para>

<para
>The command issued to update to a date is: <screen
><command
>cvs update -D <replaceable
>date</replaceable
></command
></screen>
</para>

<para
>The command issued to update to the main branch (HEAD) is: <screen
><command
>cvs update <option
>-A</option
></command
></screen>
</para>

</sect1>


<sect1 id="taggingbranching">
<title
>Tagging and Branching</title>

<para
>We discuss here only the technical aspects of tagging and branching. If you are only a <emphasis
>user</emphasis
>, not the administrator of the repository, you will probably not be confronted with the problem. If however you are your own administrator, you should first read about the non-technical problems that accompany branching, in order to get an impression of how time-consuming and error-prone maintaining different branches of a project can be. The appendix includes some references about this topic. </para>

<para
>Simple tagging is something you usually do when a release is made, so that you can at any time easily get back to the project state at that time. Tags are usually given a name consisting of the project name and the version number. For example, &cervisia; 1.0 is available under the tag <literal
>CERVISIA_1_0</literal
>. &cervisia; enforces &CVS;'s strict rules about what constitutes valid tag name. It must begin with a letter and may contain letters, digits, hyphens and underscores. </para>

<para
>Normally, you will want to tag the whole project (although &CVS; of course allows you to tag only a subset). To this end, mark the toplevel folder in the view and choose <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Tag/Branch</guimenuitem
></menuchoice
>. Now enter the name of the tag, press <keycap
>Return</keycap
> and you are done. </para>

<para
>Creating a branch is not significantly more difficult: In the tag dialogue, check the box <guibutton
>Create branch with this tag</guibutton
>. You can also delete an existing tag: Choose <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Delete Tag</guimenuitem
></menuchoice
> in the main view. </para>

<para
>Another aspect of branching is the merging of modifications from a branch to the current branch. If you are going to do this, choose <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Merge...</guimenuitem
></menuchoice
>. The dialogue that appears now gives you two options: </para>

<para
>Either you may merge all modifications done on a branch to the current branch. In that case, check the box <guibutton
>Merge from branch</guibutton
> and fill in the branch you want to merge from. &cervisia; will then execute the command </para>

<para>
<screen
><command
>cvs update <option
>-j</option
> <replaceable
>branchtag</replaceable
></command
></screen>
</para>

<para
>The other possibility is that you want to merge only the modifications made between two tags on a branch. This usually happens when you merge from the same branch to the trunk several times. In that case, check the box <guibutton
>Merge modifications</guibutton
> and enter (in the correct order) the two relevant tags. This will result in a command </para>

<para>
<screen
><command
>cvs update <option
>-j</option
> <replaceable
>branchtag1</replaceable
> <option
>-j</option
> <replaceable
>branchtag2</replaceable
></command
></screen>
</para>

</sect1>


<sect1 id="watches">
<title
>Using Watches</title>

<para
>A watch is the conventional name for &CVS;'s feature to notify users of the repository whenever a file has been changed or a developer has started editing a file. The usage of watches requires that the file <filename
><envar
>$CVSROOT</envar
>/CVSROOT/notify</filename
> has been set up properly. This is not discussed here; if you need further information on the setup from the administrator's point of view, read one of the books listed in the appendix. </para>

<para
>&cervisia;'s main support of watches are six menu items. </para>

<para
>In order to add a watch to one or several files, use <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Add Watch...</guimenuitem
></menuchoice
>. In the dialogue you get, you can choose to get notified for any of the types of events that &CVS; supports. For example, if you only want to get notified when a file is committed, check the boxes <guibutton
>Only</guibutton
> and <guibutton
>Commits</guibutton
>. If you want to get notified about any event related to the marked files, check the box <guibutton
>All</guibutton
>. The command line used when you accept the dialogue is </para>

<para>
<screen
><command
>cvs watch add -a commit <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>or with a similar option, depending on the events you chose to watch. </para>

<para
>If you are not interested in some files anymore, you can remove your watches on them. To this end, use <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Remove Watch...</guimenuitem
></menuchoice
>. In the dialogue you get here, the same options are offered as in the form you filled out when adding the watch. When you confirm this dialogue, &cervisia; issues the command </para>

<para>
<screen
><command
>cvs watch remove <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>possibly with an option <option
>-a</option
> for the chosen events. </para>

<para
>Finally, you can get a list of the people who are watching a couple of files. Choose <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Show Watchers</guimenuitem
></menuchoice
>. Using this menu item will result in a command </para>

<para>
<screen
><command
>cvs watchers <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>In the normal usage scenario of &CVS;, each developer works separately in his checked out sandbox. When he wants to modify some file, he can just open it in his editor and start working on it. Nobody else will know about this work until the file gets committed. </para>

<para
>For some developer groups, this is not the preferred model of cooperation. They want to get notified about someone working on a file <emphasis
>as soon as</emphasis
> he starts with it. This can be achieved by some further &CVS; commands. Before you start editing a file, select it in &cervisia;'s main window and choose <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Edit</guimenuitem
></menuchoice
>. This will execute the command </para>

<para>
<screen
><command
>cvs edit <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>This will send out a notification to everyone who has set an <literal
>edit</literal
> watch on this file. It will also register you as an <emphasis
>editor</emphasis
> of the file. You can obtain a list of all editors of a certain file by using <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Show Editors</guimenuitem
></menuchoice
>. This is equivalent to typing on the command line </para>

<para>
<screen
><command
>cvs editors <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>An editing session is automatically ended when you commit the affected file. At that moment, an <literal
>unedit</literal
> notification gets sent out to all people who have registered a respective watch on the file. Of course, sometimes you may not want to commit the file, but abort the editing session and revert to the previous version of the file. This is done by using <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Unedit</guimenuitem
></menuchoice
>. Note that &cervisia; will not ask you for confirmation; that means if you use this menu item, all your work done since you used <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Edit</guimenuitem
></menuchoice
> will be lost. Precisely, &cervisia; uses the command line </para>

<para>
<screen
><command
>echo y | cvs unedit <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>So far, we have only the discussed the case where edits and unedits are used voluntarily be the developers. In addition &CVS; supports a model which <emphasis
>enforces</emphasis
> the usage of these commands. The responsible command to switch to this model is <command
>cvs watch on</command
> which we will not explain further because it is mostly used by the administrator of the repository. However, the important point from the developer's point of view is that when the project enforces edits, working copies are checked out <emphasis
>readonly</emphasis
>. That means you cannot edit a file by default (unless you use tricks like <command
>chmod</command
>). Only when you use <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Edit</guimenuitem
></menuchoice
>, the file becomes writable. It is made read-only again when you commit the file or use <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Unedit</guimenuitem
></menuchoice
>. </para>

<para
>&cervisia;'s editor interface helps you with projects that enforce watches also in a different way. If you just started an editor with a readonly file by double-clicking on it or by using <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Edit</guimenuitem
></menuchoice
>, you would not be able to save your modifications later. This has of course a reason: Whenever you want to change a file, you should run <command
>cvs edit</command
> before, so that all people watching the file get a notification that you are working on it. </para>

<para
>In such a case, it is advisable to check the option <menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Do cvs edit Automatically When Necessary</guimenuitem
></menuchoice
>. Now, whenever you edit a file by double-clicking it, &cervisia; will run <command
>cvs edit</command
> before the editor is actually executed. Then you can edit your file as usual. When you have finished your work, commit your files, and the committed files are read-only again. </para>

</sect1>


<sect1 id="locking">
<title
>Locking</title>

<para
>The development model usually followed when &CVS; is used is called <emphasis
>unreserved checkouts</emphasis
>. Each developer has his own sandbox where he can edit files as he likes. If when the watch features - like <command
>cvs edit</command
> - are used, multiple developers can work on files synchronously. Changes done by a different developer are merged into the local sandbox when an update is performed. </para>

<para
>Other revision control systems - like <acronym
>RCS</acronym
> and <application
>SourceSafe</application
> use a different model. When a developer wants to a edit a file, he has to <emphasis
>lock</emphasis
> it. Only one developer at a time can a lock a file. When he has finished editing, the lock is released. On the one hand, with this model, conflicts can never happen. On the other hand, two developers can not work on the same file at the same time, even when their changes do not affect each other. This can be a bottleneck. We are not going to discuss the organisational benefits of both approaches. Nevertheless we mention that although &CVS; has some support for locking, it is not the preferred way of working with &CVS;. You should not use these features unless you are sure that your project manager allows them. </para>

<para
>With &cervisia;, you lock files as follows. Select the desired files in the main view. Then choose <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Lock</guimenuitem
></menuchoice
>. This runs the command </para>

<para>
<screen
><command
>cvs admin -l <replaceable
>file names</replaceable
></command
></screen>
</para>

<para
>The reverse effect is achieved by using <menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Unlock</guimenuitem
></menuchoice
>. This runs the command</para>

<para>
<screen
><command
>cvs admin -u <replaceable
>file names</replaceable
></command
></screen>
</para>

</sect1>

</chapter>


<chapter id="customization">
<title
>Customising &cervisia;</title>

<para
>&cervisia; can be customised in various ways to your needs and preferences. Some options which you may want to change regularly are directly available in the <guimenu
>Settings</guimenu
> menu. Others are united in a common dialogue which is available via <menuchoice
><guimenu
>Option</guimenu
><guimenuitem
>Settings...</guimenuitem
></menuchoice
>. </para>


<sect1 id="customize-general">
<title
>General</title>

<variablelist>

<varlistentry id="customize-username">
<term
><guilabel
>User name for the ChangeLog editor:</guilabel
></term>
<listitem
><para
>Whenever you use the menu item <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Insert ChangeLog Entry...</guimenuitem
></menuchoice
>, a new ChangeLog entry is generated with the current date and your username. Normally, it is considered good style to insert your full name and your email address into each of your ChangeLog entries. &cervisia; add automatically the full name and email address entered here. </para
></listitem>
</varlistentry>

<varlistentry id="customize-cvspath">
<term
><guilabel
>Path to cvs executable, or 'cvs':</guilabel
></term>
<listitem
><para
>Here you can set the name (or path) to the <command
>cvs</command
> command line client. By default, the &CVS; executable found in your <envar
>$PATH</envar
> is used by &cervisia;. </para
></listitem>
</varlistentry>

</variablelist>

</sect1>

<sect1 id="customize-diff">
<title
>Diff Viewer</title>

<variablelist>

<varlistentry id="customize-context">
<term
><guilabel
>Number of context lines in the diff dialogue:</guilabel
></term>
<listitem
><para
>For the diff dialogue, &cervisia; uses the option <option
>-U</option
> to <command
>diff</command
>. This lets <command
>diff</command
> show only a limited number of lines around each difference region (context lines). Here you can set the argument to <option
>-U</option
>. </para
></listitem>
</varlistentry>

<varlistentry id="customize-diffopt">
<term
><guilabel
>Additional options for cvs diff:</guilabel
></term>
<listitem
><para
>Here you can add additional arguments to the <command
>diff</command
>. A popular example is <option
>-b</option
> which lets <command
>diff</command
> ignore changes in the amount of whitespace. </para
></listitem>
</varlistentry>

<varlistentry id="customize-tabwidth">
<term
><guilabel
>Tab width in diff dialogue:</guilabel
></term>
<listitem
><para
>In the diff dialogue, tab characters present in your file or in the output of the <command
>diff</command
> command are expanded into a fixed number of space characters. By default, each tab is replaced by eight spaces, but here you can setup a different number. </para
></listitem>
</varlistentry>

<varlistentry id="customize-difffrontend">
<term
><guilabel
>External diff frontend:</guilabel
></term>
<listitem
><para
>When you use any of the features which show the diff dialogue, like <menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Difference to Repository...</guimenuitem
></menuchoice
>, &cervisia; invokes its internal diff frontend. If you prefer a different one, like <application
>Kompare</application
>, <application
>TkDiff</application
> or <application
>xxdiff</application
>, enter its file name and path here. </para
></listitem>
</varlistentry>

</variablelist>

</sect1>

<sect1 id="customize-status">
<title
>Status</title>

<variablelist>

<varlistentry id="customize-startstatus-remote">
<term
><guilabel
>When opening a sandbox from a remote repository, start a File-&gt;Status command automatically</guilabel
></term>
<listitem
><para
>When you check this option, the <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Status</guimenuitem
></menuchoice
> command is started whenever you open a remote sandbox. This command may need some time and also needs a connection to the server for remote repositories (making it unusable for offline usage). </para
></listitem>
</varlistentry>

<varlistentry id="customize-startstatus-local">
<term
><guilabel
>When opening a sandbox from a local repository, start a File-&gt;Status command automatically</guilabel
></term>
<listitem
><para
>When you check this option, the <menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Status</guimenuitem
></menuchoice
> command is started whenever you open a local sandbox. </para
></listitem>
</varlistentry>

</variablelist>

</sect1>

<sect1 id="customize-advanced">
<title
>Advanced</title>

<variablelist>

<varlistentry id="customize-timeout">
<term
><guilabel
>Timeout after which a progress dialogue appears (in ms):</guilabel
></term>
<listitem
><para
>Practically all &CVS; commands started in a sandbox which belongs to a remote repository need a connection to the &CVS; server. This is affected by delays from the network connection or a high load on the server. For this reason, for commands like <menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Difference to Repository...</guimenuitem
></menuchoice
> &cervisia; opens a dialogue which indicates that the command is still running and which allows you to abort it. Furthermore, this dialogue is used to show you error messages from &CVS;. As this dialogue may become annoying after some time, it is shown only after a certain timeout which is 4 seconds by default. Here you can change this value. </para
></listitem>
</varlistentry>

<varlistentry id="customize-compression">
<term
><guilabel
>Default compression level:</guilabel
></term>
<listitem
><para
>The <command
>cvs</command
> client compresses files and patches when they are transferred over a network. With the command line option <option
>-z</option
>, the compression level can be set. You can setup &cervisia; to use this option by configuring the level here. The value set here is used only as a default; additionally there is a per-repository setting available in <menuchoice
><guimenu
>Repository</guimenu
><guimenuitem
>Repositories...</guimenuitem
></menuchoice
>. </para
></listitem>
</varlistentry>

<varlistentry id="customize-sshagent">
<term
><guilabel
>Utilise a running or start a new ssh-agent process</guilabel
></term>
<listitem
><para
>Check this box if you use <link linkend="rsh"
>ext (rsh) repositories</link
>, the &ssh; remote shell to communicate with the repository and <application
>ssh-agent</application
> to manage your keys. </para
></listitem>
</varlistentry>

</variablelist>

</sect1>


<sect1 id="customize-look">
<title
>Look'n'feel</title>

<variablelist>

<varlistentry id="customize-protocolfont">
<term
><guilabel
>Font for protocol window...</guilabel
></term>
<listitem
><para
>Press this button to open the <guilabel
>Set Font</guilabel
> dialogue, to set the font used in the protocol window (this is the window showing the output of the <command
>cvs</command
> client). </para
></listitem>
</varlistentry>

<varlistentry id="customize-annotatefont">
<term
><guilabel
>Font for annotate view...</guilabel
></term>
<listitem
><para
>Press this button to open the <guilabel
>Set Font</guilabel
> dialogue, to set the font used in the <link linkend="annotate"
>annotate view</link
>. </para
></listitem>
</varlistentry>

<varlistentry id="customize-difffont">
<term
><guilabel
>Font for diff view...</guilabel
></term>
<listitem
><para
>Press this button to open the <guilabel
>Set Font</guilabel
> dialogue, to set the font used in <link linkend="diff"
>diff dialogs</link
>. </para
></listitem>
</varlistentry>

<varlistentry id="customize-colors">
<term
><guilabel
>Colours</guilabel
></term>
<listitem
><para
>Press the coloured buttons to open the <guilabel
>Select Colour</guilabel
> dialogue, to set the colour used for <guilabel
>Conflict</guilabel
>, <guilabel
>Local Change</guilabel
> or <guilabel
>Remote Change</guilabel
>, in the main view or <guilabel
>Diff change</guilabel
>, <guilabel
>Diff insertion</guilabel
> or <guilabel
>Diff deletion</guilabel
>, in &cervisia;'s built-in diff frontend. </para
></listitem>
</varlistentry>

<varlistentry id="customize-splitter">
<term
><guilabel
>Split main window horizontally</guilabel
></term>
<listitem
><para
>&cervisia;'s main window is normally split vertically into a window with the file tree above and one with the &CVS; output below; alternatively, you can arrange them horizontally. </para
></listitem>
</varlistentry>

</variablelist>

</sect1>
</chapter>


<chapter id="appendix">
<title
>Appendix</title>

<sect1 id="ignoredfiles">
<title
>Ignored Files</title>

<para
>In its main file tree, &cervisia; does not display all files which are actually there. This is analogue to <command
>cvs</command
> itself and helps to avoid clutter caused by uninteresting stuff like object files. &cervisia; tries to mimic <command
>cvs</command
>'s behavior as close as possible, i.e. it gets ignore lists from the following sources: </para>

<itemizedlist>

<listitem
><para
>A static list of entries which includes things like <literal role="extension"
>*.o</literal
> and <filename
>core</filename
>. For details, see the &CVS; documentation. </para
></listitem>
<listitem
><para
>The file <filename
><envar
>$HOME</envar
>/.cvsignore</filename
>. </para
></listitem>

<listitem
><para
>The environment variable <envar
>$CVSIGNORE</envar
>. </para
></listitem>
<listitem
><para
>The <filename
>.cvsignore</filename
> file in the respective folder. </para
></listitem>

</itemizedlist>

<para
><command
>cvs</command
> itself additionally looks up entries in <filename
><envar
>$CVSROOT</envar
>/CVSROOT/cvsignore</filename
>, but this is a file on the server, and &cervisia; should be able to start up offline. If you are working with a group that prefers to use an ignore list on the server, it's probably a good idea to take a look which patterns are listed there and to put them into the <filename
>.cvsignore</filename
> file in your home folder. </para>

</sect1>
   

<sect1 id="information">
<title
>Further Information and Support</title>

<itemizedlist>

<listitem
><para
>&CVS; comes with a complete set of documentation in the form of info pages, known as "The Cederqvist". If it is properly installed, you get browse it by typing in <userinput
>info:/cvs</userinput
> into the locationbar of <application
>kdehelp</application
>, <application
>khelpcenter</application
> resp. Alternative, you can just choose <menuchoice
><guimenu
>Help</guimenu
><guimenuitem
>CVS Info</guimenuitem
></menuchoice
> in &cervisia;. An on-line HTML version of the Cederqvist is available <ulink url="http://cvshome.org/docs/manual/cvs.html"
>on the web</ulink
>. </para>

<para
>As this book is maintained together with &CVS;, it is normally the most up-to-date reference; nevertheless, considering other documentation for learning to use &CVS; is recommended, in particular the following. </para
></listitem>

<listitem
><para
>Karl Fogel has written the excellent book <ulink url="http://cvsbook.red-bean.com/index.html"
>Open Source Development with CVS</ulink
>. About half of this book is about the development process of Open Source software. The other half is a technical documentation of &CVS;. Thankfully, the technical part of the book has been made freely redistributable under the GPL, so that you can download a HTML version of it. A list of errata is available on the webpage mentioned above. </para
></listitem>

<listitem
><para
>&CVS; issues are discussed on a dedicated <ulink url="http://mail.gnu.org/mailman/listinfo/info-cvs"
>mailing list</ulink
>. </para
></listitem>

<listitem
><para
>There is USENET group <literal
>comp.software.config-mgmt</literal
> dedicated to configuration management in general. &CVS; is only marginally a topic in this group, but nevertheless it may be interesting for discussing merits of various revision control systems compared to &CVS;. </para
></listitem>

<listitem
><para
>Last but not least, there is a (low traffic) <ulink url="http://lists.sourceforge.net/mailman/listinfo/cervisia-user"
>&cervisia; mailing list</ulink
>. </para
></listitem>

</itemizedlist>

</sect1>
   

<sect1 id="commandreference">
<title
>Command Reference</title>
      
<!-- File Menu -->
<sect2 id="menufile">

<title
>The File Menu</title>

<variablelist>

<varlistentry>
<term
><menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Open Sandbox...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens a sandbox in the main window. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Recent sandboxes</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens one of the sandboxes that were in use recently. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Insert ChangeLog Entry...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens the ChangeLog editor, prepared such that you can add a new entry with the current date. See <xref linkend="committingfiles"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycombo
><keycap
>&Ctrl;</keycap
><keycap
>U</keycap
></keycombo
></shortcut
> <guimenu
>File</guimenu
><guimenuitem
>Update</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Runs 'cvs update' on selected files and changes the status and revision numbers in the listing accordingly. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycap
>F5</keycap
></shortcut
> <guimenu
>File</guimenu
><guimenuitem
>Status</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Runs 'cvs -n update' on selected files and changes the status and revision numbers in the listing accordingly. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Edit</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens the selected file in KDE's default editor for the selected file's type. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Resolve...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens a dialogue for the selected file which allows you to resolve merge conflicts in it. See <xref linkend="resolvingconflicts"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycap
>#</keycap
></shortcut
> <guimenu
>File</guimenu
><guimenuitem
>Commit...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Allows you to commit the selected files. See <xref linkend="committingfiles"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycap
>+</keycap
></shortcut
> <guimenu
>File</guimenu
><guimenuitem
>Add to Repository...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Allows you to add the selected files to the repository. See <xref linkend="addingfiles"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Add Binary...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Allows you to add the selected files to the repository as binaries (<command
>cvs add<option
>-kb</option
></command
>). See <xref linkend="addingfiles"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycap
>-</keycap
></shortcut
> <guimenu
>File</guimenu
><guimenuitem
>Remove from Repository...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Allows you to remove the selected files from the repository. See <xref linkend="removingfiles"/>. </para
></listitem>
</varlistentry>

<!--TODO: add the revert action to the working with files chapter -->

<varlistentry>
<term
><menuchoice
><guimenu
>File</guimenu
><guimenuitem
>Revert</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Discards any local changes you have made to the selected files and reverts to the version in the repository (Option <option
>-C</option
> to <command
>cvs update</command
>). </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycombo
><keycap
>&Ctrl;</keycap
><keycap
>Q</keycap
></keycombo
></shortcut
> <guimenu
>File</guimenu
><guimenuitem
>Exit</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Quits &cervisia;. </para
></listitem>
</varlistentry>

</variablelist>

</sect2>

<!-- View Menu -->
<sect2 id="menuview">

<title
>The View Menu</title>

<variablelist>

<varlistentry>
<term
><menuchoice
><shortcut
><keycap
>Escape</keycap
></shortcut
> <guimenu
>View</guimenu
><guimenuitem
>Stop</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Aborts any running subprocesses. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycombo
><keycap
>&Ctrl;</keycap
><keycap
>L</keycap
></keycombo
></shortcut
> <guimenu
>View</guimenu
><guimenuitem
>Browse Log...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Shows the log browser of the selected file versions. See <xref linkend="browsinglogs"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycombo
><keycap
>&Ctrl;</keycap
><keycap
>A</keycap
></keycombo
></shortcut
> <guimenu
>View</guimenu
><guimenuitem
>Annotate...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Shows an annotated view of the selected file, i.e. a view where you can for each line see which author modified it last. See <xref linkend="annotate"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycombo
><keycap
>&Ctrl;</keycap
><keycap
>D</keycap
></keycombo
></shortcut
> <guimenu
>View</guimenu
><guimenuitem
>Difference to Repository (BASE)...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Shows the differences between the selected file in the sandbox and the revision you last updated (BASE). See <xref linkend="diff"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><shortcut
><keycombo
><keycap
>&Ctrl;</keycap
><keycap
>H</keycap
></keycombo
></shortcut
> <guimenu
>View</guimenu
><guimenuitem
>Difference to Repository (HEAD)...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Shows the differences between the selected file in the sandbox and the revision you last updated (HEAD). See <xref linkend="diff"/>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Last Change...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Shows the differences between the revision of the selected file you last updated (BASE) and the revision before. See <xref linkend="diff"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>History...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Shows the &CVS; history as reported by the server. See <xref linkend="browsinghistory"/>. </para
></listitem>
</varlistentry>

<!--TODO: add hide menus to mainscreen section-->

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Hide All Files</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether only folders are shown in the main tree view. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Hide Unmodified Files</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether unknown and up to date files are hidden in the main tree view. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Hide Removed Files</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether removed files are hidden in the main tree view. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Hide Non-CVS Files</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether files not in CVS are hidden in the main tree view. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Hide Empty Folders</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether without visible entries are hidden in the main tree view. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Unfold File Tree</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens all branches in the file tree so that you can see all files and folders. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Fold File Tree</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Closes all branches in the file tree. See <xref linkend="mainscreen"/>. </para
></listitem>
</varlistentry>

</variablelist>

</sect2>

<!-- Advanced Menu -->
<sect2 id="menuadvanced">

<title
>The Advanced Menu</title>

<variablelist>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Tag/Branch...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Tags or branches the selected files. See <xref linkend="taggingbranching"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Delete Tag...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Removes a given tag from the selected files. See <xref linkend="taggingbranching"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Update to Tag/Date...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Brings the selected files to a given tag or date, making it sticky. See <xref linkend="updatingto"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Update to HEAD...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Brings the selected files to the respective HEAD revision. See <xref linkend="updatingto"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Merge...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Merges either a given branch or the modifications between two tags into the selected files. See <xref linkend="taggingbranching"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Add Watch...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Adds a watch for a set of events on the selected files. See <xref linkend="watches"/>. </para
></listitem>
</varlistentry>
<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Remove Watch...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Removes a watch for a set of events from the selected files. See <xref linkend="watches"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Show Watchers</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Lists the watchers of the selected files. See <xref linkend="watches"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Edit</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Runs <command
>cvs edit</command
> on the selected files. See <xref linkend="watches"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Unedit</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Runs <command
>cvs unedit</command
> on the selected files. See <xref linkend="watches"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Show Editors</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Runs <command
>cvs editors</command
> on the selected files. See <xref linkend="watches"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Lock</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Locks the selected files. See <xref linkend="locking"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Unlock</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Unlocks the selected files. See <xref linkend="locking"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Advanced</guimenu
><guimenuitem
>Create Patch Against Repository...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Creates a patch from the modifications in your sandbox. See <xref linkend="creatingpatches"/>. </para
></listitem>
</varlistentry>

</variablelist>

</sect2>

<!-- Repository Menu -->
<sect2 id="menurepository">

<title
>The Repository Menu</title>

<variablelist>

<varlistentry>
<term
><menuchoice
><guimenu
>Repository</guimenu
><guimenuitem
>Create...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens a dialogue which allows you to create a new local repository. See <xref linkend="accessing-repository"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Repository</guimenu
><guimenuitem
>Checkout...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens a dialogue which allows you to checkout a module from a repository. See <xref linkend="checkingout"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Repository</guimenu
><guimenuitem
>Import...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens a dialogue which allows you to import a package into the repository. See <xref linkend="importing"/>. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Repository</guimenu
><guimenuitem
>Repositories...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Configures a list of repositories you often use and how to access them. See <xref linkend="accessing-repository"/>. </para
></listitem>
</varlistentry>

</variablelist>

</sect2>

<!-- Settings Menu -->
<sect2 id="menuoptions">
<title
>The Settings Menu</title>

<variablelist>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Show Toolbar</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether the toolbar is displayed. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Create Folders on Update</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether updates create folders in the sandbox which were not there before (Option <option
>-d</option
> to <command
>cvs update</command
>). </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Prune Empty Folders on Update</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether updates remove empty folders in the sandbox. (Option <option
>-P</option
> to <command
>cvs update</command
>). </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Update Recursively</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether updates are recursive (Option <option
>-r</option
> to <command
>cvs update</command
>). </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Commit and Remove Recursively</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether commits and removes are recursive (Option <option
>-r</option
> to <command
>cvs add</command
>, <command
>cvs remove</command
> resp.). </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Do cvs edit Automatically When Necessary</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Determines whether <command
>cvs edit</command
> is executed automatically whenever you edit a file. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Configure Shortcuts...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens a dialogue for configuring keybindings. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Configure Toolbars...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens a dialogue for configuring &cervisia;'s toolbars. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Configure Cervisia...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens a dialogue for customising &cervisia;. </para
></listitem>
</varlistentry>

</variablelist>

</sect2>

<!-- Help -->
<sect2 id="menuhelp">
<title
>The Help Menu</title>

<variablelist>

<varlistentry>
<term
><menuchoice
><shortcut
><keycap
>F1</keycap
></shortcut
> <guimenu
>Help</guimenu
><guimenuitem
>Handbook</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Invokes the KDE Help system starting at the &cervisia; help pages. (this document). </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Help</guimenu
><guimenuitem
>Report Bug...</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens the Bug report dialogue. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Help</guimenu
> <guimenuitem
>About &cervisia;</guimenuitem
> </menuchoice
></term>
<listitem
><para
>This will display version and author information. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Help</guimenu
><guimenuitem
>About KDE</guimenuitem
> </menuchoice
></term>
<listitem
><para
>This displays the KDE version and other basic information. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Help</guimenu
><guimenuitem
>CVS Manual</guimenuitem
> </menuchoice
></term>
<listitem
><para
>Opens the &CVS; info pages in the KDE help system. </para
></listitem>
</varlistentry>

</variablelist>

</sect2>

</sect1>

</chapter>


<chapter id="credits-and-licenses">
<title
>Credits And Licenses</title>
&underFDL; </chapter>
</book>