"show application <foo>" changes for clarity.
authorMark Michelson <mmichelson@digium.com>
Tue, 6 Nov 2007 19:04:45 +0000 (19:04 +0000)
committerMark Michelson <mmichelson@digium.com>
Tue, 6 Nov 2007 19:04:45 +0000 (19:04 +0000)
(closes issue #11171, reported and patched by blitzrage)

Many thanks!

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

33 files changed:
apps/app_amd.c
apps/app_chanisavail.c
apps/app_chanspy.c
apps/app_directed_pickup.c
apps/app_exec.c
apps/app_festival.c
apps/app_followme.c
apps/app_forkcdr.c
apps/app_getcpeid.c
apps/app_macro.c
apps/app_minivm.c
apps/app_mixmonitor.c
apps/app_morsecode.c
apps/app_mp3.c
apps/app_nbscat.c
apps/app_playback.c
apps/app_readfile.c
apps/app_sayunixtime.c
apps/app_sms.c
apps/app_softhangup.c
apps/app_speech_utils.c
apps/app_stack.c
apps/app_test.c
apps/app_waitforring.c
apps/app_waitforsilence.c
apps/app_while.c
channels/chan_agent.c
channels/chan_sip.c
main/pbx.c
res/res_features.c
res/res_indications.c
res/res_monitor.c
res/res_musiconhold.c

index dea61ff..a33bb72 100644 (file)
@@ -69,7 +69,7 @@ static char *descrip =
 "- 'maximumNumberOfWords'is the maximum number of words in the greeting. \n"
 "   If exceeded then MACHINE.\n"
 "- 'silenceThreshold' is the silence threshold.\n"
-"This application sets the following channel variable upon completion:\n"
+"This application sets the following channel variables upon completion:\n"
 "    AMDSTATUS - This is the status of the answering machine detection.\n"
 "                Possible values are:\n"
 "                MACHINE | HUMAN | NOTSURE | HANGUP\n"
index 18c97e8..b5c2736 100644 (file)
@@ -55,14 +55,15 @@ static char *synopsis = "Check channel availability";
 static char *descrip = 
 "  ChanIsAvail(Technology/resource[&Technology2/resource2...][,options]): \n"
 "This application will check to see if any of the specified channels are\n"
-"available. The following variables will be set by this application:\n"
-"  ${AVAILCHAN}     - the name of the available channel, if one exists\n"
-"  ${AVAILORIGCHAN} - the canonical channel name that was used to create the channel\n"
-"  ${AVAILSTATUS}   - the status code for the available channel\n"
+"available.\n"
 "  Options:\n"
-"    s - Consider the channel unavailable if the channel is in use at all\n"
+"    s - Consider the channel unavailable if the channel is in use at all.\n"
 "    t - Simply checks if specified channels exist in the channel list\n"
-"        (implies option s) \n";
+"        (implies option s).\n"
+"This application sets the following channel variable upon completion:\n"
+"  AVAILCHAN     - the name of the available channel, if one exists\n"
+"  AVAILORIGCHAN - the canonical channel name that was used to create the channel\n"
+"  AVAILSTATUS   - the status code for the available channel\n";
 
 
 static int chanavail_exec(struct ast_channel *chan, void *data)
index 9aed512..c30a427 100644 (file)
@@ -73,7 +73,7 @@ static const char *desc_chan =
 "        and a digit sequence.\n"
 "  Options:\n"
 "    b             - Only spy on channels involved in a bridged call.\n"
-"    g(grp)        - Match only channels where their ${SPYGROUP} variable is set to\n"
+"    g(grp)        - Match only channels where their SPYGROUP variable is set to\n"
 "                    contain 'grp' in an optional : delimited list.\n"
 "    q             - Don't play a beep when beginning to spy on a channel, or speak the\n"
 "                    selected channel name.\n"
index b6e483a..e5c6af3 100644 (file)
@@ -49,7 +49,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 static const char *app = "Pickup";
 static const char *synopsis = "Directed Call Pickup";
 static const char *descrip =
-"  Pickup([extension[@context][&extension2@context...]]):  This application can\n"
+"  Pickup([extension[@context][&extension2@[context]...]]):  This application can\n"
 "pickup any ringing channel that is calling the specified extension.  If no\n"
 "context is specified, the current context will be used. If you use the special\n"
 "string \"PICKUPMARK\" for the context parameter, for example 10@PICKUPMARK,\n"
index 048c338..8309684 100644 (file)
@@ -61,8 +61,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 static char *app_exec = "Exec";
 static char *exec_synopsis = "Executes dialplan application";
 static char *exec_descrip =
-"Usage: Exec(appname(arguments))\n"
-"  Allows an arbitrary application to be invoked even when not\n"
+"  Exec(appname(arguments)):\n"
+"Allows an arbitrary application to be invoked even when not\n"
 "hardcoded into the dialplan.  If the underlying application\n"
 "terminates the dialplan, or if the application cannot be found,\n"
 "Exec will terminate the dialplan.\n"
@@ -72,11 +72,11 @@ static char *exec_descrip =
 static char *app_tryexec = "TryExec";
 static char *tryexec_synopsis = "Executes dialplan application, always returning";
 static char *tryexec_descrip =
-"Usage: TryExec(appname(arguments))\n"
-"  Allows an arbitrary application to be invoked even when not\n"
+"  TryExec(appname(arguments)):\n"
+"Allows an arbitrary application to be invoked even when not\n"
 "hardcoded into the dialplan. To invoke external applications\n"
 "see the application System.  Always returns to the dialplan.\n"
-"The channel variable TRYSTATUS will be set to:\n"
+"The channel variable TRYSTATUS will be set to one of:\n"
 "    SUCCESS   if the application returned zero\n"
 "    FAILED    if the application returned non-zero\n"
 "    NOAPP     if the application was not found or was not specified\n";
@@ -84,7 +84,7 @@ static char *tryexec_descrip =
 static char *app_execif = "ExecIf";
 static char *execif_synopsis = "Executes dialplan application, conditionally";
 static char *execif_descrip = 
-"Usage:  ExecIF (<expr>?<app>(<data>):<app2>(<data2>))\n"
+"  ExecIF (<expr>?<app>(<data>):<app2>(<data2>))\n"
 "If <expr> is true, execute and return the result of <app>(<data>).\n"
 "If <expr> is true, but <app> is not found, then the application\n"
 "will return a non-zero value.\n";
index 05f4535..835cede 100644 (file)
@@ -66,7 +66,7 @@ static char *app = "Festival";
 static char *synopsis = "Say text to the user";
 
 static char *descrip = 
-"  Festival(text[,intkeys]):  Connect to Festival, send the argument, get back the waveform,"
+"  Festival(text[,intkeys]):  Connect to Festival, send the argument, get back the waveform,\n"
 "play it to the user, allowing any given interrupt keys to immediately terminate and return\n"
 "the value, or 'any' to allow any number back (useful in dialplan)\n";
 
index 751bef4..0624157 100644 (file)
@@ -61,7 +61,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 static char *app = "FollowMe";
 static char *synopsis = "Find-Me/Follow-Me application";
 static char *descrip = 
-"  FollowMe(followmeid,options):\n"
+"  FollowMe(followmeid[,options]):\n"
 "This application performs Find-Me/Follow-Me functionality for the caller\n"
 "as defined in the profile matching the <followmeid> parameter in\n"
 "followme.conf. If the specified <followmeid> profile doesn't exist in\n"
index 72c26bd..e18a600 100644 (file)
@@ -47,8 +47,9 @@ static char *synopsis =
 "Forks the Call Data Record";
 static char *descrip = 
 "  ForkCDR([options]):  Causes the Call Data Record to fork an additional\n"
-       "cdr record starting from the time of the fork call\n"
-"If the option 'v' is passed all cdr variables will be passed along also.\n";
+"cdr record starting from the time of the fork call\n"
+"  Options:\n"
+"    v  - If the option is passed all cdr variables will be passed along also.\n";
 
 
 static void ast_cdr_fork(struct ast_channel *chan) 
index ba67bd9..37ee66b 100644 (file)
@@ -48,7 +48,7 @@ static char *app = "GetCPEID";
 static char *synopsis = "Get ADSI CPE ID";
 
 static char *descrip =
-"  GetCPEID: Obtains and displays ADSI CPE ID and other information in order\n"
+"  GetCPEID(): Obtains and displays ADSI CPE ID and other information in order\n"
 "to properly setup zapata.conf for on-hook operations.\n";
 
 
index 07284ca..47bc42b 100644 (file)
@@ -79,7 +79,7 @@ static char *if_descrip =
 "  MacroIf(<expr>?macroname_a[,arg1][:macroname_b[,arg1]])\n"
 "Executes macro defined in <macroname_a> if <expr> is true\n"
 "(otherwise <macroname_b> if provided)\n"
-"Arguments and return values as in application macro()\n";
+"Arguments and return values as in application Macro()\n";
 
 static char *exclusive_descrip =
 "  MacroExclusive(macroname,arg1,arg2...):\n"
index 50300a9..6e7a29b 100644 (file)
@@ -230,7 +230,7 @@ static char *app_minivm_accmess = "MinivmAccMess";  /* Record personal voicemail
 
 static char *synopsis_minivm_record = "Receive Mini-Voicemail and forward via e-mail";
 static char *descrip_minivm_record = 
-       "Syntax: MinivmRecord(username@domain[,options])\n"
+       "  MinivmRecord(username@domain[,options]):\n"
        "This application is part of the Mini-Voicemail system, configured in minivm.conf.\n"
        "MiniVM records audio file in configured format and forwards message to e-mail and pager.\n"
        "If there's no user account for that address, a temporary account will\n"
@@ -253,7 +253,7 @@ static char *descrip_minivm_record =
 
 static char *synopsis_minivm_greet = "Play Mini-Voicemail prompts";
 static char *descrip_minivm_greet = 
-       "Syntax: MinivmGreet(username@domain[,options])\n"
+       "  MinivmGreet(username@domain[,options]):\n"
        "This application is part of the Mini-Voicemail system, configured in minivm.conf.\n"
        "MinivmGreet() plays default prompts or user specific prompts for an account.\n"
        "Busy and unavailable messages can be choosen, but will be overridden if a temporary\n"
@@ -270,7 +270,7 @@ static char *descrip_minivm_greet =
 
 static char *synopsis_minivm_notify = "Notify voicemail owner about new messages.";
 static char *descrip_minivm_notify = 
-       "Syntax: MinivmNotify(username@domain[,template])\n"
+       "  MinivmNotify(username@domain[,template]):\n"
        "This application is part of the Mini-Voicemail system, configured in minivm.conf.\n"
        "MiniVMnotify forwards messages about new voicemail to e-mail and pager.\n"
        "If there's no user account for that address, a temporary account will\n"
@@ -289,7 +289,7 @@ static char *descrip_minivm_notify =
 
 static char *synopsis_minivm_delete = "Delete Mini-Voicemail voicemail messages";
 static char *descrip_minivm_delete = 
-       "Syntax: MinivmDelete(filename)\n"
+       "  MinivmDelete(filename):\n"
        "This application is part of the Mini-Voicemail system, configured in minivm.conf.\n"
        "It deletes voicemail file set in MVM_FILENAME or given filename.\n"
        "\n"
@@ -300,7 +300,7 @@ static char *descrip_minivm_delete =
 
 static char *synopsis_minivm_accmess = "Record account specific messages";
 static char *descrip_minivm_accmess = 
-       "Syntax: MinivmAccmess(username@domain,option)\n"
+       "  MinivmAccmess(username@domain,option):\n"
        "This application is part of the Mini-Voicemail system, configured in minivm.conf.\n"
        "Use this application to record account specific audio/video messages for\n"
        "busy, unavailable and temporary messages.\n"
index 3c4ef97..4c705ad 100644 (file)
@@ -60,7 +60,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 static const char *app = "MixMonitor";
 static const char *synopsis = "Record a call and mix the audio during the recording";
 static const char *desc = ""
-"  MixMonitor(<file>.<ext>[,<options>[,<command>]])\n\n"
+"  MixMonitor(<file>.<ext>[,<options>[,<command>]]):\n"
 "Records the audio on the current channel to the specified file.\n"
 "If the filename is an absolute path, uses that path, otherwise\n"
 "creates the file in the configured monitoring directory from\n"
@@ -83,7 +83,7 @@ static const char *desc = ""
 static const char *stop_app = "StopMixMonitor";
 static const char *stop_synopsis = "Stop recording a call through MixMonitor";
 static const char *stop_desc = ""
-"  StopMixMonitor()\n\n"
+"  StopMixMonitor():\n"
 "Stops the audio recording that was started with a call to MixMonitor()\n"
 "on the current channel.\n"
 "";
index 45b3c67..c828394 100644 (file)
@@ -46,7 +46,7 @@ static char *app_morsecode = "Morsecode";
 static char *morsecode_synopsis = "Plays morse code";
 
 static char *morsecode_descrip =
-"Usage: Morsecode(<string>)\n"
+"  Morsecode(<string>):\n"
 "Plays the Morse code equivalent of the passed string.  If the variable\n"
 "MORSEDITLEN is set, it will use that value for the length (in ms) of the dit\n"
 "(defaults to 80).  Additionally, if MORSETONE is set, it will use that tone\n"
index b8275e8..7dc2d4c 100644 (file)
@@ -55,7 +55,7 @@ static char *app = "MP3Player";
 static char *synopsis = "Play an MP3 file or stream";
 
 static char *descrip = 
-"  MP3Player(location) Executes mpg123 to play the given location,\n"
+"  MP3Player(location): Executes mpg123 to play the given location,\n"
 "which typically would be a filename or a URL. User can exit by pressing\n"
 "any key on the dialpad, or by hanging up."; 
 
index 12131dd..6c9097c 100644 (file)
@@ -60,8 +60,8 @@ static char *app = "NBScat";
 static char *synopsis = "Play an NBS local stream";
 
 static char *descrip = 
-"  NBScat: Executes nbscat to listen to the local NBS stream.\n"
-"User can exit by pressing any key\n.";
+"  NBScat(): Executes nbscat to listen to the local NBS stream.\n"
+"User can exit by pressing any key.\n";
 
 
 static int NBScatplay(int fd)
index cb49b36..17d34cb 100644 (file)
@@ -53,8 +53,8 @@ static char *synopsis = "Play a file";
 
 static char *descrip = 
 "  Playback(filename[&filename2...][,option]):  Plays back given filenames (do not put\n"
-"extension). Options may also be included following a pipe symbol. The 'skip'\n"
-"option causes the playback of the message to be skipped if the channel\n"
+"extension). Options may also be included following a comma.\n"
+"The 'skip' option causes the playback of the message to be skipped if the channel\n"
 "is not in the 'up' state (i.e. it hasn't been  answered  yet). If 'skip' is \n"
 "specified, the application will return immediately should the channel not be\n"
 "off hook.  Otherwise, unless 'noanswer' is specified, the channel will\n"
index c230376..f20e028 100644 (file)
@@ -44,13 +44,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 static char *app_readfile = "ReadFile";
 
-static char *readfile_synopsis = "ReadFile(varname=file,length)";
+static char *readfile_synopsis = "Read the contents of a text file into a channel variable";
 
 static char *readfile_descrip =
 "ReadFile(varname=file,length)\n"
-"  Varname - Result stored here.\n"
-"  File - The name of the file to read.\n"
-"  Length - Maximum number of characters to capture.\n";
+"  varname  - Result stored here.\n"
+"  file     - The name of the file to read.\n"
+"  length   - Maximum number of characters to capture.\n";
 
 
 static int readfile_exec(struct ast_channel *chan, void *data)
index a22666a..0c433cd 100644 (file)
@@ -50,19 +50,19 @@ static char *sayunixtime_synopsis = "Says a specified time in a custom format";
 
 static char *sayunixtime_descrip =
 "SayUnixTime([unixtime][,[timezone][,format]])\n"
-"  unixtime: time, in seconds since Jan 1, 1970.  May be negative.\n"
+"  unixtime  - time, in seconds since Jan 1, 1970.  May be negative.\n"
 "              defaults to now.\n"
-"  timezone: timezone, see /usr/share/zoneinfo for a list.\n"
+"  timezone  - timezone, see /usr/share/zoneinfo for a list.\n"
 "              defaults to machine default.\n"
-"  format:   a format the time is to be said in.  See voicemail.conf.\n"
+"  format    - a format the time is to be said in.  See voicemail.conf.\n"
 "              defaults to \"ABdY 'digits/at' IMp\"\n";
 static char *datetime_descrip =
 "DateTime([unixtime][,[timezone][,format]])\n"
-"  unixtime: time, in seconds since Jan 1, 1970.  May be negative.\n"
+"  unixtime  - time, in seconds since Jan 1, 1970.  May be negative.\n"
 "              defaults to now.\n"
-"  timezone: timezone, see /usr/share/zoneinfo for a list.\n"
+"  timezone  - timezone, see /usr/share/zoneinfo for a list.\n"
 "              defaults to machine default.\n"
-"  format:   a format the time is to be said in.  See voicemail.conf.\n"
+"  format:   - a format the time is to be said in.  See voicemail.conf.\n"
 "              defaults to \"ABdY 'digits/at' IMp\"\n";
 
 
index 8dd468b..b1cbfbb 100644 (file)
@@ -88,13 +88,13 @@ static char *descrip =
        "service centre to SMS()\n"
        "name is the name of the queue used in /var/spool/asterisk/sms\n"
        "Arguments:\n"
-       " a: answer, i.e. send initial FSK packet.\n"
-       " s: act as service centre talking to a phone.\n"
-       " t: use protocol 2 (default used is protocol 1).\n"
-       " p(N): set the initial delay to N ms (default is 300).\n"
-       "addr and body are a deprecated format to send messages out.\n"
-       " s: set the Status Report Request (SRR) bit.\n"
-       " o: the body should be coded as octets not 7-bit symbols.\n"
+       " a  - answer, i.e. send initial FSK packet.\n"
+       " s  - act as service centre talking to a phone.\n"
+       " t  - use protocol 2 (default used is protocol 1).\n"
+       " p(N)  - set the initial delay to N ms (default is 300).\n"
+       "         addr and body are a deprecated format to send messages out.\n"
+       " s  - set the Status Report Request (SRR) bit.\n"
+       " o  - the body should be coded as octets not 7-bit symbols.\n"
        "Messages are processed as per text file message queues.\n" 
        "smsq (a separate software) is a command to generate message\n"
        "queues and send messages.\n"
index 5bc90fd..b4e0ccc 100644 (file)
@@ -45,11 +45,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 static char *synopsis = "Soft Hangup Application";
 
-static char *desc = "SoftHangup(Technology/resource[,options])\n"
+static char *desc = "  SoftHangup(Technology/resource[,options]):\n"
 "Hangs up the requested channel.  If there are no channels to hangup,\n"
 "the application will report it.\n"
-"- 'options' may contain the following letter:\n"
-"     'a' : hang up all channels on a specified device instead of a single resource\n";
+"  Options:\n"
+"     'a'  - hang up all channels on a specified device instead of a single resource\n";
 
 static char *app = "SoftHangup";
 
index 0402194..693546a 100644 (file)
@@ -45,49 +45,57 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$");
 
 /* Descriptions for each application */
 static char *speechcreate_descrip =
-"SpeechCreate(engine name)\n"
-"This application creates information to be used by all the other applications. It must be called before doing any speech recognition activities such as activating a grammar.\n"
+"  SpeechCreate(engine name):\n"
+"This application creates information to be used by all the other applications.\n"
+"It must be called before doing any speech recognition activities such as activating a grammar.\n"
 "It takes the engine name to use as the argument, if not specified the default engine will be used.\n";
 
 static char *speechactivategrammar_descrip =
-"SpeechActivateGrammar(Grammar Name)\n"
-"This activates the specified grammar to be recognized by the engine. A grammar tells the speech recognition engine what to recognize, \n"
-       "and how to portray it back to you in the dialplan. The grammar name is the only argument to this application.\n";
+"  SpeechActivateGrammar(Grammar Name):\n"
+"This activates the specified grammar to be recognized by the engine.\n"
+"A grammar tells the speech recognition engine what to recognize, and how to portray it back to you \n"
+"in the dialplan. The grammar name is the only argument to this application.\n";
 
 static char *speechstart_descrip =
-"SpeechStart()\n"
-       "Tell the speech recognition engine that it should start trying to get results from audio being fed to it. This has no arguments.\n";
+"  SpeechStart():\n"
+"Tell the speech recognition engine that it should start trying to get results from audio being \n"
+"fed to it. This has no arguments.\n";
 
 static char *speechbackground_descrip =
-"SpeechBackground(Sound File,Timeout)\n"
-"This application plays a sound file and waits for the person to speak. Once they start speaking playback of the file stops, and silence is heard.\n"
-"Once they stop talking the processing sound is played to indicate the speech recognition engine is working.\n"
-"Once results are available the application returns and results (score and text) are available using dialplan functions.\n"
-"The first text and score are ${SPEECH_TEXT(0)} AND ${SPEECH_SCORE(0)} while the second are ${SPEECH_TEXT(1)} and ${SPEECH_SCORE(1)}.\n"
-"The first argument is the sound file and the second is the timeout integer in seconds. Note the timeout will only start once the sound file has stopped playing.\n";
+"  SpeechBackground(Sound File,Timeout):\n"
+"This application plays a sound file and waits for the person to speak. Once they start speaking playback\n"
+"of the file stops, and silence is heard. Once they stop talking the processing sound is played to indicate\n"
+"the speech recognition engine is working. Once results are available the application returns and results \n"
+"(score and text) are available using dialplan functions.\n"
+"The first text and score are ${SPEECH_TEXT(0)} AND ${SPEECH_SCORE(0)} while the second are ${SPEECH_TEXT(1)}\n"
+"and ${SPEECH_SCORE(1)}.\n"
+"The first argument is the sound file and the second is the timeout integer in seconds. Note the timeout will\n"
+"only start once the sound file has stopped playing.\n";
 
 static char *speechdeactivategrammar_descrip =
-"SpeechDeactivateGrammar(Grammar Name)\n"
-       "This deactivates the specified grammar so that it is no longer recognized. The only argument is the grammar name to deactivate.\n";
+"  SpeechDeactivateGrammar(Grammar Name):\n"
+"This deactivates the specified grammar so that it is no longer recognized.\n"
+"The only argument is the grammar name to deactivate.\n";
 
 static char *speechprocessingsound_descrip =
-"SpeechProcessingSound(Sound File)\n"
-"This changes the processing sound that SpeechBackground plays back when the speech recognition engine is processing and working to get results.\n"
-       "It takes the sound file as the only argument.\n";
+"  SpeechProcessingSound(Sound File):\n"
+"This changes the processing sound that SpeechBackground plays back when the speech recognition engine is\n"
+"processing and working to get results.\n"
+"It takes the sound file as the only argument.\n";
 
 static char *speechdestroy_descrip =
-"SpeechDestroy()\n"
+"  SpeechDestroy():\n"
 "This destroys the information used by all the other speech recognition applications.\n"
 "If you call this application but end up wanting to recognize more speech, you must call SpeechCreate\n"
        "again before calling any other application. It takes no arguments.\n";
 
 static char *speechload_descrip =
-"SpeechLoadGrammar(Grammar Name,Path)\n"
+"  SpeechLoadGrammar(Grammar Name,Path):\n"
 "Load a grammar only on the channel, not globally.\n"
 "It takes the grammar name as first argument and path as second.\n";
 
 static char *speechunload_descrip =
-"SpeechUnloadGrammar(Grammar Name)\n"
+"  SpeechUnloadGrammar(Grammar Name):\n"
 "Unload a grammar. It takes the grammar name as the only argument.\n";
 
 /*! \brief Helper function used by datastores to destroy the speech structure upon hangup */
index c4b1c88..753048f 100644 (file)
@@ -55,20 +55,20 @@ static const char *return_synopsis = "Return from gosub routine";
 static const char *pop_synopsis = "Remove one address from gosub stack";
 
 static const char *gosub_descrip =
-"Gosub([[context,]exten,]priority[(arg1[,...][,argN])])\n"
-"  Jumps to the label specified, saving the return address.\n";
+"  Gosub([[context,]exten,]priority[(arg1[,...][,argN])]):\n"
+"Jumps to the label specified, saving the return address.\n";
 static const char *gosubif_descrip =
-"GosubIf(condition?labeliftrue[(arg1[,...])][:labeliffalse[(arg1[,...])]])\n"
-"  If the condition is true, then jump to labeliftrue.  If false, jumps to\n"
+"  GosubIf(condition?labeliftrue[(arg1[,...])][:labeliffalse[(arg1[,...])]]):\n"
+"If the condition is true, then jump to labeliftrue.  If false, jumps to\n"
 "labeliffalse, if specified.  In either case, a jump saves the return point\n"
 "in the dialplan, to be returned to with a Return.\n";
 static const char *return_descrip =
-"Return([return-value])\n"
-"  Jumps to the last label on the stack, removing it.  The return value, if\n"
+"  Return([return-value]):\n"
+"Jumps to the last label on the stack, removing it.  The return value, if\n"
 "any, is saved in the channel variable GOSUB_RETVAL.\n";
 static const char *pop_descrip =
-"StackPop()\n"
-"  Removes last label on the stack, discarding it.\n";
+"  StackPop():\n"
+"Removes last label on the stack, discarding it.\n";
 
 
 static void gosub_free(void *data);
index c4a10ba..ae49fa2 100644 (file)
@@ -49,13 +49,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/utils.h"
 
 static char *tests_descrip = 
-        "TestServer(): Perform test server function and write call report.\n"
+        "  TestServer(): Perform test server function and write call report.\n"
         "Results stored in /var/log/asterisk/testreports/<testid>-server.txt";
 static char *tests_app = "TestServer";
 static char *tests_synopsis = "Execute Interface Test Server";
 
 static char *testc_descrip = 
-        "TestClient(testid): Executes test client with given testid.\n"
+        "  TestClient(testid): Executes test client with given testid.\n"
         "Results stored in /var/log/asterisk/testreports/<testid>-client.txt";
 
 static char *testc_app = "TestClient";
index 1378c3e..b7064c1 100644 (file)
@@ -45,7 +45,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 static char *synopsis = "Wait for Ring Application";
 
-static char *desc = "  WaitForRing(timeout)\n"
+static char *desc = "  WaitForRing(timeout):\n"
 "Returns 0 after waiting at least timeout seconds. and\n"
 "only after the next ring has completed.  Returns 0 on\n"
 "success or -1 on hangup\n";
index bd0c081..f2adbf2 100644 (file)
@@ -52,7 +52,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 static char *app = "WaitForSilence";
 static char *synopsis = "Waits for a specified amount of silence";
 static char *descrip =
-"  WaitForSilence(silencerequired[,iterations][,timeout]) \n"
+"  WaitForSilence(silencerequired[,iterations][,timeout]):\n"
 "Wait for Silence: Waits for up to 'silencerequired' \n"
 "milliseconds of silence, 'iterations' times or once if omitted.\n"
 "An optional timeout specified the number of seconds to return\n"
index 43d9762..7569ccd 100644 (file)
@@ -46,30 +46,26 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 static char *start_app = "While";
 static char *start_desc = 
-"Usage:  While(<expr>)\n"
-"Start a While Loop.  Execution will return to this point when\n"
-"EndWhile is called until expr is no longer true.\n";
+"  While(<expr>): Start a While Loop.  Execution will return to this\n"
+"point when EndWhile() is called until expr is no longer true.\n";
 
 static char *start_synopsis = "Start a while loop";
 
 
 static char *stop_app = "EndWhile";
 static char *stop_desc = 
-"Usage:  EndWhile()\n"
-"Return to the previous called While\n";
+"  EndWhile(): Return to the previous called While()\n";
 
 static char *stop_synopsis = "End a while loop";
 
 static char *exit_app = "ExitWhile";
 static char *exit_desc =
-"Usage:  ExitWhile()\n"
-"Exits a While loop, whether or not the conditional has been satisfied.\n";
+"  ExitWhile(): Exits a While() loop, whether or not the conditional has been satisfied.\n";
 static char *exit_synopsis = "End a While loop";
 
 static char *continue_app = "ContinueWhile";
 static char *continue_desc =
-"Usage:  ContinueWhile()\n"
-"Returns to the top of the while loop and re-evaluates the conditional.\n";
+"  ContinueWhile(): Returns to the top of the while loop and re-evaluates the conditional.\n";
 static char *continue_synopsis = "Restart a While loop";
 
 #define VAR_SIZE 64
index 0b8ed76..70c2b9d 100644 (file)
@@ -89,7 +89,7 @@ static const char descrip[] =
 "when a new call comes in. The agent can dump the call by pressing\n"
 "the star key.\n"
 "The option string may contain zero or more of the following characters:\n"
-"      's' -- silent login - do not announce the login ok segment after agent logged in/off\n";
+"      's' -- silent login - do not announce the login ok segment after agent logged on/off\n";
 
 static const char descrip3[] =
 "  AgentMonitorOutgoing([options]):\n"
@@ -97,11 +97,11 @@ static const char descrip3[] =
 "comparison of the callerid of the current interface and the global variable \n"
 "placed by the AgentCallbackLogin application. That's why it should be used only\n"
 "with the AgentCallbackLogin app. Uses the monitoring functions in chan_agent \n"
-"instead of Monitor application. That have to be configured in the agents.conf file.\n"
+"instead of Monitor application. That has to be configured in the agents.conf file.\n"
 "\nReturn value:\n"
 "Normally the app returns 0 unless the options are passed.\n"
 "\nOptions:\n"
-"      'd' - make the app return -1 if there is an error condition"
+"      'd' - make the app return -1 if there is an error condition\n"
 "      'c' - change the CDR so that the source of the call is 'Agent/agent_id'\n"
 "      'n' - don't generate the warnings when there is no callerid or the\n"
 "            agentid is not known.\n"
index 3046ea3..7b4764b 100644 (file)
@@ -18703,14 +18703,14 @@ static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struc
 }
 
 static char *synopsis_dtmfmode = "Change the dtmfmode for a SIP call";
