From 930b8d8442c3ee88ad088d45e744510a5f815187 Mon Sep 17 00:00:00 2001
From: Pavel Březina <pbrezina@redhat.com>
Date: Tue, 9 Aug 2011 12:50:10 +0200
Subject: New DEBUG facility - man pages

https://fedorahosted.org/sssd/ticket/925

Modified sssd and sssd.conf man pages to reflect new levels.
Added new man include: include/debug_levels.xml
---
 src/man/include/debug_levels.xml | 60 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 src/man/include/debug_levels.xml

(limited to 'src/man/include/debug_levels.xml')

diff --git a/src/man/include/debug_levels.xml b/src/man/include/debug_levels.xml
new file mode 100644
index 00000000..ce506405
--- /dev/null
+++ b/src/man/include/debug_levels.xml
@@ -0,0 +1,60 @@
+<listitem>
+    <para>
+        Bit mask that indicates which debug levels will be visible. 0x0010 is the default value as well
+        as the lowest allowed value, 0xFFF0 is the most verbose mode. This setting
+        overrides the settings from config file.
+    </para>
+    <para>
+        Currently supported debug levels:
+    </para>
+    <para>
+         <emphasis>0x0010</emphasis>:
+         Fatal failures. Anything that would prevent SSSD from starting up or causes it to cease running.
+    </para>
+    <para>
+         <emphasis>0x0020</emphasis>:
+         Critical failures. An error that doesn't kill the SSSD, but one that indicates
+         that at least one major feature is not going to work properly.
+    </para>
+    <para>
+         <emphasis>0x0040</emphasis>: Serious failures. An error announcing that a particular request or
+         operation has failed.
+    </para>
+    <para>
+         <emphasis>0x0080</emphasis>: Minor failures. These are the errors that would percolate down to
+         cause the operation failure of 2.
+    </para>
+    <para>
+         <emphasis>0x0100</emphasis>: Configuration settings.
+    </para>
+    <para>
+         <emphasis>0x0200</emphasis>: Function data.
+    </para>
+    <para>
+         <emphasis>0x0400</emphasis>: Trace messages for operation functions.
+    </para>
+    <para>
+         <emphasis>0x1000</emphasis>: Trace messages for internal control functions.
+    </para>
+    <para>
+         <emphasis>0x2000</emphasis>: Contents of function-internal variables that may be interesting.
+    </para>
+    <para>
+         <emphasis>0x4000</emphasis>: Extremely low-level tracing information.
+    </para>
+    <para>
+        To log required debug levels, simply add their numbers together as shown in following examples:
+    </para>
+    <para>
+        <emphasis>Example</emphasis>: To log fatal failures, critical failures,
+        serious failures and function data use 0x0270.
+    </para>
+    <para>
+        <emphasis>Example</emphasis>: To log fatal failures, configuration settings, function data,
+        trace messages for internal control functions use 0x1310.
+    </para>
+    <para>
+        <emphasis>Note</emphasis>: This is new format of debug levels introduced in 1.7.0.
+        Older format (numbers from 0-10) is compatible but deprecated.
+    </para>
+</listitem>
-- 
cgit