/
gitweb.html
1442 lines (1355 loc) · 46.3 KB
/
gitweb.html
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
<!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="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.5.2" />
<title>gitweb(1)</title>
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
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;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
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;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, 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-family: sans-serif;
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 silver;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #dddddd;
color: #777777;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > div.content {
white-space: pre;
}
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; }
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;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden 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;
}
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;
}
@media print {
div#footer-badges { display: none; }
}
div#toc {
margin-bottom: 2.5em;
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
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;
}
/* Overrides for manpage documents */
h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
h2 {
border-style: none;
}
div.sectionbody {
margin-left: 5%;
}
@media print {
div#toc { display: none; }
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock-content {
white-space: pre;
}
div.verseblock-attribution {
padding-top: 0.75em;
text-align: left;
}
div.exampleblock-content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</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");
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 () {
var cont = document.getElementById("content");
var noteholder = document.getElementById("footnotes");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
// 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];
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
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>]";
}
}
}
}
}
/*]]>*/
</script>
</head>
<body>
<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">
<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 would configure and start your web server, and run web browser pointing to
gitweb.</p></div>
</div>
<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,
see what was changed when, by who.
</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 step through
revisions one at a time, viewing the history of the repository.
</p>
</li>
<li>
<p>
Finding commits which commit messages matches given search term.
</p>
</li>
</ul></div>
<div class="paragraph"><p>See <a href="http://git.kernel.org/?p=git/git.git;a=tree;f=gitweb">http://git.kernel.org/?p=git/git.git;a=tree;f=gitweb</a> or
<a href="http://repo.or.cz/w/git.git/tree/HEAD:/gitweb/">http://repo.or.cz/w/git.git/tree/HEAD:/gitweb/</a> for gitweb source code,
browsed using gitweb itself.</p></div>
</div>
<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 <em>gitweb_config.perl</em> or <em>/etc/gitweb.conf</em>. See the <a href="gitweb.conf.html">gitweb.conf(5)</a>
for details.</p></div>
<h3 id="_repositories">Repositories</h3><div style="clear:left"></div>
<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 common
repository root, i.e. be all under a single parent repository (but see also
"Advanced web server setup" section, "Webserver configuration with multiple
projects' root" subsection).</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>our $projectroot = '/path/to/parent/directory';</tt></pre>
</div></div>
<div class="paragraph"><p>The default value for <tt>$projectroot</tt> is <em>/pub/git</em>. You can change it during
building gitweb via <tt>GITWEB_PROJECTROOT</tt> build configuration variable.</p></div>
<div class="paragraph"><p>By default all git repositories under <tt>$projectroot</tt> are visible and available
to gitweb. The list of projects is generated by default by scanning the
<tt>$projectroot</tt> 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 <tt>$GIT_DIR</tt> (its object
database) relative to <tt>$projectroot</tt>. Therefore the repository $repo can be
found at "$projectroot/$repo".</p></div>
<h3 id="_projects_list_file_format">Projects list file format</h3><div style="clear:left"></div>
<div class="paragraph"><p>Instead of having gitweb find repositories by scanning filesystem
starting from $projectroot, you can provide a pre-generated list of
visible projects by setting <tt>$projects_list</tt> 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 "<tt>split(" ", $line)</tt>").
</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="http://en.wikipedia.org/wiki/Query_string#URL_encoding">http://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 <tt>$projectroot</tt>
</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><tt>foo.git Joe+R+Hacker+<joe@example.com>
foo/bar.git O+W+Ner+<owner@example.org></tt></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 <tt>$strict_export</tt> 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>
<h3 id="_generating_projects_list_using_gitweb">Generating projects list using gitweb</h3><div style="clear:left"></div>
<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><tt>read_config_file("gitweb_config.perl");
$projects_list = $projectroot;</tt></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
<tt>$projects_list</tt> variable in gitweb config):</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>#!/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</tt></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 <tt>$projects_list</tt> to its
filename.</p></div>
<h3 id="_controlling_access_to_git_repositories">Controlling access to git repositories</h3><div style="clear:left"></div>
<div class="paragraph"><p>By default all git repositories under <tt>$projectroot</tt> 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 <tt>$projects_list</tt> gitweb configuration variable to
point to it. With <tt>$strict_export</tt> 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 <tt>$export_ok</tt> 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 <tt>$export_ok</tt> exists in its object
database (if directory has the magic file named <tt>$export_ok</tt>).
</p>
<div class="paragraph"><p>For example <a href="git-daemon.html">git-daemon(1)</a> by default (unless <tt>--export-all</tt> 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><tt>our $export_ok = "git-daemon-export-ok";</tt></pre>
</div></div>
<div class="paragraph"><p>makes gitweb show and allow access only to those repositories that can be
fetched from via <tt>git://</tt> 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><tt>$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;
};</tt></pre>
</div></div>
</li>
</ul></div>
<h3 id="_per_repository_gitweb_configuration">Per-repository gitweb configuration</h3><div style="clear:left"></div>
<div class="paragraph"><p>You can configure individual repositories shown in gitweb by creating file
in the <em>GIT_DIR</em> of git repository, or by setting some repo configuration
variable (in <em>GIT_DIR/config</em>, 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 <tt><div></tt> 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
(<tt>$prevent_xss</tt> 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 <tt>gitweb.description</tt>)
</dt>
<dd>
<p>
Short (shortened to <tt>$projects_list_description_width</tt> 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><tt>Unnamed repository; edit this file to name it for gitweb.</tt></pre>
</div></div>
<div class="paragraph"><p>from the template during repository creation, usually installed in
<em>/usr/share/git-core/templates/</em>. You can use the <tt>gitweb.description</tt> repo
configuration variable, but the file takes precedence.</p></div>
</dd>
<dt class="hdlist1">
category (or <tt>gitweb.category</tt>)
</dt>
<dd>
<p>
Singe line category of a project, used to group projects if
<tt>$projects_list_group_categories</tt> is enabled. By default (file and
configuration variable absent), uncategorized projects are put in the
<tt>$project_list_default_category</tt> category. You can use the
<tt>gitweb.category</tt> repo configuration variable, but the file takes
precedence.
</p>
<div class="paragraph"><p>The configuration variables <tt>$projects_list_group_categories</tt> and
<tt>$project_list_default_category</tt> are described in <a href="gitweb.conf.html">gitweb.conf(5)</a></p></div>
</dd>
<dt class="hdlist1">
cloneurl (or multiple-valued <tt>gitweb.url</tt>)
</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
<tt>gitweb.url</tt> 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
<tt>@git_base_url_list</tt> 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 <tt>gitweb.owner</tt> 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 <tt>$projects_list</tt> is unset
(gitweb scans <tt>$projectroot</tt> for repositories); if <tt>$projects_list</tt>
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 <tt>gitweb.*</tt> config variables (in config)
</dt>
<dd>
<p>
Read description of <tt>%feature</tt> 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>
<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><tt>.../gitweb.cgi/<repo>/<action>/<revision>:/<path>?<arguments></tt></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><tt>.../gitweb.cgi/<repo>/<action>/<revision_from>:/<path_from>..<revision_to>:/<path_to>?<arguments></tt></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><tt>$feature{'blame'}{'default'} = [1];</tt></pre>
</div></div>
<h3 id="_actions">Actions:</h3><div style="clear:left"></div>
<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>