summaryrefslogtreecommitdiffstats
path: root/lib/libc/gen/getpass.3
diff options
context:
space:
mode:
authormpp <mpp@FreeBSD.org>1996-08-22 22:05:59 +0000
committermpp <mpp@FreeBSD.org>1996-08-22 22:05:59 +0000
commitccc340f5aa69616bbbd416cc749090a688c283f6 (patch)
tree6d567531aa723650fda7eb154a0b70535bb19e38 /lib/libc/gen/getpass.3
parentad1ec74818520313d967232c210bcdbbc1ad0e44 (diff)
downloadFreeBSD-src-ccc340f5aa69616bbbd416cc749090a688c283f6.zip
FreeBSD-src-ccc340f5aa69616bbbd416cc749090a688c283f6.tar.gz
Update a bunch of man pages to use .Fn instead
of .Nm when referencing funciton names.
Diffstat (limited to 'lib/libc/gen/getpass.3')
-rw-r--r--lib/libc/gen/getpass.318
1 files changed, 10 insertions, 8 deletions
diff --git a/lib/libc/gen/getpass.3 b/lib/libc/gen/getpass.3
index 6582ddd..c1fb0e6 100644
--- a/lib/libc/gen/getpass.3
+++ b/lib/libc/gen/getpass.3
@@ -48,7 +48,7 @@ The
function displays a prompt to, and reads in a password from,
.Pa /dev/tty .
If this file is not accessible,
-.Nm getpass
+.Fn getpass
displays the prompt on the standard error output and reads from the standard
input.
.Pp
@@ -57,12 +57,14 @@ characters in length.
Any additional
characters and the terminating newline character are discarded.
.Pp
-.Nm Getpass
-turns off character echoing while reading the password.
+The
+.Fn getpass
+function turns off character echoing while reading the password.
.Pp
.Sh RETURN VALUES
-.Nm Getpass
-returns a pointer to the null terminated password.
+The
+.Fn getpass
+function returns a pointer to the null terminated password.
.Sh FILES
.Bl -tag -width /dev/tty -compact
.It Pa /dev/tty
@@ -71,16 +73,16 @@ returns a pointer to the null terminated password.
.Xr crypt 3
.Sh HISTORY
A
-.Nm getpass
+.Fn getpass
function appeared in
.At v7 .
.Sh BUGS
The
-.Nm getpass
+.Fn getpass
function leaves its result in an internal static object and returns
a pointer to that object.
Subsequent calls to
-.Nm getpass
+.Fn getpass
will modify the same object.
.Pp
The calling process should zero the password as soon as possible to
OpenPOWER on IntegriCloud