docs/README.first

   1                                 Notes
   2                                 =====
   3
   4 o Please be careful: dak sends out lots of emails and if not
   5   configured properly will happily send them to lots of people who
   6   probably didn't want those emails.
   7
   8 o Don't use the debian dak.conf, cron.* etc. as starting
   9   points for your own configuration files, they're highly Debian
  10   specific.  Start from scratch and refer to the security.debian.org
  11   config files (-security) as they're a better example for a private
  12   archive.
  13
  14                     What do all these scripts do?
  15                     =============================
  16
  17 Generic and generally useful
  18 ----------------------------
  19
  20 o To process queue/:
  21
  22   * dak process-upload - processes queue/unchecked
  23   * dak process-new - allows ftp administrator to process queue/new and queue/byhand
  24   * dak process-policy - processes policy queues (including new and byhand)
  25
  26 o To generate indices files:
  27
  28   * dak dominate          - removes obsolete packages from suites
  29   * dak generate-packages-sources2 - generate Packages, Sources
  30   * dak generate-releases - generates Release
  31
  32 o To clean things up:
  33
  34   * dak clean-suites - to remove obsolete files from the pool
  35   * dak clean-queues - to remove obsolete/stray files from the queue
  36   * dak rm - to remove package(s) from suite(s)
  37   * dak override - to change individual override entries
  38
  39 o Information display:
  40
  41   * dak ls - shows information about package(s)
  42   * dak queue-report - shows information about package(s) in queue/
  43   * dak override - can show you individual override entries
  44   * dak graph - creates some pretty graphs of queue sizes over time
  45
  46 Generic and useful, but only for those with existing archives
  47 -------------------------------------------------------------
  48
  49 o dak init-archive - initializes a projectb database from an exisiting archive
  50
  51 Generic but not overly useful (in normal use)
  52 ---------------------------------------------
  53
  54 o dak import-users-from-passwd - sync PostgreSQL users with system users
  55 o dak cruft-report - check for obsolete or duplicated packages
  56 o dak init-dirs - directory creation in the initial setup of an archive
  57 o dak check-archive - various sanity checks of the database and archive
  58 o dak control-overrides - manpiulates/list override entries
  59 o dak control-suite - removes/adds/lists package(s) from/to/for a suite
  60 o dak stats - produces various statistics
  61 o dak find-null-maintainers - checks for users with no packages in the archive
  62
  63 Semi-generic
  64 ------------
  65
  66 To generate less-used indices files:
  67
  68 o dak make-maintainers - generates Maintainers file used by, e.g. debbugs
  69 o dak make-overrides  - generates override.<foo> files
  70
  71 Mostly Debian(.org) specific
  72 ----------------------------
  73
  74 o dak security-install - wrapper for Debian security team
  75 o dak import-ldap-fingerprints - syncs fingerprint and uid information with a debian.org LDAP DB
  76
  77 Very Incomplete or otherwise not generally useful
  78 -------------------------------------------------
  79
  80 o dak init-db - currently only initializes a DB from a dak.conf config file
  81 o dak check-overrides - override cruft checker that doesn't work well with New Incoming
  82
  83 Scripts invoked by other scripts
  84 --------------------------------
  85
  86 o dak examine-package - invoked by 'dak process-new' to "check" NEW packages
  87
  88                         How do I get started?
  89                         =====================
  90
  91 Please refer to setup/README for instructions how to setup dak.