summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPavel Březina <pbrezina@redhat.com>2016-07-04 12:19:37 +0200
committerJakub Hrozek <jhrozek@redhat.com>2016-07-07 19:22:04 +0200
commitdc6dd1ef6a70a0a07017d362e13c7680e83c4fc8 (patch)
tree46711ca68dcdbfbc94c3ebcebce1273ff58c4cac
parent8b2bd0587af6ed6bbd7eab7a332ec88de6b7c36c (diff)
downloadsssd-dc6dd1ef6a70a0a07017d362e13c7680e83c4fc8.zip
sssd-dc6dd1ef6a70a0a07017d362e13c7680e83c4fc8.tar.gz
sssd-dc6dd1ef6a70a0a07017d362e13c7680e83c4fc8.tar.xz
sssctl: manual page
Resolves: https://fedorahosted.org/sssd/ticket/3055 Reviewed-by: Michal Židek <mzidek@redhat.com> Reviewed-by: Lukáš Slebodník <lslebodn@redhat.com>
-rw-r--r--contrib/sssd.spec.in1
-rw-r--r--src/man/Makefile.am2
-rw-r--r--src/man/po/po4a.cfg1
-rw-r--r--src/man/sssctl.8.xml69
4 files changed, 72 insertions, 1 deletions
diff --git a/contrib/sssd.spec.in b/contrib/sssd.spec.in
index b8a9efc..d5730a4 100644
--- a/contrib/sssd.spec.in
+++ b/contrib/sssd.spec.in
@@ -950,6 +950,7 @@ done
%{_mandir}/man8/sss_override.8*
%{_mandir}/man8/sss_debuglevel.8*
%{_mandir}/man8/sss_seed.8*
+%{_mandir}/man8/sssctl.8*
%files -n python-sssdconfig -f python2_sssdconfig.lang
%defattr(-,root,root,-)
diff --git a/src/man/Makefile.am b/src/man/Makefile.am
index 433d1cd..cd23b02 100644
--- a/src/man/Makefile.am
+++ b/src/man/Makefile.am
@@ -51,7 +51,7 @@ man_MANS = \
sssd-krb5.5 sssd-simple.5 \
sssd_krb5_locator_plugin.8 sss_groupshow.8 \
pam_sss.8 sss_obfuscate.8 sss_cache.8 sss_debuglevel.8 sss_seed.8 \
- sss_override.8 idmap_sss.8 \
+ sss_override.8 idmap_sss.8 sssctl.8 \
$(NULL)
if BUILD_SAMBA
diff --git a/src/man/po/po4a.cfg b/src/man/po/po4a.cfg
index ca9d66a..2a51731 100644
--- a/src/man/po/po4a.cfg
+++ b/src/man/po/po4a.cfg
@@ -27,6 +27,7 @@
[type:docbook] sss_ssh_authorizedkeys.1.xml $lang:$(builddir)/$lang/sss_ssh_authorizedkeys.1.xml
[type:docbook] sss_ssh_knownhostsproxy.1.xml $lang:$(builddir)/$lang/sss_ssh_knownhostsproxy.1.xml
[type:docbook] idmap_sss.8.xml $lang:$(builddir)/$lang/idmap_sss.8.xml
+[type:docbook] sssctl.8.xml $lang:$(builddir)/$lang/sssctl.8.xml
[type:docbook] include/service_discovery.xml $lang:$(builddir)/$lang/include/service_discovery.xml opt:"-k 0"
[type:docbook] include/upstream.xml $lang:$(builddir)/$lang/include/upstream.xml opt:"-k 0"
[type:docbook] include/failover.xml $lang:$(builddir)/$lang/include/failover.xml opt:"-k 0"
diff --git a/src/man/sssctl.8.xml b/src/man/sssctl.8.xml
new file mode 100644
index 0000000..721d0a2
--- /dev/null
+++ b/src/man/sssctl.8.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<reference>
+<title>SSSD Manual pages</title>
+<refentry>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />
+
+ <refmeta>
+ <refentrytitle>sssctl</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv id='name'>
+ <refname>sssctl</refname>
+ <refpurpose>SSSD control and status utility</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>sssctl</command>
+ <arg choice='plain'><replaceable>COMMAND</replaceable></arg>
+ <arg choice='opt'>
+ <replaceable>options</replaceable>
+ </arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>sssctl</command> provides simple and unified way to obtain
+ information about SSSD status such as active server or list of
+ auto-discovered servers and domains or information about cached
+ objects. It also provides tools to manage SSSD data files during
+ troubleshooting such as a safe way to remove cache files or fetching
+ all SSSD log files and more.
+ </para>
+ </refsect1>
+
+ <refsect1 id='commands'>
+ <title>AVAILABLE COMMANDS</title>
+ <para>
+ To list all available commands run <command>sssctl</command>
+ without any parameter. To print help for selected command
+ run <command>sssctl COMMAND --help</command>.
+ </para>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>COMMON OPTIONS</title>
+ <para>
+ Those options are available with all commands.
+ </para>
+ <variablelist remap='IP'>
+ <varlistentry>
+ <term>
+ <option>--debug</option>
+ <replaceable>LEVEL</replaceable>
+ </term>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/debug_levels.xml" />
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />
+
+</refentry>
+</reference>