From 89743adff01c79436520463ae02b86ea146bc5c7 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 27 Apr 2020 20:40:22 +0000 Subject: [PATCH] doc: add clients.txt Since some client tools exist for dealing with public-inbox specifically, it seems like a good idea to list some of them. Cc: Danh Doan Acked-by: Daniel Borkmann Cc: Konstantin Ryabitsev Cc: Leah Neukirchen --- Documentation/clients.txt | 38 ++++++++++++++++++++++++++++++++++++++ MANIFEST | 1 + 2 files changed, 39 insertions(+) create mode 100644 Documentation/clients.txt diff --git a/Documentation/clients.txt b/Documentation/clients.txt new file mode 100644 index 00000000..65cb9063 --- /dev/null +++ b/Documentation/clients.txt @@ -0,0 +1,38 @@ +clients and tools related to public-inbox +----------------------------------------- + +While public-inbox exposes NNTP and gzipped mboxrd over HTTP, +some public-inbox-specific/aware tools have sprung up. + +Below is a non-exhaustive list of them. Feel free to send +additions, corrections and discussions to meta@public-inbox.org +Discussions will be visible from our own public-inbox instance: +https://public-inbox.org/meta/ + +Disclaimer: public-inbox itself comes with no warranty or +guarantees; so don't treat any of these links as endorsements, +either. + +* l2md - Maildir and procmail importer using C + libgit2 + https://git.kernel.org/pub/scm/linux/kernel/git/dborkman/l2md.git + +* b4 - helper utility for patch-based workflows + https://git.kernel.org/pub/scm/utils/b4/b4.git + +* impibe - Perl script to import v1 or v2 to Maildir + https://leahneukirchen.org/dotfiles/bin/impibe + discussion: https://public-inbox.org/meta/87v9m0l8t1.fsf@vuxu.org/ + +* kernel.org helpers - various scripts used by *.kernel.org + https://git.kernel.org/pub/scm/linux/kernel/git/mricon/korg-helpers.git + +* grokmirror - git mirroring tool (not public-inbox-specific) + https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git + +* ssoma - v1 only, abandoned in favor of NNTP + https://80x24.org/ssoma.git + +There's also a bunch of random scripts in the scripts/ directory +of our source tree at: + + git clone https://public-inbox.org/public-inbox.git diff --git a/MANIFEST b/MANIFEST index e3e0f2a8..90a05d33 100644 --- a/MANIFEST +++ b/MANIFEST @@ -9,6 +9,7 @@ Documentation/RelNotes/v1.2.0.eml Documentation/RelNotes/v1.3.0.eml Documentation/RelNotes/v1.4.0.eml Documentation/RelNotes/v1.5.0.eml +Documentation/clients.txt Documentation/dc-dlvr-spam-flow.txt Documentation/design_notes.txt Documentation/design_www.txt -- 2.44.0