user/dev discussion of public-inbox itself
 help / color / mirror / Atom feed
* [PATCH] doc: add clients.txt
@ 2020-04-27 20:57 Eric Wong
  2020-04-27 21:10 ` Konstantin Ryabitsev
                   ` (3 more replies)
  0 siblings, 4 replies; 6+ messages in thread
From: Eric Wong @ 2020-04-27 20:57 UTC (permalink / raw)
  To: meta; +Cc: Danh Doan, Daniel Borkmann, Konstantin Ryabitsev, Leah Neukirchen

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 <congdanhqx@gmail.com>
Cc: Daniel Borkmann <daniel@iogearbox.net>
Cc: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Cc: Leah Neukirchen <leah@vuxu.org>
---
 Documentation/clients.txt | 34 ++++++++++++++++++++++++++++++++++
 MANIFEST                  |  1 +
 2 files changed, 35 insertions(+)
 create mode 100644 Documentation/clients.txt

diff --git a/Documentation/clients.txt b/Documentation/clients.txt
new file mode 100644
index 00000000..d2ac7561
--- /dev/null
+++ b/Documentation/clients.txt
@@ -0,0 +1,34 @@
+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 importer using C + libgit2
+  https://git.kernel.org/pub/scm/linux/kernel/git/dborkman/l2md.git
+
+* impibe - Perl script to import v1 or v2 to Maildir
+  https://public-inbox.org/meta/87v9m0l8t1.fsf@vuxu.org/
+
+* kernel.org helpers, including get-lore-mbox and sendmail-pi-feed
+  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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] doc: add clients.txt
  2020-04-27 20:57 [PATCH] doc: add clients.txt Eric Wong
@ 2020-04-27 21:10 ` Konstantin Ryabitsev
  2020-04-27 21:30   ` Eric Wong
  2020-04-27 21:10 ` Leah Neukirchen
                   ` (2 subsequent siblings)
  3 siblings, 1 reply; 6+ messages in thread
From: Konstantin Ryabitsev @ 2020-04-27 21:10 UTC (permalink / raw)
  To: Eric Wong; +Cc: meta, Danh Doan, Daniel Borkmann, Leah Neukirchen

On Mon, Apr 27, 2020 at 08:57:08PM +0000, Eric Wong wrote:
> +* kernel.org helpers, including get-lore-mbox and sendmail-pi-feed
> +  https://git.kernel.org/pub/scm/linux/kernel/git/mricon/korg-helpers.git

I'd rather it listed b4 instead, as it's a successor to get-lore-mbox:
https://git.kernel.org/pub/scm/utils/b4/b4.git

The "sendmail-pi-feed" wrapper is more of a proof of concept, so I'm not 
sure it should be mentioned at all.

Best,
-K

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] doc: add clients.txt
  2020-04-27 20:57 [PATCH] doc: add clients.txt Eric Wong
  2020-04-27 21:10 ` Konstantin Ryabitsev
@ 2020-04-27 21:10 ` Leah Neukirchen
  2020-04-27 21:14 ` Daniel Borkmann
  2020-04-27 22:21 ` [PATCH v2] " Eric Wong
  3 siblings, 0 replies; 6+ messages in thread
From: Leah Neukirchen @ 2020-04-27 21:10 UTC (permalink / raw)
  To: Eric Wong; +Cc: meta, Danh Doan, Daniel Borkmann, Konstantin Ryabitsev

Eric Wong <e@yhbt.net> writes:

> diff --git a/Documentation/clients.txt b/Documentation/clients.txt
> +* impibe - Perl script to import v1 or v2 to Maildir
> +  https://public-inbox.org/meta/87v9m0l8t1.fsf@vuxu.org/

Please link to https://leahneukirchen.org/dotfiles/bin/impibe, too.

Thanks,
-- 
Leah Neukirchen  <leah@vuxu.org>  https://leahneukirchen.org

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] doc: add clients.txt
  2020-04-27 20:57 [PATCH] doc: add clients.txt Eric Wong
  2020-04-27 21:10 ` Konstantin Ryabitsev
  2020-04-27 21:10 ` Leah Neukirchen
@ 2020-04-27 21:14 ` Daniel Borkmann
  2020-04-27 22:21 ` [PATCH v2] " Eric Wong
  3 siblings, 0 replies; 6+ messages in thread
