README

   1                      DEBIAN BUG TRACKING SYSTEM
   2                      --------------------------
   3
   4 This bug tracking system was developed by Ian Jackson from 1994-1997,
   5 with assistance from nCipher Corporation Limited in 1997.  I am grateful to
   6 nCipher for allowing me to redistribute modifications I have made to the
   7 system while working as an employee of nCipher (obviously I gave my
   8 permission for nCipher to use and modify my work in this way).
   9
  10 SYSTEM REQUIREMENTS
  11  - GNU m4
  12  - GNU date
  13  - GNU gzip
  14  - Perl 5 (5.004 is known to work)
  15  - Lynx 2.7 or later
  16  - atob/btoa
  17  - The bug system requires its own mail domain.  It comes with code
  18    which understands how exim and qmail deliver mail for such a domain to a
  19    script.
  20  - If the local MTA is qmail you _must_ install a different MTA
  21    somewhere (eg in a subdirectory) and tell the bug system to use that;
  22    qmail has broken command-line parsing in its /usr/lib/sendmail
  23    emulation.
  24  - A webserver (this is easiest if the bug system can write
  25    directly to the webspace).
  26  - Somewhere to run CGI scripts (unless you don't need the `go to
  27    bug' and `go to package' forms to work).
  28
  29 INSTALLATION INSTRUCTIONS
  30
  31 1. Create a directory `config/local', alongside `config/common' and
  32 `config/debian'.
  33
  34 2. Copy the template files from `config/template' to `config/local'
  35 and edit them.  There is currently no documentation about the meanings
  36 of the config variables, I'm afraid.  The m4 quotes have been set to
  37 [[ and ]], so almost all definitions should use these.  Pieces of text
  38 which do not contain DBC_... macros should be enclosed in further sets
  39 of [[ ]] (making [[[[ ]]]] in all), as commas and other metacharacters
  40 might otherwise be interpreted by m4 in undesirable ways.  Note that
  41 you can also add settings for the variables mentioned in defaults.m4.
  42
  43 3. Set up the mail arrangements to deliver mail to the right place, and to
  44 set up a blackhole mail alias if you need one.  Ensure that owner@bugs, if
  45 that's what you're using, is handled by the MTA.
  46
  47 4. Run `./build'; if all was well run `./install'.  If `./build'
  48 complains or there are brokennesses in the results then the files
  49 `config/trace' (for failures during the check by `build') and
  50 `*.trace' for each `*.in' and `*.out' may be useful.
  51
  52 5. Test things a bit, by sending mail messages to the bug system and
  53 running .../scripts/processall and/or .../scripts/update-html.
  54
  55 6. If all seems well then install the crontab in `misc/crontab.out'.
  56
  57 COPYRIGHT AND LACK-OF-WARRANTY NOTICE
  58
  59 Copyright 1994,1995,1996,1997 Ian Jackson <ijackson@chiark.greenend.org.uk>
  60 Copyright 1997 nCipher Corporation Limited
  61 Copyright 1995 Steven Brenner (for cgi-lib.pl).
  62
  63 This bug system is free software; you can redistribute it and/or modify it
  64 under the terms of the GNU General Public License as published by the Free
  65 Software Foundation; either version 2 of the License, or (at your option)
  66 any later version.
  67
  68 This program and documentation is distributed in the hope that it will be
  69 useful, but without any warranty; without even the implied warranty of
  70 merchantability or fitness for a particular purpose. See the GNU General
  71 Public License for more details.
  72
  73 You should have received a copy of the GNU General Public License along
  74 with this program, or one should be available above; if not, write to the
  75 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  76 02111-1307, USA, or email debbugs-maint@chiark.greenend.org.uk.
  77
  78  - Ian Jackson 30.10.1997