about summary refs log tree commit homepage
path: root/Documentation/public-inbox-config.pod
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2023-11-14 00:32:20 +0000
committerEric Wong <e@80x24.org>2023-11-14 20:08:08 +0000
commit0e2b20d6eb0754426d021d8db1fb8db7584dd925 (patch)
treeca5bb354e948ed079cb104fbeab875dd57cf9fcc /Documentation/public-inbox-config.pod
parent69c0b8ece354146649112268935d4db6b2cb7964 (diff)
downloadpublic-inbox-0e2b20d6eb0754426d021d8db1fb8db7584dd925.tar.gz
Start lowercasing newsgroup names automatically since uppercase
names are incompatible with IMAP and POP3 and also causes
problems with both -extindex and -cindex.

We'll also warn on eidx_key and newsgroup conflicts to avoid
sometimes subtle breakage when using -extindex and -cindex.
Diffstat (limited to 'Documentation/public-inbox-config.pod')
-rw-r--r--Documentation/public-inbox-config.pod5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index 1ef7f46f..d394d31f 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -74,6 +74,11 @@ Omitting this for a given inbox will prevent the inbox from
 being served by L<public-inbox-nntpd(1)>,
 L<public-inbox-imapd(1)>, and/or L<public-inbox-pop3d(1)>
 
+Newsgroup names should be all lowercase.  Uppercase characters are
+converted to lowercase for compatibility with IMAP, POP3, and our
+L<public-inbox-extindex(1)> and L<public-inbox-cindex(1)> tools
+starting with public-inbox 2.0+ (they were unusable before).
+
 Default: none, optional
 
 =item publicinbox.<name>.watch