]> Sergey Matveev's repositories - public-inbox.git/blobdiff - Documentation/public-inbox-edit.pod
treewide: update to v3 Tor onions
[public-inbox.git] / Documentation / public-inbox-edit.pod
index 97c7c92aeb37fd796ccfb926f05f4e09cb9163e4..17f66c7c2bc911632ffa223ec8a9d098ee01eff7 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-public-inbox-edit - edit messages in a public inbox
+public-inbox-edit - destructively edit messages in a public inbox
 
 =head1 SYNOPSIS
 
@@ -73,10 +73,10 @@ Default: none
 
 =over 8
 
-=for comment MAIL_EDITOR is undocumented (unstable, don't want naming conflicts)
-
 =item GIT_EDITOR / VISUAL / EDITOR
 
+=for comment MAIL_EDITOR is undocumented (unstable, don't want naming conflicts)
+
 public-inbox-edit will fall back to using one of these variables
 (in that order) if C<publicinbox.mailEditor> is unset.
 
@@ -91,19 +91,33 @@ See L<public-inbox-config(5)>
 
 Only L<v2|public-inbox-v2-format(5)> repositories are supported.
 
+This is safe to run while normal inbox writing tools
+(L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
+L<public-inbox-learn(1)>) are active.
+
+Running this in parallel with L<public-inbox-xcpdb(1)> or
+C<"public-inbox-index --reindex"> can lead to errors or
+edited data remaining indexed.
+
+Incremental L<public-inbox-index(1)> (without C<--reindex>)
+is fine.
+
+Keep in mind this is a last resort, as it will be disruptive
+to anyone using L<git(1)> to mirror the inbox being edited.
+
 =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/>
+The mail archives are hosted at L<https://public-inbox.org/meta/> and
+L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2019 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2019-2021 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>
+L<public-inbox-purge(1)>