Explorar o código

Exec module: Documentation update, typo fix

Olle E. Johansson %!s(int64=13) %!d(string=hai) anos
pai
achega
a30d64af62
Modificáronse 2 ficheiros con 15 adicións e 16 borrados
  1. 7 7
      modules_k/exec/README
  2. 8 9
      modules_k/exec/doc/exec_admin.xml

+ 7 - 7
modules_k/exec/README

@@ -71,10 +71,10 @@ Chapter 1. Admin Guide
 
 
 1. Overview
 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
      * SIP_HF_<hf_name> contains value of each header field in request. If
        a header field occurred multiple times, values are concatenated and
        a header field occurred multiple times, values are concatenated and
        comma-separated. <hf_name> is in capital letters. Ff a header-field
        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.
      * SIP_DID is dialog identifier, which is the same as to-tag.
        Initially, it is empty.
        Initially, it is empty.
      * SIP_SRCIP is source IP address from which request came.
      * 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_RURI is current request URI (if unchanged, equal to original).
      * SIP_USER is userpart of current request URI.
      * SIP_USER is userpart of current request URI.
      * SIP_OUSER is userpart of original 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
    $$SIP_OUSER) in the parameters given to exec functions. Otherwise they
    will be evaluated as Kamailio pseudo-variables, throwing errors.
    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])
 4.3. exec_avp(command [, avplist])
 
 
    Executes an external command. Each line from output of the command is
    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, ...
    named 1, 2, 3, ...
 
 
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:

+ 8 - 9
modules_k/exec/doc/exec_admin.xml

@@ -16,11 +16,10 @@
 	<section>
 	<section>
 	<title>Overview</title>
 	<title>Overview</title>
 	<para>
 	<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>
 	</para>
 	<itemizedlist>
 	<itemizedlist>
 		<listitem>
 		<listitem>
@@ -52,7 +51,7 @@
 		</listitem>
 		</listitem>
 		<listitem>
 		<listitem>
 		<para>
 		<para>
-			SIP_ORURI is original request &uri;.
+			SIP_ORURI is the original request &uri;.
 		</para>
 		</para>
 		</listitem>
 		</listitem>
 		<listitem>
 		<listitem>
@@ -73,7 +72,7 @@
 		</listitem>
 		</listitem>
 	</itemizedlist>
 	</itemizedlist>
 	<para>
 	<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.
 		(e.g., $$SIP_OUSER) in the parameters given to exec functions.
 		Otherwise they will be evaluated as &kamailio; pseudo-variables,
 		Otherwise they will be evaluated as &kamailio; pseudo-variables,
 		throwing errors.
 		throwing errors.
@@ -85,7 +84,7 @@
 	<section>
 	<section>
 		<title>&kamailio; Modules</title>
 		<title>&kamailio; Modules</title>
 		<para>
 		<para>
-		The following  modules must be loaded before this module:
+		The following modules must be loaded before this module:
 			<itemizedlist>
 			<itemizedlist>
 			<listitem>
 			<listitem>
 			<para>
 			<para>
@@ -238,7 +237,7 @@ exec_msg("echo TEST > /tmp/$rU.txt");
 		<para>
 		<para>
 		Executes an external command. Each line from output of the command
 		Executes an external command. Each line from output of the command
 		is saved in an AVP from 'avplist'. If 'avplist' is missing, the
 		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>
 		<para>Meaning of the parameters is as follows:</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
 		<itemizedlist>