sss_usermod.8.xml revision 9b3f37cb0c70c7b18c49b657e3799094a8711cad
<?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_usermod</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv id='name'>
<refname>sss_usermod</refname>
<refpurpose>modify a user account</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>sss_usermod</command>
<arg choice='opt'>
<replaceable>options</replaceable>
</arg>
<arg choice='plain'><replaceable>LOGIN</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
<command>sss_usermod</command> modifies the
account specified by <replaceable>LOGIN</replaceable>
to reflect the changes that are specified on the command line.
</para>
</refsect1>
<refsect1 id='options'>
<title>OPTIONS</title>
<variablelist remap='IP'>
<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>
The home directory of the user account.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-s</option>,<option>--shell</option>
<replaceable>SHELL</replaceable>
</term>
<listitem>
<para>
The user's login shell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-a</option>,<option>--append-group</option>
<replaceable>GROUPS</replaceable>
</term>
<listitem>
<para>
Append this user to groups specified by the
<replaceable>GROUPS</replaceable> parameter.
The <replaceable>GROUPS</replaceable> parameter
is a comma separated list of group names.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-r</option>,<option>--remove-group</option>
<replaceable>GROUPS</replaceable>
</term>
<listitem>
<para>
Remove this user from groups specified by the
<replaceable>GROUPS</replaceable> parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-l</option>,<option>--lock</option>
</term>
<listitem>
<para>
Lock the user account. The user won't be able
to log in.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-u</option>,<option>--unlock</option>
</term>
<listitem>
<para>
Unlock the user account.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-Z</option>,<option>--selinux-user</option>
<replaceable>SELINUX_USER</replaceable>
</term>
<listitem>
<para>
The SELinux user for the user's login.
</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/local.xml" />
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>sss_groupadd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sss_groupdel</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sss_groupshow</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sss_useradd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>.
</para>
</refsect1>
</refentry>
</reference>