Add note about how Authenticate() application with option 'd' works.

(closes issue ASTERISK-17422)
Reported by: Leif Madsen
........

Merged revisions 343102 from http://svn.asterisk.org/svn/asterisk/branches/1.8
........

Merged revisions 343103 from http://svn.asterisk.org/svn/asterisk/branches/10

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@343104 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/apps/app_authenticate.c b/apps/app_authenticate.c
index 8b5fa11..540e3df 100644 (file)
--- a/apps/app_authenticate.c
+++ b/apps/app_authenticate.c
@@ -73,7 +73,13 @@ static const char app[] = "Authenticate";
                                                <para>Set the channels' account code to the password that is entered</para>
                                        </option>
                                        <option name="d">
-                                               <para>Interpret the given path as database key, not a literal file</para>
+                                               <para>Interpret the given path as database key, not a literal file.</para>
+                                               <note>
+                                                       <para>The value is not used at all in the authentication when using this option.
+                                                       If the family/key is set to <literal>/pin/100</literal> (value does not matter)
+                                                       then the password field needs to be set to <literal>/pin</literal> and the pin entered
+                                                       by the user would be authenticated against <literal>100</literal>.</para>
+                                               </note>
                                        </option>
                                        <option name="m">
                                                <para>Interpret the given path as a file which contains a list of account