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