Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
46 lines (32 sloc) 1.6 KB
layout title published tags
data functions

[%CFEngine_function_prototype(string, regex, replacement, options)%]

Description: In a given string, replaces a regular expression with something else.

[%CFEngine_function_attributes(string, regex, replacement, options)%]

The supported options are single letters you place in the options string in any order. Consult for the exact meaning of the uppercase options, and note that some can be turned on inside the regular expression, e.g. (?s).

  • i: case-insensitive
  • m: multiline (PCRE_MULTILINE)
  • s: dot matches newlines too (PCRE_DOTALL)
  • x: extended regular expressions (PCRE_EXTENDED, very nice for readability)
  • U: ungreedy (PCRE_UNGREEDY)
  • T: disables special characters and backreferences in the replacement string

In the replacement, $1 and \1 refer to the first capture group. $2 and \2 refer to the second, and so on, except there is no \10 or higher, you have to use $10 etc.

In addition, $+ is replaced with the capture count. $' (dollar sign + single quote) is the part of the string after the regex match. $` (dollar sign + backtick) is the part of the string before the regex match. $& holds the entire regex match.


[%CFEngine_include_snippet(, #+begin_src cfengine3, .*end_src)%]


[%CFEngine_include_snippet(, #+begin_src\s+example_output\s*, .*end_src)%]

History: Was introduced in version 3.8.0 (2015)

See also: data_regextract() regextract()

You can’t perform that action at this time.