help text cleanups (bug #4072, with mods)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@5508 f38db490-d61c-443f-a65b-d21fe96a405b
This commit is contained in:
parent
8607bf9fbe
commit
2f0559dad7
|
@ -31,10 +31,10 @@ static char *tdesc = "Cuts up variables";
|
|||
|
||||
static char *app_cut = "Cut";
|
||||
|
||||
static char *cut_synopsis = "Cut(newvar=varname|delimiter|fieldspec)";
|
||||
static char *cut_synopsis = "Splits a variable's content using the specified delimiter";
|
||||
|
||||
static char *cut_descrip =
|
||||
"Cut(newvar=varname,delimiter,field)\n"
|
||||
"Usage: Cut(newvar=varname,delimiter,fieldspec)\n"
|
||||
" newvar - new variable created from result string\n"
|
||||
" varname - variable you want cut\n"
|
||||
" delimiter - defaults to '-'\n"
|
||||
|
|
|
@ -122,7 +122,7 @@ static char *descrip =
|
|||
|
||||
/* RetryDial App by Anthony Minessale II <anthmct@yahoo.com> Jan/2005 */
|
||||
static char *rapp = "RetryDial";
|
||||
static char *rsynopsis = "Place a call, retrying on failure allowing optional exit extension.\n";
|
||||
static char *rsynopsis = "Place a call, retrying on failure allowing optional exit extension.";
|
||||
static char *rdescrip =
|
||||
" RetryDial(announce|sleep|loops|Technology/resource[&Technology2/resource2...][|timeout][|options][|URL]):\n"
|
||||
"Attempt to place a call. If no channel can be reached, play the file defined by 'announce'\n"
|
||||
|
|
|
@ -31,10 +31,10 @@ static char *tdesc = "Reevaluates strings";
|
|||
|
||||
static char *app_eval = "Eval";
|
||||
|
||||
static char *eval_synopsis = "Eval(newvar=somestring)";
|
||||
static char *eval_synopsis = "Evaluates a string";
|
||||
|
||||
static char *eval_descrip =
|
||||
"Eval(newvar=somestring)\n"
|
||||
"Usage: Eval(newvar=somestring)\n"
|
||||
" Normally Asterisk evaluates variables inline. But what if you want to\n"
|
||||
"store variable offsets in a database, to be evaluated later? Eval is\n"
|
||||
"the answer, by allowing a string to be evaluated twice in the dialplan,\n"
|
||||
|
|
|
@ -31,13 +31,14 @@ static char *tdesc = "Executes applications";
|
|||
|
||||
static char *app_exec = "Exec";
|
||||
|
||||
static char *exec_synopsis = "Exec(Appname(arguments))";
|
||||
static char *exec_synopsis = "Executes internal application";
|
||||
|
||||
static char *exec_descrip =
|
||||
"Exec(appname(arguments))\n"
|
||||
"Usage: Exec(appname(arguments))\n"
|
||||
" Allows an arbitrary application to be invoked even when not\n"
|
||||
"hardcoded into the dialplan. Returns whatever value the\n"
|
||||
"app returns or a non-zero value when the app cannot be found.\n";
|
||||
"hardcoded into the dialplan. To invoke external applications\n"
|
||||
"see the application System. Returns whatever value the\n"
|
||||
"app returns or a non-zero value if the app cannot be found.\n";
|
||||
|
||||
STANDARD_LOCAL_USER;
|
||||
|
||||
|
|
|
@ -186,24 +186,24 @@ static char *app_group_set = "SetGroup";
|
|||
static char *app_group_check = "CheckGroup";
|
||||
static char *app_group_match_count = "GetGroupMatchCount";
|
||||
|
||||
static char *group_count_synopsis = "GetGroupCount([groupname][@category])";
|
||||
static char *group_set_synopsis = "SetGroup(groupname[@category])";
|
||||
static char *group_check_synopsis = "CheckGroup(max[@category])";
|
||||
static char *group_match_count_synopsis = "GetGroupMatchCount(groupmatch[@category])";
|
||||
static char *group_count_synopsis = "Get the channel count of a group";
|
||||
static char *group_set_synopsis = "Set the channel's group";
|
||||
static char *group_check_synopsis = "Check the channel count of a group against a limit";
|
||||
static char *group_match_count_synopsis = "Get the channel count of all groups that match a pattern";
|
||||
|
||||
static char *group_count_descrip =
|
||||
"GetGroupCount([group][@category])\n"
|
||||
"Usage: GetGroupCount([groupname][@category])\n"
|
||||
" Calculates the group count for the specified group, or uses\n"
|
||||
"the current channel's group if not specifed (and non-empty).\n"
|
||||
"Stores result in GROUPCOUNT. Always returns 0.\n";
|
||||
|
||||
static char *group_set_descrip =
|
||||
"SetGroup(group)\n"
|
||||
"Usage: SetGroup(groupname[@category])\n"
|
||||
" Sets the channel group to the specified value. Equivalent to\n"
|
||||
"SetVar(GROUP=group). Always returns 0.\n";
|
||||
|
||||
static char *group_check_descrip =
|
||||
"CheckGroup(max[@category])\n"
|
||||
"Usage: CheckGroup(max[@category])\n"
|
||||
" Checks that the current number of total channels in the\n"
|
||||
"current channel's group does not exceed 'max'. If the number\n"
|
||||
"does not exceed 'max', we continue to the next step. If the\n"
|
||||
|
@ -211,7 +211,7 @@ static char *group_check_descrip =
|
|||
"execution continues at that step, otherwise -1 is returned.\n";
|
||||
|
||||
static char *group_match_count_descrip =
|
||||
"GetGroupMatchCount(groupmatch[@category])\n"
|
||||
"Usage: GetGroupMatchCount(groupmatch[@category])\n"
|
||||
" Calculates the group count for all groups that match the specified\n"
|
||||
"pattern. Uses standard regular expression matching (see regex(7)).\n"
|
||||
"Stores result in GROUPCOUNT. Always returns 0.\n";
|
||||
|
|
|
@ -28,14 +28,16 @@
|
|||
|
||||
|
||||
static char *exec_app = "ExecIf";
|
||||
static char *exec_desc = " ExecIF (<expr>|<app>|<data>)\n"
|
||||
static char *exec_desc =
|
||||
"Usage: ExecIF (<expr>|<app>|<data>)\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.";
|
||||
static char *exec_synopsis = "ExecIF (<expr>|<app>|<data>)";
|
||||
static char *exec_synopsis = "Conditional exec";
|
||||
|
||||
static char *start_app = "While";
|
||||
static char *start_desc = " While(<expr>)\n"
|
||||
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";
|
||||
|
||||
|
@ -43,7 +45,8 @@ static char *start_synopsis = "Start A While Loop";
|
|||
|
||||
|
||||
static char *stop_app = "EndWhile";
|
||||
static char *stop_desc = " EndWhile()\n"
|
||||
static char *stop_desc =
|
||||
"Usage: EndWhile()\n"
|
||||
"Return to the previous called While\n\n";
|
||||
|
||||
static char *stop_synopsis = "End A While Loop";
|
||||
|
|
Reference in New Issue