Document the -k, --skel option, and update the -m, --create-home documentation.

This commit is contained in:
nekral-guest 2008-05-19 21:32:19 +00:00
parent 7ab3a97dfe
commit a071d72e48
3 changed files with 36 additions and 12 deletions

View File

@ -1,3 +1,8 @@
2008-05-19 Nicolas François <nicolas.francois@centraliens.net>
* NEWS, man/useradd.8.xml: Document the -k, --skel option, and
update the -m, --create-home documentation.
2008-05-19 Nicolas François <nicolas.francois@centraliens.net>
* man/useradd.8.xml: Sort options.

1
NEWS
View File

@ -27,6 +27,7 @@ shadow-4.1.1 -> shadow-4.1.2 UNRELEASED
manpages.
- Document the -c, --crypt-method and -s, --sha-rounds options in the
newusers manpage.
- Document the -k, --skel option in the useradd manpage.
shadow-4.1.0 -> shadow-4.1.1 02-04-2008

View File

@ -183,21 +183,23 @@
</varlistentry>
<varlistentry>
<term>
<option>-m</option>, <option>--create-home</option>
<option>-k</option>, <option>--skel</option>
<replaceable>SKEL_DIR</replaceable>
</term>
<listitem>
<para>
The user's home directory will be created if it does not exist.
The files contained in <replaceable>SKEL_DIR</replaceable> will
be copied to the home directory if the <option>-k</option>
option is used, otherwise the files contained in
<filename>/etc/skel</filename> will be used instead. Any
directories contained in <replaceable>SKEL_DIR</replaceable> or
<filename>/etc/skel</filename> will be created in the user's
home directory as well. The <option>-k</option> option is only
valid in conjunction with the <option>-m</option> option. The
default is to not create the directory and to not copy any
files.
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>useradd</command>.
</para>
<para>
This option is only valid if the <option>-m</option> (or
<option>--create-home</option>) option is specified.
</para>
<para>
If this option is not set, the skeleton directory is defined
in <filename>/etc/default/useradd</filename> or, by default,
<filename>/etc/skel</filename>.
</para>
</listitem>
</varlistentry>
@ -241,6 +243,22 @@
</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 <option>-k</option> option)
will be copied to the home directory.
</para>
<para>
By default, no home directories are created.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-N</option>, <option>--no-user-group</option>