summaryrefslogtreecommitdiffstats
path: root/src/man
diff options
context:
space:
mode:
authorPavel Reichl <preichl@redhat.com>2014-03-11 10:36:29 +0000
committerJakub Hrozek <jhrozek@redhat.com>2014-03-13 18:36:44 +0100
commit64319158ab6a0e6df2bb03f4fde31668cceb082b (patch)
treedaefd29deda2abcc26b9d4aa48c3f56cd9e60e6a /src/man
parenta059f853074260f4b6a6ead1dca9f18280cb9cdb (diff)
downloadsssd-64319158ab6a0e6df2bb03f4fde31668cceb082b.tar.gz
sssd-64319158ab6a0e6df2bb03f4fde31668cceb082b.tar.xz
sssd-64319158ab6a0e6df2bb03f4fde31668cceb082b.zip
MAN: new general options section
Some options are relevant to multiple sections of sssd.conf. This patch adds new sections for those. Resolves: https://fedorahosted.org/sssd/ticket/2218 Reviewed-by: Sumit Bose <sbose@redhat.com>
Diffstat (limited to 'src/man')
-rw-r--r--src/man/sssd.conf.5.xml101
1 files changed, 62 insertions, 39 deletions
diff --git a/src/man/sssd.conf.5.xml b/src/man/sssd.conf.5.xml
index 9668bb0c0..4c5337606 100644
--- a/src/man/sssd.conf.5.xml
+++ b/src/man/sssd.conf.5.xml
@@ -55,6 +55,68 @@
</para>
</refsect1>
+ <refsect1 id='general-options'>
+ <title>GENERAL OPTIONS</title>
+ <para>
+ Following options are usable in more than one configuration
+ sections.
+ </para>
+ <refsect2 id='all-section-options'>
+ <title>Options usable in all sections</title>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>debug_level (integer)</term>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/debug_levels.xml" />
+ </varlistentry>
+ <varlistentry>
+ <term>debug_timestamps (bool)</term>
+ <listitem>
+ <para>
+ Add a timestamp to the debug messages
+ </para>
+ <para>
+ Default: true
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>debug_microseconds (bool)</term>
+ <listitem>
+ <para>
+ Add microseconds to the timestamp in debug messages
+ </para>
+ <para>
+ Default: false
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect2>
+
+ <refsect2 id='services-and-domains-section-options'>
+ <title>Options usable in SERVICE and DOMAIN sections</title>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>timeout (integer)</term>
+ <listitem>
+ <para>
+ Timeout in seconds between heartbeats for this
+ service. This is used to ensure that the process
+ is alive and capable of answering requests.
+ </para>
+ <para>
+ Default: 10
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect2>
+ </refsect1>
+
<refsect1 id='special-sections'>
<title>SPECIAL SECTIONS</title>
@@ -279,45 +341,6 @@
</para>
<variablelist>
<varlistentry>
- <term>debug_level (integer)</term>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/debug_levels.xml" />
- </varlistentry>
- <varlistentry>
- <term>debug_timestamps (bool)</term>
- <listitem>
- <para>
- Add a timestamp to the debug messages
- </para>
- <para>
- Default: true
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>debug_microseconds (bool)</term>
- <listitem>
- <para>
- Add microseconds to the timestamp in debug messages
- </para>
- <para>
- Default: false
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>timeout (integer)</term>
- <listitem>
- <para>
- Timeout in seconds between heartbeats for this
- service. This is used to ensure that the process
- is alive and capable of answering requests.
- </para>
- <para>
- Default: 10
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term>reconnection_retries (integer)</term>
<listitem>
<para>