update TODO

[elogind.git] / man / sysusers.d.xml

diff --git a/man/sysusers.d.xml b/man/sysusers.d.xml
index 00eb7ec942e0f60b62c41a93512eba75f3593348..18c71db63e737635eb213c4c12849f96862e1db2 100644 (file)
--- a/man/sysusers.d.xml
+++ b/man/sysusers.d.xml
@@ -77,13 +77,14 @@
                 configuration.</para>
 
                 <para>The file format is one line per user or group
                 configuration.</para>
 
                 <para>The file format is one line per user or group

-                containing name, ID and GECOS field description:</para>
+                containing name, ID, GECOS field description and home directory:</para>

 
                 <programlisting># Type Name ID GECOS
 u httpd 440 "HTTP User"
 u authd /usr/bin/authd "Authorization user"
 g input - -
 
                 <programlisting># Type Name ID GECOS
 u httpd 440 "HTTP User"
 u authd /usr/bin/authd "Authorization user"
 g input - -

-m authd input</programlisting>
+m authd input
+u root 0 "Superuser" /root</programlisting>

 
                 <refsect2>
                         <title>Type</title>
 
                 <refsect2>
                         <title>Type</title>


@@ -102,12 +103,14 @@ m authd input</programlisting>
                                         group will be set to the group
                                         bearing the same name. The
                                         user's shell will be set to
                                         group will be set to the group
                                         bearing the same name. The
                                         user's shell will be set to

-                                        <filename>/sbin/login</filename>,
-                                        the home directory to
-                                        <filename>/</filename>. The
-                                        account will be created
-                                        disabled, so that logins are
-                                        not allowed.</para></listitem>
+                                        <filename>/sbin/nologin</filename>,
+                                        the home directory to the
+                                        specified home directory, or
+                                        <filename>/</filename> if none
+                                        is given. The account will be
+                                        created disabled, so that
+                                        logins are not
+                                        allowed.</para></listitem>

                                 </varlistentry>
 
                                 <varlistentry>
                                 </varlistentry>
 
                                 <varlistentry>


@@ -131,6 +134,25 @@ m authd input</programlisting>
                                         will be implicitly
                                         created.</para></listitem>
                                 </varlistentry>
                                         will be implicitly
                                         created.</para></listitem>
                                 </varlistentry>

+
+                                <varlistentry>
+                                        <term><varname>r</varname></term>
+                                        <listitem><para>Add a range of
+                                        numeric UIDs/GIDs to the pool
+                                        to allocate new UIDs and GIDs
+                                        from. If no line of this type
+                                        is specified the range of
+                                        UIDs/GIDs is set to some
+                                        compiled-in default. Note that
+                                        both UIDs and GIDs are
+                                        allocated from the same pool,
+                                        in order to ensure that users
+                                        and groups of the same name
+                                        are likely to carry the same
+                                        numeric UID and
+                                        GID.</para></listitem>
+                                </varlistentry>
+

                         </variablelist>
                 </refsect2>
 
                         </variablelist>
                 </refsect2>
 


@@ -138,7 +160,7 @@ m authd input</programlisting>
                         <title>Name</title>
 
                         <para>The name field specifies the user or
                         <title>Name</title>
 
                         <para>The name field specifies the user or

-                        group name. It should be be shorter than 31
+                        group name. It should be shorter than 31

                         characters and avoid any non-ASCII characters,
                         and not begin with a numeric character. It is
                         strongly recommended to pick user and group
                         characters and avoid any non-ASCII characters,
                         and not begin with a numeric character. It is
                         strongly recommended to pick user and group


@@ -151,6 +173,10 @@ m authd input</programlisting>
                         <para>For <varname>m</varname> lines this
                         field should contain the user name to add to a
                         group.</para>
                         <para>For <varname>m</varname> lines this
                         field should contain the user name to add to a
                         group.</para>

+
+                        <para>For lines of type <varname>r</varname>
+                        this field should be set to
+                        <literal>-</literal>.</para>

                 </refsect2>
 
                 <refsect2>
                 </refsect2>
 
                 <refsect2>


@@ -160,8 +186,8 @@ m authd input</programlisting>
                         <varname>g</varname> the numeric 32bit UID or
                         GID of the user/group. Do not use IDs 65535 or
                         4294967295, as they have special placeholder
                         <varname>g</varname> the numeric 32bit UID or
                         GID of the user/group. Do not use IDs 65535 or
                         4294967295, as they have special placeholder

-                        meanings. Specify "-" for automatic UID/GID
-                        allocation for the user or
+                        meanings. Specify <literal>-</literal> for
+                        automatic UID/GID allocation for the user or

                         group. Alternatively, specify an absolute path
                         in the file system. In this case the UID/GID
                         is read from the path's owner/group. This is
                         group. Alternatively, specify an absolute path
                         in the file system. In this case the UID/GID
                         is read from the path's owner/group. This is


@@ -172,6 +198,14 @@ m authd input</programlisting>
                         <para>For <varname>m</varname> lines this
                         field should contain the group name to add to
                         a user to.</para>
                         <para>For <varname>m</varname> lines this
                         field should contain the group name to add to
                         a user to.</para>

+
+                        <para>For lines of type <varname>r</varname>
+                        this field should be set to a UID/GID range in
+                        the format <literal>FROM-TO</literal> where
+                        both values are formatted as decimal ASCII
+                        numbers. Alternatively, a single UID/GID may
+                        be specified formatted as decimal ASCII
+                        numbers.</para>

                 </refsect2>
 
                 <refsect2>
                 </refsect2>
 
                 <refsect2>


@@ -183,7 +217,24 @@ m authd input</programlisting>
 
                         <para>Only applies to lines of type
                         <varname>u</varname> and should otherwise be
 
                         <para>Only applies to lines of type
                         <varname>u</varname> and should otherwise be

-                        left unset.</para>
+                        left unset, or be set to
+                        <literal>-</literal>.</para>
+                </refsect2>
+
+                <refsect2>
+                        <title>Home Directory</title>
+
+                        <para>The home directory for a new system
+                        user. If omitted defaults to the root
+                        directory. It is recommended to not
+                        unnecessarily specify home directories for
+                        system users, unless software strictly
+                        requires one to be set.</para>
+
+                        <para>Only applies to lines of type
+                        <varname>u</varname> and should otherwise be
+                        left unset, or be set to
+                        <literal>-</literal>.</para>

                 </refsect2>
 
         </refsect1>
                 </refsect2>
 
         </refsect1>