-static char *descrip_dtmfmode = "SIPDtmfMode(inband|info|rfc2833): Changes the dtmfmode for a SIP call\n";
+static char *descrip_dtmfmode = "  SIPDtmfMode(inband|info|rfc2833): Changes the dtmfmode for a SIP call\n";
 static char *app_dtmfmode = "SIPDtmfMode";
 
 static char *app_sipaddheader = "SIPAddHeader";
 static char *synopsis_sipaddheader = "Add a SIP header to the outbound call";
 
 static char *descrip_sipaddheader = ""
-"  SIPAddHeader(Header: Content)\n"
+"  SIPAddHeader(Header: Content):\n"
 "Adds a header to a SIP call placed with DIAL.\n"
 "Remember to user the X-header if you are adding non-standard SIP\n"
 "headers, like \"X-Asterisk-Accountcode:\". Use this with care.\n"
index aa4459d..3d4e812 100644 (file)
@@ -435,11 +435,12 @@ static struct pbx_builtin {
        },
 
        { "NoOp", pbx_builtin_noop,
-       "Do Nothing",
-       "  NoOp(): This applicatiion does nothing. However, it is useful for debugging\n"
+       "Do Nothing (No Operation)",
+       "  NoOp(): This application does nothing. However, it is useful for debugging\n"
        "purposes. Any text that is provided as arguments to this application can be\n"
        "viewed at the Asterisk CLI. This method can be used to see the evaluations of\n"
-       "variables or functions without having any effect."
+       "variables or functions without having any effect. Alternatively, see the\n"
+  "Verbose() application for finer grain control of output at custom verbose levels.\n"
        },
 
        { "Progress", pbx_builtin_progress,
index 3e47f2e..6aeb2b1 100644 (file)
@@ -134,7 +134,7 @@ static char *registrar = "res_features";               /*!< Registrar for operations */
 /* module and CLI command definitions */
 static char *synopsis = "Answer a parked call";
 
-static char *descrip = "ParkedCall(exten):"
+static char *descrip = "ParkedCall(exten): "
 "Used to connect to a parked call.  This application is always\n"
 "registered internally and does not need to be explicitly added\n"
 "into the dialplan, although you should include the 'parkedcalls'\n"
@@ -144,14 +144,14 @@ static char *parkcall = "Park";
 
 static char *synopsis2 = "Park yourself";
 
-static char *descrip2 = "Park():"
+static char *descrip2 = "Park(): "
 "Used to park yourself (typically in combination with a supervised\n"
 "transfer to know the parking space). This application is always\n"
 "registered internally and does not need to be explicitly added\n"
 "into the dialplan, although you should include the 'parkedcalls'\n"
 "context (or the context specified in features.conf).\n\n"
 "If you set the PARKINGEXTEN variable to an extension in your\n"
-"parking context, park() will park the call on that extension, unless\n"
+"parking context, Park() will park the call on that extension, unless\n"
 "it already exists. In that case, execution will continue at next\n"
 "priority.\n" ;
 
@@ -3107,12 +3107,14 @@ static int load_config(void)
 static char *app_bridge = "Bridge";
 static char *bridge_synopsis = "Bridge two channels";
 static char *bridge_descrip =
-"Usage: Bridge(channel[|options])\n"
+"Usage: Bridge(channel[,options])\n"
 "      Allows the ability to bridge two channels via the dialplan.\n"
 "The current channel is bridged to the specified 'channel'.\n"
-"The following options are supported:\n"
-"   p - Play a courtesy tone to 'channel'.\n"
-"BRIDGERESULT dial plan variable will contain SUCCESS, FAILURE, LOOP, NONEXISTENT or INCOMPATIBLE.\n";
+"  Options:\n"
+"    p - Play a courtesy tone to 'channel'.\n"
+"This application sets the following channel variable upon completion:\n"
+" BRIDGERESULT    The result of the bridge attempt as a text string, one of\n"
+"           SUCCESS | FAILURE | LOOP | NONEXISTENT | INCOMPATIBLE\n";
 
 enum {
        BRIDGE_OPT_PLAYTONE = (1 << 0),
index 2374245..ce6227d 100644 (file)
@@ -53,7 +53,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 static const char config[] = "indications.conf";
 
 char *playtones_desc=
-"PlayTones(arg): Plays a tone list. Execution will continue with the next step immediately,\n"
+"  PlayTones(arg): Plays a tone list. Execution will continue with the next step immediately,\n"
 "while the tones continue to play.\n"
 "Arg is either the tone name defined in the indications.conf configuration file, or a directly\n"
 "specified list of frequencies and durations.\n"
@@ -408,7 +408,7 @@ static int load_module(void)
                return AST_MODULE_LOAD_DECLINE; 
        ast_cli_register_multiple(cli_indications, sizeof(cli_indications) / sizeof(struct ast_cli_entry));
        ast_register_application("PlayTones", handle_playtones, "Play a tone list", playtones_desc);
-       ast_register_application("StopPlayTones", handle_stopplaytones, "Stop playing a tone list","Stop playing a tone list");
+       ast_register_application("StopPlayTones", handle_stopplaytones, "Stop playing a tone list","  StopPlayTones(): Stop playing a tone list");
 
        return AST_MODULE_LOAD_SUCCESS;
 }
index 048bcf1..ec770ea 100644 (file)
@@ -65,7 +65,7 @@ static unsigned long seq = 0;
 
 static char *monitor_synopsis = "Monitor a channel";
 
-static char *monitor_descrip = "Monitor([file_format[:urlbase],[fname_base],[options]]):\n"
+static char *monitor_descrip = "  Monitor([file_format[:urlbase],[fname_base],[options]]):\n"
 "Used to start monitoring a channel. The channel's input and output\n"
 "voice packets are logged to files until the channel hangs up or\n"
 "monitoring is stopped by the StopMonitor application.\n"
@@ -85,9 +85,7 @@ static char *monitor_descrip = "Monitor([file_format[:urlbase],[fname_base],[opt
 "          administrator interface\n"
 "\n"
 "    b   - Don't begin recording unless a call is bridged to another channel\n"
-"\n"
 "    i   - Skip recording of input stream (disables m option)\n"
-"\n"
 "    o   - Skip recording of output stream (disables m option)\n"
 "\nReturns -1 if monitor files can't be opened or if the channel is already\n"
 "monitored, otherwise 0.\n"
@@ -95,23 +93,23 @@ static char *monitor_descrip = "Monitor([file_format[:urlbase],[fname_base],[opt
 
 static char *stopmonitor_synopsis = "Stop monitoring a channel";
 
-static char *stopmonitor_descrip = "StopMonitor\n"
+static char *stopmonitor_descrip = "  StopMonitor():\n"
        "Stops monitoring a channel. Has no effect if the channel is not monitored\n";
 
 static char *changemonitor_synopsis = "Change monitoring filename of a channel";
 
-static char *changemonitor_descrip = "ChangeMonitor(filename_base)\n"
-       "Changes monitoring filename of a channel. Has no effect if the channel is not monitored\n"
+static char *changemonitor_descrip = "  ChangeMonitor(filename_base):\n"
+       "Changes monitoring filename of a channel. Has no effect if the channel is not monitored.\n"
        "The argument is the new filename base to use for monitoring this channel.\n";
 
 static char *pausemonitor_synopsis = "Pause monitoring of a channel";
 
-static char *pausemonitor_descrip = "PauseMonitor\n"
+static char *pausemonitor_descrip = "  PauseMonitor():\n"
        "Pauses monitoring of a channel until it is re-enabled by a call to UnpauseMonitor.\n";
 
 static char *unpausemonitor_synopsis = "Unpause monitoring of a channel";
 
-static char *unpausemonitor_descrip = "UnpauseMonitor\n"
+static char *unpausemonitor_descrip = "  UnpauseMonitor():\n"
        "Unpauses monitoring of a channel on which monitoring had\n"
        "previously been paused with PauseMonitor.\n";
 
index 920c57c..4e2df23 100644 (file)
@@ -85,29 +85,29 @@ static char *set_moh_syn = "Set default Music On Hold class";
 static char *start_moh_syn = "Play Music On Hold";
 static char *stop_moh_syn = "Stop Playing Music On Hold";
 
-static char *play_moh_desc = "MusicOnHold(class): "
+static char *play_moh_desc = "  MusicOnHold(class):\n"
 "Plays hold music specified by class.  If omitted, the default\n"
 "music source for the channel will be used. Set the default \n"
 "class with the SetMusicOnHold() application.\n"
 "Returns -1 on hangup.\n"
 "Never returns otherwise.\n";
 
-static char *wait_moh_desc = "WaitMusicOnHold(delay): "
+static char *wait_moh_desc = "  WaitMusicOnHold(delay):\n"
 "Plays hold music specified number of seconds.  Returns 0 when\n"
 "done, or -1 on hangup.  If no hold music is available, the delay will\n"
 "still occur with no sound.\n";
 
-static char *set_moh_desc = "SetMusicOnHold(class): "
+static char *set_moh_desc = "  SetMusicOnHold(class):\n"
 "Sets the default class for music on hold for a given channel.  When\n"
 "music on hold is activated, this class will be used to select which\n"
 "music is played.\n";
 
-static char *start_moh_desc = "StartMusicOnHold(class): "
+static char *start_moh_desc = "  StartMusicOnHold(class):\n"
 "Starts playing music on hold, uses default music class for channel.\n"
 "Starts playing music specified by class.  If omitted, the default\n"
 "music source for the channel will be used.  Always returns 0.\n";
 
-static char *stop_moh_desc = "StopMusicOnHold: "
+static char *stop_moh_desc = "  StopMusicOnHold(): "
 "Stops playing music on hold.\n";
 
 static int respawn_time = 20;