Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

Refashion dump command to match common syntax and update the resulting appdocs TeX file

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.4@58946 65c4cc65-6c06-0410-ace0-fbb531ad65f3
1.4
Tilghman Lesher 19 years ago
parent 045e66abda
commit b6bd80b7f2
2 changed files with 91 additions and 4 deletions
Show Stats Download Patch File Download Diff File

87
doc/ast_appdocs.tex
Unescape View File

@ -224,6 +224,8 @@ AppendCDRUserField(value): Append value to the CDR user field
(I.E. telephone survey responses)
Also see SetCDRUserField().
This application is deprecated in favor of Set(CDR(userfield)=...)
\end{verbatim}
@ -1170,6 +1172,8 @@ in that folder.
HASVMSTATUS The result of the new voicemail check returned as a text string as follows
<# of messages in the folder, 0 for NONE>
This application has been deprecated in favor of the VMCOUNT() function
\end{verbatim}
@ -1188,6 +1192,8 @@ HasVoicemail(vmbox[/folder][@context][|varname[|options]])
HASVMSTATUS The result of the voicemail check returned as a text string as follows
<# of messages in the folder, 0 for NONE>
This application has been deprecated in favor of the VMCOUNT() function
\end{verbatim}
@ -1236,6 +1242,19 @@ Set for more information.
\end{verbatim}
\section{IVRDemo}
\subsection{Synopsis}
\begin{verbatim}
IVR Demo Application
\end{verbatim}
\subsection{Description}
\begin{verbatim}
This is a skeleton application that shows you the basic structure to create your
own asterisk applications and demonstrates the IVR demo.
\end{verbatim}
\section{JabberSend}
\subsection{Synopsis}
\begin{verbatim}
@ -2182,6 +2201,50 @@ tone to the user.
\end{verbatim}
\section{Rpt}
\subsection{Synopsis}
\begin{verbatim}
Radio Repeater/Remote Base Control System
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Rpt(nodename[|options]): Radio Remote Link or Remote Base Link Endpoint Process.
Not specifying an option puts it in normal endpoint mode (where source
IP and nodename are verified).
Options are as follows:
X - Normal endpoint mode WITHOUT security check. Only specify
this if you have checked security already (like with an IAX2
user/password or something).
Rannounce-string[|timeout[|timeout-destination]] - Amateur Radio
Reverse Autopatch. Caller is put on hold, and announcement (as
specified by the 'announce-string') is played on radio system.
Users of radio system can access autopatch, dial specified
code, and pick up call. Announce-string is list of names of
recordings, or "PARKED" to substitute code for un-parking,
or "NODE" to substitute node number.
P - Phone Control mode. This allows a regular phone user to have
full control and audio access to the radio system. For the
user to have DTMF control, the 'phone_functions' parameter
must be specified for the node in 'rpt.conf'. An additional
function (cop,6) must be listed so that PTT control is available.
D - Dumb Phone Control mode. This allows a regular phone user to
have full control and audio access to the radio system. In this
mode, the PTT is activated for the entire length of the call.
For the user to have DTMF control (not generally recomended in
this mode), the 'dphone_functions' parameter must be specified
for the node in 'rpt.conf'. Otherwise no DTMF control will be
available to the phone user.
\end{verbatim}
\section{SayAlpha}
\subsection{Synopsis}
\begin{verbatim}
@ -2359,6 +2422,10 @@ channel and all children channels.
g - Set variable globally instead of on the channel
(applies only to variables, not functions)
The use of Set to set multiple variables at once and the g flag have both
been deprecated. Please use multiple Set calls and the GLOBAL() dialplan
function instead.
\end{verbatim}
@ -2385,6 +2452,8 @@ Set CallerID
SetCallerID(clid[|a]): Set Caller*ID on a call to a new
value. Sets ANI as well if a flag is used.
This application has been deprecated in favor of Set(CALLERID(all)=...)
\end{verbatim}
@ -2430,6 +2499,8 @@ SetCDRUserField(value): Set the CDR 'user field' to value
(I.E. telephone survey responses)
Also see AppendCDRUserField().
This application has been deprecated in favor of Set(CDR(userfield)=...)
\end{verbatim}
@ -2443,6 +2514,8 @@ Set a global variable to a given value
SetGlobalVar(variable=value): This application sets a given global variable to
the specified value.
This application has been deprecated in favor of Set(GLOBAL(var)=value)
\end{verbatim}
@ -2478,6 +2551,7 @@ Valid Transfer Capabilities are:
DIGITAL_W_TONES : 0x11 - Unrestricted digital information with tones/announcements
VIDEO : 0x18 - Video
This application has been deprecated in favor of Set(CHANNEL(transfercapability)=...)
\end{verbatim}
@ -3223,3 +3297,16 @@ Limit scanning to a channel GROUP by setting the option group argument.
\end{verbatim}
\section{ZapSendKeypadFacility}
\subsection{Synopsis}
\begin{verbatim}
Send digits out of band over a PRI
\end{verbatim}
\subsection{Description}
\begin{verbatim}
ZapSendKeypadFacility(): This application will send the given string of digits in a Keypad Facility
IE over the current channel.
\end{verbatim}

8
main/pbx.c
Unescape View File

@ -3208,8 +3208,8 @@ static int handle_show_application(int fd, int argc, char *argv[])
#ifdef AST_DEVMODE
static char core_dumpappdocs_help[] =
"Usage: core dumpappdocs [application]\n"
" Dump Application documentation to \\tmp\\ast_appdocs.tex.\n";
"Usage: core dump appdocs [application]\n"
" Dump Application documentation to /tmp/ast_appdocs.tex.\n";
static int handle_core_dumpappdocs(int fd, int argc, char *argv[])
{
@ -3843,8 +3843,8 @@ static struct ast_cli_entry pbx_cli[] = {
show_application_help, complete_show_application, &cli_show_application_deprecated },
#ifdef AST_DEVMODE
{ { "core", "dumpappdocs", NULL },
handle_core_dumpappdocs, "Dump App docs in LaTeX format",
{ { "core", "dump", "appdocs", NULL },
handle_core_dumpappdocs, "Dump application documentation in LaTeX format",
core_dumpappdocs_help, NULL },
#endif

Write Preview
Loading…
Cancel
Save