From 21cb9fb28db1f2eb4ee770eb029bfe20233e4392 Mon Sep 17 00:00:00 2001
From: Sumit Bose <sbose@redhat.com>
Date: Thu, 12 Dec 2019 13:10:16 +0100
Subject: [PATCH] certmap: mention special regex characters in man page
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Since some of the matching rules use regular expressions some characters
must be escaped so that they can be used a ordinary characters in the
rules.

Related to https://pagure.io/SSSD/sssd/issue/4127

Reviewed-by: Michal Židek <mzidek@redhat.com>
---
 src/man/sss-certmap.5.xml | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/man/sss-certmap.5.xml b/src/man/sss-certmap.5.xml
index db258d14a..10343625e 100644
--- a/src/man/sss-certmap.5.xml
+++ b/src/man/sss-certmap.5.xml
@@ -92,6 +92,15 @@
                     <para>
                         Example: &lt;SUBJECT&gt;.*,DC=MY,DC=DOMAIN
                     </para>
+                    <para>
+                        Please note that the characters "^.[$()|*+?{\" have a
+                        special meaning in regular expressions and must be
+                        escaped with the help of the '\' character so that they
+                        are matched as ordinary characters.
+                    </para>
+                    <para>
+                        Example: &lt;SUBJECT&gt;^CN=.* \(Admin\),DC=MY,DC=DOMAIN$
+                    </para>
                     </listitem>
                 </varlistentry>
                 <varlistentry>
-- 
2.20.1