diff options
Diffstat (limited to 'Documentation/public-inbox-nntpd.pod')
-rw-r--r-- | Documentation/public-inbox-nntpd.pod | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/Documentation/public-inbox-nntpd.pod b/Documentation/public-inbox-nntpd.pod new file mode 100644 index 00000000..2f9dbabf --- /dev/null +++ b/Documentation/public-inbox-nntpd.pod @@ -0,0 +1,53 @@ +=head1 NAME + +public-inbox-nntpd - NNTP server for sharing public-inbox + +=head1 SYNOPSIS + +B<public-inbox-nntpd> [OPTIONS] + +=head1 DESCRIPTION + +public-inbox-nntpd provides a read-only NNTP daemon for +public-inbox. It uses options and environment variables common +to all L<public-inbox-daemon(8)> implementations. + +The default configuration will never require write access +tto the directory where the public-inbox is stored, so it +may be run as a different user than the user running +L<public-inbox-watch(1)>, L<public-inbox-mda(1)>, or +L<git-fetch(1)>. + +=head1 CONFIGURATION + +These configuration knobs should be used in the +L<public-inbox-config(5)> + +=over 8 + +=item publicinbox.<name>.newsgroup + +=item publicinbox.nntpserver + +=back + +See L<public-inbox-config(5)> for documentation on them. + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/>, +L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>, +L<nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta> + +=head1 COPYRIGHT + +Copyright 2013-2016 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + +=head1 SEE ALSO + +L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>, +L<public-inbox-config(5)> |