user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
Search results ordered by [date|relevance]  view[summary|nested|Atom feed]
thread overview below | download mbox.gz: |
* [PATCH 14/14] doc: add public-inbox-learn(1) manpage
  2019-10-28 10:45  7% [PATCH 00/14] learn: sync w/ -mda changes and add manpage Eric Wong
@ 2019-10-28 10:45  6% ` Eric Wong
  0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2019-10-28 10:45 UTC (permalink / raw)
  To: meta

Tools intended for end users need manpages.
---
 Documentation/include.mk             |  1 +
 Documentation/public-inbox-learn.pod | 86 ++++++++++++++++++++++++++++
 MANIFEST                             |  1 +
 3 files changed, 88 insertions(+)
 create mode 100644 Documentation/public-inbox-learn.pod

diff --git a/Documentation/include.mk b/Documentation/include.mk
index d2357ffc..bb622c1a 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -41,6 +41,7 @@ m1 += public-inbox-edit
 m1 += public-inbox-httpd
 m1 += public-inbox-index
 m1 += public-inbox-init
+m1 += public-inbox-learn
 m1 += public-inbox-mda
 m1 += public-inbox-nntpd
 m1 += public-inbox-watch
diff --git a/Documentation/public-inbox-learn.pod b/Documentation/public-inbox-learn.pod
new file mode 100644
index 00000000..b8190b59
--- /dev/null
+++ b/Documentation/public-inbox-learn.pod
@@ -0,0 +1,86 @@
+=head1 NAME
+
+public-inbox-learn - spam trainer and remover for public-inbox
+
+=head1 SYNOPSIS
+
+B<public-inbox-learn> <spam|ham|rm> E<lt>MESSAGE
+
+=head1 DESCRIPTION
+
+public-inbox-learn can remove spam or inject ham messages into
+an inbox while training a SpamAssassin instance.
+
+It is intended for users of L<public-inbox-mda(1)> or
+L<public-inbox-watch(1)>, but not users relying on
+L<git-fetch(1)> to mirror inboxes.
+
+It reads one message from standard input and operates on it
+depending on the command given:
+
+=head1 COMMANDS
+
+public-inbox-learn takes one of the following commands as its
+first and only argument:
+
+=over 8
+
+=item spam
+
+Treat the message as spam.  This will mark the message as
+removed so it becomes inaccessible via NNTP or WWW endpoints
+for all configured inboxes.
+
+The message remains accessible in git history.
+
+It will also be fed to L<spamc(1)> for training purposes unless
+C<publicinboxmda.spamcheck> is C<none> in L<public-inbox-config(5)>.
+
+=item ham
+
+Treat standard input as ham.  This is useful for manually injecting
+messages into the archives which failed the spam check run by
+L<public-inbox-mda(1)> or L<public-inbox-watch(1)>.
+
+It relies on the C<To:>, C<Cc:>, and C<List-ID:> headers
+to match configured inbox addresses and C<listid> directives.
+
+It will also be fed to L<spamc(1)> for training purposes unless
+C<publicinboxmda.spamcheck> is C<none> in L<public-inbox-config(5)>.
+
+=item rm
+
+This is identical to the C<spam> command above, but does
+not feed the message to L<spamc(1)>
+
+=back
+
+=head1 ENVIRONMENT
+
+=over 8
+
+=item PI_CONFIG
+
+Per-user config file parseable by L<git-config(1)>.
+See L<public-inbox-config(5)>.
+
+Default: ~/.public-inbox/config
+
+=back
+
+=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<spamc(1)>, L<public-inbox-mda(1)>, L<public-inbox-watch(1)>
diff --git a/MANIFEST b/MANIFEST
index 7d2ac17c..d1b6749a 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -22,6 +22,7 @@ Documentation/public-inbox-edit.pod
 Documentation/public-inbox-httpd.pod
 Documentation/public-inbox-index.pod
 Documentation/public-inbox-init.pod
+Documentation/public-inbox-learn.pod
 Documentation/public-inbox-mda.pod
 Documentation/public-inbox-nntpd.pod
 Documentation/public-inbox-overview.pod

^ permalink raw reply	[relevance 6%]

* [PATCH 00/14] learn: sync w/ -mda changes and add manpage
@ 2019-10-28 10:45  7% Eric Wong
  2019-10-28 10:45  6% ` [PATCH 14/14] doc: add public-inbox-learn(1) manpage Eric Wong
  0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2019-10-28 10:45 UTC (permalink / raw)
  To: meta

What started with adding a manpage for public-inbox-learn,
ended up being a bunch of fixes and improvements to catch
up to -mda changes.

-mda also learned to deal with multiple List-ID headers in the
meantime.

Eric Wong (14):
  learn: support multiple To/Cc headers
  learn: only map recipient list on "ham" or "rm"
  learn: update usage statement
  learn: GIT_COMMITTER_<NAME|EMAIL> may be "" or "0"
  learn: hoist out remove_or_add subroutine
  mda: hoist out List-ID handling and reuse in -learn
  filter/base: remove MAX_MID_SIZE constant
  mda: hoist out mda_filter_adjust
  mda: skip MIME parsing if spam
  inboxwritable: add assert_usable_dir sub
  mda: prepare for multiple destinations
  mda: support multiple List-ID matches
  learn: allow running without spamc
  doc: add public-inbox-learn(1) manpage

 Documentation/include.mk             |   1 +
 Documentation/public-inbox-learn.pod |  86 +++++++++++++++++++++
 MANIFEST                             |   1 +
 lib/PublicInbox/Filter/Base.pm       |   1 -
 lib/PublicInbox/InboxWritable.pm     |   9 ++-
 lib/PublicInbox/MDA.pm               |  22 ++++++
 lib/PublicInbox/V2Writable.pm        |   5 +-
 script/public-inbox-learn            |  84 +++++++++++---------
 script/public-inbox-mda              | 110 ++++++++++++++++-----------
 t/import.t                           |   8 ++
 t/mda.t                              |  19 +++++
 t/v2writable.t                       |  12 +++
 12 files changed, 275 insertions(+), 83 deletions(-)
 create mode 100644 Documentation/public-inbox-learn.pod
 mode change 100755 => 100644 script/public-inbox-learn


^ permalink raw reply	[relevance 7%]

Results 1-2 of 2 | reverse | sort options + mbox downloads above
-- links below jump to the message on this page --
2019-10-28 10:45  7% [PATCH 00/14] learn: sync w/ -mda changes and add manpage Eric Wong
2019-10-28 10:45  6% ` [PATCH 14/14] doc: add public-inbox-learn(1) manpage Eric Wong

Code repositories for project(s) associated with this 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).