aboutsummaryrefslogtreecommitdiffstats
path: root/apps/app_authenticate.c
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2005-11-10 20:56:45 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2005-11-10 20:56:45 +0000
commit44abf0bbac9c9e29b548bf5850e39153f3647f9d (patch)
tree9ed66235ab8f2ed345f1023143544e1598d0b5d8 /apps/app_authenticate.c
parent4221e76950af188abee8336dfc3cd5a2006b252a (diff)
clean up some application descriptions to use more gooder English
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@7047 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'apps/app_authenticate.c')
-rwxr-xr-xapps/app_authenticate.c38
1 files changed, 18 insertions, 20 deletions
diff --git a/apps/app_authenticate.c b/apps/app_authenticate.c
index a3f5f91c9..583c5f4d3 100755
--- a/apps/app_authenticate.c
+++ b/apps/app_authenticate.c
@@ -49,26 +49,24 @@ static char *app = "Authenticate";
static char *synopsis = "Authenticate a user";
static char *descrip =
-" Authenticate(password[|options]): Requires a user to enter a"
-"given password in order to continue execution. If the\n"
-"password begins with the '/' character, it is interpreted as\n"
-"a file which contains a list of valid passwords (1 per line).\n"
-"an optional set of opions may be provided by concatenating any\n"
-"of the following letters:\n"
-" a - Set account code to the password that is entered\n"
-" d - Interpret path as database key, not literal file\n"
-" j - Support jumping to n+101\n"
-" m - Interpret path as a file which contains a list of\n"
-" account codes and password hashes delimited with ':'\n"
-" one per line. When password matched, corresponding\n"
-" account code will be set\n"
-" r - Remove database key upon successful entry (valid with 'd' only)\n"
-"\n"
-"When using a database key, the value associated with the key can be\n"
-"anything. Users have three attempts to authenticate before the line is \n"
-"hungup. If the passsword is invalid, and the 'j' flag is specified, \n"
-"and priority n+101 exists, the call would be sent to the n+101 priority \n"
-"and executed \n";
+" Authenticate(password[|options]): This application asks the caller to enter a\n"
+"given password in order to continue dialplan execution. If the password begins\n"
+"with the '/' character, it is interpreted as a file which contains a list of\n"
+"valid passwords, listed 1 password per line in the file.\n"
+" When using a database key, the value associated with the key can be anything.\n"
+"Users have three attempts to authenticate before the channel is hung up. If the\n"
+"passsword is invalid, the 'j' option is specified, and priority n+101 exists,\n"
+"dialplan execution will continnue at this location.\n"
+" Options:\n"
+" a - Set the channels' account code to the password that is entered\n"
+" d - Interpret the given path as database key, not a literal file\n"
+" j - Support jumping to n+101 if authentication fails\n"
+" m - Interpret the given path as a file which contains a list of account\n"
+" codes and password hashes delimited with ':', listed one per line in\n"
+" the file. When one of the passwords is matched, the channel will have\n"
+" its account code set to the corresponding account code in the file.\n"
+" r - Remove the database key upon successful entry (valid with 'd' only)\n"
+;
STANDARD_LOCAL_USER;