summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Hrozek <jhrozek@redhat.com>2012-04-16 10:38:05 +0200
committerStephen Gallagher <sgallagh@redhat.com>2012-04-20 10:55:15 -0400
commit9b3f37cb0c70c7b18c49b657e3799094a8711cad (patch)
tree72eaa432724a51525ff9818ddd0dfedc871fcfff
parent9d7d4458d94d0aac0a7edf999368eb18f89cb76a (diff)
downloadsssd-9b3f37cb0c70c7b18c49b657e3799094a8711cad.tar.gz
sssd-9b3f37cb0c70c7b18c49b657e3799094a8711cad.tar.xz
sssd-9b3f37cb0c70c7b18c49b657e3799094a8711cad.zip
Document sss_tools better
https://fedorahosted.org/sssd/ticket/917
-rw-r--r--src/man/include/local.xml20
-rw-r--r--src/man/po/po4a.cfg1
-rw-r--r--src/man/sss_groupadd.8.xml2
-rw-r--r--src/man/sss_groupdel.8.xml2
-rw-r--r--src/man/sss_groupmod.8.xml2
-rw-r--r--src/man/sss_groupshow.8.xml2
-rw-r--r--src/man/sss_useradd.8.xml2
-rw-r--r--src/man/sss_userdel.8.xml2
-rw-r--r--src/man/sss_usermod.8.xml2
9 files changed, 35 insertions, 0 deletions
diff --git a/src/man/include/local.xml b/src/man/include/local.xml
new file mode 100644
index 000000000..913ed8265
--- /dev/null
+++ b/src/man/include/local.xml
@@ -0,0 +1,20 @@
+<refsect1 id='local'>
+ <title>THE LOCAL DOMAIN</title>
+ <para>
+ In order to function correctly, a domain with
+ <quote>id_provider=local</quote> must be created and the SSSD must
+ be running.
+ </para>
+ <para>
+ The administrator might want to use the SSSD local users instead
+ of traditional UNIX users in cases where the group nesting (see
+ <citerefentry>
+ <refentrytitle>sss_groupadd</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>) is needed. The local users are also useful for
+ testing and development of the SSSD without having to deploy
+ a full remote server. The <command>sss_user*</command> and
+ <command>sss_group*</command> tools use a local LDB storage to
+ store users and groups.
+ </para>
+</refsect1>
diff --git a/src/man/po/po4a.cfg b/src/man/po/po4a.cfg
index 3e5af7421..e0f835d4c 100644
--- a/src/man/po/po4a.cfg
+++ b/src/man/po/po4a.cfg
@@ -26,3 +26,4 @@
[type:docbook] include/param_help.xml $lang:$(builddir)/$lang/include/param_help.xml opt:"-k 0"
[type:docbook] include/debug_levels.xml $lang:$(builddir)/$lang/include/debug_levels.xml opt:"-k 0"
[type:docbook] include/experimental.xml $lang:$(builddir)/$lang/include/experimental.xml opt:"-k 0"
+[type:docbook] include/local.xml $lang:$(builddir)/$lang/include/local.xml opt:"-k 0"
diff --git a/src/man/sss_groupadd.8.xml b/src/man/sss_groupadd.8.xml
index 15b7ea5ac..16fb99bfe 100644
--- a/src/man/sss_groupadd.8.xml
+++ b/src/man/sss_groupadd.8.xml
@@ -54,6 +54,8 @@
</variablelist>
</refsect1>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/local.xml" />
+
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
diff --git a/src/man/sss_groupdel.8.xml b/src/man/sss_groupdel.8.xml
index 978fc7368..1003fbf37 100644
--- a/src/man/sss_groupdel.8.xml
+++ b/src/man/sss_groupdel.8.xml
@@ -42,6 +42,8 @@
</variablelist>
</refsect1>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/local.xml" />
+
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
diff --git a/src/man/sss_groupmod.8.xml b/src/man/sss_groupmod.8.xml
index b2226e2e6..34874e66e 100644
--- a/src/man/sss_groupmod.8.xml
+++ b/src/man/sss_groupmod.8.xml
@@ -68,6 +68,8 @@
</variablelist>
</refsect1>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/local.xml" />
+
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
diff --git a/src/man/sss_groupshow.8.xml b/src/man/sss_groupshow.8.xml
index cb1046b9c..bfc6b371f 100644
--- a/src/man/sss_groupshow.8.xml
+++ b/src/man/sss_groupshow.8.xml
@@ -54,6 +54,8 @@
</variablelist>
</refsect1>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/local.xml" />
+
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
diff --git a/src/man/sss_useradd.8.xml b/src/man/sss_useradd.8.xml
index 70998f8e6..2520e95e1 100644
--- a/src/man/sss_useradd.8.xml
+++ b/src/man/sss_useradd.8.xml
@@ -163,6 +163,8 @@
</variablelist>
</refsect1>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/local.xml" />
+
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
diff --git a/src/man/sss_userdel.8.xml b/src/man/sss_userdel.8.xml
index b37718c6c..4ba46d2d1 100644
--- a/src/man/sss_userdel.8.xml
+++ b/src/man/sss_userdel.8.xml
@@ -89,6 +89,8 @@
</variablelist>
</refsect1>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/local.xml" />
+
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
diff --git a/src/man/sss_usermod.8.xml b/src/man/sss_usermod.8.xml
index 2b4370856..ff8469be9 100644
--- a/src/man/sss_usermod.8.xml
+++ b/src/man/sss_usermod.8.xml
@@ -134,6 +134,8 @@
</variablelist>
</refsect1>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/local.xml" />
+
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>