[sr-dev] git:master:385fdc71: exec: docs for exec_cmd() function

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 385fdc71abd0b4f8349f725273bccd483d859088
URL: https://github.com/kamailio/kamailio/commit/385fdc71abd0b4f8349f725273bccd483d859088

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-01-28T08:20:32+01:00

exec: docs for exec_cmd() function

---

Modified: src/modules/exec/doc/exec_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/385fdc71abd0b4f8349f725273bccd483d859088.diff
Patch: https://github.com/kamailio/kamailio/commit/385fdc71abd0b4f8349f725273bccd483d859088.patch

---

diff --git a/src/modules/exec/doc/exec_admin.xml b/src/modules/exec/doc/exec_admin.xml
index 51667fb60d..12249d5104 100644
--- a/src/modules/exec/doc/exec_admin.xml
+++ b/src/modules/exec/doc/exec_admin.xml
@@ -267,6 +267,41 @@ exec_msg("echo TEST > /tmp/$rU.txt");
 exec_avp("echo TEST");
 exec_avp("echo TEST", "$avp(s:test)");
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="exec.f.exec_cmd">
+		<title>
+		<function moreinfo="none">exec_cmd(command)</function>
+		</title>
+		<para>
+			Executes an external command. It is a lightweight version, which
+			does not pass the SIP message as parameter, does not set the
+			environment variables and it does not use the output of the command.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para><emphasis>command</emphasis> - Command to be executed. It
+			can include pseudo-variables.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		WARNING: if the var you are passing out has a bash special
+		character in it, the var needs to be placed inside quotes, for example:
+		exec_msg("print-contact.sh '$ct'");
+		</para>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function moreinfo="none">exec_cmd</function> usage</title>
+		<programlisting format="linespecific">
+...
+exec_cmd("echo TEST > /tmp/test.txt");
+exec_cmd("echo TEST > /tmp/$rU.txt");
+...
 </programlisting>
 		</example>
 	</section>
@@ -274,8 +309,8 @@ exec_avp("echo TEST", "$avp(s:test)");
 	<section id="exec.known_issues">
 	<title>Known Issues</title>
 	<para>
-		There is currently no guarantee that scripts ever return and stop 
-		blocking the &sip; server. (There is kill.c but it is not used along with 
+		There is currently no guarantee that scripts ever return and stop
+		blocking the &sip; server. (There is kill.c but it is not used along with
 		the current mechanisms based on popen. Besides that kill.c is ugly).
 	</para>
 	</section>