summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorlifecrisis <15251574+lifecrisis@users.noreply.github.com>2019-09-06 17:11:17 -0400
committerTomas Mraz <tmraz@fedoraproject.org>2019-09-09 15:36:02 +0200
commit6b10b693f8e20a9d6452fe195f42bd978e9e4ee8 (patch)
tree76eee15ff7d0b9d4d2d75391b47a78151b455535 /doc
parent8daf77a011553e160012899d29765c968c952897 (diff)
downloadlinux-pam-git-6b10b693f8e20a9d6452fe195f42bd978e9e4ee8.tar.gz
Fix the man page for "pam_fail_delay()"
This man page contained the incorrect statement that setting the PAM_FAIL_DELAY item to NULL would disable any form of delay on authentication failure. I removed the incorrect statement and added a paragraph explaining how an application should properly avoid delays. Closes #137.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/pam_fail_delay.3.xml11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/man/pam_fail_delay.3.xml b/doc/man/pam_fail_delay.3.xml
index d886e9e0..53c1f89e 100644
--- a/doc/man/pam_fail_delay.3.xml
+++ b/doc/man/pam_fail_delay.3.xml
@@ -93,8 +93,15 @@ void (*delay_fn)(int retval, unsigned usec_delay, void *appdata_ptr);
<citerefentry>
<refentrytitle>pam_set_item</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>.
- Note, if PAM_FAIL_DELAY item is unset (or set to NULL), then no delay
- will be performed.
+ </para>
+ <para>
+ Note that the PAM_FAIL_DELAY item is set to NULL by default. This
+ indicates that PAM should perform a random delay as described
+ above when authentication fails and a delay has been suggested.
+ If an application does not want the PAM library to perform any
+ delay on authentication failure, then the application must define
+ a custom delay function that executes no statements and set
+ the PAM_FAIL_DELAY item to point to this function.
</para>
</refsect1>