update the descriptions of a couple more apps
authorRussell Bryant <russell@russellbryant.com>
Fri, 11 Nov 2005 15:52:55 +0000 (15:52 +0000)
committerRussell Bryant <russell@russellbryant.com>
Fri, 11 Nov 2005 15:52:55 +0000 (15:52 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@7073 65c4cc65-6c06-0410-ace0-fbb531ad65f3

apps/app_dial.c
apps/app_directed_pickup.c
apps/app_directory.c

index 97196bc..c0e5ba9 100755 (executable)
@@ -72,7 +72,7 @@ static char *descrip =
 "  Unless there is a timeout specified, the Dial application will wait\n"
 "indefinitely until one of the called channels answers, the user hangs up, or\n"
 "if all of the called channels are busy or unavailable. Dialplan executing will\n"
-"continue if no requested channels can be called, or if the timeout expires.\n"
+"continue if no requested channels can be called, or if the timeout expires.\n\n"
 "  This application sets the following channel variables upon completion:\n"
 "    DIALEDTIME   - This is the time from dialing a channel until when it\n"
 "                   answers.\n" 
@@ -89,7 +89,7 @@ static char *descrip =
 "ends the call.\n"
 "  The optional URL will be sent to the called party if the channel supports it.\n"
 "  If the OUTBOUND_GROUP variable is set, all peer channels created by this\n"
-"application will be put into that group (as in Set(GROUP()=...).\n"
+"application will be put into that group (as in Set(GROUP()=...).\n\n"
 "  Options:\n"
 "    A(x) - Play an announcement to the called party, using 'x' as the file.\n"
 "    C    - Reset the CDR for this call.\n"
index cd9c62e..7008ff0 100755 (executable)
@@ -42,10 +42,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 static const char *tdesc = "Directed Call Pickup Application";
 static const char *app = "Pickup";
-static const char *synopsis = "Directed Call Pickup application.";
+static const char *synopsis = "Directed Call Pickup";
 static const char *descrip =
-" Pickup(extension@context):\n"
-"Steals any calls to a specified extension that are in a ringing state and bridges them to the current channel. Context is an optional argument.\n";
+"  Pickup(extension[@context]): This application can pickup any ringing channel\n"
+"that is calling the specified extension. If no context is specified, the current\n"
+"context will be used.\n";
 
 STANDARD_LOCAL_USER;
 
index 3e4472f..dc1181b 100755 (executable)
@@ -47,17 +47,23 @@ static char *app = "Directory";
 
 static char *synopsis = "Provide directory of voicemail extensions";
 static char *descrip =
-"  Directory(vm-context[|dial-context[|options]]): Presents the user with a directory\n"
-"of extensions from which they  may  select  by name. The  list  of  names \n"
-"and  extensions are retrieved from  voicemail.conf. The  vm-context  argument\n"
-"is required, and specifies  the  context  of voicemail.conf to use.  The\n"
-"dial-context is the context to use for dialing the users, and defaults to\n"
-"the vm-context if unspecified. The 'f' option causes the directory to match\n"
-"based on the first name in voicemail.conf instead of the last name.\n"
-"The query should yield a contact unless the caller disconnects.\n"
-"It  also sets up the channel on exit to enter the extension the user selected.\n"  "If the user enters '0' and there exists an extension 'o' in the current \n"" context, the directory will contact the extension associated with 'o'\n"
-"and call control will resume at that extension.  Entering '*' will exit similarly,\n"
-"but to the 'a' extension, much like app_voicemail's behavior.\n";
+"  Directory(vm-context[|dial-context[|options]]): This application will present\n"
+"the calling channel with a directory of extensions from which they can search\n"
+"by name. The list of names and corresponding extensions is retrieved from the\n"
+"voicemail configuration file, voicemail.conf.\n"
+"  This applicaiton will immediate exit if one of the following DTMF digits are\n"
+"received and the extension to jump to exists:\n"
+"    0 - Jump to the 'o' extension, if it exists.\n"
+"    * - Jump to the 'a' extension, if it exists.\n\n"
+"  Parameters:\n"
+"    vm-context   - This is the context within voicemail.conf to use for the\n"
+"                   Directory.\n"
+"    dial-context - This is the dialplan context to use when looking for an\n"
+"                   extension that the user has selected, or when jumping to the\n"
+"                   'o' or 'a' extension.\n\n"
+"  Options:\n"
+"    f - Allow the caller to enter the first name of a user in the directory\n"
+"        instead of using the last name.\n"; 
 
 /* For simplicity, I'm keeping the format compatible with the voicemail config,
    but i'm open to suggestions for isolating it */