Documentation/public-inbox-purge.pod

   1 =head1 NAME
   2
   3 public-inbox-purge - erase messages from a public inbox and its history
   4
   5 =head1 SYNOPSIS
   6
   7         # requires ~/.public-inbox/config
   8         public-inbox-purge --all </path/to/message-to-purge
   9
  10         # for testing with unconfigured inboxes:
  11         public-inbox-purge $INBOX_DIR </path/to/message-to-purge
  12
  13 =head1 DESCRIPTION
  14
  15 public-inbox-purge allows removing entire messages in a given
  16 inbox from history.  It is only intended as a last resort, as it
  17 will cause discontiguous git history and draw more attention to
  18 the sensitive data in mirrors.
  19
  20 For removing spam, L<public-inbox-learn(1)> is preferable as it
  21 preserves contiguous git history.
  22
  23 For editing sensitive information out of messages, consider
  24 L<public-inbox-edit(1)>, instead, but keep in mind it still
  25 leads to discontiguous git history.
  26
  27 =head1 OPTIONS
  28
  29 =over
  30
  31 =item --all
  32
  33 Purge the message in all inboxes configured in ~/.public-inbox/config.
  34 This is an alternative to specifying individual inboxes directories
  35 on the command-line.
  36
  37 =back
  38
  39 =head1 ENVIRONMENT
  40
  41 =over 8
  42
  43 =item PI_CONFIG
  44
  45 The default config file, normally "~/.public-inbox/config".
  46 See L<public-inbox-config(5)>
  47
  48 =back
  49
  50 =head1 LIMITATIONS
  51
  52 Only L<public-inbox-v2-format(5)> inboxes are supported.
  53
  54 This is safe to run while normal inbox writing tools
  55 (L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
  56 L<public-inbox-learn(1)>) are active.
  57
  58 Running this in parallel with L<public-inbox-xcpdb(1)> or
  59 C<"public-inbox-index --reindex"> can lead to errors or
  60 purged data remaining indexed.
  61
  62 Incremental L<public-inbox-index(1)> (without C<--reindex>)
  63 is fine.
  64
  65 Keep in mind this is a last resort, as it will be distruptive
  66 to anyone using L<git(1)> to mirror the inbox being purged.
  67
  68 =head1 CONTACT
  69
  70 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  71
  72 The mail archives are hosted at L<https://public-inbox.org/meta/>
  73 and L<http://hjrcffqmbrq6wope.onion/meta/>
  74
  75 =head1 COPYRIGHT
  76
  77 Copyright 2019-2020 all contributors L<mailto:meta@public-inbox.org>
  78
  79 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  80
  81 =head1 SEE ALSO
  82
  83 L<public-inbox-edit(1)>, L<public-inbox-learn(1)>