summaryrefslogtreecommitdiff
path: root/sys/src/cmd/python/Doc/lib/libgetpass.tex
diff options
context:
space:
mode:
authorcinap_lenrek <cinap_lenrek@localhost>2011-05-03 11:25:13 +0000
committercinap_lenrek <cinap_lenrek@localhost>2011-05-03 11:25:13 +0000
commit458120dd40db6b4df55a4e96b650e16798ef06a0 (patch)
tree8f82685be24fef97e715c6f5ca4c68d34d5074ee /sys/src/cmd/python/Doc/lib/libgetpass.tex
parent3a742c699f6806c1145aea5149bf15de15a0afd7 (diff)
add hg and python
Diffstat (limited to 'sys/src/cmd/python/Doc/lib/libgetpass.tex')
-rw-r--r--sys/src/cmd/python/Doc/lib/libgetpass.tex36
1 files changed, 36 insertions, 0 deletions
diff --git a/sys/src/cmd/python/Doc/lib/libgetpass.tex b/sys/src/cmd/python/Doc/lib/libgetpass.tex
new file mode 100644
index 000000000..a7424390d
--- /dev/null
+++ b/sys/src/cmd/python/Doc/lib/libgetpass.tex
@@ -0,0 +1,36 @@
+\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\optional{, stream}}}
+ Prompt the user for a password without echoing. The user is
+ prompted using the string \var{prompt}, which defaults to
+ \code{'Password: '}. On \UNIX, the prompt is written to the
+ file-like object \var{stream}, which defaults to
+ \code{sys.stdout} (this argument is ignored on Windows).
+
+ Availability: Macintosh, \UNIX, Windows.
+ \versionchanged[The \var{stream} parameter was added]{2.5}
+\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}