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

src/modules/rtpengine/README

@@ -461,8 +461,8 @@ Chapter 1. Admin Guide
    of nodes. There is no locking when setting the nodes enabled/disabled
    (to keep the memory access as fast as possible). Thus, problems related
    to node state might appear for concurrent processes that might set the
-   nodes enabled/disabled(e.g. by fifo command). These robustness problems
-   are overcome as follows.
+   nodes enabled/disabled (e.g. by fifo command). These robustness
+   problems are overcome as follows.
 
    If the current process sees the selected node as disabled, the node is
    force tested before the current process actually accepts the disabled
@@ -490,7 +490,7 @@ Chapter 1. Admin Guide
    The following modules must be loaded before this module:
      * tm module - (optional) if you want to have rtpengine_manage() fully
        functional
-       lwsc module - (optional) if you plan to use “wsapi” parameter
+     * lwsc module - (optional) if you plan to use “wsapi” parameter
 
 3.2. External Libraries or Applications
 
@@ -665,7 +665,7 @@ modparam("rtpengine", "rtpengine_tout_ms", 2000)
 
    Nodes can be manually deactivated via kamctl command i.e.
    "disabled(permanent)" nodes. Probably the manually deactivated machine
-   is still running(did not crash).
+   is still running (did not crash).
 
    This is useful when deactivating a node for maintenance and reject new
    sessions but allow current ones to finish.
@@ -849,7 +849,7 @@ modparam("rtpengine", "hash_table_size", 123)
    the insert/remove/lookup path.
 
    NOTE: When configuring this parameter, one should consider maximum call
-   time VS share memory for unfinished calls.
+   time VS shared memory for unfinished calls.
 
    Example 1.15. Set hash_table_tout parameter
 ...
@@ -996,8 +996,9 @@ modparam("rtpengine", "media_duration", "$avp(MEDIA_DURATION)")
 
 4.24. mos_min_pv (string)
 
-   The name of a pseudovariable to hold the minimum encountered MOS value
-   for the call. The value typically has a range of 1.0 through 5.0.
+   The name of a pseudovariable to hold the minimum encountered MOS (Mean
+   Opinion Score) value for the call. The value typically has a range of
+   1.0 through 5.0.
 
    There is no default value.
 
@@ -1987,9 +1988,9 @@ modparam("rtpengine", "control_cmd_tos", 144)
 4.78. hash_algo (integer)
 
    Hashing algorithm to be used in node selection algorithm. Now there are
-   2 possibilities: legacy algorithm - 0(very basic hash over callid),
-   SHA1 - 1(apply sha1 over the callid and calculate hash) or CRC32 -
-   2(calculate crc32 sum over the callid).
+   3 possibilities: legacy algorithm - 0 (very basic hash over callid),
+   SHA1 - 1 (apply sha1 over the callid and calculate hash) or CRC32 - 2
+   (calculate crc32 sum over the callid).
 
    Default value is 0, legacy algorithm.
 
@@ -2150,7 +2151,7 @@ rtpengine_offer();
             different m-lines with different IP-protocols grouped
             together.
           + force - instructs the RTP proxy to ignore marks inserted by
-            another RTP proxy in transit to indicate that the session is
+            another RTP proxy in transit to indicate that the session
             already goes through another proxy. Allows creating a chain of
             proxies. Not supported and ignored by Sipwise rtpengine.
           + trust-address - flags that IP address in SDP should be
@@ -2276,6 +2277,17 @@ rtpengine_offer();
             SDES-authenticated_srtp - the opposites of the flags above.
             Useful if accepting these parameters is not desired and they
             should be rejected instead.
+          + SDES-nonew - don't add any new crypto suites into the offer.
+            This means, offered SDES crypto suites will be accepted,
+            meanwhile no new is going to be generated by RTPEngine. It
+            takes precedence over the `SDES-no` and `SDES-only` flags, if
+            used in combination.
+          + SDES-pad - RFC 4568 (section 6.1) is somewhat ambiguous
+            regarding the base64 encoding format of `a=crypto` parameters
+            added to an SDP body. The default interpretation is that
+            trailing `=` characters used for padding should be omitted.
+            With this flag set, these padding characters will be left in
+            place.
           + unidirectional - allows kernelization of one-way streams in
             the Sipwise rtpengine proxy. This is especially useful when
             the first call leg is handled by some rtpengine machine while
@@ -2316,7 +2328,7 @@ rtpengine_offer();
           + T.38=decode - If the offered SDP contains a media section
             advertising T.38 over UDPTL, translate it to a regular audio
             media section over RTP. By default, PCMU and PCMA will be used
-            as audio codecs, but that can be overriden using the codec
+            as audio codecs, but that can be overridden using the codec
             options described above. Other transport protocols (e.g. SRTP)
             can also be selected in the same way. If the offered SDP does
             not contain a T.38 section, then this flag has no effect.
@@ -2802,8 +2814,8 @@ $ kamcmd rtpengine.reload
    to it. If it fails, the proxy is not enabled. Displays success or fail
    when try to enable/disable.
 
-   NOTE: If a RTP proxy is defined multiple times (in the same or diferent
-   sets), all of its instances will be enabled/disabled.
+   NOTE: If a RTP proxy is defined multiple times (in the same or
+   different sets), all of its instances will be enabled/disabled.
 
    NOTE: If a RTP proxy is in the disabled permanent state and one tries
    to enable it, even if the ping fails, it is moved to a disabled