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