Annotation of cvsweb/cvsweb.conf, Revision 3.32
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.22 knu 169: This script has been written by Bill Fenner <<a
170: href="mailto:fenner\@FreeBSD.org">fenner\@FreeBSD.org</a>> and
171: improved by Henner Zeller <<a
172: href="mailto:zeller\@think.de">zeller\@think.de</a>>, Henrik
173: Nordström <<a
174: href="mailto:hno\@hem.passagen.se">hno\@hem.passagen.se</a>>, and
175: Ken Coar <<a
176: href="mailto:Ken.Coar\@Golux.Com">Ken.Coar\@Golux.Com</a>>, then
177: Akinori MUSHA <<a
178: href="mailto:knu\@FreeBSD.org">knu\@FreeBSD.org</a>> brought it
179: back to FreeBSD community and made further improvements; it is covered
180: by the <a
181: href="http://www.opensource.org/licenses/bsd-license.html">BSD-Licence</a>.
3.1 knu 182: </p>
183: <p>
184: If you would like to use this CGI script on your own web server and
3.23 knu 185: CVS tree, download the latest version <a
3.32 ! scop 186: href="http://www.FreeBSD.org/projects/cvsweb.html">here</a>, and also check
3.24 knu 187: out Zeller's <a
3.32 ! scop 188: href="http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/">CVSweb
! 189: distribution site</a>.
3.1 knu 190: </p>
191: <p>
3.32 ! scop 192: Feel free to send any patches, suggestions and comments to
! 193: <a href="mailto:freebsd-cvsweb\@FreeBSD.org">The FreeBSD-CVSweb mailing list</a>.
3.1 knu 194: </p>
195: EOT
196:
197: $short_instruction = <<EOT;
198: <p>
199: Click on a directory to enter that directory. Click on a file to display
3.32 ! scop 200: its revision history and to get a chance to display diffs between revisions.
3.1 knu 201: </p>
202: EOT
203:
204: # used icons; if icon-url is empty, the text representation is used; if
205: # you do not want to have an ugly tooltip for the icon, remove the
206: # text-representation.
207: # The width and height of the icon allow the browser to correcly display
208: # the table while still loading the icons.
209: # These default icons are coming with apache.
210: # If these icons are too large, check out the miniicons in the
211: # icons/ directory; they have a width/height of 16/16
3.15 knu 212: my $iconsdir = "/icons";
3.26 knu 213:
3.15 knu 214: # format: TEXT ICON-URL width height
3.26 knu 215: %ICONS = (
216: back => [("[BACK]", "$iconsdir/back.gif", 20, 22)],
217: dir => [("[DIR]", "$iconsdir/dir.gif", 20, 22)],
218: file => [("[TXT]", "$iconsdir/text.gif", 20, 22)],
219: );
3.15 knu 220: undef $iconsdir;
3.1 knu 221:
222: # the length to which the last logentry should
223: # be truncated when shown in the directory view
224: $shortLogLen = 80;
225:
226: # Show author of last change
227: $show_author = 1;
228:
229: ##############
230: # table view for directories
231: ##############
232:
233: # Show directory as table
234: # this is much more readable but has one
235: # drawback: the whole table has to be loaded
236: # before common browsers display it which may
237: # be annoying if you have a slow link - and a
238: # large directory ..
239: $dirtable = 1;
240:
241: # show different colors for even/odd rows
242: @tabcolors = ('#ffffff', '#ffffff');
243: $tablepadding = 2;
244:
245: # Color of Header
246: $columnHeaderColorDefault = '#ffffcc';
247: $columnHeaderColorSorted = '#ffcc66';
248:
249: #
250: # If you want to have colored borders
251: # around each row, uncomment this
252: $tableBorderColor = '#cccccc';
253:
254: #
255: # Modules in the repository that should not be displayed, either by default
256: # nor by explicit path specification.
257: #
3.27 knu 258: @HideModules = (
259: # "^my/secret/module",
260: );
261:
262: #
263: # Files matching these pathnames shouldn't be checked out with cvsweb,
264: # since they may contain sensitive information. Simple file name based
265: # filter. Often, the CVSROOT/passwd is exposed and some people tend
266: # to check in their .cvspass, though this is a bad idea. These files
267: # shouldn't be readable by default. Thanks to Damian Gryski to point
268: # this out.
269: @ForbiddenFiles = (
270: "^CVSROOT/passwd\$", # CVSROOT/passwd should not be cvs add'ed, though
271: "/\\.cvspass\$", # Ditto. Just in case.
272: );
3.1 knu 273:
274: #
275: # Use CVSROOT/CVSROOT/descriptions for describing the directories/modules
276: # See INSTALL section 8
277: #
278: $use_descriptions = 0;
279:
280: ##############
281: # Human Readable Diff
282: ##############
283:
284: # (c) 1998 H. Zeller <zeller@think.de>
285: #
286: # Generates two columns of color encoded
287: # diff; much like xdiff or emacs-ediff mode.
288: #
289: # The diff-stuff is a piece of code I once made for
290: # cvs2html which is under GPL,
291: # see http://www.sslug.dk/cvs2html
292: # (c) 1997/98 Peter Toft <pto@sslug.imm.dtu.dk>
293: #
294: # some parameters to screw:
295: ##
296:
297: # make lines breakable so that the columns do not
298: # exceed the width of the browser
299: $hr_breakable = 1;
300:
3.4 knu 301: # give out function names in diffs
3.1 knu 302: # this just makes sense if we have C-files, otherwise
303: # diff's heuristic doesn't work well ..
304: # ( '-p' option to diff)
3.4 knu 305: $showfunc = 1;
3.1 knu 306:
307: # For each pair of regexps, files that match the first regexp will be diff'ed
308: # with an '-F' option with the second regexp.
3.4 knu 309: %funcline_regexp = (
3.26 knu 310: "\\.(4th|fr)\$" => "\\(^\\|[ \t]\\): ",
311: "\\.rb\$" => "^[\t ]*\\(class\\|module\\|def\\) ",
312: );
3.1 knu 313:
314: # ignore whitespaces for human readable diffs
315: # (indendation and stuff ..)
316: # ( '-w' option to diff)
3.7 knu 317: $hr_ignwhite = 0;
3.1 knu 318:
319: # ignore diffs which are caused by
320: # keyword-substitution like $Id - Stuff
321: # ( '-kk' option to rcsdiff)
322: $hr_ignkeysubst = 1;
323:
324: # Colors and font to show the diff type of code changes
3.26 knu 325: $diffcolorHeading = '#99cccc'; # color of 'Line'-head of each diffed file
326: $diffcolorEmpty = '#cccccc'; # color of 'empty' lines
327: $diffcolorRemove = '#ff9999'; # Removed line(s) (left) ( - )
328: $diffcolorChange = '#99ff99'; # Changed line(s) ( both )
329: $diffcolorAdd = '#ccccff'; # Added line(s) ( - ) (right)
330: $diffcolorDarkChange = '#99cc99'; # lines, which are empty in change
331: $difffontface = "Helvetica,Arial";
332: $difffontsize = "-1";
3.1 knu 333:
334: # the width of the textinput of the
335: # request-diff-form
336: $inputTextSize = 12;
337:
338: ##############
339: # Mime Types
340: ##############
341:
342: # mapping to mimetypes to help
343: # cvsweb to guess the correct mime-type on
344: # checkout; you can use the mime.types from
345: # apache here:
346: $mime_types = '/usr/local/etc/apache/mime.types';
347:
348: # quick mime-type lookup; maps file-suffices to
349: # mime-types for displaying checkouts in the browser.
350: # Further MimeTypes will be found in the
351: # file $mime_types (apache style mime.types - file)
352: # - add common mappings here for faster lookup
353: %MTYPES = (
3.26 knu 354: "html" => "text/html",
355: "shtml" => "text/html",
356: "gif" => "image/gif",
357: "jpeg" => "image/jpeg",
358: "jpg" => "image/jpeg",
359: "png" => "image/png",
360: "xpm" => "image/xpm",
361: "*" => "text/plain",
362: );
3.11 knu 363:
364: # Charset for HTML output
3.13 knu 365: $charset = '';
3.26 knu 366:
3.13 knu 367: # e.g.
368: #$charset = $where =~ m,/ru[/_-], ? 'koi8-r'
369: # : $where =~ m,/zh[/_-], ? 'big5'
370: # : $where =~ m,/ja[/_-], ? 'x-euc-jp'
371: # : $where =~ m,/ko[/_-], ? 'x-euc-kr'
372: # : 'iso-8859-1';
3.29 knu 373:
374: # Output filter
375: $output_filter = '';
376:
377: # e.g.
378: ## unify/convert Japanese code into EUC-JP
379: #$output_filter= '/usr/local/bin/nkf -e';
3.1 knu 380:
381: ##############
382: # Misc
383: ##############
384: # allow annotation of files
385: # this requires rw-access to the
3.12 knu 386: # CVSROOT/history file (if you have one)
387: # and rw-access to the subdirectory to
388: # place the lock so you maybe don't want it
3.1 knu 389: $allow_annotate = 1;
390:
391: # allow pretty-printed version of files
392: $allow_markup = 1;
393:
3.31 knu 394: # allow extra hlink formatting (such as PR xrefs) in logs
395: $allow_log_extra = 1; # default: enabled
396:
397: # allow extra hlink formatting (such as PR xrefs) in directories
398: $allow_dir_extra = 1;
399:
400: # allow extra hlink formatting in source code/formatted diff views
401: $allow_source_extra = 1;
402:
3.1 knu 403: # allow compression with gzip
404: # of output if the Browser accepts
405: # it (HTTP_ACCEPT_ENCODING=gzip)
406: # [make sure to have gzip in the path]
3.16 knu 407: $allow_compress = 0;
3.1 knu 408:
409: # Make use of javascript functions.
410: # This way you can select one of your CVSroot
411: # without pressing 'Go' (.. if you do have more
412: # than one CVSROOT defined)
413: $use_java_script = 1;
414:
415: # open Download-Links in another window
416: $open_extern_window = 1;
417:
418: # The size of this extern window; this size option
419: # needs use_java_script to be defined
420: # just comment them if you don't want to have a fixed
421: # size
422: #$extern_window_width = 600;
423: #$extern_window_height = 440;
424:
425: # Edit Options
426: # Enable form to edit your options (hideattic,sortbydate)
427: # this isn't necessary if you've $dirtable defined 'cause
428: # this allows editing of all your options more intuitive
429: $edit_option_form = (not $dirtable);
430:
431: # If you have files which automatically refers to other files
432: # (such as HTML) then this allows you to browse the checked
433: # out files as if outside CVS.
434: $checkout_magic = 1;
435:
436: # Show last changelog message for sub directories
437: # The current implementation makes many assumptions and may show the
438: # incorrect file at some times. The main assumption is that the last
439: # modified file has the newest filedate. But some CVS operations
440: # touches the file without even when a new version is't checked in,
441: # and TAG based browsing essientially puts this out of order, unless
442: # the last checkin was on the same tag as you are viewing.
443: # Enable this if you like the feature, but don't rely on correct results.
444: $show_subdir_lastmod = 0;
445:
446: # Background color of logentry in markup
447: $markupLogColor = "#ffffff";
448:
449: # Show CVS log when viewing file contents
450: $show_log_in_markup = 1;
451:
3.13 knu 452: # Preformat when viewing file contents. This should be turned off
453: # when you have files in the repository that are in a multibyte
454: # encoding which uses HTML special characters ([<>&"]) as part of a
455: # multi-byte character. (such as iso-2022-jp, ShiftJIS, etc.)
456: # Otherwise those files will get screwed up in markup.
457: $preformat_in_markup = '';
458:
3.1 knu 459: # Tabstop used to expand tabs in colored diffs. If undefined then
460: # tabs are always expanded to 8 spaces.
461: $tabstop = 8;
462:
463: # if you wish to display absolute times in your local timezone,
464: # then define mytz and fill in the strings for your standard and
465: # daylight time. Note that you must also make sure the system
466: # timezone is correctly set.
467: # @mytz=("EST", "EDT");
468:
469: # cvsweb is friendly to caches by indicating a suitable
470: # last-modified timestamp. Doing this uses slightly more
471: # CPU so you might want to disable it if you have a slow
472: # server
473: $use_moddate = 1;
474:
3.12 knu 475: # Allows downloading a tarball of the current directory if set.
476: # Bear in mind that this allows downloading a tarball of your entire
477: # repository, which can take a lot of time and disk space to create!
478: # If you enable this, you may need to make sure that cvsweb can write to
479: # CVSROOT/val-tags, due to a bug in cvs.
480: $allow_tar = '';
3.13 knu 481:
482: # Options to pass to tar(1).
3.15 knu 483: @tar_options = qw();
3.26 knu 484:
3.13 knu 485: # e.g. @tar_options = qw(--ignore-failed-read);
486: # GNU tar has some useful options against unexpected errors.
487:
3.19 knu 488: # Options to pass to gzip(1) when compressing a tarball to download.
489: @gzip_options = qw();
3.26 knu 490:
3.19 knu 491: # e.g. @gzip_options = qw(-3);
3.25 knu 492: # Try lower compression level than 6 (default) if you want faster
493: # compression, or higher, for better compression.
494:
495: # Options to pass to zip(1) when compressing a zip archive to download.
496: @zip_options = qw();
3.26 knu 497:
3.25 knu 498: # e.g. @zip_options = qw(-3);
3.19 knu 499: # Try lower compression level than 6 (default) if you want faster
3.21 knu 500: # compression, or higher, for better compression.
3.19 knu 501:
3.13 knu 502: # Options to pass to cvs(1).
503: @cvs_options = qw(-l);
3.19 knu 504:
505: push @cvs_options, '-R' if ($uname eq 'FreeBSD' || $uname eq 'OpenBSD');
3.26 knu 506:
3.19 knu 507: # Only FreeBSD's and OpenBSD's cvs(1) supports -R (read only access
508: # mode) option, which considerably speeds up checkouts over NFS.
3.12 knu 509:
510: 1;
3.26 knu 511:
3.1 knu 512: #EOF
CVSweb