summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-11-16 17:11:30 (GMT)
committerFred Drake <fdrake@acm.org>1998-11-16 17:11:30 (GMT)
commitc46973c89b7fccf7a7ac69406dfc3f12e0e533a3 (patch)
tree901cab8b3083dcbe04a3269e6edd74b79ca4933a /Doc/lib
parent441abb4c8fa5f37c9dd24dd2478c6df57860534c (diff)
downloadcpython-c46973c89b7fccf7a7ac69406dfc3f12e0e533a3.zip
cpython-c46973c89b7fccf7a7ac69406dfc3f12e0e533a3.tar.gz
cpython-c46973c89b7fccf7a7ac69406dfc3f12e0e533a3.tar.bz2
Document the user and password parameters to the NNTP constructor.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libnntplib.tex8
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/lib/libnntplib.tex b/Doc/lib/libnntplib.tex
index 8b59fed..b8d7e5f 100644
--- a/Doc/lib/libnntplib.tex
+++ b/Doc/lib/libnntplib.tex
@@ -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}