From: Fred Drake <fdrake@acm.org>
Date: Tue, 22 Dec 1998 23:37:21 +0000 (+0000)
Subject: Basic documentation for the getpass module.
X-Git-Tag: v1.5.2b2~513
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5ac2a07fca7d578c46ce90e5b5e4d45a6edf9bd7;p=thirdparty%2FPython%2Fcpython.git

Basic documentation for the getpass module.
---

diff --git a/Doc/lib/libgetpass.tex b/Doc/lib/libgetpass.tex
new file mode 100644
index 000000000000..4d7e8b94aaee
--- /dev/null
+++ b/Doc/lib/libgetpass.tex
@@ -0,0 +1,31 @@
+\section{\module{getpass}
+         --- Portable password reading.}
+
+\declaremodule{standard}{getpass}
+\moduleauthor{Piers Lauder}{piers@cs.su.oz.au}
+% Windows support by Guido van Rossum.
+\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}
+
+\modulesynopsis{Portable reading of passwords and retrieval of the userid.}
+
+
+The \module{getpass} module provides two functions:
+
+
+\begin{funcdesc}{getpass}{\optional{prompt}}
+  Prompt the user for a password without echoing.  The user is
+  prompted using the string \var{prompt}, which defaults to
+  \code{'Password: '}.
+\end{funcdesc}
+
+
+\begin{funcdesc}{getuser}{}
+  Return the ``login name'' of the user.
+
+  This function checks the environment variables \envvar{LOGNAME},
+  \envvar{USER}, \envvar{LNAME} and \envvar{USERNAME}, in order, and
+  returns the value of the first one which is set to a non-empty
+  string.  If none are set, the login name from the password database
+  is returned on systems which support the \module{pwd} module,
+  otherwise, an exception is raised.
+\end{funcdesc}