Annotation of cvsweb/cvsweb.conf, Revision 4.20
4.2 schwarze 1: # -*- perl -*-
4.20 ! schwarze 2: # $Id: cvsweb.conf,v 4.19 2019/11/29 14:40:27 schwarze Exp $
4.2 schwarze 3: # $doc: cvsweb.conf,v 1.38 2006/01/19 19:53:38 ceri
4: # $knu: cvsweb.conf,v 1.97 2005/06/19 09:13:50 scop
5: #
3.76 scop 6: # Configuration of cvsweb.cgi, a web interface to CVS repositories.
3.1 knu 7: #
8: # (c) 1998-1999 H. Zeller <zeller@think.de>
9: # 1999 H. Nordstrom <hno@hem.passagen.se>
3.30 knu 10: # 2000-2002 A. MUSHA <knu@FreeBSD.org>
3.95 scop 11: # 2002-2005 V. Skyttä <scop@FreeBSD.org>
3.1 knu 12: # based on work by Bill Fenner <fenner@FreeBSD.org>
13:
3.92 scop 14: #
15: # Unless otherwise noted, all boolean parameters here default to off
16: # when no value for them has been explicitly set.
17: #
3.19 knu 18:
3.53 scop 19: # CVS roots
20: #
21: # CVSweb can handle several CVS repositories at once. Enter short (internal)
22: # symbolic repository names, their names in the UI and the actual locations
23: # here. The repositories will be listed in the order they're specified here.
24: #
3.93 scop 25: # Obviously, CVSweb will need read access to these repository dirs. If you
26: # receive an error that no valid CVS roots were found, double-check the file
27: # permissions and any other attributes your system may have for the repository
28: # directories, such as SELinux file contexts.
29: #
3.76 scop 30: # CVSweb will also load per-cvsroot configuration files if they exist.
31: # The symbolic_name (see below) of the CVS root will be concatenated into the
32: # name of the main (this) configuration file along with a hyphen, and that
33: # file will be loaded for that particular CVS root. For examples, see
34: # cvsweb.conf-* in the CVSweb distribution.
35: #
3.53 scop 36: # Note that only local repositories are currently supported. Things like
37: # :pserver:someone@xyz.com:/data/cvsroot won't work.
38: #
39: # 'symbolic_name' => ['Name to display', '/path/to/cvsroot']
40: #
3.17 knu 41: @CVSrepositories = (
4.4 schwarze 42: 'local' => ['Local Repository', '/cvs'],
3.26 knu 43: );
3.88 scop 44:
3.92 scop 45: # Manual gateway linking. This will be done only for views for which
46: # $allow_*_extra below is true.
3.76 scop 47: #
3.26 knu 48: $mancgi =
3.98 ceri 49: "http://www.FreeBSD.org/cgi/man.cgi?apropos=0&sektion=%s&query=%s&manpath=FreeBSD+7.0-current&format=html";
3.1 knu 50:
3.90 scop 51: # Defaults for user definable options.
3.76 scop 52: #
3.1 knu 53: %DEFAULTVALUE = (
3.26 knu 54:
3.76 scop 55: # sortby: File sort order
56: # file Sort by filename
57: # rev Sort by revision number
58: # date Sort by commit date
59: # author Sort by author
60: # log Sort by log message
61: "sortby" => "file",
62:
63: # ignorecase: Ignore case in sorts (filenames, authors, log messages)
64: # 0 Honor case
65: # 1 Ignore case
66: "ignorecase" => "0",
67:
68: # hideattic: Hide or show files in Attic
69: # 1 Hide files in Attic
70: # 0 Show files in Attic
71: "hideattic" => "1",
72:
73: # logsort: Sort order for CVS logs
74: # date Sort revisions by date
75: # rev Sort revision by revision number
76: # cvs Don't sort them. Same order as CVS/RCS shows them.
77: "logsort" => "date",
78:
79: # f: Default diff format
80: # h Human readable
81: # u Unified diff
82: # c Context diff
83: "f" => "u",
84:
3.90 scop 85: # hidecvsroot: Don't show the CVSROOT directory. Note that this is
86: # just the default for a user settable option (like others in this
87: # %DEFAULTVALUE hash); it won't really prevent access to CVSROOT.
88: # See @ForbiddenFiles for that.
89: # 1 Do not include the top-level CVSROOT directory in dir listings
90: # 0 Treat the top-level CVSROOT directory just like all other dirs
3.76 scop 91: "hidecvsroot" => "0",
92:
3.90 scop 93: # hidenonreadable: Don't show files and directories that cannot be read
94: # in directory listings.
3.76 scop 95: # 1 Hide non-readable entries
96: # 0 Show non-readable entries
97: "hidenonreadable" => "1",
98:
99: # ln: Show line numbers in HTMLized views
100: # 1 Show line numbers
101: # 0 Don't show line numbers
102: "ln" => "0",
3.1 knu 103: );
104:
3.76 scop 105: #
106: # Layout options (see also the included CSS file)
107: #
3.1 knu 108:
109: # Wanna have a logo on the page ?
3.58 scop 110: #
3.79 scop 111: #$logo = '<p><img src="/icons/apache_pb.gif" alt="Powered by Apache" /></p>';
3.1 knu 112:
3.79 scop 113: # The title of the Page on startup. This will be put inside <h1> and <title>
114: # tags, and HTML escaped.
3.58 scop 115: #
3.1 knu 116: $defaulttitle = "CVS Repository";
117:
3.34 scop 118: # The address is shown on the footer. This will be put inside a <address> tag.
3.58 scop 119: #
4.5 schwarze 120: $address = '<span style="font-size: smaller">CVSweb</span>';
3.1 knu 121:
3.42 scop 122: # Icons for the web UI. If ICON-URL is empty, the TEXT representation is
123: # used. If you do not want to have a tool tip for an icon, set TEXT empty.
124: # The width and height of the icon allow the browser to correctly display
125: # the table while still loading the icons. If these icons are too large,
126: # check out the "mini" versions in the icons/ directory; they have a
127: # width/height of 16/16.
3.58 scop 128: #
3.42 scop 129: my $iconsdir = '/icons';
130:
3.51 scop 131: # format: TEXT ICON-URL width height
3.26 knu 132: %ICONS = (
3.51 scop 133: back => [('[BACK]', "$iconsdir/back.gif", 20, 22)],
134: dir => [('[DIR]', "$iconsdir/dir.gif", 20, 22)],
135: file => [('[TXT]', "$iconsdir/text.gif", 20, 22)],
3.87 scop 136: binfile => [('[BIN]', "$iconsdir/binary.gif", 20, 22)],
3.26 knu 137: );
3.15 knu 138: undef $iconsdir;
3.1 knu 139:
3.43 scop 140: # An URL where to find the CSS.
3.58 scop 141: #
3.43 scop 142: $cssurl = '/css/cvsweb.css';
143:
3.76 scop 144: # The length to which the last log entry should be truncated when shown
145: # in the directory view.
3.58 scop 146: #
3.1 knu 147: $shortLogLen = 80;
148:
3.76 scop 149: # Show author of last change?
3.58 scop 150: #
3.1 knu 151: $show_author = 1;
152:
3.76 scop 153: # Cell padding for directory table.
3.58 scop 154: #
3.1 knu 155: $tablepadding = 2;
156:
3.91 scop 157: # Regular expressions for files and directories which should be hidden.
3.75 scop 158: # Each regexp is compared against a path relative to a CVS root, after
159: # stripping the trailing ",v" if present. Matching files and directories
160: # are not displayed.
3.58 scop 161: #
3.27 knu 162: @ForbiddenFiles = (
3.74 scop 163: qr|^CVSROOT/+passwd$|o, # CVSROOT/passwd should not be 'cvs add'ed though.
164: qr|/\.cvspass$|o, # Ditto. Just in case.
3.75 scop 165: #qr|^my/+secret/+dir|o,
3.27 knu 166: );
3.1 knu 167:
3.77 scop 168: # Use CVSROOT/descriptions for describing the directories/modules?
3.69 scop 169: # See INSTALL, section 9.
3.1 knu 170: #
171: $use_descriptions = 0;
172:
3.76 scop 173: #
174: # Human readable diff.
175: #
3.1 knu 176: # (c) 1998 H. Zeller <zeller@think.de>
177: #
3.76 scop 178: # Generates two columns of color encoded diff; much like xdiff or GNU Emacs'
179: # ediff-mode.
3.1 knu 180: #
3.76 scop 181: # The diff-stuff is a piece of code I once made for cvs2html which is under
182: # GPL, see http://www.sslug.dk/cvs2html
3.1 knu 183: # (c) 1997/98 Peter Toft <pto@sslug.imm.dtu.dk>
184:
3.76 scop 185: # Make lines breakable so that the columns do not exceed the width of the
186: # browser?
3.58 scop 187: #
3.1 knu 188: $hr_breakable = 1;
189:
3.80 scop 190: # Print function names in diffs (unified and context only).
191: # See the -p option in the diff(1) man page.
3.58 scop 192: #
3.4 knu 193: $showfunc = 1;
3.1 knu 194:
3.76 scop 195: # Ignore whitespace in human readable diffs? ('-w' option to diff)
3.58 scop 196: #
3.7 knu 197: $hr_ignwhite = 0;
3.1 knu 198:
3.76 scop 199: # Ignore diffs which are caused by keyword substitution, $Id and friends?
200: # ('-kk' option to rcsdiff)
3.58 scop 201: #
3.1 knu 202: $hr_ignkeysubst = 1;
203:
3.76 scop 204: # The width of the textinput of the "request diff" form.
3.58 scop 205: #
3.1 knu 206: $inputTextSize = 12;
3.70 scop 207:
208: # Custom per MIME type diff tools, used for comparing binary files such as
209: # spreadsheets, images etc. Each key is a MIME type in lowercase.
210: # Each value is an array ref of available diff tools for that type, each of
211: # which is a hash ref with values (mandatory where default not listed):
212: # name: the name to show in the UI for this diff type
213: # cmd: full path to executable
214: # args: arguments as an array ref (not string!, defaults to no arguments)
215: # type: output MIME type (defaults to text/plain)
216: #
217: %DIFF_COMMANDS = (
218: #'text/xml' => [
219: # { name => 'XMLdiff',
220: # cmd => $CMD{xmldiff},
221: # },
222: # { name => 'XMLdiff (XUpdate)',
223: # cmd => $CMD{xmldiff},
224: # args => [ qw(-x) ],
225: # type => 'text/xml',
226: # },
227: #],
228: );
3.1 knu 229:
3.76 scop 230: #
231: # Mime types
232: #
3.1 knu 233:
3.52 scop 234: # The MIME type lookup works like this:
235: # 1) Look up from %MTYPES below with the file name extension (suffix).
236: # 2) If not found, use the MIME::Types(3) module if it's available.
237: # 3) If not found, lookup from the $mime_types file (see below).
238: # 4) If not found, try %MTYPES{'*'}.
239: # 5) If not found, use 'application/octet-stream' if the file's keyword
240: # substitution mode is b (ie. the file was checked in as binary to CVS),
241: # 'text/plain' otherwise.
3.1 knu 242:
3.52 scop 243: # Quick MIME type lookup; maps filename extensions to MIME types.
244: # Add common mappings here for fast lookup. You can also use this
245: # to override MIME::Types(3) or the $mime_types file (see below).
3.58 scop 246: #
3.1 knu 247: %MTYPES = (
3.26 knu 248: "html" => "text/html",
249: "shtml" => "text/html",
250: "gif" => "image/gif",
251: "jpeg" => "image/jpeg",
252: "jpg" => "image/jpeg",
253: "png" => "image/png",
254: "xpm" => "image/xpm",
3.52 scop 255: # "*" => "text/plain",
3.26 knu 256: );
3.52 scop 257:
258: # The traditional mime.types file, eg. the one from Apache is fine.
259: # See above where this gets used.
3.58 scop 260: #
4.3 schwarze 261: $mime_types = '/conf/mime.types';
3.11 knu 262:
3.56 scop 263: # Charset appended to the Content-Type HTTP header for text/* MIME types.
264: # Note that the web server may default to some charset which may take effect
265: # if you leave this parameter empty or unset.
3.69 scop 266: # For Apache, see also the AddDefaultCharset directive.
3.56 scop 267: #
3.13 knu 268: $charset = '';
3.26 knu 269:
3.13 knu 270: # e.g.
271: #$charset = $where =~ m,/ru[/_-], ? 'koi8-r'
272: # : $where =~ m,/zh[/_-], ? 'big5'
273: # : $where =~ m,/ja[/_-], ? 'x-euc-jp'
274: # : $where =~ m,/ko[/_-], ? 'x-euc-kr'
275: # : 'iso-8859-1';
3.29 knu 276:
277: # Output filter
3.58 scop 278: #
3.29 knu 279: $output_filter = '';
280:
281: # e.g.
282: ## unify/convert Japanese code into EUC-JP
283: #$output_filter= '/usr/local/bin/nkf -e';
3.1 knu 284:
285: ##############
286: # Misc
287: ##############
3.58 scop 288:
3.76 scop 289: # Allow annotation of files? See also @annotate_options below.
3.58 scop 290: #
3.1 knu 291: $allow_annotate = 1;
292:
3.96 scop 293: # Allow HTMLized versions of files?
3.58 scop 294: #
3.1 knu 295: $allow_markup = 1;
296:
3.96 scop 297: # Allow CVSweb to create mailto: links from email addresses in various
298: # HTMLized views? Default: yes.
299: #
300: #$allow_mailtos = 0;
301:
4.8 schwarze 302: ## Extra hyperlinking means hyperlinks to manual page
303: ## gateways, see $mancgi above.
3.92 scop 304:
3.76 scop 305: # Allow extra hyperlinking (such as PR cross-references) in logs?
3.92 scop 306: # Default: yes.
3.58 scop 307: #
3.92 scop 308: #$allow_log_extra = 0;
3.31 knu 309:
3.92 scop 310: # Allow extra hyperlinking in directory views?
3.58 scop 311: #
3.31 knu 312: $allow_dir_extra = 1;
313:
3.76 scop 314: # Allow extra hyperlinking in source code/formatted diff views?
3.58 scop 315: #
3.31 knu 316: $allow_source_extra = 1;
317:
3.76 scop 318: # Allow compression with gzip in general? Note that this also requires
319: # that the browser supports it, and will be disabled on the fly when necessary.
3.58 scop 320: #
3.92 scop 321: #$allow_compress = 1;
3.1 knu 322:
3.76 scop 323: # Show a form for setting options in the directory view?
3.58 scop 324: #
325: $edit_option_form = 1;
3.1 knu 326:
3.77 scop 327: # Show last changelog message for subdirectories?
3.1 knu 328: # The current implementation makes many assumptions and may show the
329: # incorrect file at some times. The main assumption is that the last
330: # modified file has the newest filedate. But some CVS operations
3.97 scop 331: # touch the file even when a new version isn't checked in, and TAG
332: # based browsing essentially puts this out of order unless the last
333: # checkin was on the same tag as you are viewing.
3.1 knu 334: # Enable this if you like the feature, but don't rely on correct results.
3.58 scop 335: #
3.92 scop 336: #$show_subdir_lastmod = 1;
3.1 knu 337:
3.76 scop 338: # Show CVS log when viewing file contents?
3.58 scop 339: #
3.1 knu 340: $show_log_in_markup = 1;
341:
3.77 scop 342: # Preformat when viewing file contents? This should be turned off
3.13 knu 343: # when you have files in the repository that are in a multibyte
344: # encoding which uses HTML special characters ([<>&"]) as part of a
3.97 scop 345: # multibyte character. (such as iso-2022-jp, ShiftJIS, etc.)
3.13 knu 346: # Otherwise those files will get screwed up in markup.
3.58 scop 347: #
3.92 scop 348: #$preformat_in_markup = 1;
3.13 knu 349:
3.92 scop 350: # Default tab width used to expand tabs to spaces in various HTMLized views.
351: # Note that CVSweb scans the first few lines of sources for some common editor
352: # directives controlling the tab width. It uses the value from them if found,
353: # falling back to the value of $tabstop if not. Default: 8.
3.58 scop 354: #
3.92 scop 355: #$tabstop = 4;
3.1 knu 356:
3.82 scop 357: # CVSweb is friendly to caches by sending the HTTP Last-Modified
358: # header corresponding to the sent content. In the case of a
359: # checkout, this may require running rcslog on the file solely for the
360: # purpose of retrieving the timestamp to be sent. If you have a slow
3.92 scop 361: # server, you may want to turn this off for a small performance gain.
3.58 scop 362: #
3.1 knu 363: $use_moddate = 1;
364:
3.45 scop 365: # Maximum number of filenames to pass to rlog(1) in one command.
4.16 schwarze 366: # If you see "Failed to spawn rlog" errors with directories containing
3.45 scop 367: # lots of files, experiment by setting this to different values and see if
368: # the error still occurs. A good value to start from would be eg. 200.
369: # Just comment this out if you're not bitten by the problem.
3.57 scop 370: #
3.45 scop 371: #$file_list_len = 200;
3.86 scop 372:
4.13 schwarze 373: # Whether to allow downloading a tarball of the current directory.
3.57 scop 374: # While downloading of the entire repository is disallowed, depending on
375: # the directory this may take a lot of time and disk space. For some CVS
3.69 scop 376: # versions, the user account running CVSweb needs write access to
4.18 schwarze 377: # CVSROOT/val-tags. See also the tar options below.
3.57 scop 378: #
4.18 schwarze 379: $allow_tar = 0;
3.57 scop 380:
3.13 knu 381: # Options to pass to tar(1).
3.57 scop 382: # For example: @tar_options = qw(--ignore-failed-read);
383: # GNU tar has some useful options against unexpected errors.
384: # Other useful options include "--owner=0" and "--group=0", see
385: # the tar(1) (or gtar(1)) manpage for details.
386: #
3.15 knu 387: @tar_options = qw();
3.26 knu 388:
3.13 knu 389: # Options to pass to cvs(1).
3.63 scop 390: # For cvs versions 1.11 to 1.11.6 (broken in < 1.11, removed in 1.11.7), you
391: # can use the '-l' option to prevent cvs from writing to the history file.
392: # For other cvs versions, either suppress history logging by using the
3.69 scop 393: # LogHistory parameter in CVSROOT/config or make sure that the CVSweb user
3.63 scop 394: # can read and write to CVSROOT/history.
3.61 scop 395: # FreeBSD's and OpenBSD's cvs(1) has long since supported -R (read only access
396: # mode) option, which considerably speeds up checkouts over NFS. For other
4.19 schwarze 397: # platforms, the -R option is available in cvs >= 1.12.1.
398: # A similar effect is provided by -u on NetBSD.
3.57 scop 399: #
3.85 scop 400: @cvs_options = qw(-f);
3.47 scop 401: push @cvs_options, '-R' if ($^O eq 'freebsd' || $^O eq 'openbsd');
402: push @cvs_options, '-u' if ($^O eq 'netbsd');
3.26 knu 403:
3.39 scop 404: # Options to pass to the 'cvs annotate' command, usually the normal
405: # @cvs_options are good enough here.
3.57 scop 406: # To make annotate work against a read only repository, add -n, ie.:
407: # @annotate_options = (@cvs_options, '-n');
408: #
3.39 scop 409: @annotate_options = @cvs_options;
410:
3.54 scop 411: # Options to pass to rcsdiff(1).
412: # Probably the only useful one here is -q (suppress diagnostic output).
3.57 scop 413: #
3.54 scop 414: @rcsdiff_options = qw(-q);
3.39 scop 415:
3.89 scop 416: # Troubleshooting: in case of problems, setting this to 1 will cause more
417: # error output into your web server error log. Under normal operation,
418: # this should be set to 0 or commented out.
419: #
420: #$DEBUG = 1;
3.94 scop 421:
3.12 knu 422: 1;
3.26 knu 423:
3.57 scop 424: # 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