X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README;fp=README;h=526f8d3637b337eb3bc9b8b52fa46384cb2d2853;hb=d550720e843caf97647c2a562ab6e5f64cd9dc37;hp=cbbb2462c5d5171fa94043014a71916a99751e81;hpb=ad94296c148bb2ddb66f1d2ce312bdffb4ff4a91;p=debbugs.git diff --git a/README b/README index cbbb246..526f8d3 100644 --- a/README +++ b/README @@ -2,68 +2,125 @@ -------------------------- This bug tracking system was developed by Ian Jackson from 1994-1997, -with assistance from nCipher Corporation Limited in 1997. I am grateful to -nCipher for allowing me to redistribute modifications I have made to the -system while working as an employee of nCipher (obviously I gave my -permission for nCipher to use and modify my work in this way). +with assistance from nCipher Corporation Limited in 1997. nCipher allowed +Ian to redistribute modifications he made to the system while working as an +employee of nCipher. +============================================================================= SYSTEM REQUIREMENTS +============================================================================= - GNU m4 - GNU date - GNU gzip - Perl 5 (5.004 is known to work) + - Mailtools perl module to manipulate email - Lynx 2.7 or later - - atob/btoa - The bug system requires its own mail domain. It comes with code - which understands how exim and qmail deliver mail for such a domain to a - script. - - If the local MTA is qmail you _must_ install a different MTA - somewhere (eg in a subdirectory) and tell the bug system to use that; - qmail has broken command-line parsing in its /usr/lib/sendmail - emulation. + which understands how exim, qmail and sendmail deliver mail for such a + domain to a script. - A webserver (this is easiest if the bug system can write directly to the webspace). - Somewhere to run CGI scripts (unless you don't need the `go to bug' and `go to package' forms to work). +============================================================================= INSTALLATION INSTRUCTIONS +============================================================================= +1. Install the deb. If you don't have a deb, consult the file list at the +end of this document. -1. Create a directory `config/local', alongside `config/common' and -`config/debian'. +2. Copy the template files from /usr/share/doc/debbugs/examples to +/etc/debbugs. Edit the config file, it is necessary. Edit the text file if +you wish to change some of the text as it gets displayed. -2. Copy the template files from `config/template' to `config/local' -and edit them. There is currently no documentation about the meanings -of the config variables, I'm afraid. The m4 quotes have been set to -[[ and ]], so almost all definitions should use these. Pieces of text -which do not contain DBC_... macros should be enclosed in further sets -of [[ ]] (making [[[[ ]]]] in all), as commas and other metacharacters -might otherwise be interpreted by m4 in undesirable ways. Note that -you can also add settings for the variables mentioned in defaults.m4. +3. Run "debbugsconfig" -3. Set up the mail arrangements to deliver mail to the right place, and to +4. Edit the /etc/debbugs/Maintainers file in the format of +"packagemaintianer". + +5. Set up the mail arrangements to deliver mail to the right place, and to set up a blackhole mail alias if you need one. Ensure that owner@bugs, if that's what you're using, is handled by the MTA. -4. Run `./build'; if all was well run `./install'. If `./build' -complains or there are brokennesses in the results then the files -`config/trace' (for failures during the check by `build') and -`*.trace' for each `*.in' and `*.out' may be useful. - -5. Test things a bit, by sending mail messages to the bug system and +6. Test things a bit, by sending mail messages to the bug system and running .../scripts/processall and/or .../scripts/update-html. -6. If all seems well then install the crontab in `misc/crontab.out'. +7. If all seems well then install the crontab in `misc/crontab.out'. -COPYRIGHT AND LACK-OF-WARRANTY NOTICE +============================================================================= +FURTHER INFORMATION +============================================================================= +Web: http://benham.net/debbugs/ +Email: debbugs@benham.net (mailing list) + debbugs-REQUEST@benham.net with the word subscribe in the body +============================================================================= +Filelist of installed files +============================================================================= +********************config files** +-rw-r--r-- root/root 1293 1999-10-14 13:14:08 ./etc/debbugs/html/Access.html +-rw-r--r-- root/root 6983 1999-10-14 13:14:08 ./etc/debbugs/html/Reporting.html +-rw-r--r-- root/root 7460 1999-10-14 13:14:08 ./etc/debbugs/html/Developer.html +-rw-r--r-- root/root 3394 1999-10-14 13:14:08 ./etc/debbugs/html/index.html +-rw-r--r-- root/root 7608 1999-10-14 13:14:08 ./etc/debbugs/html/server-control.html +-rw-r--r-- root/root 6434 1999-10-14 13:14:08 ./etc/debbugs/html/server-request.html +-rw-r--r-- root/root 3579 1999-10-14 13:14:08 ./etc/debbugs/html/server-refcard.html +-rw-r--r-- root/root 2 1999-10-14 13:14:08 ./etc/debbugs/lynx-cfg +-rw-r--r-- root/root 79 1999-10-14 13:14:08 ./etc/debbugs/Maintainers +-rw-r--r-- root/root 59 1999-10-14 13:14:08 ./etc/debbugs/pseudo-packages.description +********************scripts** +-rwxr-xr-x root/root 177 1999-10-14 13:14:07 ./usr/lib/debbugs/age-1 +-rwxr-xr-x root/root 24471 1999-10-14 13:14:07 ./usr/lib/debbugs/db2html +-rwxr-xr-x root/root 2159 1999-10-14 13:14:07 ./usr/lib/debbugs/expire +-rwxr-xr-x root/root 3925 1999-10-14 13:14:07 ./usr/lib/debbugs/html-install +-rwxr-xr-x root/root 2747 1999-10-14 13:14:07 ./usr/lib/debbugs/mailsummary +-rwxr-xr-x root/root 1621 1999-10-14 13:14:07 ./usr/lib/debbugs/processall +-rwxr-xr-x root/root 25566 1999-10-14 13:14:08 ./usr/lib/debbugs/service +-rw-r--r-- root/root 2952 1999-10-14 13:14:08 ./usr/lib/debbugs/errorlib +-rwxr-xr-x root/root 3024 1999-10-14 13:14:08 ./usr/lib/debbugs/html-control +-rwxr-xr-x root/root 29290 1999-10-14 13:14:08 ./usr/lib/debbugs/process +-rwxr-xr-x root/root 3664 1999-10-14 13:14:08 ./usr/lib/debbugs/receive +-rwxr-xr-x root/root 3056 1999-10-14 13:14:08 ./usr/lib/debbugs/summary +********************admin scripts* +-rwxr-xr-x root/root 1958 1999-10-14 13:14:08 ./usr/sbin/debbugsconfig +-rwxr-xr-x root/root 859 1999-10-14 13:14:08 ./usr/sbin/debbugs-maketxt +********************documentation** +-rw-r--r-- root/root 2390 1999-10-14 13:14:08 ./usr/share/doc/debbugs/examples/config +-rw-r--r-- root/root 11146 1999-10-14 13:14:08 ./usr/share/doc/debbugs/examples/text +-rw-r--r-- root/root 432 1999-10-14 13:14:08 ./usr/share/doc/debbugs/examples/crontab +-rw-r--r-- root/root 3 1999-10-14 13:14:08 ./usr/share/doc/debbugs/examples/nextnumber +-rw-r--r-- root/root 321 1999-04-02 10:12:03 ./usr/share/doc/debbugs/TODO +-rw-r--r-- root/root 1430 1999-04-02 10:08:36 ./usr/share/doc/debbugs/README.Debian +-rw-r--r-- root/root 321 1999-04-02 10:12:03 ./usr/share/doc/debbugs/TODO.Debian +-rw-r--r-- root/root 1419 1999-03-27 11:26:38 ./usr/share/doc/debbugs/copyright +-rw-r--r-- root/root 1977 1999-04-16 17:21:00 ./usr/share/doc/debbugs/README.mail.gz +-rw-r--r-- root/root 812 1999-07-27 11:27:22 ./usr/share/doc/debbugs/changelog.Debian.gz +********************web/data files +drwxr-xr-x root/root 0 1999-10-14 13:14:08 ./var/lib/debbugs/www/cgi/ +-rwxr-xr-x root/root 1807 1999-10-14 13:14:08 ./var/lib/debbugs/www/cgi/bugs-fetch2.pl +-rwxr-xr-x root/root 4755 1999-10-14 13:14:08 ./var/lib/debbugs/www/cgi/cgi-lib.pl +drwxr-xr-x root/root 0 1999-10-14 13:14:08 ./var/lib/debbugs/www/db/ +-rw-r--r-- root/root 37 1999-10-14 13:14:08 ./var/lib/debbugs/www/db/.htaccess +drwxr-xr-x root/root 0 1999-10-14 13:14:07 ./var/lib/debbugs/www/txt/ +-rw-r--r-- root/root 17 1999-10-14 13:14:08 ./var/lib/debbugs/spool/updateseqs +********************needed, precreated directories +drwxr-xr-x root/root 0 1999-10-14 13:14:07 ./var/lib/debbugs/indices/ +drwxr-xr-x root/root 0 1999-10-14 13:14:07 ./var/lib/debbugs/spool/lock/ +drwxr-xr-x root/root 0 1999-10-14 13:14:07 ./var/lib/debbugs/spool/archive/ +drwxr-xr-x root/root 0 1999-10-14 13:14:07 ./var/lib/debbugs/spool/incoming/ +drwxr-xr-x root/root 0 1999-10-14 13:14:07 ./var/lib/debbugs/spool/db/ + +============================================================================= +COPYRIGHT AND LACK-OF-WARRANTY NOTICE +============================================================================= +Copyright 1999 Darren O. Benham Copyright 1994,1995,1996,1997 Ian Jackson Copyright 1997 nCipher Corporation Limited Copyright 1995 Steven Brenner (for cgi-lib.pl). This bug system is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free -Software Foundation; either version 2 of the License, or (at your option) -any later version. +Software Foundation; version 2 of the License. This program and documentation is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of @@ -73,6 +130,6 @@ Public License for more details. You should have received a copy of the GNU General Public License along with this program, or one should be available above; if not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA -02111-1307, USA, or email debbugs-maint@chiark.greenend.org.uk. +02111-1307, USA. - - Ian Jackson 30.10.1997 + - gecko 14 Oct, 1999