summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libnntplib.tex9
1 files changed, 7 insertions, 2 deletions
diff --git a/Doc/lib/libnntplib.tex b/Doc/lib/libnntplib.tex
index a2161ce..1aa5d43 100644
--- a/Doc/lib/libnntplib.tex
+++ b/Doc/lib/libnntplib.tex
@@ -54,12 +54,14 @@ The module itself defines the following items:
\begin{classdesc}{NNTP}{host\optional{, port
\optional{, user\optional{, password
- \optional{, readermode}}}}}
+ \optional{, readermode}
+ \optional{, usenetrc}}}}}
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. If the optional
\var{user} and \var{password} are provided,
-or if suitable credentials are present in \file{~/.netrc},
+or if suitable credentials are present in \file{~/.netrc} and the
+optional flag \var{usenetrc} is true (the default),
the \samp{AUTHINFO USER} and \samp{AUTHINFO PASS} commands are used to
identify and authenticate the user to the server. If the optional
flag \var{readermode} is true, then a \samp{mode reader} command is
@@ -68,6 +70,9 @@ necessary if you are connecting to an NNTP server on the local machine
and intend to call reader-specific commands, such as \samp{group}. If
you get unexpected \code{NNTPPermanentError}s, you might need to set
\var{readermode}. \var{readermode} defaults to \code{None}.
+\var{usenetrc} defaults to \code{True}.
+
+\versionchanged[\var{usenetrc} argument added]{2.4}
\end{classdesc}
\begin{classdesc}{NNTPError}{}