first.rst 3.4 KB

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