From: Leif Madsen <leif@leifmadsen.com>
Date: Wed, 2 Nov 2011 19:32:39 +0000 (+0000)
Subject: Add note about how Authenticate() application with option 'd' works.
X-Git-Tag: 1.8.9.0-rc1~110
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=53c1ecd8eaf3cad3ceacd5567ba2928803a1c7c5;p=thirdparty%2Fasterisk.git

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

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

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

diff --git a/apps/app_authenticate.c b/apps/app_authenticate.c
index 8b5fa11a62..540e3df1cd 100644
--- 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