kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2026-01-21 17:12:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge changes from team/group/appdocsxml

Browse Source 
This commit introduces the first phase of an effort to manage documentation of the
interfaces in Asterisk in an XML format.  Currently, a new format is available for
applications and dialplan functions.  A good number of conversions to the new format
are also included.

For more information, see the following message to asterisk-dev:

http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2008-11-01 21:10:07 +00:00
parent 1fef0f63bb
commit 5b168ee34b
111 changed files with 8063 additions and 2478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
funcs/func_shell.c
View File

@@ -63,19 +63,31 @@ static int shell_helper(struct ast_channel *chan, const char *cmd, char *data,
return 0;
}
/*** DOCUMENTATION
<function name="SHELL" language="en_US">
<synopsis>
Executes a command as if you were at a shell.
</synopsis>
<syntax>
<parameter name="command" required="true">
<para>This is the argument to the function, the command you want to pass to the shell.</para>
</parameter>
</syntax>
<description>
<para>Returns the value from a system command</para>
<para>Example: <literal>Set(foo=${SHELL(echo \bar\)})</literal></para>
<note><para>When using the SHELL() dialplan function, your \SHELL\ is /bin/sh,
which may differ as to the underlying shell, depending upon your production
platform. Also keep in mind that if you are using a common path, you should
be mindful of race conditions that could result from two calls running
SHELL() simultaneously.</para></note>
</description>
</function>
***/
static struct ast_custom_function shell_function = {
.name = "SHELL",
.synopsis = "Executes a command as if you were at a shell.",
.syntax = "SHELL(<command>)",
.read = shell_helper,
.desc =
"Returns the value from a system command\n"
" Example: Set(foo=${SHELL(echo \"bar\")})\n"
" Note: When using the SHELL() dialplan function, your \"SHELL\" is /bin/sh,\n"
" which may differ as to the underlying shell, depending upon your production\n"
" platform. Also keep in mind that if you are using a common path, you should\n"
" be mindful of race conditions that could result from two calls running\n"
" SHELL() simultaneously.\n",
};
static int unload_module(void)