* [PATCH] doc: add public-inbox-purge(1) manpage
@ 2019-11-02 21:34 7% Eric Wong
0 siblings, 0 replies; 1+ results
From: Eric Wong @ 2019-11-02 21:34 UTC (permalink / raw)
To: meta
Tools intended for end users need manpages, and doubly so
to convince potential users NOT to use them :)
---
Documentation/include.mk | 1 +
Documentation/public-inbox-purge.pod | 69 ++++++++++++++++++++++++++++
MANIFEST | 1 +
3 files changed, 71 insertions(+)
create mode 100644 Documentation/public-inbox-purge.pod
diff --git a/Documentation/include.mk b/Documentation/include.mk
index bb622c1..fd2c95f 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -44,6 +44,7 @@ m1 += public-inbox-init
m1 += public-inbox-learn
m1 += public-inbox-mda
m1 += public-inbox-nntpd
+m1 += public-inbox-purge
m1 += public-inbox-watch
m1 += public-inbox-xcpdb
m5 =
diff --git a/Documentation/public-inbox-purge.pod b/Documentation/public-inbox-purge.pod
new file mode 100644
index 0000000..098ffba
--- /dev/null
+++ b/Documentation/public-inbox-purge.pod
@@ -0,0 +1,69 @@
+=head1 NAME
+
+public-inbox-purge - erase messages from a public inbox and its history
+
+=head1 SYNOPSIS
+
+ # requires ~/.public-inbox/config
+ public-inbox-purge --all </path/to/message-to-purge
+
+ # for testing with unconfigured inboxes:
+ public-inbox-purge $INBOX_DIR </path/to/message-to-purge
+
+=head1 DESCRIPTION
+
+public-inbox-purge allows removing entire messages in a given
+inbox from history. It is only intended as a last resort, as it
+will cause discontiguous git history and draw more attention to
+the sensitive data in mirrors.
+
+For removing spam, L<public-inbox-learn(1)> is preferable as it
+preserves contiguous git history.
+
+For editing sensitive information out of messages, consider
+L<public-inbox-edit(1)>, instead, but keep in mind it still
+leads to discontiguous git history.
+
+=head1 OPTIONS
+
+=over
+
+=item --all
+
+Purge the message in all inboxes configured in ~/.public-inbox/config.
+This is an alternative to specifying individual inboxes directories
+on the command-line.
+
+=back
+
+=head1 ENVIRONMENT
+
+=over 8
+
+=item PI_CONFIG
+
+The default config file, normally "~/.public-inbox/config".
+See L<public-inbox-config(5)>
+
+=back
+
+=head1 LIMITATIONS
+
+Only L<public-inbox-v2-format(5)> inboxes are supported.
+
+=head1 CONTACT
+
+Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
+
+The mail archives are hosted at L<https://public-inbox.org/meta/>
+and L<http://hjrcffqmbrq6wope.onion/meta/>
+
+=head1 COPYRIGHT
+
+Copyright 2019 all contributors L<mailto:meta@public-inbox.org>
+
+License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
+
+=head1 SEE ALSO
+
+L<public-inbox-edit(1)>, L<public-inbox-learn(1)>
diff --git a/MANIFEST b/MANIFEST
index dfabd7f..9582642 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -26,6 +26,7 @@ Documentation/public-inbox-learn.pod
Documentation/public-inbox-mda.pod
Documentation/public-inbox-nntpd.pod
Documentation/public-inbox-overview.pod
+Documentation/public-inbox-purge.pod
Documentation/public-inbox-v1-format.pod
Documentation/public-inbox-v2-format.pod
Documentation/public-inbox-watch.pod
^ permalink raw reply related [relevance 7%]
Results 1-1 of 1 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2019-11-02 21:34 7% [PATCH] doc: add public-inbox-purge(1) manpage Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).