diff options
author | Pavel Březina <pbrezina@redhat.com> | 2016-07-04 12:19:37 +0200 |
---|---|---|
committer | Jakub Hrozek <jhrozek@redhat.com> | 2016-07-07 19:22:04 +0200 |
commit | dc6dd1ef6a70a0a07017d362e13c7680e83c4fc8 (patch) | |
tree | 46711ca68dcdbfbc94c3ebcebce1273ff58c4cac /src/man/sssctl.8.xml | |
parent | 8b2bd0587af6ed6bbd7eab7a332ec88de6b7c36c (diff) | |
download | sssd-dc6dd1ef6a70a0a07017d362e13c7680e83c4fc8.tar.gz sssd-dc6dd1ef6a70a0a07017d362e13c7680e83c4fc8.tar.xz sssd-dc6dd1ef6a70a0a07017d362e13c7680e83c4fc8.zip |
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>
Diffstat (limited to 'src/man/sssctl.8.xml')
-rw-r--r-- | src/man/sssctl.8.xml | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/src/man/sssctl.8.xml b/src/man/sssctl.8.xml new file mode 100644 index 000000000..721d0a2f7 --- /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> |