summaryrefslogtreecommitdiff
path: root/server/man/sss_useradd.8.xml
diff options
context:
space:
mode:
Diffstat (limited to 'server/man/sss_useradd.8.xml')
-rw-r--r--server/man/sss_useradd.8.xml191
1 files changed, 0 insertions, 191 deletions
diff --git a/server/man/sss_useradd.8.xml b/server/man/sss_useradd.8.xml
deleted file mode 100644
index 7620ffda..00000000
--- a/server/man/sss_useradd.8.xml
+++ /dev/null
@@ -1,191 +0,0 @@
-<?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_useradd</refentrytitle>
- <manvolnum>8</manvolnum>
- </refmeta>
-
- <refnamediv id='name'>
- <refname>sss_useradd</refname>
- <refpurpose>create a new user</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv id='synopsis'>
- <cmdsynopsis>
- <command>sss_useradd</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_useradd</command> creates a new user account using
- the values specified on the command line plus the default values from
- the system.
- </para>
- </refsect1>
-
- <refsect1 id='options'>
- <title>OPTIONS</title>
- <variablelist remap='IP'>
- <varlistentry>
- <term>
- <option>-u</option>,<option>--uid</option>
- <replaceable>UID</replaceable>
- </term>
- <listitem>
- <para>
- Set the UID of the user to the value of <replaceable>UID</replaceable>.
- If not given, it is chosen automatically.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-g</option>,<option>--gid</option>
- <replaceable>GID</replaceable>
- </term>
- <listitem>
- <para>
- Set the GID or group membership of the user to the value
- of <replaceable>GID</replaceable>. If not given, it is
- chosen automatically.
- </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>
- The home directory of the user account.
- The default is to append the <replaceable>LOGIN</replaceable> name
- to <filename>/home</filename> and use that as the home directory.
- The base that is prepended before <replaceable>LOGIN</replaceable> is tunable
- with <quote>user_defaults/baseDirectory</quote> setting in sssd.conf.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-s</option>,<option>--shell</option>
- <replaceable>SHELL</replaceable>
- </term>
- <listitem>
- <para>
- The user's login shell. The default is currently <filename>/bin/bash</filename>.
- The default can be changed with
- <quote>user_defaults/defaultShell</quote> setting
- in sssd.conf.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-G</option>,<option>--groups</option>
- <replaceable>GROUPS</replaceable>
- </term>
- <listitem>
- <para>
- A list of existing groups this user is also a member of.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-m</option>,<option>--create-home</option>
- </term>
- <listitem>
- <para>
- Create the user's home directory if it does not
- exist. The files and directories contained in the
- skeleton directory (which can be defined with the
- -k option or in the config file) will be copied
- to the home directory.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-M</option>,<option>--no-create-home</option>
- </term>
- <listitem>
- <para>
- Do not create the user's home directory. Overrides
- configuration settings.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-k</option>,<option>--skel</option>
- <replaceable>SKELDIR</replaceable>
- </term>
- <listitem>
- <para>
- The skeleton directory, which contains files
- and directories to be copied in the user's home
- directory, when the home directory is
- created by <command>sss_useradd</command>.
- </para>
- <para>
- This option is only valid if the <option>-m</option>
- (or <option>--create-home</option>) option is
- specified, or creation of home directories is set to TRUE
- in the configuration.
- </para>
- </listitem>
- </varlistentry>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
- </variablelist>
- </refsect1>
-
- <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_groupshow</refentrytitle><manvolnum>8</manvolnum>
- </citerefentry>,
- <citerefentry>
- <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum>
- </citerefentry>,
- <citerefentry>
- <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum>
- </citerefentry>,
- <citerefentry>
- <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum>
- </citerefentry>.
- </para>
- </refsect1>
-</refentry>
-</reference>