Browse code

textops: docs update to state regex params expect posix format

Daniel-Constantin Mierla authored on 05/10/2021 07:56:33
Showing 1 changed files
... ...
@@ -19,9 +19,15 @@
19 19
 		The module implements text based operations over the SIP message
20 20
 		processed by &kamailio;. SIP is a text based protocol and the module
21 21
 		provides a large set of very useful functions to manipulate the
22
-		message at text level, e.g., regular expression search and replace,
23
-		Perl-like substitutions, checks for method type, header presence,
24
-		insert of new header and date, etc.
22
+		message at text level, e.g., regular expression search, replace
23
+		or substitutions, checks for method type, header presence,
24
+		insert of new header and date, string comparisons, multi-part body
25
+		operations, etc.
26
+	</para>
27
+	<para>
28
+		If not stated otherwise, the regular expressions parameters for search,
29
+		replace or substitute have to be in POSIX format. For PCRE regular
30
+		expression matching, see the pcre or dialplan modules.
25 31
 	</para>
26 32
 	</section>
27 33
 	<section>
... ...
@@ -591,7 +597,7 @@ replace_hdrs_str("&kamailio;", "&kamailio; SIP Proxy", "a");
591 597
 		<function moreinfo="none">subst('/re/repl/flags')</function>
592 598
 		</title>
593 599
 		<para>
594
-		Replaces re with repl (sed or perl like).
600
+		Replaces re with repl.
595 601
 		</para>
596 602
 		<para>Meaning of the parameters is as follows:</para>
597 603
 		<itemizedlist>
... ...
@@ -728,7 +734,7 @@ if (subst_user('/(.*)3642$/$avp(user_prefix)\13642/')){$
728 734
 		<function moreinfo="none">subst_body('/re/repl/flags')</function>
729 735
 		</title>
730 736
 		<para>
731
-		Replaces re with repl (sed or perl like) in the body of the message.
737
+		Replaces re with repl in the body of the message.
732 738
 		</para>
733 739
 		<para>Meaning of the parameters is as follows:</para>
734 740
 		<itemizedlist>
... ...
@@ -768,7 +774,7 @@ if ( subst_body('/^o=(.*) /o=$fU /') ) {};
768 774
 		<function moreinfo="none">subst_hf(hf, subexp, flags)</function>
769 775
 		</title>
770 776
 		<para>
771
-		Perl-like substitutions in the body of a header field.
777
+		Substitutions in the body of a header field.
772 778
 		</para>
773 779
 		<para>Meaning of the parameters is as follows:</para>
774 780
 		<itemizedlist>