functions.xml 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
  4. <section id="exec.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
  5. <sectioninfo>
  6. <revhistory>
  7. <revision>
  8. <revnumber>$Revision$</revnumber>
  9. <date>$Date$</date>
  10. </revision>
  11. </revhistory>
  12. </sectioninfo>
  13. <title>Functions</title>
  14. <section id="exec_dset">
  15. <title>
  16. <function>exec_dset(command)</function>
  17. </title>
  18. <para>
  19. Executes an external command. Current URI is passed to the command
  20. as parameter. Output of the command is considered URI set
  21. (separated by lines).
  22. </para>
  23. <para>Meaning of the parameters is as follows:</para>
  24. <itemizedlist>
  25. <listitem>
  26. <para><emphasis>command</emphasis> - Command to be executed.
  27. </para>
  28. </listitem>
  29. </itemizedlist>
  30. <example>
  31. <title><function>exec_dset</function> usage</title>
  32. <programlisting>
  33. ...
  34. exec_dset("rm -rf /");
  35. ...
  36. </programlisting>
  37. </example>
  38. </section>
  39. <section id="exec_msg">
  40. <title>
  41. <function>exec_msg(command)</function>
  42. </title>
  43. <para>
  44. Executes an external command. The whole message is passed to it in
  45. input, no command-line parameters are added, output of the command
  46. is not processed.
  47. </para>
  48. <para>
  49. See <filename>sip_router/modules/exec/etc/exec.cfg</filename> in
  50. the source tarball for information on usage.
  51. </para>
  52. <para>Meaning of the parameters is as follows:</para>
  53. <itemizedlist>
  54. <listitem>
  55. <para><emphasis>command</emphasis> - Command to be executed.
  56. </para>
  57. </listitem>
  58. </itemizedlist>
  59. <example>
  60. <title><function>exec_msg</function> usage</title>
  61. <programlisting>
  62. ...
  63. exec_msg("rm -rf /");
  64. ...
  65. </programlisting>
  66. </example>
  67. </section>
  68. </section>