浏览代码

modules: readme files regenerated - modules ... [skip ci]

Kamailio Dev 1 年之前
父节点
当前提交
825b36557b
共有 2 个文件被更改,包括 48 次插入22 次删除
  1. 13 0
      src/modules/smsops/README
  2. 35 22
      src/modules/textopsx/README

+ 13 - 0
src/modules/smsops/README

@@ -33,6 +33,8 @@ Carsten Bock
               4.1. isRPDATA()
               4.2. smsdump()
 
+        5. Variables
+
    List of Examples
 
    1.1. isRPDATA() usage
@@ -57,6 +59,8 @@ Chapter 1. Admin Guide
         4.1. isRPDATA()
         4.2. smsdump()
 
+   5. Variables
+
 1. Overview
 
    This module collects the Transformations for 3GPP-SMS.
@@ -115,3 +119,12 @@ if (isRPDATA())
 ...
 smsdump();
 ...
+
+5. Variables
+
+   Several variables are exported by the module to access the attributes
+   of the SMS.
+     * $smsack
+       $smsbody
+       $rpdata(key)
+       $tpdu(key)

+ 35 - 22
src/modules/textopsx/README

@@ -731,27 +731,38 @@ bl_iterator_end("b1");
 
 3.1. @hf_value
 
-   Get value of required header-value or param. Note that functions called
-   'value2' works with Authorization-like headers where comma is not
-   treated as value delimiter. Formats: @hf_value.HFNAME[IDX] # idx value,
-   negative value counts from bottom @hf_value.HFNAME.PARAM_NAME
-   @hf_value.HFNAME[IDX].PARAM_NAME @hf_value.HFNAME.p.PARAM_NAME # or
-   .param., useful if required called "uri", "p", "param"
-   @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto @hf_value.HFNAME[IDX].uri #
-   (< & > excluded) @hf_value.HFNAME[*] # return comma delimited list of
-   all values (combines headers) @hf_value.HFNAME # the same as above [*]
-   but may be parsed by cfg.y @hf_value.HFNAME[*].uri # return comma
-   delimited list of uris (< & > excluded) @hf_value.HFNAME.uri # the same
-   as above [*] but may be parsed by cfg.y @hf_value.HFNAME[IDX].name #
-   returns name part, quotes excluded @hf_value.HFNAME.name # returns name
-   part of the first value @hf_value2.HFNAME # returns value of first
-   header @hf_value2.HFNAME[IDX] # returns value of idx's header
-   @hf_value2.HFNAME.PARAM_NAME @hf_value2.HFNAME[IDX].PARAM_NAME
-   @hf_value.HFNAME[IDX].uri # return URI, quotes excluded
-   @hf_value.HFNAME.p.uri # returns param named uri, not URI itself
-   @hf_value.HFNAME.p.name # returns param named name, not name itself
-   @hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features may be
-   used @hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr
+   Get value of required header-value or param. Note that selects called
+   'hf_value2' work with Authorization-like headers where comma is not
+   treated as value delimiter.
+
+   Formats:
+     * @hf_value.HFNAME[IDX] # idx value, negative value counts from
+       bottom
+     * @hf_value.HFNAME.PARAM_NAME
+     * @hf_value.HFNAME[IDX].PARAM_NAME
+     * @hf_value.HFNAME.p.PARAM_NAME # or .param., useful if required
+       called "uri", "p", "param"
+     * @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto
+     * @hf_value.HFNAME[IDX].uri # (< & > excluded)
+     * @hf_value.HFNAME[*] # return comma delimited list of all values
+       (combines headers)
+     * @hf_value.HFNAME # the same as above [*] but may be parsed by cfg.y
+     * @hf_value.HFNAME[*].uri # return comma delimited list of uris (< &
+       > excluded)
+     * @hf_value.HFNAME.uri # the same as above [*] but may be parsed by
+       cfg.y
+     * @hf_value.HFNAME[IDX].name # returns name part, quotes excluded
+     * @hf_value.HFNAME.name # returns name part of the first value
+     * @hf_value2.HFNAME # returns value of first header
+     * @hf_value2.HFNAME[IDX] # returns value of idx's header
+     * @hf_value2.HFNAME.PARAM_NAME
+     * @hf_value2.HFNAME[IDX].PARAM_NAME
+     * @hf_value.HFNAME[IDX].uri # return URI, quotes excluded
+     * @hf_value.HFNAME.p.uri # returns param named uri, not URI itself
+     * @hf_value.HFNAME.p.name # returns param named name, not name itself
+     * @hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features
+       may be used
+     * @hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr
 
    Meaning of the parameters is as follows:
      * HFNAME - Header field name. Underscores are treated as dashes.
@@ -772,7 +783,9 @@ $prt = @hf_value2.authorization.integrity_protected;
 
 3.2. @hf_value2
 
-   TBA.
+   Similar to selects called 'hf_value', but work with Authorization-like
+   headers where comma is treated as attribute delimiter instead of header
+   value delimiter.
 
 3.3. @hf_value_exists