summaryrefslogtreecommitdiffstats
path: root/src/man
diff options
context:
space:
mode:
authorNick Guay <nguay@redhat.com>2012-08-01 12:17:55 -0400
committerJakub Hrozek <jhrozek@redhat.com>2012-08-01 21:14:17 +0200
commit6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8 (patch)
tree2fa5fe47f80d028b862682769c01d22d8b07bdf8 /src/man
parent39b20025db12d88cd564666b3de0dbe0ce09ff2c (diff)
downloadsssd_unused-6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8.zip
sssd_unused-6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8.tar.gz
sssd_unused-6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8.tar.xz
First-boot sss_seed tool
Diffstat (limited to 'src/man')
-rw-r--r--src/man/Makefile.am2
-rw-r--r--src/man/include/seealso.xml5
-rw-r--r--src/man/po/po4a.cfg1
-rw-r--r--src/man/sss_seed.8.xml165
4 files changed, 171 insertions, 2 deletions
diff --git a/src/man/Makefile.am b/src/man/Makefile.am
index 4ed76c8..eb87980 100644
--- a/src/man/Makefile.am
+++ b/src/man/Makefile.am
@@ -42,7 +42,7 @@ man_MANS = \
sssd.8 sssd.conf.5 sssd-ldap.5 \
sssd-krb5.5 sssd-ipa.5 sssd-simple.5 sssd-ad.5 \
sssd_krb5_locator_plugin.8 sss_groupshow.8 \
- pam_sss.8 sss_obfuscate.8 sss_cache.8 sss_debuglevel.8
+ pam_sss.8 sss_obfuscate.8 sss_cache.8 sss_debuglevel.8 sss_seed.8
if BUILD_SSH
man_MANS += sss_ssh_authorizedkeys.1 sss_ssh_knownhostsproxy.1
diff --git a/src/man/include/seealso.xml b/src/man/include/seealso.xml
index 80c228e..3763e9a 100644
--- a/src/man/include/seealso.xml
+++ b/src/man/include/seealso.xml
@@ -59,6 +59,9 @@
<refentrytitle>sss_obfuscate</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
+ <refentrytitle>sss_seed</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
<refentrytitle>sssd_krb5_locator_plugin</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<phrase condition="with_ssh">
@@ -78,4 +81,4 @@
<refentrytitle>pam_sss</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>.
</para>
- </refsect1> \ No newline at end of file
+ </refsect1>
diff --git a/src/man/po/po4a.cfg b/src/man/po/po4a.cfg
index 1f05c7a..e20b713 100644
--- a/src/man/po/po4a.cfg
+++ b/src/man/po/po4a.cfg
@@ -20,6 +20,7 @@
[type:docbook] sss_usermod.8.xml $lang:$(builddir)/$lang/sss_usermod.8.xml
[type:docbook] sss_cache.8.xml $lang:$(builddir)/$lang/sss_cache.8.xml
[type:docbook] sss_debuglevel.8.xml $lang:$(builddir)/$lang/sss_debuglevel.8.xml
+[type:docbook] sss_seed.8.xml $lang:$(builddir)/$lang/sss_seed.8.xml
[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] include/service_discovery.xml $lang:$(builddir)/$lang/include/service_discovery.xml opt:"-k 0"
diff --git a/src/man/sss_seed.8.xml b/src/man/sss_seed.8.xml
new file mode 100644
index 0000000..e83b610
--- /dev/null
+++ b/src/man/sss_seed.8.xml
@@ -0,0 +1,165 @@
+<?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>sss_seed</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv id='name'>
+ <refname>sss_seed</refname>
+ <refpurpose>seed the SSSD cache with a user</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>sss_seed</command>
+ <arg choice='opt'>
+ <replaceable>options</replaceable>
+ </arg>
+ <arg choice='plain'>-D <replaceable>DOMAIN</replaceable></arg>
+ <arg choice='plain'>-n <replaceable>USER</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>sss_seed</command> seeds the SSSD cache with a user entry
+ and temporary password. If a user entry is already present in the
+ SSSD cache then the entry is updated with the temporary password.
+ </para>
+ <para>
+ </para>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>OPTIONS</title>
+ <variablelist remap='IP'>
+ <varlistentry>
+ <term>
+ <option>-D</option>,<option>--domain</option>
+ <replaceable>DOMAIN</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Provide the name of the domain in which the
+ user is a member of. The domain is also used to
+ retrieve user information. The domain must be configured
+ in sssd.conf. The <replaceable>DOMAIN</replaceable>
+ option must be provided.
+ Information retrieved from the domain
+ overrides what is provided in the options.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-n</option>,<option>--username</option>
+ <replaceable>USER</replaceable>
+ </term>
+ <listitem>
+ <para>
+ The username of the entry to be created or modified
+ in the cache. The <replaceable>USER</replaceable> option
+ must be provided.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-u</option>,<option>--uid</option>
+ <replaceable>UID</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Set the UID of the user to
+ <replaceable>UID</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-g</option>,<option>--gid</option>
+ <replaceable>GID</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Set the GID of the user to
+ <replaceable>GID</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-c</option>,<option>--gecos</option>
+ <replaceable>COMMENT</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Any text string describing the user. Often used as
+ the field for the user's full name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-h</option>,<option>--home</option>
+ <replaceable>HOME_DIR</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Set the home directory of the user to
+ <replaceable>HOME_DIR</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-s</option>,<option>--shell</option>
+ <replaceable>SHELL</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Set the login shell of the user to
+ <replaceable>SHELL</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-i</option>,<option>--interactive</option>
+ </term>
+ <listitem>
+ <para>
+ Interactive mode for entering user information. This
+ option will only prompt for information not provided in
+ the options or retrieved from the domain.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-p</option>,<option>--password-file</option>
+ <replaceable>PASS_FILE</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Specify file to read user's password from. (if not
+ specified password is prompted for)
+ </para>
+ </listitem>
+ </varlistentry>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
+ </variablelist>
+ </refsect1>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />
+
+</refentry>
+</reference>