diff options
Diffstat (limited to 'Doc/lib/libnntplib.tex')
| -rw-r--r-- | Doc/lib/libnntplib.tex | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Doc/lib/libnntplib.tex b/Doc/lib/libnntplib.tex index 8616fb9..9b9217b 100644 --- a/Doc/lib/libnntplib.tex +++ b/Doc/lib/libnntplib.tex @@ -175,6 +175,23 @@ then the method will open a file object with that name, write to it then close it. If \var{file} is a file object, then it will start calling \method{write()} on it to store the lines of the command output. If \var{file} is supplied, then the returned \var{list} is an empty list. + +\begin{methoddesc}{descriptions}{grouppattern} +Send a \samp{LIST NEWSGROUPS} command, where \var{grouppattern} is a wildmat +string as specified in RFC2980 (it's essentially the same as DOS or UNIX +shell wildcard strings). Return a pair \code{(\var{response}, +\var{list})}, where \var{list} is a list of tuples containing +\code{(\var{name}, \var{title})}. +\end{methoddesc} + +\begin{methoddesc}{description}{group} +Get a description for a single group \var{group}. If more than one group +matches (if 'group' is a real wildmat string), return the first match. If no group +matches, return an empty string. + +This elides the response code from the server. If the response code is +needed, use \method{descriptions()}. + \end{methoddesc} \begin{methoddesc}{group}{name} @@ -294,6 +311,9 @@ calling \method{write()} on it to store the lines of the command output. If \var{file} is supplied, then the returned \var{list} is an empty list. This is an optional NNTP extension, and may not be supported by all servers. + +RFC2980 says ``It is suggested that this extension be deprecated''. Use +\method{descriptions()} or \method{description()} instead. \end{methoddesc} \begin{methoddesc}{xover}{start, end, \optional{file}} |