summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libgetpass.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/lib/libgetpass.tex')
-rw-r--r--Doc/lib/libgetpass.tex8
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/lib/libgetpass.tex b/Doc/lib/libgetpass.tex
index 28bfe8f..1d177d3 100644
--- a/Doc/lib/libgetpass.tex
+++ b/Doc/lib/libgetpass.tex
@@ -11,11 +11,15 @@
The \module{getpass} module provides two functions:
-\begin{funcdesc}{getpass}{\optional{prompt}}
+\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: '}.
+ \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.
+ \versionadded[The \var{stream} parameter]{2.5}
\end{funcdesc}