Annotation of cvsweb/cvsweb.conf, Revision 3.33
3.1 knu 1: # -*-perl-*-
2: # Configuration of cvsweb.cgi, the
3: # CGI interface to CVS Repositories.
4: #
5: # (c) 1998-1999 H. Zeller <zeller@think.de>
6: # 1999 H. Nordstrom <hno@hem.passagen.se>
3.30 knu 7: # 2000-2002 A. MUSHA <knu@FreeBSD.org>
3.32 scop 8: # 2002 V. Skyttä <scop@FreeBSD.org>
3.1 knu 9: # based on work by Bill Fenner <fenner@FreeBSD.org>
3.28 knu 10: #
3.30 knu 11: # $FreeBSD$
3.27 knu 12: # $Id: cvsweb.conf,v 3.29 2001/07/23 09:14:52 hzeller Exp $
3.28 knu 13: # $Idaemons: /home/cvs/cvsweb/cvsweb.conf,v 3.27 2001/08/01 09:48:39 knu Exp $
3.1 knu 14: #
15: ###
16:
3.19 knu 17: # Set the path for the following commands:
18: # uname, cvs, rlog, rcsdiff
19: # gzip (if you enable $allow_compress)
3.25 knu 20: # tar, rm, zip (if you enable $allow_tar)
3.19 knu 21: $command_path = '/bin:/usr/bin:/usr/local/bin';
22:
23: # Search the above directories for each command
3.25 knu 24: for (qw(uname cvs rlog rcsdiff gzip tar rm zip)) {
3.26 knu 25: $CMD{$_} = search_path($_);
3.19 knu 26: }
27:
28: # The name of the operating system implementation
3.21 knu 29: chomp($uname = `$CMD{uname}`);
3.19 knu 30:
3.1 knu 31: ##############
32: # CVS Root
33: ##############
34: # CVSweb can handle several CVS-Repositories
35: # at once. Enter a short symbolic names and the
36: # full path of these repositories here.
37: # NOTE that the symbolic names may not contain
38: # whitespaces.
39: # Note, that cvsweb.cgi currently needs to have physical access
40: # to the CVS repository so :pserver:someone@xyz.com:/data/cvsroot
41: # won't work!
42:
3.17 knu 43: # 'symbolic_name' => ['name_to_display', 'path_to_the_actual_repository']
44: # Listed in the order specified:
45: @CVSrepositories = (
3.26 knu 46: 'local' => ['Local Repository', '/home/cvs'],
47: # 'freebsd' => ['FreeBSD', '/home/ncvs'],
48: # 'openbsd' => ['OpenBSD', '/home/ncvs'],
49: # 'netbsd' => ['NetBSD', '/home/ncvs'],
50: # 'ruby' => ['Ruby', '/var/anoncvs/ruby'],
51: );
3.1 knu 52:
53: # This tree is enabled by default when
54: # you enter the page
3.26 knu 55: $cvstreedefault = $CVSrepositories[2 * 0]; # The first one
3.1 knu 56:
57: ##############
3.15 knu 58: # Bug tracking system options
59: # ("PR" means Problem Report, as in GNATS)
3.1 knu 60: ##############
3.15 knu 61: #@prcategories = qw(
3.26 knu 62: # advocacy
63: # alpha
64: # bin
65: # conf
66: # docs
67: # gnu
68: # i386
69: # kern
70: # misc
71: # pending
72: # ports
73: # sparc
74: #);
75:
3.15 knu 76: #
77: #$prcgi = "http://www.FreeBSD.org/cgi/query-pr.cgi?pr=%s";
78: #
79: #$prkeyword = "PR";
3.1 knu 80:
81: ##############
3.15 knu 82: # Manual gateway
3.8 knu 83: ##############
3.26 knu 84: $mancgi =
85: "http://www.FreeBSD.org/cgi/man.cgi?apropos=0&sektion=%s&query=%s&manpath=FreeBSD+5.0-current&format=html";
3.1 knu 86:
87: ##############
88: # Defaults for UserSettings
89: ##############
90: %DEFAULTVALUE = (
3.26 knu 91:
92: # sortby: File sort order
93: # file Sort by filename
94: # rev Sort by revision number
95: # date Sort by commit date
96: # author Sort by author
97: # log Sort by log message
98:
99: "sortby" => "file",
100:
101: # hideattic: Hide or show files in Attic
102: # 1 Hide files in Attic
103: # 0 Show files in Attic
104:
105: "hideattic" => "1",
106:
107: # logsort: Sort order for CVS logs
108: # date Sort revisions by date
109: # rev Sort revision by revision number
110: # cvs Don't sort them. Same order as CVS/RCS shows them.
111:
112: "logsort" => "date",
113:
114: # f: Default diff format
115: # h Human readable
116: # u Unified diff
117: # c Context diff
118: # s Side by side
119: "f" => "u",
120:
121: # hidecvsroot: Don't show the CVSROOT directory
122: # 1 Hide CVSROOT directory
123: # 0 Show CVSROOT directory
124: "hidecvsroot" => "0",
125:
126: # hidenonreadable: Don't show entries which cannot be read
127: # 1 Hide non-readable entries
128: # 0 Show non-readable entries
129: "hidenonreadable" => "1",
3.1 knu 130: );
131:
132: ##############
133: # some layout stuff
134: ##############
135:
3.9 knu 136: # The body-tag for directory views and logs
3.1 knu 137: $body_tag = '<body text="#000000" bgcolor="#ffffff">';
138:
3.9 knu 139: # The body-tag for diffs and annotations
140: $body_tag_for_src = '<body text="#000000" bgcolor="#eeeeee">';
141:
3.1 knu 142: # Wanna have a logo on the page ?
3.30 knu 143: $logo = '<p><img src="/icons/apache_pb.gif" alt="Powered by Apache"></p>';
3.1 knu 144:
145: # The title of the Page on startup
146: $defaulttitle = "CVS Repository";
147:
148: # The address is shown on the footer
3.32 scop 149: $address = '<font size="-1">CVSweb <freebsd-cvsweb@FreeBSD.org></font>';
3.1 knu 150:
151: # color of navigation Header for
152: # diffs and annotations
153: $navigationHeaderColor = '#9999ee';
154:
155: $long_intro = <<EOT;
156: <p>
157: This is a WWW interface for CVS Repositories.
158: You can browse the file hierarchy by picking directories
159: (which have slashes after them, <i>e.g.</i>, <b>src/</b>).
160: If you pick a file, you will see the revision history
161: for that file.
162: Selecting a revision number will download that revision of
163: the file. There is a link at each revision to display
164: diffs between that revision and the previous one, and
165: a form at the bottom of the page that allows you to
166: display diffs between arbitrary revisions.
167: </p>
168: <p>
3.33 ! scop 169: This script has been written by Bill Fenner and improved by Henner Zeller,
! 170: Henrik Nordström, and Ken Coar, then Akinori MUSHA brought it
3.22 knu 171: back to FreeBSD community and made further improvements; it is covered
3.33 ! scop 172: by <a
! 173: href="http://www.opensource.org/licenses/bsd-license.html">The BSD Licence</a>.
3.1 knu 174: </p>
175: <p>
176: If you would like to use this CGI script on your own web server and
3.33 ! scop 177: CVS tree, download the latest version from <URL:<a
! 178: href="http://www.FreeBSD.org/projects/cvsweb.html">http://www.FreeBSD.org/projects/cvsweb.html</a>>.
3.1 knu 179: </p>
180: <p>
3.33 ! scop 181: Feel free to send any patches, suggestions and comments to the FreeBSD-CVSweb
! 182: mailing list at
! 183: <<a
! 184: href="mailto:freebsd-cvsweb\@FreeBSD.org">freebsd-cvsweb\@FreeBSD.org</a>>.
3.1 knu 185: </p>
186: EOT
187:
188: $short_instruction = <<EOT;
189: <p>
190: Click on a directory to enter that directory. Click on a file to display
3.32 scop 191: its revision history and to get a chance to display diffs between revisions.
3.1 knu 192: </p>
193: EOT
194:
195: # used icons; if icon-url is empty, the text representation is used; if
196: # you do not want to have an ugly tooltip for the icon, remove the
197: # text-representation.
198: # The width and height of the icon allow the browser to correcly display
199: # the table while still loading the icons.
200: # These default icons are coming with apache.
201: # If these icons are too large, check out the miniicons in the
202: # icons/ directory; they have a width/height of 16/16
3.15 knu 203: my $iconsdir = "/icons";
3.26 knu 204:
3.15 knu 205: # format: TEXT ICON-URL width height
3.26 knu 206: %ICONS = (
207: back => [("[BACK]", "$iconsdir/back.gif", 20, 22)],
208: dir => [("[DIR]", "$iconsdir/dir.gif", 20, 22)],
209: file => [("[TXT]", "$iconsdir/text.gif", 20, 22)],
210: );
3.15 knu 211: undef $iconsdir;
3.1 knu 212:
213: # the length to which the last logentry should
214: # be truncated when shown in the directory view
215: $shortLogLen = 80;
216:
217: # Show author of last change
218: $show_author = 1;
219:
220: ##############
221: # table view for directories
222: ##############
223:
224: # Show directory as table
225: # this is much more readable but has one
226: # drawback: the whole table has to be loaded
227: # before common browsers display it which may
228: # be annoying if you have a slow link - and a
229: # large directory ..
230: $dirtable = 1;
231:
232: # show different colors for even/odd rows
233: @tabcolors = ('#ffffff', '#ffffff');
234: $tablepadding = 2;
235:
236: # Color of Header
237: $columnHeaderColorDefault = '#ffffcc';
238: $columnHeaderColorSorted = '#ffcc66';
239:
240: #
241: # If you want to have colored borders
242: # around each row, uncomment this
243: $tableBorderColor = '#cccccc';
244:
245: #
246: # Modules in the repository that should not be displayed, either by default
247: # nor by explicit path specification.
248: #
3.27 knu 249: @HideModules = (
250: # "^my/secret/module",
251: );
252:
253: #
254: # Files matching these pathnames shouldn't be checked out with cvsweb,
255: # since they may contain sensitive information. Simple file name based
256: # filter. Often, the CVSROOT/passwd is exposed and some people tend
257: # to check in their .cvspass, though this is a bad idea. These files
258: # shouldn't be readable by default. Thanks to Damian Gryski to point
259: # this out.
260: @ForbiddenFiles = (
261: "^CVSROOT/passwd\$", # CVSROOT/passwd should not be cvs add'ed, though
262: "/\\.cvspass\$", # Ditto. Just in case.
263: );
3.1 knu 264:
265: #
266: # Use CVSROOT/CVSROOT/descriptions for describing the directories/modules
267: # See INSTALL section 8
268: #
269: $use_descriptions = 0;
270:
271: ##############
272: # Human Readable Diff
273: ##############
274:
275: # (c) 1998 H. Zeller <zeller@think.de>
276: #
277: # Generates two columns of color encoded
278: # diff; much like xdiff or emacs-ediff mode.
279: #
280: # The diff-stuff is a piece of code I once made for
281: # cvs2html which is under GPL,
282: # see http://www.sslug.dk/cvs2html
283: # (c) 1997/98 Peter Toft <pto@sslug.imm.dtu.dk>
284: #
285: # some parameters to screw:
286: ##
287:
288: # make lines breakable so that the columns do not
289: # exceed the width of the browser
290: $hr_breakable = 1;
291:
3.4 knu 292: # give out function names in diffs
3.1 knu 293: # this just makes sense if we have C-files, otherwise
294: # diff's heuristic doesn't work well ..
295: # ( '-p' option to diff)
3.4 knu 296: $showfunc = 1;
3.1 knu 297:
298: # For each pair of regexps, files that match the first regexp will be diff'ed
299: # with an '-F' option with the second regexp.
3.4 knu 300: %funcline_regexp = (
3.26 knu 301: "\\.(4th|fr)\$" => "\\(^\\|[ \t]\\): ",
302: "\\.rb\$" => "^[\t ]*\\(class\\|module\\|def\\) ",
303: );
3.1 knu 304:
305: # ignore whitespaces for human readable diffs
306: # (indendation and stuff ..)
307: # ( '-w' option to diff)
3.7 knu 308: $hr_ignwhite = 0;
3.1 knu 309:
310: # ignore diffs which are caused by
311: # keyword-substitution like $Id - Stuff
312: # ( '-kk' option to rcsdiff)
313: $hr_ignkeysubst = 1;
314:
315: # Colors and font to show the diff type of code changes
3.26 knu 316: $diffcolorHeading = '#99cccc'; # color of 'Line'-head of each diffed file
317: $diffcolorEmpty = '#cccccc'; # color of 'empty' lines
318: $diffcolorRemove = '#ff9999'; # Removed line(s) (left) ( - )
319: $diffcolorChange = '#99ff99'; # Changed line(s) ( both )
320: $diffcolorAdd = '#ccccff'; # Added line(s) ( - ) (right)
321: $diffcolorDarkChange = '#99cc99'; # lines, which are empty in change
322: $difffontface = "Helvetica,Arial";
323: $difffontsize = "-1";
3.1 knu 324:
325: # the width of the textinput of the
326: # request-diff-form
327: $inputTextSize = 12;
328:
329: ##############
330: # Mime Types
331: ##############
332:
333: # mapping to mimetypes to help
334: # cvsweb to guess the correct mime-type on
335: # checkout; you can use the mime.types from
336: # apache here:
337: $mime_types = '/usr/local/etc/apache/mime.types';
338:
339: # quick mime-type lookup; maps file-suffices to
340: # mime-types for displaying checkouts in the browser.
341: # Further MimeTypes will be found in the
342: # file $mime_types (apache style mime.types - file)
343: # - add common mappings here for faster lookup
344: %MTYPES = (
3.26 knu 345: "html" => "text/html",
346: "shtml" => "text/html",
347: "gif" => "image/gif",
348: "jpeg" => "image/jpeg",
349: "jpg" => "image/jpeg",
350: "png" => "image/png",
351: "xpm" => "image/xpm",
352: "*" => "text/plain",
353: );
3.11 knu 354:
355: # Charset for HTML output
3.13 knu 356: $charset = '';
3.26 knu 357:
3.13 knu 358: # e.g.
359: #$charset = $where =~ m,/ru[/_-], ? 'koi8-r'
360: # : $where =~ m,/zh[/_-], ? 'big5'
361: # : $where =~ m,/ja[/_-], ? 'x-euc-jp'
362: # : $where =~ m,/ko[/_-], ? 'x-euc-kr'
363: # : 'iso-8859-1';
3.29 knu 364:
365: # Output filter
366: $output_filter = '';
367:
368: # e.g.
369: ## unify/convert Japanese code into EUC-JP
370: #$output_filter= '/usr/local/bin/nkf -e';
3.1 knu 371:
372: ##############
373: # Misc
374: ##############
375: # allow annotation of files
376: # this requires rw-access to the
3.12 knu 377: # CVSROOT/history file (if you have one)
378: # and rw-access to the subdirectory to
379: # place the lock so you maybe don't want it
3.1 knu 380: $allow_annotate = 1;
381:
382: # allow pretty-printed version of files
383: $allow_markup = 1;
384:
3.31 knu 385: # allow extra hlink formatting (such as PR xrefs) in logs
386: $allow_log_extra = 1; # default: enabled
387:
388: # allow extra hlink formatting (such as PR xrefs) in directories
389: $allow_dir_extra = 1;
390:
391: # allow extra hlink formatting in source code/formatted diff views
392: $allow_source_extra = 1;
393:
3.1 knu 394: # allow compression with gzip
395: # of output if the Browser accepts
396: # it (HTTP_ACCEPT_ENCODING=gzip)
397: # [make sure to have gzip in the path]
3.16 knu 398: $allow_compress = 0;
3.1 knu 399:
400: # Make use of javascript functions.
401: # This way you can select one of your CVSroot
402: # without pressing 'Go' (.. if you do have more
403: # than one CVSROOT defined)
404: $use_java_script = 1;
405:
406: # open Download-Links in another window
407: $open_extern_window = 1;
408:
409: # The size of this extern window; this size option
410: # needs use_java_script to be defined
411: # just comment them if you don't want to have a fixed
412: # size
413: #$extern_window_width = 600;
414: #$extern_window_height = 440;
415:
416: # Edit Options
417: # Enable form to edit your options (hideattic,sortbydate)
418: # this isn't necessary if you've $dirtable defined 'cause
419: # this allows editing of all your options more intuitive
420: $edit_option_form = (not $dirtable);
421:
422: # If you have files which automatically refers to other files
423: # (such as HTML) then this allows you to browse the checked
424: # out files as if outside CVS.
425: $checkout_magic = 1;
426:
427: # Show last changelog message for sub directories
428: # The current implementation makes many assumptions and may show the
429: # incorrect file at some times. The main assumption is that the last
430: # modified file has the newest filedate. But some CVS operations
431: # touches the file without even when a new version is't checked in,
432: # and TAG based browsing essientially puts this out of order, unless
433: # the last checkin was on the same tag as you are viewing.
434: # Enable this if you like the feature, but don't rely on correct results.
435: $show_subdir_lastmod = 0;
436:
437: # Background color of logentry in markup
438: $markupLogColor = "#ffffff";
439:
440: # Show CVS log when viewing file contents
441: $show_log_in_markup = 1;
442:
3.13 knu 443: # Preformat when viewing file contents. This should be turned off
444: # when you have files in the repository that are in a multibyte
445: # encoding which uses HTML special characters ([<>&"]) as part of a
446: # multi-byte character. (such as iso-2022-jp, ShiftJIS, etc.)
447: # Otherwise those files will get screwed up in markup.
448: $preformat_in_markup = '';
449:
3.1 knu 450: # Tabstop used to expand tabs in colored diffs. If undefined then
451: # tabs are always expanded to 8 spaces.
452: $tabstop = 8;
453:
454: # if you wish to display absolute times in your local timezone,
455: # then define mytz and fill in the strings for your standard and
456: # daylight time. Note that you must also make sure the system
457: # timezone is correctly set.
458: # @mytz=("EST", "EDT");
459:
460: # cvsweb is friendly to caches by indicating a suitable
461: # last-modified timestamp. Doing this uses slightly more
462: # CPU so you might want to disable it if you have a slow
463: # server
464: $use_moddate = 1;
465:
3.12 knu 466: # Allows downloading a tarball of the current directory if set.
467: # Bear in mind that this allows downloading a tarball of your entire
468: # repository, which can take a lot of time and disk space to create!
469: # If you enable this, you may need to make sure that cvsweb can write to
470: # CVSROOT/val-tags, due to a bug in cvs.
471: $allow_tar = '';
3.13 knu 472:
473: # Options to pass to tar(1).
3.15 knu 474: @tar_options = qw();
3.26 knu 475:
3.13 knu 476: # e.g. @tar_options = qw(--ignore-failed-read);
477: # GNU tar has some useful options against unexpected errors.
478:
3.19 knu 479: # Options to pass to gzip(1) when compressing a tarball to download.
480: @gzip_options = qw();
3.26 knu 481:
3.19 knu 482: # e.g. @gzip_options = qw(-3);
3.25 knu 483: # Try lower compression level than 6 (default) if you want faster
484: # compression, or higher, for better compression.
485:
486: # Options to pass to zip(1) when compressing a zip archive to download.
487: @zip_options = qw();
3.26 knu 488:
3.25 knu 489: # e.g. @zip_options = qw(-3);
3.19 knu 490: # Try lower compression level than 6 (default) if you want faster
3.21 knu 491: # compression, or higher, for better compression.
3.19 knu 492:
3.13 knu 493: # Options to pass to cvs(1).
494: @cvs_options = qw(-l);
3.19 knu 495:
496: push @cvs_options, '-R' if ($uname eq 'FreeBSD' || $uname eq 'OpenBSD');
3.26 knu 497:
3.19 knu 498: # Only FreeBSD's and OpenBSD's cvs(1) supports -R (read only access
499: # mode) option, which considerably speeds up checkouts over NFS.
3.12 knu 500:
501: 1;
3.26 knu 502:
3.1 knu 503: #EOF
CVSweb