debian/debbugsconfig.8

   1 .TH DEBBUGSCONFIG 8
   2 .SH NAME
   3 debbugsconfig \- copy basic debbugs configuration files from templates
   4 .SH SYNOPSIS
   5 .B debbugsconfig
   6 .SH DESCRIPTION
   7 .B debbugsconfig
   8 will copy basic debbugs configuration files from templates if the files
   9 do not already exist, and will also create BTS user documentation in
  10 HTML and text.
  11 It should be run on installation and whenever
  12 .I /etc/debbugs/config
  13 or
  14 .I /etc/debbugs/text
  15 are changed.
  16 .SH FILES
  17 .B debbugsconfig
  18 creates the following template configuration files in
  19 .I $gConfigDir
  20 .RI ( /etc/debbugs
  21 by default):
  22 .RS
  23 .TP
  24 .I config
  25 General debbugs configuration file.
  26 .TP
  27 .I text
  28 Longer messages output by debbugs.
  29 .TP
  30 .I Maintainers
  31 Index of maintainers for each package.
  32 This will typically be automatically generated.
  33 .TP
  34 .I Maintainers.override
  35 Manual overrides for the maintainer index.
  36 .TP
  37 .I pseudo-packages.description
  38 Descriptions of any entries in the system's maintainer index that do not
  39 correspond to \(lqreal\(rq packages.
  40 For example, the Debian Project uses pseudo-packages for bugs against
  41 facilities such as the Debian web site, the mailing list archives, and
  42 the bug tracking system itself.
  43 .TP
  44 .I sources
  45 Index of source packages corresponding to each package.
  46 This may be used when several packages are produced from a single
  47 source, in which case the bug tracking system will group them together
  48 with links in the web front-end.
  49 .RE
  50 .PP
  51 .B debbugsconfig
  52 creates the following template state files in
  53 .I $gSpoolDir
  54 .RI ( /var/lib/debbugs/spool
  55 by default):
  56 .RS
  57 .TP
  58 .I nextnumber
  59 The file which records the tracking number that will be assigned to the
  60 next incoming bug report.
  61 .TP
  62 .I index.archive.realtime
  63 Real-time index of archived bugs.
  64 Created empty.
  65 .TP
  66 .I index.db.realtime
  67 Real-time index of non-archived bugs.
  68 Created empty.
  69 .RE
  70 .PP
  71 .B debbugsconfig
  72 creates the following documents in
  73 .I $gWebDir
  74 .RI ( /var/lib/debbugs/www
  75 by default):
  76 .RS
  77 .TP
  78 .I index.html
  79 Main contents page.
  80 .TP
  81 .IR Access.html ", " bug-log-access.txt
  82 Description of how to access bug reports.
  83 .TP
  84 .IR Reporting.html ", " bug-reporting.txt
  85 Advice on reporting bugs.
  86 .TP
  87 .IR server-control.html ", " bug-maint-mailcontrol.txt
  88 Introduction to the bug control and manipulation mail server.
  89 .TP
  90 .IR server-refcard.html ", " bug-mailserver-refcard.txt
  91 Mail servers' reference card.
  92 .TP
  93 .IR server-request.html ", " bug-log-mailserver.txt
  94 Introduction to the bug system request server.
  95 .RE
  96 .SH AUTHORS
  97 .B debbugsconfig
  98 was originally written by Darren Benham and later rewritten by Josip Rodin.
  99 Colin Watson wrote this man page.