Mercurial > cpython-lru_cache-weakref
view Doc/lib/libgetpass.tex @ 21467:4e35fa5d5708 legacy-trunk
Add documentation for the help() built-in; contributed by Ka-Ping Yee.
This is part of SF patch #494622.
| author | Fred Drake <fdrake@acm.org> |
|---|---|
| date | Tue, 18 Dec 2001 16:31:08 +0000 |
| parents | bc02c3b09626 |
| children | fe3b93c22481 |
line wrap: on
line source
\section{\module{getpass} --- Portable password input} \declaremodule{standard}{getpass} \modulesynopsis{Portable reading of passwords and retrieval of the userid.} \moduleauthor{Piers Lauder}{piers@cs.su.oz.au} % Windows (& Mac?) support by Guido van Rossum. \sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org} 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: '}. Availability: Macintosh, \UNIX, Windows. \end{funcdesc} \begin{funcdesc}{getuser}{} Return the ``login name'' of the user. Availability: \UNIX, Windows. 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 \refmodule{pwd} module, otherwise, an exception is raised. \end{funcdesc}
