From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 852581F9E0; Mon, 27 Apr 2020 22:21:58 +0000 (UTC) Date: Mon, 27 Apr 2020 22:21:58 +0000 From: Eric Wong To: meta@public-inbox.org Cc: Danh Doan , Daniel Borkmann , Konstantin Ryabitsev , Leah Neukirchen Subject: [PATCH v2] doc: add clients.txt Message-ID: <20200427222158.GA2129@dcvr> References: <20200427205708.2540-1-e@yhbt.net> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <20200427205708.2540-1-e@yhbt.net> List-Id: 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 --- Changes in v2: - add b4, de-emphasize korg-helpers, - direct link to downloadable impibe, - note procmail support l2md, acked by Daniel Interdiff: diff --git a/Documentation/clients.txt b/Documentation/clients.txt index d2ac7561..65cb9063 100644 --- a/Documentation/clients.txt +++ b/Documentation/clients.txt @@ -13,13 +13,17 @@ Disclaimer: public-inbox itself comes with no warranty or guarantees; so don't treat any of these links as endorsements, either. -* l2md - Maildir importer using C + libgit2 +* 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://public-inbox.org/meta/87v9m0l8t1.fsf@vuxu.org/ + https://leahneukirchen.org/dotfiles/bin/impibe + discussion: https://public-inbox.org/meta/87v9m0l8t1.fsf@vuxu.org/ -* kernel.org helpers, including get-lore-mbox and sendmail-pi-feed +* 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) 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