]> granicus.if.org Git - python/commitdiff
Document the user and password parameters to the NNTP constructor.
authorFred Drake <fdrake@acm.org>
Mon, 16 Nov 1998 17:11:30 +0000 (17:11 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 16 Nov 1998 17:11:30 +0000 (17:11 +0000)
Doc/lib/libnntplib.tex

index 8b59fed9d3024c7a57ed529aa40938a99339e0a6..b8d7e5f1de407b798430c8312cc9dc69566abe93 100644 (file)
@@ -53,10 +53,14 @@ valid headers):
 %
 The module itself defines the following items:
 
-\begin{classdesc}{NNTP}{host\optional{, port}}
+\begin{classdesc}{NNTP}{host\optional{, port
+                        \optional{, user\optional{, password}}}}
 Return a new instance of the \class{NNTP} class, representing a
 connection to the NNTP server running on host \var{host}, listening at
-port \var{port}.  The default \var{port} is 119.
+port \var{port}.  The default \var{port} is 119.  If the optional
+\var{user} and \var{password} are provided, the \samp{AUTHINFO USER}
+and \samp{AUTHINFO PASS} commands are used to identify and
+authenticate the user to the server.
 \end{classdesc}
 
 \begin{excdesc}{error_reply}