From: Daniel Borkmann @ 2020-04-27 21:14 UTC (permalink / raw)
  To: Eric Wong, meta; +Cc: Danh Doan, Konstantin Ryabitsev, Leah Neukirchen

On 4/27/20 10:57 PM, Eric Wong wrote:
> 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 <congdanhqx@gmail.com>
> Cc: Daniel Borkmann <daniel@iogearbox.net>
> Cc: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
> Cc: Leah Neukirchen <leah@vuxu.org>

For l2md, one nit below:

Acked-by: Daniel Borkmann <daniel@iogearbox.net>

> ---
>   Documentation/clients.txt | 34 ++++++++++++++++++++++++++++++++++
>   MANIFEST                  |  1 +
>   2 files changed, 35 insertions(+)
>   create mode 100644 Documentation/clients.txt
> 
> diff --git a/Documentation/clients.txt b/Documentation/clients.txt
> new file mode 100644
> index 00000000..d2ac7561
> --- /dev/null
> +++ b/Documentation/clients.txt
> @@ -0,0 +1,34 @@
> +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 importer using C + libgit2

Maildir and procmail importer using C + libgit2

> +  https://git.kernel.org/pub/scm/linux/kernel/git/dborkman/l2md.git
> +
> +* impibe - Perl script to import v1 or v2 to Maildir
> +  https://public-inbox.org/meta/87v9m0l8t1.fsf@vuxu.org/
> +
> +* kernel.org helpers, including get-lore-mbox and sendmail-pi-feed
> +  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
> 


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] doc: add clients.txt
  2020-04-27 21:10 ` Konstantin Ryabitsev
@ 2020-04-27 21:30   ` Eric Wong
  0 siblings, 0 replies; 6+ messages in thread
From: Eric Wong @ 2020-04-27 21:30 UTC (permalink / raw)
  To: meta, Danh Doan, Daniel Borkmann, Leah Neukirchen

Konstantin Ryabitsev <konstantin@linuxfoundation.org> wrote:
> On Mon, Apr 27, 2020 at 08:57:08PM +0000, Eric Wong wrote:
> > +* kernel.org helpers, including get-lore-mbox and sendmail-pi-feed
> > +  https://git.kernel.org/pub/scm/linux/kernel/git/mricon/korg-helpers.git
> 
> I'd rather it listed b4 instead, as it's a successor to get-lore-mbox:
> https://git.kernel.org/pub/scm/utils/b4/b4.git
>  
> The "sendmail-pi-feed" wrapper is more of a proof of concept, so I'm not 
> sure it should be mentioned at all.

OK, I think keeping korg-helpers in some form will still be
useful.  Will have the followings changes in v2:

  +* b4 - helper utility for patch-based workflows
  +  https://git.kernel.org/pub/scm/utils/b4/b4.git
  +

  -* 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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH v2] doc: add clients.txt
  2020-04-27 20:57 [PATCH] doc: add clients.txt Eric Wong
                   ` (2 preceding siblings ...)
  2020-04-27 21:14 ` Daniel Borkmann
@ 2020-04-27 22:21 ` Eric Wong
  3 siblings, 0 replies; 6+ messages in thread
From: Eric Wong @ 2020-04-27 22:21 UTC (permalink / raw)
  To: meta; +Cc: Danh Doan, Daniel Borkmann, Konstantin Ryabitsev, Leah Neukirchen

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 <congdanhqx@gmail.com>
Acked-by: Daniel Borkmann <daniel@iogearbox.net>
Cc: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Cc: Leah Neukirchen <leah@vuxu.org>
---
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

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2020-04-27 22:21 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-27 20:57 [PATCH] doc: add clients.txt Eric Wong
2020-04-27 21:10 ` Konstantin Ryabitsev
2020-04-27 21:30   ` Eric Wong
2020-04-27 21:10 ` Leah Neukirchen
2020-04-27 21:14 ` Daniel Borkmann
2020-04-27 22:21 ` [PATCH v2] " Eric Wong

user/dev discussion of public-inbox itself

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ http://public-inbox.org/meta \
		meta@public-inbox.org
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for the project(s) associated with this inbox:

	https://80x24.org/public-inbox.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git