diff options
| author | Eric Wong <e@yhbt.net> | 2020-08-20 20:24:39 +0000 |
|---|---|---|
| committer | Eric Wong <e@yhbt.net> | 2020-08-20 21:11:04 +0000 |
| commit | 6f5b7803c82c45105272802b818df684b87bd2ec (patch) | |
| tree | e4c9b6bc5096b62a0074b03f65f266ee67ca0ce1 /Documentation | |
| parent | 3f3867da5e5ff10b941e942c9974ddbf1e5464c1 (diff) | |
| download | public-inbox-6f5b7803c82c45105272802b818df684b87bd2ec.tar.gz | |
We can reduce the need to edit the config file for NNTP group names this way.
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/public-inbox-config.pod | 2 | ||||
| -rw-r--r-- | Documentation/public-inbox-init.pod | 25 |
2 files changed, 22 insertions, 5 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 05b84819..1dfb926e 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -63,7 +63,7 @@ Default: none, optional =item publicinbox.<name>.newsgroup The NNTP group name for use with L<public-inbox-nntpd(8)>. This -may be any newsgroup name with hierarchies delimited by '.'. +may be any newsgroup name with hierarchies delimited by C<.>. For example, the newsgroup for L<mailto:meta@public-inbox.org> is: C<inbox.comp.mail.public-inbox.meta> diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod index d0c87563..ea2b38dd 100644 --- a/Documentation/public-inbox-init.pod +++ b/Documentation/public-inbox-init.pod @@ -39,6 +39,21 @@ See L<public-inbox-config(5)> for more information. Default: C<full> +=item --ng, --newsgroup NEWSGROUP + +The NNTP group name for use with L<public-inbox-nntpd(8)>. This +may be any newsgroup name with hierarchies delimited by C<.>. +For example, the newsgroup for L<mailto:meta@public-inbox.org> +is: C<inbox.comp.mail.public-inbox.meta> + +This may be set after-the-fact via C<publicinbox.$NAME.newsgroup> +in the configuration file. See L<public-inbox-config(5)> for more +info. + +Available since public-inbox 1.6.0 (PENDING). + +Default: none. + =item -N, --skip-artnum This option allows archivists to publish incomplete archives @@ -94,10 +109,12 @@ Used to override the default C<~/.public-inbox/config> value. =head1 LIMITATIONS -This tool predates NNTP support in public-inbox and is missing -C<newsgroup> and many of the options documented in -L<public-inbox-config(5)>. See L<public-inbox-config(5)> for all the -options which may be applied to a given inbox. +Some of the options documented in L<public-inbox-config(5)> +require editing the config file. Old versions lack the +C<--ng>/C<--newsgroup> parameter + +See L<public-inbox-config(5)> for all the options which may be applied +to a given inbox. =head1 CONTACT |