[sr-dev] git:master: Exec module: Documentation update, typo fix

Olle E. Johansson oej at edvina.net
Tue Nov 13 15:45:43 CET 2012


Module: sip-router
Branch: master
Commit: a30d64af62684c8bba61bbb842209046daab97d5
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a30d64af62684c8bba61bbb842209046daab97d5

Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date:   Tue Nov 13 15:45:18 2012 +0100

Exec module: Documentation update, typo fix

---

 modules_k/exec/README             |   14 +++++++-------
 modules_k/exec/doc/exec_admin.xml |   17 ++++++++---------
 2 files changed, 15 insertions(+), 16 deletions(-)

diff --git a/modules_k/exec/README b/modules_k/exec/README
index f821e77..0b7c1da 100644
--- a/modules_k/exec/README
+++ b/modules_k/exec/README
@@ -71,10 +71,10 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   Exec module allows to start an external command from a Kamailio script.
-   The commands may be any valid shell commands--the command string is
-   passed to shell using "popen" command. Kamailio passes additionally lot
-   of information about request in environment variables:
+   The exec module allows external commands to be executed from a Kamailio
+   script. The commands may be any valid shell commands--the command
+   string is passed to the shell using "popen" command. Kamailio passes
+   additional information about the request in environment variables:
      * SIP_HF_<hf_name> contains value of each header field in request. If
        a header field occurred multiple times, values are concatenated and
        comma-separated. <hf_name> is in capital letters. Ff a header-field
@@ -85,12 +85,12 @@ Chapter 1. Admin Guide
      * SIP_DID is dialog identifier, which is the same as to-tag.
        Initially, it is empty.
      * SIP_SRCIP is source IP address from which request came.
-     * SIP_ORURI is original request URI.
+     * SIP_ORURI is the original request URI.
      * SIP_RURI is current request URI (if unchanged, equal to original).
      * SIP_USER is userpart of current request URI.
      * SIP_OUSER is userpart of original request URI.
 
-   NOTE: The envirnment variables must be specified with double $ (e.g.,
+   NOTE: The environment variables must be specified with double $ (e.g.,
    $$SIP_OUSER) in the parameters given to exec functions. Otherwise they
    will be evaluated as Kamailio pseudo-variables, throwing errors.
 
@@ -193,7 +193,7 @@ exec_msg("echo TEST > /tmp/$rU.txt");
 4.3. exec_avp(command [, avplist])
 
    Executes an external command. Each line from output of the command is
-   saved in an AVP from 'avplist'. If 'avplist' is missing, the AVP are
+   saved in an AVP from 'avplist'. If 'avplist' is missing, the AVPs are
    named 1, 2, 3, ...
 
    Meaning of the parameters is as follows:
diff --git a/modules_k/exec/doc/exec_admin.xml b/modules_k/exec/doc/exec_admin.xml
index 632bb52..45ae097 100644
--- a/modules_k/exec/doc/exec_admin.xml
+++ b/modules_k/exec/doc/exec_admin.xml
@@ -16,11 +16,10 @@
 	<section>
 	<title>Overview</title>
 	<para>
-		Exec module allows to start an external command from a &kamailio; script. 
-		The commands may be any valid shell commands--the command string is 
-		passed to shell using <quote>popen</quote> command. &kamailio; passes 
-		additionally lot of information about request in environment
-		variables:
+		The exec module allows external commands to be executed from a &kamailio; 
+		script. The commands may be any valid shell commands--the command string is 
+		passed to the shell using <quote>popen</quote> command. &kamailio; passes 
+		additional information about the request in environment variables:
 	</para>
 	<itemizedlist>
 		<listitem>
@@ -52,7 +51,7 @@
 		</listitem>
 		<listitem>
 		<para>
-			SIP_ORURI is original request &uri;.
+			SIP_ORURI is the original request &uri;.
 		</para>
 		</listitem>
 		<listitem>
@@ -73,7 +72,7 @@
 		</listitem>
 	</itemizedlist>
 	<para>
-		NOTE: The envirnment variables must be specified with double $
+		NOTE: The environment variables must be specified with double $
 		(e.g., $$SIP_OUSER) in the parameters given to exec functions.
 		Otherwise they will be evaluated as &kamailio; pseudo-variables,
 		throwing errors.
@@ -85,7 +84,7 @@
 	<section>
 		<title>&kamailio; Modules</title>
 		<para>
-		The following  modules must be loaded before this module:
+		The following modules must be loaded before this module:
 			<itemizedlist>
 			<listitem>
 			<para>
@@ -238,7 +237,7 @@ exec_msg("echo TEST > /tmp/$rU.txt");
 		<para>
 		Executes an external command. Each line from output of the command
 		is saved in an AVP from 'avplist'. If 'avplist' is missing, the
-		AVP are named 1, 2, 3, ...
+		AVPs are named 1, 2, 3, ...
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>




More information about the sr-dev mailing list