Mention AUTHINFO GENERIC.
[sgt/utils] / nntpid / nntpid.but
CommitLineData
3096ed75 1\cfg{man-identity}{nntpid}{1}{2004-11-21}{Simon Tatham}{Simon Tatham}
2
3\title Man page for \cw{nntpid}
4
5\U NAME
6
7\cw{nntpid} - retrieve a single article from a news server
8
9\U SYNOPSIS
10
11\c nntpid [ -v ] message-id
12\e bbbbbb bb iiiiiiiiii
13\c nntpid [ -v ] newsgroup-name article-number
14\e bbbbbb bb iiiiiiiiiiiiii iiiiiiiiiiiiii
15
16\U DESCRIPTION
17
18\cw{nntpid} makes a connection to a news server, retrieves a single
19article, and displays it.
20
21You can specify the article you want by either:
22
23\b giving its Message-ID. Message-IDs are globally unique, so you
24don't need to know which newsgroup the article was in. Also, they do
25not vary between news servers.
26
27\b giving a newsgroup name and an article number within that
28newsgroup. Article numbers are assigned internally by a particular
29news server, so they will be different on other servers carrying the
30same group.
31
32\U ARGUMENTS
33
34If you specify one argument, \cw{nntpid} assumes it is a Message-ID.
35The angle brackets that usually delimit Message-IDs are optional;
36\cw{nntpid} will strip them off if it sees them, and will not
37complain if it does not.
38
39If you specify two arguments, \cw{nntpid} will interpret the first
40as a newsgroup name, and the second as an article number.
41
42\U OPTIONS
43
44\dt \cw{-v}
45
46\dd Verbose mode. In this mode, \cw{nntpid} will log its entire
47conversation with the news server on standard error.
48
0f90ca06 49\U AUTHENTICATION
50
51Currently, the only form of authentication supported by \cw{nntpid}
52is \cw{AUTHINFO GENERIC}, using the environment variable
53\cw{NNTPAUTH}. It will only attempt this if it receives a 480
54response from the news server; if your news server never sends 480
55then \cw{nntpid} will never even look at \cw{NNTPAUTH}.
56
3096ed75 57\U LICENCE
58
59\cw{nntpid} is free software, distributed under the MIT licence.
60Type \cw{nntpid --licence} to see the full licence text.
61
62\versionid $Id$