summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libnetrc.tex
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1998-12-22 05:18:24 (GMT)
committerGuido van Rossum <guido@python.org>1998-12-22 05:18:24 (GMT)
commit5e97c9dff91ad885d36a9d26f97549f198b90ee8 (patch)
tree4985eec3925141c56a7e7d647097191aa429a18f /Doc/lib/libnetrc.tex
parenta7d9bdfab61551ed16efc55c1b6c37268c2d9832 (diff)
downloadcpython-5e97c9dff91ad885d36a9d26f97549f198b90ee8.zip
cpython-5e97c9dff91ad885d36a9d26f97549f198b90ee8.tar.gz
cpython-5e97c9dff91ad885d36a9d26f97549f198b90ee8.tar.bz2
Adding libshlex and libnetrc by Eric Raymond.
Diffstat (limited to 'Doc/lib/libnetrc.tex')
-rw-r--r--Doc/lib/libnetrc.tex47
1 files changed, 47 insertions, 0 deletions
diff --git a/Doc/lib/libnetrc.tex b/Doc/lib/libnetrc.tex
new file mode 100644
index 0000000..4d23769
--- /dev/null
+++ b/Doc/lib/libnetrc.tex
@@ -0,0 +1,47 @@
+% Module and documentation by Eric S. Raymond, 21 Dec 1998
+\section{Standard Module \module{netrc}}
+\stmodindex{netrc}
+\label{module-netrc}
+
+The \code{netrc} class parses and encapsulates the netrc file format
+used by Unix's ftp(1) and other FTP clientd
+
+\begin{classdesc}{netrc}{\optional{file}}
+A \class{netrc} instance or subclass instance enapsulates data from
+a netrc file. The initialization argument, if present, specifies the file
+to parse. If no argument is given, the file .netrc in the user's home
+directory will be read. Parse errors will throw a SyntaxError
+exception with associated diagnostic information including the file
+name, line number, and terminating token.
+\end{classdesc}
+
+\subsection{netrc Objects}
+\label{netrc-objects}
+
+A \class{netrc} instance has the following methods:
+
+\begin{methoddesc}{authenticators}{}
+Return a 3-tuple (login, account, password) of authenticators for the
+given host. If the netrc file did not contain an entry for the given
+host, return the tuple associated with the `default' entry. If
+neither matching host nor default entry is available, return None.
+\end{methoddesc}
+
+\begin{methoddesc}{__repr__}{host}
+Dump the class data as a string in the format of a netrc file.
+(This discards comments and may reorder the entries.)
+\end{methoddesc}
+
+Instances of \class{netrc} have public instance variables:
+
+\begin{memberdesc}{hosts}
+Dictionmary mapping host names to login/account/password tuples. The
+`default' entry, if any, is represented as a pseudo-host by that name.
+\end{memberdesc}
+
+\begin{memberdesc}{macros}
+Dictionary mapping macro names to string lists.
+\end{memberdesc}
+
+
+