diff options
author | Eric Wong (Contractor, The Linux Foundation) <e@80x24.org> | 2019-06-09 02:51:47 +0000 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2019-06-09 04:33:16 +0000 |
commit | 45890d532f0ea68f5879b036b22d9dbd4e19754c (patch) | |
tree | 0f31a44c0c56a598a5109af9f18e0d82ce5486a6 /Documentation | |
parent | d209b8190d4f3fdf60e577ee8372288d0a76ac70 (diff) | |
download | public-inbox-45890d532f0ea68f5879b036b22d9dbd4e19754c.tar.gz |
This wrapper around V2Writable->replace provides a user-interface for editing messages as single-message mboxes (or the raw text via $EDITOR).
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/include.mk | 1 | ||||
-rw-r--r-- | Documentation/public-inbox-config.pod | 4 | ||||
-rw-r--r-- | Documentation/public-inbox-edit.pod | 109 |
3 files changed, 114 insertions, 0 deletions
diff --git a/Documentation/include.mk b/Documentation/include.mk index b064f295..f5f46d0b 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -32,6 +32,7 @@ podtext = $(PODTEXT) $(PODTEXT_OPTS) # MakeMaker only seems to support manpage sections 1 and 3... m1 = m1 += public-inbox-compact +m1 += public-inbox-edit m1 += public-inbox-httpd m1 += public-inbox-index m1 += public-inbox-mda diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index db81bf1c..a86132be 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -234,6 +234,10 @@ C<publicinbox.cgitbin>, but may be overridden. Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/ or /usr/share/cgit/ +=item publicinbox.mailEditor + +See L<public-inbox-edit(1)> + =item publicinbox.wwwlisting Enable a HTML listing style when the root path of the URL '/' is accessed. diff --git a/Documentation/public-inbox-edit.pod b/Documentation/public-inbox-edit.pod new file mode 100644 index 00000000..97c7c92a --- /dev/null +++ b/Documentation/public-inbox-edit.pod @@ -0,0 +1,109 @@ +=head1 NAME + +public-inbox-edit - edit messages in a public inbox + +=head1 SYNOPSIS + + public-inbox-edit -m MESSAGE-ID --all|INBOX_DIR + + public-inbox-edit -F RAW_FILE --all|INBOX_DIR [.. INBOX_DIR] + +=head1 DESCRIPTION + +public-inbox-edit allows editing messages in a given inbox +to remove sensitive information. 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. + +=head1 OPTIONS + +=over + +=item --all + +Edit the message in all inboxes configured in ~/.public-inbox/config. +This is an alternative to specifying individual inboxes directories +on the command-line. + +=item -m MESSAGE-ID + +Edits the message corresponding to the given C<MESSAGE-ID>. +If the C<MESSAGE-ID> is ambiguous, C<--force> or using the +C<--file> of the original will be required. + +=item -F FILE + +Edits the message corresponding to the Message-ID: header +and content given in C<FILE>. This requires the unmodified +raw message, and the contents of C<FILE> will not itself +be modified. This is useful if a Message-ID is ambiguous +due to filtering/munging rules or other edits. + +=item --force + +Forcibly perform the edit even if Message-ID is ambiguous. + +=item --raw + +Do not perform "From " line escaping. By default, this +generates a mboxrd variant file to detect unpurged messages +in the new mbox. This makes sense if your configured +C<publicinbox.mailEditor> is a regular editor and not +something like C<mutt -f> + +=back + +=head1 CONFIGURATION + +=over 8 + +=item publicinbox.mailEditor + +The command to perform the edit with. An example of this would be +C<mutt -f>, and the user would then use the facilities in L<mutt(1)> +to edit the mail. This is useful for editing attachments or +Base64-encoded emails which are more difficult to edit with a +normal editor (configured via C<GIT_EDITOR>, C<VISUAL> or C<EDITOR>). + +Default: none + +=back + +=head1 ENVIRONMENT + +=over 8 + +=for comment MAIL_EDITOR is undocumented (unstable, don't want naming conflicts) + +=item GIT_EDITOR / VISUAL / EDITOR + +public-inbox-edit will fall back to using one of these variables +(in that order) if C<publicinbox.mailEditor> is unset. + +=item PI_CONFIG + +The default config file, normally "~/.public-inbox/config". +See L<public-inbox-config(5)> + +=back + +=head1 LIMITATIONS + +Only L<v2|public-inbox-v2-format(5)> repositories 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-purge(1)|https://public-inbox.org/public-inbox-purge.html> |