| 1 |
.. cyrusman:: nntpd(8) |
| 2 |
|
| 3 |
.. author: Nic Bernstein (Onlight) |
| 4 |
|
| 5 |
.. _imap-reference-manpages-systemcommands-nntpd: |
| 6 |
|
| 7 |
========= |
| 8 |
**nntpd** |
| 9 |
========= |
| 10 |
|
| 11 |
NNTP server process |
| 12 |
|
| 13 |
Synopsis |
| 14 |
======== |
| 15 |
|
| 16 |
.. parsed-literal:: |
| 17 |
|
| 18 |
**nntpd** [ **-C** *config-file* ] [ **-U** *uses* ] [ **-T** *timeout* ] [ **-D** ] |
| 19 |
[ **-H** ] [ **-s** ] [ **-r** ] [ **-f** ] [ **-p** *ssf* ] |
| 20 |
|
| 21 |
Description |
| 22 |
=========== |
| 23 |
|
| 24 |
**nntpd** is an NNTP server. It accepts commands on its standard input |
| 25 |
and responds on its standard output. It MUST invoked by |
| 26 |
:cyrusman:`master(8)` with those descriptors attached to a remote client |
| 27 |
connection. |
| 28 |
|
| 29 |
**nntpd** |default-conf-text| The optional ``newsprefix`` setting |
| 30 |
specifies a prefix to be prepended to newsgroup names to make the |
| 31 |
corresponding IMAP mailbox names. The optional ``newspostuser`` |
| 32 |
setting specifies the special userid to be used when constructing the |
| 33 |
*To:* header address for following up to articles when read via IMAP. |
| 34 |
The optional ``newspeer`` setting specifies the fully qualified hostname |
| 35 |
of the upstream news server to which articles are fed. The optional |
| 36 |
``allownewnews`` setting enables the NNTP NEWNEWS command. |
| 37 |
|
| 38 |
.. Note:: |
| 39 |
For servers with a large volume of articles, the NEWNEWS command can |
| 40 |
be expensive. |
| 41 |
|
| 42 |
If the directory ``<configdirectory>/log/``\ *user* exists, then |
| 43 |
**nntpd** will create protocol telemetry logs for sessions |
| 44 |
authenticating as *user*. The telemetry logs will be stored in the |
| 45 |
``log/``\ *user* directory with a filename of the **nntpd** process-id. |
| 46 |
|
| 47 |
Options |
| 48 |
======= |
| 49 |
|
| 50 |
.. program:: nntpd |
| 51 |
|
| 52 |
.. option:: -C config-file |
| 53 |
|
| 54 |
|cli-dash-c-text| |
| 55 |
|
| 56 |
.. option:: -U uses |
| 57 |
|
| 58 |
The maximum number of times that the process should be used for new |
| 59 |
connections before shutting down. The default is 250. |
| 60 |
|
| 61 |
.. option:: -T timeout |
| 62 |
|
| 63 |
The number of seconds that the process will wait for a new |
| 64 |
connection before shutting down. Note that a value of 0 (zero) |
| 65 |
will disable the timeout. The default is 60. |
| 66 |
|
| 67 |
.. option:: -D |
| 68 |
|
| 69 |
Run external debugger specified in debug_command. |
| 70 |
|
| 71 |
.. option:: -H |
| 72 |
|
| 73 |
Tell **nntpd** to expect a HAProxy protocol header from the sender. |
| 74 |
|
| 75 |
.. option:: -s |
| 76 |
|
| 77 |
Serve NNTP over SSL (https). All data to and from **nntpd** |
| 78 |
is encrypted using the Secure Sockets Layer. |
| 79 |
|
| 80 |
.. option:: -r |
| 81 |
|
| 82 |
Only allow NNTP reader commands. Permitted clients will only be |
| 83 |
allowed to read/post articles. |
| 84 |
|
| 85 |
.. option:: -f |
| 86 |
|
| 87 |
Only allow NNTP feeder commands. Permitted clients will only be |
| 88 |
allowed to feed articles (no reading). |
| 89 |
|
| 90 |
.. option:: -p ssf |
| 91 |
|
| 92 |
Tell **nntpd** that an external layer exists. An *SSF* (security |
| 93 |
strength factor) of 1 means an integrity protection layer exists. |
| 94 |
Any higher SSF implies some form of privacy protection. |
| 95 |
|
| 96 |
Files |
| 97 |
===== |
| 98 |
|
| 99 |
/etc/imapd.conf |
| 100 |
|
| 101 |
See Also |
| 102 |
======== |
| 103 |
|
| 104 |
:cyrusman:`imapd.conf(5)`, |
| 105 |
:cyrusman:`master(8)` |