[Asterisk-doc] docs appendix03.xml,1.15,1.16
websmith
asterisk-doc@lists.digium.com
Mon, 22 Dec 2003 06:43:19 +0000
Comments:
Update of /cvsroot/asterisk/docs
In directory sc8-pr-cvs1:/tmp/cvs-serv9367
Modified Files:
appendix03.xml
Log Message:
Second pass through the appendix, fixing formatting bugs
Index: appendix03.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/appendix03.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** appendix03.xml 21 Dec 2003 07:47:05 -0000 1.15
--- appendix03.xml 22 Dec 2003 06:43:13 -0000 1.16
***************
*** 410,415 ****
</para>
<para>
! Returns 0 unless the user hangs up. It also sets up the channel
! on exit to enter the extension the user selected.
</para>
--- 410,418 ----
</para>
<para>
! <function>Directory()</function> also sets up the channel on
! exit to enter the extension the user selected.
! </para>
! <para>
! Returns 0 unless the user hangs up.
</para>
***************
*** 429,438 ****
pound sign (#). If the passcode is correct, the user is then given
system dialtone on which a call may be placed. Obviously, this type
! of access has SERIOUS security implications, and GREAT care must be
! taken NOT to compromise your security.
</para>
<para>
There is a possibility of accessing DISA without password. Simply
! exchange your password with no-password.
</para>
<programlisting>
--- 432,442 ----
pound sign (#). If the passcode is correct, the user is then given
system dialtone on which a call may be placed. Obviously, this type
! of access has <emphasis role="strong">SERIOUS</emphasis> security
! implications, and <emphasis role="strong">GREAT</emphasis> care must be
! taken not to compromise your security.
</para>
<para>
There is a possibility of accessing DISA without password. Simply
! exchange your password with 'no-password'.
</para>
<programlisting>
***************
*** 503,512 ****
</para>
<para>
! Returns 0 if the user exits with the '#' key, or -1 if the user hangs up.
</para>
<formalpara><title>EnumLookup: Lookup number in ENUM</title>
<para>
! EnumLookup(exten)
</para>
</formalpara>
--- 507,516 ----
</para>
<para>
! Returns 0 if the user exits with the <keycap>#</keycap> key, or -1 if the user hangs up.
</para>
<formalpara><title>EnumLookup: Lookup number in ENUM</title>
<para>
! <function>EnumLookup(<replaceable>exten</replaceable>)</function>
</para>
</formalpara>
***************
*** 525,529 ****
A good SIP, H323, IAX or IAX2 entry will result in normal priority handling,
whereas a good TEL entry will increase the priority by 51 (if existing).
! If the lookup was *not* successful and there exists a priority n + 101,
then that priority will be taken next.
</para>
--- 529,533 ----
A good SIP, H323, IAX or IAX2 entry will result in normal priority handling,
whereas a good TEL entry will increase the priority by 51 (if existing).
! If the lookup was <emphasis role="strong">not</emphasis> successful and there exists a priority n + 101,
then that priority will be taken next.
</para>
***************
*** 532,535 ****
--- 536,540 ----
<formalpara><title>Festival: Say text to the user</title>
<para>
+ <!-- TODO: Shouldn't this say something about TTS somewhere in the description? -->
<function>Festival(<replaceable>text</replaceable>[|<replaceable>intkeys</replaceable>])</function>
</para>
***************
*** 581,589 ****
</formalpara>
<para>
! Set the priority to the specified
! value, optionally setting the extension and optionally the context as well.
! The extension BYEXTENSION is special in that it uses the current extension,
! thus permitting you to go to a different context, without specifying a
! specific extension.
</para>
<para>
--- 586,595 ----
</formalpara>
<para>
! <!-- TODO: Isn't BYEXTENSION deprecated? -->
! Set the priority to the specified value, optionally setting the
! extension and optionally the context as well. The extension
! <varname>BYEXTENSION</varname> is special in that it uses the
! current extension, thus permitting you to go to a different
! context, without specifying a specific extension.
</para>
<para>
***************
*** 621,629 ****
<formalpara><title>Hangup: Unconditional hangup</title>
<para>
! Hangup()
</para>
</formalpara>
<para>
Unconditionally hangs up a given channel.
</para>
<para>
--- 627,637 ----
<formalpara><title>Hangup: Unconditional hangup</title>
<para>
! <function>Hangup()</function>
</para>
</formalpara>
<para>
Unconditionally hangs up a given channel.
+ <!-- TODO: Shouldn't we have a warning about using SoftHangup() -->
+ <!-- instead of Hangup()? -->
</para>
<para>
***************
*** 637,642 ****
</formalpara>
<para>
! Branches to priority + 101, if there is new voicemail Optionally sets
! <emphasis>varname</emphasis> to the number of new messages.
</para>
--- 645,650 ----
</formalpara>
<para>
! Branches to priority + 101, if there is new voicemail. Optionally sets
! <replaceable>varname</replaceable> to the number of new messages.
</para>
***************
*** 655,665 ****
channel.
</para>
<informalexample>
<para>
- <!-- Does this example make *any* sense at all? -->
database put blacklist <name/number> 1
</para>
</informalexample>
! <formalpara><title>LookupCIDName: Look up CallerID Name from local database</title>
<para>
<function>LookupCIDName()</function>
--- 663,676 ----
channel.
</para>
+ <!-- Does this example make *any* sense at all? I'm going to -->
+ <!-- comment it out, because I think it's confusing -->
+ <!--
<informalexample>
<para>
database put blacklist <name/number> 1
</para>
</informalexample>
! -->
! <formalpara><title>LookupCIDName: Look up Caller*ID Name from local database</title>
<para>
<function>LookupCIDName()</function>
***************
*** 686,692 ****
'macro-<emphasis>macroname</emphasis>', jumping to the 's' extension of that context and
executing each step, then returning when the steps end. The calling
! extension, context, and priority are stored in ${MACRO_EXTEN},
! ${MACRO_CONTEXT} and ${MACRO_PRIORITY} respectively. Arguments become
! ${ARG1}, ${ARG2}, etc in the macro context. i
</para>
<para>
--- 697,707 ----
'macro-<emphasis>macroname</emphasis>', jumping to the 's' extension of that context and
executing each step, then returning when the steps end. The calling
! extension, context, and priority are stored in
! <varname>${MACRO_EXTEN}</varname>,
! <varname>${MACRO_CONTEXT}</varname> and
! <varname>${MACRO_PRIORITY}</varname> respectively.
! Arguments become
! <varname>${ARG1}</varname>, <varname>${ARG2}</varname>,
! etc. in the macro context.
</para>
<para>
***************
*** 694,698 ****
any step in the macro returns -1, and 0 otherwise. If you Goto out
of the Macro context, the Macro will terminate and control will be return
! at the location of the Goto. Otherwise if ${MACRO_OFFSET} is set at
termination, Macro will attempt to continue at priority
MACRO_OFFSET + N + 1 if such a step exists, and N + 1 otherwise.
--- 709,714 ----
any step in the macro returns -1, and 0 otherwise. If you Goto out
of the Macro context, the Macro will terminate and control will be return
! at the location of the Goto. Otherwise if
! <varname>${MACRO_OFFSET}</varname> is set at
termination, Macro will attempt to continue at priority
MACRO_OFFSET + N + 1 if such a step exists, and N + 1 otherwise.
***************
*** 716,732 ****
<para>
The option string may contain zero or more of the following characters:
! <simplelist>
! <member>'a' -- set admin mode</member>
! <member>'m' -- set monitor only mode</member>
! <member>'p' -- allow user to exit the conference by pressing '#'</member>
! <member>'s' -- send user to admin/user menu if '*' is received</member>
! <member>'t' -- set talk only mode</member>
! <member>'d' -- dynamically add conference</member>
! <member>'v' -- video mode</member>
! <member>'q' -- quiet mode (don't play enter/leave sounds)</member>
! <member>'M' -- enable music on hold when the conference has a single caller</member>
! <member>'b' -- run AGI script specified in ${MEETME_AGI_BACKGROUND} (Zap channels only)
! (does not work with non-Zap channels in the same conference)</member>
! </simplelist>
</para>
<!-- What does MeetMe return? Does it return? -->
--- 732,779 ----
<para>
The option string may contain zero or more of the following characters:
! <variablelist>
! <varlistentry><term>'a'</term>
! <listitem><para>
! set admin mode
! </para></listitem></varlistentry>
! <varlistentry><term>'m'</term>
! <listitem><para>
! set monitor only mode
! </para></listitem></varlistentry>
! <varlistentry><term>'p'</term>
! <listitem><para>
! allow user to exit the conference by pressing '#'
! </para></listitem></varlistentry>
! <varlistentry><term>'s'</term>
! <listitem><para>
! send user to admin/user menu if '*' is received
! </para></listitem></varlistentry>
! <varlistentry><term>'t'</term>
! <listitem><para>
! set talk only mode
! </para></listitem></varlistentry>
! <varlistentry><term>'d'</term>
! <listitem><para>
! dynamically add conference
! </para></listitem></varlistentry>
! <varlistentry><term>'v'</term>
! <listitem><para>
! video mode
! </para></listitem></varlistentry>
! <varlistentry><term>'q'</term>
! <listitem><para>
! quiet mode (don't play enter/leave sounds)
! </para></listitem></varlistentry>
! <varlistentry><term>'M'</term>
! <listitem><para>
! enable music on hold when the conference has a single caller
! </para></listitem></varlistentry>
! <varlistentry><term>'b'</term>
! <listitem><para>
! run AGI script specified in <varname>${MEETME_AGI_BACKGROUND}</varname>
! (Zap channels only) (does not work with non-Zap channels
! in the same conference)
! </para></listitem></varlistentry>
! </variablelist>
</para>
<!-- What does MeetMe return? Does it return? -->
***************
*** 752,756 ****
</para>
! <formalpara><title>Milliwatt: Generate a Constant 1000Hz tone at 0dbm (mu-law)</title>
<para>
<function>Milliwatt()</function>
--- 799,803 ----
</para>
! <formalpara><title>Milliwatt: Generate a Constant 1000Hz tone</title>
<para>
<function>Milliwatt()</function>
***************
*** 763,767 ****
<formalpara><title>Monitor: Monitor a channel</title>
<para>
! <function>Monitor([<replaceable>file_format</replaceable>|[<replaceable>fname_basei</replaceable>]])</function>
</para>
</formalpara>
--- 810,814 ----
<formalpara><title>Monitor: Monitor a channel</title>
<para>
! <function>Monitor([<replaceable>file_format</replaceable>|[<replaceable>filename_base</replaceable>]])</function>
</para>
</formalpara>
***************
*** 780,784 ****
</varlistentry>
! <varlistentry><term><emphasis>fname_base</emphasis></term>
<listitem>
<para>if set, changes the filename used to the one specified</para>
--- 827,831 ----
</varlistentry>
! <varlistentry><term><emphasis>filename_base</emphasis></term>
<listitem>
<para>if set, changes the filename used to the one specified</para>
***************
*** 793,799 ****
</formalpara>
<para>
! Executes <application>mpg123</application> to play the given location
! which typically would be a filename or a URL. User can exit by pressing
! any key.
</para>
<para>
--- 840,846 ----
</formalpara>
<para>
! Executes <application>mpg123</application> to play the given
! <replaceable>location</replaceable> which typically would be a
! filename or a URL. User can exit by pressing any key.
</para>
<para>
***************
*** 815,819 ****
</para>
! <formalpara><title>NoCDR: Make sure asterisk doesn't save CDR for a certain call</title>
<para>
<function>NoCDR()</function>
--- 862,866 ----
</para>
! <formalpara><title>NoCDR: Make sure Asterisk doesn't save CDR for a certain call</title>
<para>
<function>NoCDR()</function>
***************
*** 834,837 ****
--- 881,886 ----
<note>
<para>
+ <!-- TODO: Get somebody who can write in functional English -->
+ <!-- to write this so that it makes sense -->
Actually, <function>NoOp()</function> has one very useful side-effect. It prints the argument
to the Asterisk console. This can be very helpful when debugging.
***************
*** 847,851 ****
Park a call into the parking lot and announce the call over the console.
<variablelist>
! <varlistentry><term><emphasis>announce_template</emphasis></term>
<listitem>
<para>
--- 896,900 ----
Park a call into the parking lot and announce the call over the console.
<variablelist>
! <varlistentry><term><replaceable>announce_template</replaceable></term>
<listitem>
<para>
***************
*** 855,864 ****
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>timeout</emphasis></term>
<listitem>
<para>time in seconds before the call returns into the return context.</para>
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>dial</emphasis></term>
<listitem>
<para>
--- 904,913 ----
</listitem>
</varlistentry>
! <varlistentry><term><replaceable>timeout</replaceable></term>
<listitem>
<para>time in seconds before the call returns into the return context.</para>
</listitem>
</varlistentry>
! <varlistentry><term><replaceable>dial</replaceable></term>
<listitem>
<para>
***************
*** 868,872 ****
</listitem>
</varlistentry>
! <varlistentry><term><emphasis>return_context</emphasis></term>
<listitem>
<para>
--- 917,921 ----
</listitem>
</varlistentry>
! <varlistentry><term><replaceable>return_context</replaceable></term>
<listitem>
<para>
***************
*** 895,907 ****
</para>
</formalpara>
<para>
! Plays back a given filename (do not include the file extension).
Options may also be included following a pipe symbol. The only
! defined option at this time is 'skip', which causes the playback of the
! message to be skipped if the channel is not in the 'up' state (i.e. it
! hasn't been answered yet. If 'skip' is specified, the application will
! return immediately should the channel not be off hook. Otherwise, unless
! 'noanswer' is specified, the channel channel will be answered before the sound
! is played. Not all channels support playing messages while on hook.
</para>
<para>
--- 944,961 ----
</para>
</formalpara>
+ <!-- TODO: This says that 'skip' is the only uption, but then goes on to -->
+ <!-- say that 'noanswer' is also an option -->
<para>
! Plays back a given <replaceable>filename</replaceable>
! (do not include the file extension).
Options may also be included following a pipe symbol. The only
! defined <replaceable>option</replaceable> at this time is 'skip',
! which causes the playback of the message to be skipped
! if the channel is not in the 'up' state (i.e. it
! hasn't been answered yet. If 'skip' is specified, the application
! will return immediately should the channel not be off hook.
! Otherwise, unless 'noanswer' is specified, the channel channel
! will be answered before the sound is played. Not all channels
! support playing messages while on hook.
</para>
<para>
***************
*** 917,921 ****
</formalpara>
<para>
! Play a tone list, either registered (through indications.conf) or a direct
list of tones and durations.
</para>
--- 971,976 ----
</formalpara>
<para>
! Play a tone list, either registered
! (through <filename>indications.conf</filename>) or a direct
list of tones and durations.
</para>
***************
*** 927,940 ****
</formalpara>
<para>
! Prepends the digit string specified by digits to the
! channel's associated extension. For example, the number 1212 when prefixed
! with '555' will become 5551212. This app always returns 0, and the PBX will
! continue processing at the next priority for the *new* extension.
</para>
<para>
! For example, if priority 3 of extension 1212 is Prefix 555, the next step
! executed will be priority 4 of 5551212. If you switch into an extension
! which has no first step, the PBX will treat it as though the user dialed an
! invalid extension.
</para>
--- 982,1000 ----
</formalpara>
<para>
! Prepends the digit string specified by
! <replaceable>digits</replaceable> to the
! channel's associated extension. For example, the number 1212
! when prefixed with '555' will become 5551212.
</para>
<para>
! This app always returns 0, and the PBX will
! continue processing at the next priority for the
! <emphasis role="strong">new</emphasis> extension.
! </para>
! <para>
! For example, if priority 3 of extension 1212 is Prefix 555, the
! next step executed will be priority 4 of 5551212. If you switch
! into an extension which has no first step, the PBX will treat it
! as though the user dialed an invalid extension.
</para>
***************
*** 962,973 ****
<para>
Queues an incoming call in a particular call queue as defined in <filename>queues.conf</filename>.
! The <emphasis>option</emphasis> string may contain zero or more of the following characters:
! <simplelist>
! <member>'t' -- allow the called user transfer the calling user</member>
! <member>'T' -- to allow the calling user to transfer the call.</member>
! <member>'d' -- data-quality (modem) call (minimum delay).</member>
! <member>'H' -- allow caller to hang up by hitting *.</member>
! <member>'n' -- no retries on the timeout; will exit this application and go to the next step.</member>
! </simplelist>
In addition to transferring the call, a call may be parked and then
picked up by another user. The optional URL will be sent to the
--- 1022,1049 ----
<para>
Queues an incoming call in a particular call queue as defined in <filename>queues.conf</filename>.
! The <replaceable>option</replaceable> string may contain zero or more of the following characters:
! <variablelist>
! <varlistentry><term>t</term>
! <listitem><para>
! allow the called user transfer the calling user
! </para></listitem></varlistentry>
! <varlistentry><term>T</term>
! <listitem><para>
! to allow the calling user to transfer the call.
! </para></listitem></varlistentry>
! <varlistentry><term>d</term>
! <listitem><para>
! data-quality (modem) call (minimum delay).
! </para></listitem></varlistentry>
! <varlistentry><term>H</term>
! <listitem><para>
! allow caller to hang up by hitting *.
! </para></listitem></varlistentry>
! <varlistentry><term>n</term>
! <listitem><para>
! no retries on the timeout; will exit this application and
! go to the next step.
! </para></listitem></varlistentry>
! </variablelist>
In addition to transferring the call, a call may be parked and then
picked up by another user. The optional URL will be sent to the
***************
*** 985,992 ****
</para>
</formalpara>
!
<para>
! Reads a '#' terminated string of digits from
! the user, optionally playing a given filename first.
</para>
--- 1061,1069 ----
</para>
</formalpara>
! <!-- Shouldn't this explain that it saves the digits to 'variable'? -->
<para>
! Reads a <keycap>#</keycap> terminated string of digits from
! the user, optionally playing a given
! <replaceable>filename</replaceable> first.
</para>
***************
*** 1003,1010 ****
</formalpara>
<para>
! Records from the current channel into the given <emphasis>filename</emphasis>.
! If the file exists it will be overwritten. The <emphasis>extension</emphasis>
is the extension of the file type to be recorded (wav, gsm, etc).
! The <emphasis>silence</emphasis> argument is the number of seconds of
silence to allow before returning.
</para>
--- 1080,1087 ----
</formalpara>
<para>
! Records from the current channel into the given <replaceable>filename</replaceable>.
! If the file exists it will be overwritten. The <replaceable>extension</replaceable>
is the extension of the file type to be recorded (wav, gsm, etc).
! The <replaceable>silence</replaceable> argument is the number of seconds of
silence to allow before returning.
</para>
***************
*** 1025,1031 ****
</para>
<informalexample>
! <para>
! Example: RemoveQueueMember(techsupport|SIP/3000)
! </para>
</informalexample>
--- 1102,1109 ----
</para>
<informalexample>
! <programlisting>
! RemoveQueueMember(techsupport|SIP/3000)
! <lineannotation>;remove SIP/3000 from techsupport queue</lineannotation>
! </programlisting>
</informalexample>
***************
*** 1037,1042 ****
<para>
Causes the Call Data Record to be reset, optionally
! storing the current CDR before zeroing it out (if 'w' option is specifed).
! record WILL be stored.
</para>
<para>
--- 1115,1120 ----
<para>
Causes the Call Data Record to be reset, optionally
! storing the current CDR before zeroing it out (if 'w' option is
! specifed the record <emphasis role="strong">WILL</emphasis> be stored.
</para>
<para>
***************
*** 1054,1058 ****
begin typing an extension. If the user does not type an extension in this
amount of time, control will pass to the 't' extension if it exists, and
! if not the call would be terminated.
</para>
<para>
--- 1132,1136 ----
begin typing an extension. If the user does not type an extension in this
amount of time, control will pass to the 't' extension if it exists, and
! if not the call will be terminated.
</para>
<para>
***************
*** 1078,1082 ****
</formalpara>
<para>
! Says the passed digits. With this, if you insert a string of digits,
Asterisk will say the individual numbers.
<!-- TODO: Show the difference between this and SayNumber() -->
--- 1156,1161 ----
</formalpara>
<para>
! Says the passed <replaceable>digits</replaceable>. With this,
! if you insert a string of digits,
Asterisk will say the individual numbers.
<!-- TODO: Show the difference between this and SayNumber() -->
***************
*** 1089,1102 ****
<formalpara><title>SayNumber: Say Number</title>
<para>
! <function>SayNumber(<replaceable>digits</replaceable>)</function>
</para>
</formalpara>
<para>
! Says the passed number. With this, if you insert a string of digits,
Asterisk will say the number, and not the individual digits.
</para>
! <para>
! Example: SayNumber(12345) will be said as "Twelve-Thousand Three-Hundred Forty-Five".
! </para>
<formalpara><title>SayUnixTime: Says a specified time in a custom format</title>
--- 1168,1185 ----
<formalpara><title>SayNumber: Say Number</title>
<para>
! <function>SayNumber(<replaceable>number</replaceable>)</function>
</para>
</formalpara>
<para>
! Says the passed <replaceable>number</replaceable>. With this,
! if you insert a string of digits,
Asterisk will say the number, and not the individual digits.
</para>
! <informalexample>
! <para>
! Example: <programlisting>SayNumber(12345)</programlisting>
! will be said as "Twelve-Thousand Three-Hundred Forty-Five".
! </para>
! </informalexample>
<formalpara><title>SayUnixTime: Says a specified time in a custom format</title>
***************
*** 1108,1112 ****
<variablelist>
<varlistentry>
! <term><emphasis>unixtime</emphasis></term>
<listitem>
<para>
--- 1191,1195 ----
<variablelist>
<varlistentry>
! <term><replaceable>unixtime</replaceable></term>
<listitem>
<para>
***************
*** 1117,1124 ****
</varlistentry>
<varlistentry>
! <term><emphasis>timezone</emphasis></term>
<listitem>
<para>
! timezone, see /usr/share/zoneinfo for a list. defaults to machine default.
</para>
</listitem>
--- 1200,1208 ----
</varlistentry>
<varlistentry>
! <term><replaceable>timezone</replaceable></term>
<listitem>
<para>
! timezone, see <filename>/usr/share/zoneinfo</filename>
! for a list. Defaults to machine default.
</para>
</listitem>
***************
*** 1126,1133 ****
</varlistentry>
<varlistentry>
! <term><emphasis>format</emphasis></term>
<listitem>
<para>
! a format the time is to be said in. See voicemail.conf.
Defaults to "ABdY 'digits/at' IMp"
</para>
--- 1210,1218 ----
</varlistentry>
<varlistentry>
! <term><replaceable>format</replaceable></term>
<listitem>
<para>
! a format the time is to be said in.
! See <filename>voicemail.conf</filename>.
Defaults to "ABdY 'digits/at' IMp"
</para>
***************
*** 1181,1189 ****
</para>
<para>
! SendURL only returns 0 if the URL was sent correctly or if
the channel does not support HTML transport, and -1 otherwise.
If the option 'wait' is specified, execution will wait for an
acknowledgement that the URL has been loaded before continuing
! and will return -1 if the peer is unable to load the URL
</para>
--- 1266,1274 ----
</para>
<para>
! <function>SendURL()</function> only returns 0 if the URL was sent correctly or if
the channel does not support HTML transport, and -1 otherwise.
If the option 'wait' is specified, execution will wait for an
acknowledgement that the URL has been loaded before continuing
! and will return -1 if the peer is unable to load the URL.
</para>
***************
*** 1200,1206 ****
</para>
! <formalpara><title>SetCallerID: Set CallerID</title>
<para>
! <function>SetCallerID(<replaceable>clid</replaceable>[|<replaceable>a</replaceable>])</function>
</para>
</formalpara>
--- 1285,1291 ----
</para>
! <formalpara><title>SetCallerID: Set Caller*ID</title>
<para>
! <function>SetCallerID(<replaceable>callerid</replaceable>[|<replaceable>a</replaceable>])</function>
</para>
</formalpara>
***************
*** 1213,1217 ****
</para>
! <formalpara><title>SetCIDName: Set CallerID Name</title>
<para>
<replaceable>SetCIDName</replaceable>(<replaceable>cname</replaceable>[|<replaceable>a</replaceable>])
--- 1298,1302 ----
</para>
! <formalpara><title>SetCIDName: Set Caller*ID Name</title>
<para>
<replaceable>SetCIDName</replaceable>(<replaceable>cname</replaceable>[|<replaceable>a</replaceable>])
***************
*** 1228,1232 ****
</para>
! <formalpara><title>SetCIDNum: Set CallerID Number</title>
<para>
<function>SetCIDNum(<replaceable>cnum</replaceable>[|<replaceable>a</replaceable>])</function>
--- 1313,1317 ----
</para>
! <formalpara><title>SetCIDNum: Set Caller*ID Number</title>
<para>
<function>SetCIDNum(<replaceable>cnum</replaceable>[|<replaceable>a</replaceable>])</function>
***************
*** 1287,1303 ****
</formalpara>
<para>
! Sets variable n to value
</para>
<formalpara><title>SIPDtmfMode: Change the dtmfmode for a SIP call</title>
<para>
! <function>SIPDtmfMode(<replaceable>inband</replaceable>|info|rfc2833)</function>
</para>
</formalpara>
<para>
! The <replaceable>option</replaceable> argument can be one of 'inband', 'info', or 'rfc2883'.
</para>
<para>
! Changes the dtmfmode for a SIP call
</para>
--- 1372,1388 ----
</formalpara>
<para>
! Sets variable <replaceable>n</replaceable> to <replaceable>value</replaceable>
</para>
<formalpara><title>SIPDtmfMode: Change the dtmfmode for a SIP call</title>
<para>
! <function>SIPDtmfMode(<replaceable>option</replaceable>)</function>
</para>
</formalpara>
<para>
! Changes the dtmfmode for a SIP call
</para>
<para>
! The <replaceable>option</replaceable> argument can be one of 'inband', 'info', or 'rfc2883'.
</para>
***************
*** 1357,1361 ****
associated extension. For example, the number 5551212 when stripped with a
count of 3 would be changed to 1212. This app always returns 0, and the PBX
! will continue processing at the next priority for the *new* extension.
</para>
<para>
--- 1442,1446 ----
associated extension. For example, the number 5551212 when stripped with a
count of 3 would be changed to 1212. This app always returns 0, and the PBX
! will continue processing at the next priority for the <emphasis role="strong">new</emphasis> extension.
</para>
<para>
***************
*** 1395,1398 ****
--- 1480,1484 ----
<para>
If there are no parameters it'll return with -1.
+ <!-- TODO: This next line is a classic! Fix it! -->
If there wrong parameters it go on and return with 0
</para>
***************
*** 1407,1411 ****
channel's associated extension. For example, the number 555 when suffixed
with '1212' will become 5551212. This app always returns 0, and the PBX will
! continue processing at the next priority for the *new* extension.
</para>
<para>
--- 1493,1497 ----
channel's associated extension. For example, the number 555 when suffixed
with '1212' will become 5551212. This app always returns 0, and the PBX will
! continue processing at the next priority for the <emphasis role="strong">new</emphasis> extension.
</para>
<para>
***************
*** 1426,1430 ****
<para>
Returns -1 on
! failure to execute the specified command. If the command itself executes
but is in error, and if there exists a priority n + 101, where 'n' is the
priority of the current instance, then the channel will be setup to
--- 1512,1517 ----
<para>
Returns -1 on
! failure to execute the specified <replaceable>command</replaceable>.
! If the <replaceable>command</replaceable> itself executes
but is in error, and if there exists a priority n + 101, where 'n' is the
priority of the current instance, then the channel will be setup to
***************
*** 1444,1448 ****
Returns -1 on hangup, or 0 on completion
regardless of whether the transfer was successful. If the transfer
! was *not* supported or successful and there exists a priority n + 101,
then that priority will be taken next.
</para>
--- 1531,1535 ----
Returns -1 on hangup, or 0 on completion
regardless of whether the transfer was successful. If the transfer
! was <emphasis role="strong">not</emphasis> supported or successful and there exists a priority n + 101,
then that priority will be taken next.
</para>
***************
*** 1495,1499 ****
The <replaceable>mailbox</replaceable> can be passed as the option,
which will stop the voicemail system from prompting the user for the mailbox.
! If the mailbox is preceded by 's' then the password check will be skipped. If
a <replaceable>context</replaceable> is specified, logins are considered
in that context only.
--- 1582,1586 ----
The <replaceable>mailbox</replaceable> can be passed as the option,
which will stop the voicemail system from prompting the user for the mailbox.
! If the mailbox is preceded by <replaceable>s</replaceable> then the password check will be skipped. If
a <replaceable>context</replaceable> is specified, logins are considered
in that context only.
***************
*** 1549,1554 ****
</para>
<para>
! Options is a pipe-delimited list of options. The following options
! are available:
<variablelist>
<varlistentry>
--- 1636,1641 ----
</para>
<para>
! The <replaceable>options</replaceable> argument is a pipe-delimited
! list of options. The following options are available:
<variablelist>
<varlistentry>