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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.2.0" />
<title>gitweb(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
.monospaced, code, pre {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
padding: 0;
margin: 0;
}
pre {
white-space: pre-wrap;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="manpage">
<div id="header">
<h1>
gitweb(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>gitweb -
Git web interface (web frontend to Git repositories)
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p>To get started with gitweb, run <a href="git-instaweb.html">git-instaweb(1)</a> from a Git repository.
This will configure and start your web server, and run a web browser pointing to
gitweb.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Gitweb provides a web interface to Git repositories. Its features include:</p></div>
<div class="ulist"><ul>
<li>
<p>
Viewing multiple Git repositories with common root.
</p>
</li>
<li>
<p>
Browsing every revision of the repository.
</p>
</li>
<li>
<p>
Viewing the contents of files in the repository at any revision.
</p>
</li>
<li>
<p>
Viewing the revision log of branches, history of files and directories,
seeing what was changed, when, and by whom.
</p>
</li>
<li>
<p>
Viewing the blame/annotation details of any file (if enabled).
</p>
</li>
<li>
<p>
Generating RSS and Atom feeds of commits, for any branch.
The feeds are auto-discoverable in modern web browsers.
</p>
</li>
<li>
<p>
Viewing everything that was changed in a revision, and stepping through
revisions one at a time, viewing the history of the repository.
</p>
</li>
<li>
<p>
Finding commits whose commit messages match a given search term.
</p>
</li>
</ul></div>
<div class="paragraph"><p>See <a href="https://repo.or.cz/w/git.git/tree/HEAD:/gitweb/">https://repo.or.cz/w/git.git/tree/HEAD:/gitweb/</a> for gitweb source code,
browsed using gitweb itself.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration">CONFIGURATION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Various aspects of gitweb’s behavior can be controlled through the configuration
file <code>gitweb_config.perl</code> or <code>/etc/gitweb.conf</code>. See the <a href="gitweb.conf.html">gitweb.conf(5)</a>
for details.</p></div>
<div class="sect2">
<h3 id="_repositories">Repositories</h3>
<div class="paragraph"><p>Gitweb can show information from one or more Git repositories. These
repositories have to be all on local filesystem, and have to share a common
repository root, i.e. be all under a single parent repository (but see also
the "Advanced web server setup" section, "Webserver configuration with multiple
projects' root" subsection).</p></div>
<div class="listingblock">
<div class="content">
<pre><code>our $projectroot = '/path/to/parent/directory';</code></pre>
</div></div>
<div class="paragraph"><p>The default value for <code>$projectroot</code> is <code>/pub/git</code>. You can change it during
building gitweb via the <code>GITWEB_PROJECTROOT</code> build configuration variable.</p></div>
<div class="paragraph"><p>By default all Git repositories under <code>$projectroot</code> are visible and available
to gitweb. The list of projects is generated by default by scanning the
<code>$projectroot</code> directory for Git repositories (for object databases to be
more exact; gitweb is not interested in a working area, and is best suited
to showing "bare" repositories).</p></div>
<div class="paragraph"><p>The name of the repository in gitweb is the path to its <code>$GIT_DIR</code> (its object
database) relative to <code>$projectroot</code>. Therefore the repository $repo can be
found at "$projectroot/$repo".</p></div>
</div>
<div class="sect2">
<h3 id="_projects_list_file_format">Projects list file format</h3>
<div class="paragraph"><p>Instead of having gitweb find repositories by scanning the filesystem
starting from $projectroot, you can provide a pre-generated list of
visible projects by setting <code>$projects_list</code> to point to a plain text
file with a list of projects (with some additional info).</p></div>
<div class="paragraph"><p>This file uses the following format:</p></div>
<div class="ulist"><ul>
<li>
<p>
One record (for project / repository) per line; does not support line
continuation (newline escaping).
</p>
</li>
<li>
<p>
Leading and trailing whitespace are ignored.
</p>
</li>
<li>
<p>
Whitespace separated fields; any run of whitespace can be used as field
separator (rules for Perl’s "<code>split(" ", $line)</code>").
</p>
</li>
<li>
<p>
Fields use modified URI encoding, defined in RFC 3986, section 2.1
(Percent-Encoding), or rather "Query string encoding" (see
<a href="https://en.wikipedia.org/wiki/Query_string#URL_encoding">https://en.wikipedia.org/wiki/Query_string#URL_encoding</a>), the difference
being that SP (" ") can be encoded as "+" (and therefore "+" has to be
also percent-encoded).
</p>
<div class="paragraph"><p>Reserved characters are: "%" (used for encoding), "+" (can be used to
encode SPACE), all whitespace characters as defined in Perl, including SP,
TAB and LF, (used to separate fields in a record).</p></div>
</li>
<li>
<p>
Currently recognized fields are:
</p>
<div class="dlist"><dl>
<dt class="hdlist1">
<repository path>
</dt>
<dd>
<p>
path to repository GIT_DIR, relative to <code>$projectroot</code>
</p>
</dd>
<dt class="hdlist1">
<repository owner>
</dt>
<dd>
<p>
displayed as repository owner, preferably full name, or email,
or both
</p>
</dd>
</dl></div>
</li>
</ul></div>
<div class="paragraph"><p>You can generate the projects list index file using the project_index action
(the <em>TXT</em> link on projects list page) directly from gitweb; see also
"Generating projects list using gitweb" section below.</p></div>
<div class="paragraph"><p>Example contents:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>foo.git Joe+R+Hacker+<joe@example.com>
foo/bar.git O+W+Ner+<owner@example.org></code></pre>
</div></div>
<div class="paragraph"><p>By default this file controls only which projects are <strong>visible</strong> on projects
list page (note that entries that do not point to correctly recognized Git
repositories won’t be displayed by gitweb). Even if a project is not
visible on projects list page, you can view it nevertheless by hand-crafting
a gitweb URL. By setting <code>$strict_export</code> configuration variable (see
<a href="gitweb.conf.html">gitweb.conf(5)</a>) to true value you can allow viewing only of
repositories also shown on the overview page (i.e. only projects explicitly
listed in projects list file will be accessible).</p></div>
</div>
<div class="sect2">
<h3 id="_generating_projects_list_using_gitweb">Generating projects list using gitweb</h3>
<div class="paragraph"><p>We assume that GITWEB_CONFIG has its default Makefile value, namely
<em>gitweb_config.perl</em>. Put the following in <em>gitweb_make_index.perl</em> file:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>read_config_file("gitweb_config.perl");
$projects_list = $projectroot;</code></pre>
</div></div>
<div class="paragraph"><p>Then create the following script to get list of project in the format
suitable for GITWEB_LIST build configuration variable (or
<code>$projects_list</code> variable in gitweb config):</p></div>
<div class="listingblock">
<div class="content">
<pre><code>#!/bin/sh
export GITWEB_CONFIG="gitweb_make_index.perl"
export GATEWAY_INTERFACE="CGI/1.1"
export HTTP_ACCEPT="*/*"
export REQUEST_METHOD="GET"
export QUERY_STRING="a=project_index"
perl -- /var/www/cgi-bin/gitweb.cgi</code></pre>
</div></div>
<div class="paragraph"><p>Run this script and save its output to a file. This file could then be used
as projects list file, which means that you can set <code>$projects_list</code> to its
filename.</p></div>
</div>
<div class="sect2">
<h3 id="_controlling_access_to_git_repositories">Controlling access to Git repositories</h3>
<div class="paragraph"><p>By default all Git repositories under <code>$projectroot</code> are visible and
available to gitweb. You can however configure how gitweb controls access
to repositories.</p></div>
<div class="ulist"><ul>
<li>
<p>
As described in "Projects list file format" section, you can control which
projects are <strong>visible</strong> by selectively including repositories in projects
list file, and setting <code>$projects_list</code> gitweb configuration variable to
point to it. With <code>$strict_export</code> set, projects list file can be used to
control which repositories are <strong>available</strong> as well.
</p>
</li>
<li>
<p>
You can configure gitweb to only list and allow viewing of the explicitly
exported repositories, via <code>$export_ok</code> variable in gitweb config file; see
<a href="gitweb.conf.html">gitweb.conf(5)</a> manpage. If it evaluates to true, gitweb shows
repositories only if this file named by <code>$export_ok</code> exists in its object
database (if directory has the magic file named <code>$export_ok</code>).
</p>
<div class="paragraph"><p>For example <a href="git-daemon.html">git-daemon(1)</a> by default (unless <code>--export-all</code> option
is used) allows pulling only for those repositories that have
<em>git-daemon-export-ok</em> file. Adding</p></div>
<div class="listingblock">
<div class="content">
<pre><code>our $export_ok = "git-daemon-export-ok";</code></pre>
</div></div>
<div class="paragraph"><p>makes gitweb show and allow access only to those repositories that can be
fetched from via <code>git://</code> protocol.</p></div>
</li>
<li>
<p>
Finally, it is possible to specify an arbitrary perl subroutine that will
be called for each repository to determine if it can be exported. The
subroutine receives an absolute path to the project (repository) as its only
parameter (i.e. "$projectroot/$project").
</p>
<div class="paragraph"><p>For example, if you use mod_perl to run the script, and have dumb
HTTP protocol authentication configured for your repositories, you
can use the following hook to allow access only if the user is
authorized to read the files:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$export_auth_hook = sub {
use Apache2::SubRequest ();
use Apache2::Const -compile => qw(HTTP_OK);
my $path = "$_[0]/HEAD";
my $r = Apache2::RequestUtil->request;
my $sub = $r->lookup_file($path);
return $sub->filename eq $path
&& $sub->status == Apache2::Const::HTTP_OK;
};</code></pre>
</div></div>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_per_repository_gitweb_configuration">Per-repository gitweb configuration</h3>
<div class="paragraph"><p>You can configure individual repositories shown in gitweb by creating file
in the <code>GIT_DIR</code> of Git repository, or by setting some repo configuration
variable (in <code>GIT_DIR/config</code>, see <a href="git-config.html">git-config(1)</a>).</p></div>
<div class="paragraph"><p>You can use the following files in repository:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
README.html
</dt>
<dd>
<p>
A html file (HTML fragment) which is included on the gitweb project
"summary" page inside <code><div></code> block element. You can use it for longer
description of a project, to provide links (for example to project’s
homepage), etc. This is recognized only if XSS prevention is off
(<code>$prevent_xss</code> is false, see <a href="gitweb.conf.html">gitweb.conf(5)</a>); a way to include
a README safely when XSS prevention is on may be worked out in the
future.
</p>
</dd>
<dt class="hdlist1">
description (or <code>gitweb.description</code>)
</dt>
<dd>
<p>
Short (shortened to <code>$projects_list_description_width</code> in the projects
list page, which is 25 characters by default; see
<a href="gitweb.conf.html">gitweb.conf(5)</a>) single line description of a project (of a
repository). Plain text file; HTML will be escaped. By default set to
</p>
<div class="listingblock">
<div class="content">
<pre><code>Unnamed repository; edit this file to name it for gitweb.</code></pre>
</div></div>
<div class="paragraph"><p>from the template during repository creation, usually installed in
<code>/usr/share/git-core/templates/</code>. You can use the <code>gitweb.description</code> repo
configuration variable, but the file takes precedence.</p></div>
</dd>
<dt class="hdlist1">
category (or <code>gitweb.category</code>)
</dt>
<dd>
<p>
Singe line category of a project, used to group projects if
<code>$projects_list_group_categories</code> is enabled. By default (file and
configuration variable absent), uncategorized projects are put in the
<code>$project_list_default_category</code> category. You can use the
<code>gitweb.category</code> repo configuration variable, but the file takes
precedence.
</p>
<div class="paragraph"><p>The configuration variables <code>$projects_list_group_categories</code> and
<code>$project_list_default_category</code> are described in <a href="gitweb.conf.html">gitweb.conf(5)</a></p></div>
</dd>
<dt class="hdlist1">
cloneurl (or multiple-valued <code>gitweb.url</code>)
</dt>
<dd>
<p>
File with repository URL (used for clone and fetch), one per line.
Displayed in the project summary page. You can use multiple-valued
<code>gitweb.url</code> repository configuration variable for that, but the file
takes precedence.
</p>
<div class="paragraph"><p>This is per-repository enhancement / version of global prefix-based
<code>@git_base_url_list</code> gitweb configuration variable (see
<a href="gitweb.conf.html">gitweb.conf(5)</a>).</p></div>
</dd>
<dt class="hdlist1">
gitweb.owner
</dt>
<dd>
<p>
You can use the <code>gitweb.owner</code> repository configuration variable to set
repository’s owner. It is displayed in the project list and summary
page.
</p>
<div class="paragraph"><p>If it’s not set, filesystem directory’s owner is used (via GECOS field,
i.e. real name field from <strong>getpwuid</strong>(3)) if <code>$projects_list</code> is unset
(gitweb scans <code>$projectroot</code> for repositories); if <code>$projects_list</code>
points to file with list of repositories, then project owner defaults to
value from this file for given repository.</p></div>
</dd>
<dt class="hdlist1">
various <code>gitweb.*</code> config variables (in config)
</dt>
<dd>
<p>
Read description of <code>%feature</code> hash for detailed list, and descriptions.
See also "Configuring gitweb features" section in <a href="gitweb.conf.html">gitweb.conf(5)</a>
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_actions_and_urls">ACTIONS, AND URLS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Gitweb can use path_info (component) based URLs, or it can pass all necessary
information via query parameters. The typical gitweb URLs are broken down in to
five components:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>.../gitweb.cgi/<repo>/<action>/<revision>:/<path>?<arguments></code></pre>
</div></div>
<div class="dlist"><dl>
<dt class="hdlist1">
repo
</dt>
<dd>
<p>
The repository the action will be performed on.
</p>
<div class="paragraph"><p>All actions except for those that list all available projects,
in whatever form, require this parameter.</p></div>
</dd>
<dt class="hdlist1">
action
</dt>
<dd>
<p>
The action that will be run. Defaults to <em>projects_list</em> if repo
is not set, and to <em>summary</em> otherwise.
</p>
</dd>
<dt class="hdlist1">
revision
</dt>
<dd>
<p>
Revision shown. Defaults to HEAD.
</p>
</dd>
<dt class="hdlist1">
path
</dt>
<dd>
<p>
The path within the <repository> that the action is performed on,
for those actions that require it.
</p>
</dd>
<dt class="hdlist1">
arguments
</dt>
<dd>
<p>
Any arguments that control the behaviour of the action.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Some actions require or allow to specify two revisions, and sometimes even two
pathnames. In most general form such path_info (component) based gitweb URL
looks like this:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>.../gitweb.cgi/<repo>/<action>/<revision-from>:/<path-from>..<revision-to>:/<path-to>?<arguments></code></pre>
</div></div>
<div class="paragraph"><p>Each action is implemented as a subroutine, and must be present in %actions
hash. Some actions are disabled by default, and must be turned on via feature
mechanism. For example to enable <em>blame</em> view add the following to gitweb
configuration file:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$feature{'blame'}{'default'} = [1];</code></pre>
</div></div>
<div class="sect2">
<h3 id="_actions">Actions:</h3>
<div class="paragraph"><p>The standard actions are:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
project_list
</dt>
<dd>
<p>
Lists the available Git repositories. This is the default command if no
repository is specified in the URL.
</p>
</dd>
<dt class="hdlist1">
summary
</dt>
<dd>
<p>
Displays summary about given repository. This is the default command if
no action is specified in URL, and only repository is specified.
</p>
</dd>
<dt class="hdlist1">
heads
</dt>
<dt class="hdlist1">
remotes
</dt>
<dd>
<p>
Lists all local or all remote-tracking branches in given repository.
</p>
<div class="paragraph"><p>The latter is not available by default, unless configured.</p></div>
</dd>
<dt class="hdlist1">
tags
</dt>
<dd>
<p>
List all tags (lightweight and annotated) in given repository.
</p>
</dd>
<dt class="hdlist1">
blob
</dt>
<dt class="hdlist1">
tree
</dt>
<dd>
<p>
Shows the files and directories in a given repository path, at given
revision. This is default command if no action is specified in the URL,
and path is given.
</p>
</dd>
<dt class="hdlist1">
blob_plain
</dt>
<dd>
<p>
Returns the raw data for the file in given repository, at given path and
revision. Links to this action are marked <em>raw</em>.
</p>
</dd>
<dt class="hdlist1">
blobdiff
</dt>
<dd>
<p>
Shows the difference between two revisions of the same file.
</p>
</dd>
<dt class="hdlist1">
blame
</dt>
<dt class="hdlist1">
blame_incremental
</dt>
<dd>
<p>
Shows the blame (also called annotation) information for a file. On a
per line basis it shows the revision in which that line was last changed
and the user that committed the change. The incremental version (which
if configured is used automatically when JavaScript is enabled) uses
Ajax to incrementally add blame info to the contents of given file.
</p>
<div class="paragraph"><p>This action is disabled by default for performance reasons.</p></div>
</dd>
<dt class="hdlist1">
commit
</dt>
<dt class="hdlist1">
commitdiff
</dt>
<dd>
<p>
Shows information about a specific commit in a repository. The <em>commit</em>
view shows information about commit in more detail, the <em>commitdiff</em>
action shows changeset for given commit.
</p>
</dd>
<dt class="hdlist1">
patch
</dt>
<dd>
<p>
Returns the commit in plain text mail format, suitable for applying with
<a href="git-am.html">git-am(1)</a>.
</p>
</dd>
<dt class="hdlist1">
tag
</dt>
<dd>
<p>
Display specific annotated tag (tag object).
</p>
</dd>
<dt class="hdlist1">
log
</dt>
<dt class="hdlist1">
shortlog
</dt>
<dd>
<p>
Shows log information (commit message or just commit subject) for a
given branch (starting from given revision).
</p>
<div class="paragraph"><p>The <em>shortlog</em> view is more compact; it shows one commit per line.</p></div>
</dd>
<dt class="hdlist1">
history
</dt>
<dd>
<p>
Shows history of the file or directory in a given repository path,
starting from given revision (defaults to HEAD, i.e. default branch).
</p>
<div class="paragraph"><p>This view is similar to <em>shortlog</em> view.</p></div>
</dd>
<dt class="hdlist1">
rss
</dt>
<dt class="hdlist1">
atom
</dt>
<dd>
<p>
Generates an RSS (or Atom) feed of changes to repository.
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_webserver_configuration">WEBSERVER CONFIGURATION</h2>
<div class="sectionbody">
<div class="paragraph"><p>This section explains how to configure some common webservers to run gitweb. In
all cases, <code>/path/to/gitweb</code> in the examples is the directory you ran installed
gitweb in, and contains <code>gitweb_config.perl</code>.</p></div>
<div class="paragraph"><p>If you’ve configured a web server that isn’t listed here for gitweb, please send
in the instructions so they can be included in a future release.</p></div>
<div class="sect2">
<h3 id="_apache_as_cgi">Apache as CGI</h3>
<div class="paragraph"><p>Apache must be configured to support CGI scripts in the directory in
which gitweb is installed. Let’s assume that it is <code>/var/www/cgi-bin</code>
directory.</p></div>
<div class="listingblock">
<div class="content">
<pre><code>ScriptAlias /cgi-bin/ "/var/www/cgi-bin/"
<Directory "/var/www/cgi-bin">
Options Indexes FollowSymlinks ExecCGI
AllowOverride None
Order allow,deny
Allow from all
</Directory></code></pre>
</div></div>
<div class="paragraph"><p>With that configuration the full path to browse repositories would be:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://server/cgi-bin/gitweb.cgi</code></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_apache_with_mod_perl_via_modperl_registry">Apache with mod_perl, via ModPerl::Registry</h3>
<div class="paragraph"><p>You can use mod_perl with gitweb. You must install Apache::Registry
(for mod_perl 1.x) or ModPerl::Registry (for mod_perl 2.x) to enable
this support.</p></div>
<div class="paragraph"><p>Assuming that gitweb is installed to <code>/var/www/perl</code>, the following
Apache configuration (for mod_perl 2.x) is suitable.</p></div>
<div class="listingblock">
<div class="content">
<pre><code>Alias /perl "/var/www/perl"
<Directory "/var/www/perl">
SetHandler perl-script
PerlResponseHandler ModPerl::Registry
PerlOptions +ParseHeaders
Options Indexes FollowSymlinks +ExecCGI
AllowOverride None
Order allow,deny
Allow from all
</Directory></code></pre>
</div></div>
<div class="paragraph"><p>With that configuration the full path to browse repositories would be:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://server/perl/gitweb.cgi</code></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_apache_with_fastcgi">Apache with FastCGI</h3>
<div class="paragraph"><p>Gitweb works with Apache and FastCGI. First you need to rename, copy
or symlink gitweb.cgi to gitweb.fcgi. Let’s assume that gitweb is
installed in <code>/usr/share/gitweb</code> directory. The following Apache
configuration is suitable (UNTESTED!)</p></div>
<div class="listingblock">
<div class="content">
<pre><code>FastCgiServer /usr/share/gitweb/gitweb.cgi
ScriptAlias /gitweb /usr/share/gitweb/gitweb.cgi
Alias /gitweb/static /usr/share/gitweb/static
<Directory /usr/share/gitweb/static>
SetHandler default-handler
</Directory></code></pre>
</div></div>
<div class="paragraph"><p>With that configuration the full path to browse repositories would be:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://server/gitweb</code></pre>
</div></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_advanced_web_server_setup">ADVANCED WEB SERVER SETUP</h2>
<div class="sectionbody">
<div class="paragraph"><p>All of those examples use request rewriting, and need <code>mod_rewrite</code>
(or equivalent; examples below are written for Apache).</p></div>
<div class="sect2">
<h3 id="_single_url_for_gitweb_and_for_fetching">Single URL for gitweb and for fetching</h3>
<div class="paragraph"><p>If you want to have one URL for both gitweb and your <code>http://</code>
repositories, you can configure Apache like this:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><VirtualHost *:80>
ServerName git.example.org
DocumentRoot /pub/git
SetEnv GITWEB_CONFIG /etc/gitweb.conf
# turning on mod rewrite
RewriteEngine on
# make the front page an internal rewrite to the gitweb script
RewriteRule ^/$ /cgi-bin/gitweb.cgi
# make access for "dumb clients" work
RewriteRule ^/(.*\.git/(?!/?(HEAD|info|objects|refs)).*)?$ \
/cgi-bin/gitweb.cgi%{REQUEST_URI} [L,PT]
</VirtualHost></code></pre>
</div></div>
<div class="paragraph"><p>The above configuration expects your public repositories to live under
<code>/pub/git</code> and will serve them as <code>http://git.domain.org/dir-under-pub-git</code>,
both as clonable Git URL and as browsable gitweb interface. If you then
start your <a href="git-daemon.html">git-daemon(1)</a> with <code>--base-path=/pub/git --export-all</code>
then you can even use the <code>git://</code> URL with exactly the same path.</p></div>
<div class="paragraph"><p>Setting the environment variable <code>GITWEB_CONFIG</code> will tell gitweb to use the
named file (i.e. in this example <code>/etc/gitweb.conf</code>) as a configuration for
gitweb. You don’t really need it in above example; it is required only if
your configuration file is in different place than built-in (during
compiling gitweb) <em>gitweb_config.perl</em> or <code>/etc/gitweb.conf</code>. See
<a href="gitweb.conf.html">gitweb.conf(5)</a> for details, especially information about precedence
rules.</p></div>
<div class="paragraph"><p>If you use the rewrite rules from the example you <strong>might</strong> also need
something like the following in your gitweb configuration file
(<code>/etc/gitweb.conf</code> following example):</p></div>
<div class="listingblock">
<div class="content">
<pre><code>@stylesheets = ("/some/absolute/path/gitweb.css");
$my_uri = "/";
$home_link = "/";
$per_request_config = 1;</code></pre>
</div></div>
<div class="paragraph"><p>Nowadays though gitweb should create HTML base tag when needed (to set base
URI for relative links), so it should work automatically.</p></div>
</div>
<div class="sect2">
<h3 id="_webserver_configuration_with_multiple_projects_root">Webserver configuration with multiple projects' root</h3>
<div class="paragraph"><p>If you want to use gitweb with several project roots you can edit your
Apache virtual host and gitweb configuration files in the following way.</p></div>
<div class="paragraph"><p>The virtual host configuration (in Apache configuration file) should look
like this:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><VirtualHost *:80>
ServerName git.example.org
DocumentRoot /pub/git
SetEnv GITWEB_CONFIG /etc/gitweb.conf
# turning on mod rewrite
RewriteEngine on
# make the front page an internal rewrite to the gitweb script
RewriteRule ^/$ /cgi-bin/gitweb.cgi [QSA,L,PT]
# look for a public_git directory in unix users' home
# http://git.example.org/~<user>/
RewriteRule ^/\~([^\/]+)(/|/gitweb.cgi)?$ /cgi-bin/gitweb.cgi \
[QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]
# http://git.example.org/+<user>/
#RewriteRule ^/\+([^\/]+)(/|/gitweb.cgi)?$ /cgi-bin/gitweb.cgi \
[QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]
# http://git.example.org/user/<user>/
#RewriteRule ^/user/([^\/]+)/(gitweb.cgi)?$ /cgi-bin/gitweb.cgi \
[QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]
# defined list of project roots
RewriteRule ^/scm(/|/gitweb.cgi)?$ /cgi-bin/gitweb.cgi \
[QSA,E=GITWEB_PROJECTROOT:/pub/scm/,L,PT]
RewriteRule ^/var(/|/gitweb.cgi)?$ /cgi-bin/gitweb.cgi \
[QSA,E=GITWEB_PROJECTROOT:/var/git/,L,PT]
# make access for "dumb clients" work
RewriteRule ^/(.*\.git/(?!/?(HEAD|info|objects|refs)).*)?$ \
/cgi-bin/gitweb.cgi%{REQUEST_URI} [L,PT]
</VirtualHost></code></pre>
</div></div>
<div class="paragraph"><p>Here actual project root is passed to gitweb via <code>GITWEB_PROJECT_ROOT</code>
environment variable from a web server, so you need to put the following
line in gitweb configuration file (<code>/etc/gitweb.conf</code> in above example):</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$projectroot = $ENV{'GITWEB_PROJECTROOT'} || "/pub/git";</code></pre>
</div></div>
<div class="paragraph"><p><strong>Note</strong> that this requires to be set for each request, so either
<code>$per_request_config</code> must be false, or the above must be put in code
referenced by <code>$per_request_config</code>;</p></div>
<div class="paragraph"><p>These configurations enable two things. First, each unix user (<code><user></code>) of
the server will be able to browse through gitweb Git repositories found in
<code>~/public_git/</code> with the following url:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://git.example.org/~<user>/</code></pre>
</div></div>
<div class="paragraph"><p>If you do not want this feature on your server just remove the second
rewrite rule.</p></div>
<div class="paragraph"><p>If you already use ‘mod_userdir` in your virtual host or you don’t want to
use the '~’ as first character, just comment or remove the second rewrite
rule, and uncomment one of the following according to what you want.</p></div>
<div class="paragraph"><p>Second, repositories found in <code>/pub/scm/</code> and <code>/var/git/</code> will be accessible
through <code>http://git.example.org/scm/</code> and <code>http://git.example.org/var/</code>.
You can add as many project roots as you want by adding rewrite rules like
the third and the fourth.</p></div>
</div>
<div class="sect2">
<h3 id="_path_info_usage">PATH_INFO usage</h3>
<div class="paragraph"><p>If you enable PATH_INFO usage in gitweb by putting</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$feature{'pathinfo'}{'default'} = [1];</code></pre>
</div></div>
<div class="paragraph"><p>in your gitweb configuration file, it is possible to set up your server so
that it consumes and produces URLs in the form</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://git.example.com/project.git/shortlog/sometag</code></pre>
</div></div>
<div class="paragraph"><p>i.e. without <em>gitweb.cgi</em> part, by using a configuration such as the
following. This configuration assumes that <code>/var/www/gitweb</code> is the
DocumentRoot of your webserver, contains the gitweb.cgi script and
complementary static files (stylesheet, favicon, JavaScript):</p></div>
<div class="listingblock">
<div class="content">
<pre><code><VirtualHost *:80>
ServerAlias git.example.com
DocumentRoot /var/www/gitweb
<Directory /var/www/gitweb>
Options ExecCGI
AddHandler cgi-script cgi
DirectoryIndex gitweb.cgi
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
</Directory>
</VirtualHost></code></pre>
</div></div>
<div class="paragraph"><p>The rewrite rule guarantees that existing static files will be properly
served, whereas any other URL will be passed to gitweb as PATH_INFO
parameter.</p></div>
<div class="paragraph"><p><strong>Notice</strong> that in this case you don’t need special settings for
<code>@stylesheets</code>, <code>$my_uri</code> and <code>$home_link</code>, but you lose "dumb client"
access to your project .git dirs (described in "Single URL for gitweb and
for fetching" section). A possible workaround for the latter is the
following: in your project root dir (e.g. <code>/pub/git</code>) have the projects
named <strong>without</strong> a .git extension (e.g. <code>/pub/git/project</code> instead of
<code>/pub/git/project.git</code>) and configure Apache as follows:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><VirtualHost *:80>
ServerAlias git.example.com
DocumentRoot /var/www/gitweb
AliasMatch ^(/.*?)(\.git)(/.*)?$ /pub/git$1$3
<Directory /var/www/gitweb>
Options ExecCGI
AddHandler cgi-script cgi
DirectoryIndex gitweb.cgi
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
</Directory>
</VirtualHost></code></pre>
</div></div>
<div class="paragraph"><p>The additional AliasMatch makes it so that</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://git.example.com/project.git</code></pre>
</div></div>
<div class="paragraph"><p>will give raw access to the project’s Git dir (so that the project can be
cloned), while</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://git.example.com/project</code></pre>
</div></div>
<div class="paragraph"><p>will provide human-friendly gitweb access.</p></div>
<div class="paragraph"><p>This solution is not 100% bulletproof, in the sense that if some project has
a named ref (branch, tag) starting with <code>git/</code>, then paths such as</p></div>
<div class="literalblock">
<div class="content">
<pre><code>http://git.example.com/project/command/abranch..git/abranch</code></pre>
</div></div>
<div class="paragraph"><p>will fail with a 404 error.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_bugs">BUGS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Please report any bugs or feature requests to <a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>,
putting "gitweb" in the subject of email.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph"><p><a href="gitweb.conf.html">gitweb.conf(5)</a>, <a href="git-instaweb.html">git-instaweb(1)</a></p></div>
<div class="paragraph"><p><code>gitweb/README</code>, <code>gitweb/INSTALL</code></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
2024-02-08 15:45:59 PST
</div>
</div>
</body>
</html>
|
