emo/shadow
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

Improve groupadd and useradd manpage

Browse Source 
Signed-off-by: Serge Hallyn <serge@hallyn.com>
This commit is contained in:
Markus Hiereth 2022-03-06 18:48:22 -06:00 committed by Serge Hallyn
parent 5f88f2cca7
commit 3a091d5def
2 changed files with 38 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
man/groupadd.8.xml
View File

@ -48,10 +48,10 @@
<cmdsynopsis> <cmdsynopsis>
<command>groupadd</command> <command>groupadd</command>
<arg choice='opt'> <arg choice='opt'>
<replaceable>options</replaceable> <replaceable>OPTIONS</replaceable>
</arg> </arg>
<arg choice='plain'> <arg choice='plain'>
<replaceable>group</replaceable> <replaceable>NEWGROUP</replaceable>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -63,6 +63,15 @@
values from the system. The new group will be entered into the system values from the system. The new group will be entered into the system
files as needed. files as needed.
</para> </para>
<para>
Groupnames must start with a lower case letter or an underscore,
followed by lower case letters, digits, underscores, or dashes.
They can end with a dollar sign.
In regular expression terms: [a-z_][a-z0-9_-]*[$]?
</para>
<para>
Groupnames may only be up to &GROUP_NAME_MAX_LENGTH; characters long.
</para>
</refsect1> </refsect1>
<refsect1 id='options'> <refsect1 id='options'>
@ -91,8 +100,8 @@
<option>-g</option>, <option>--gid</option>&nbsp;<replaceable>GID</replaceable> <option>-g</option>, <option>--gid</option>&nbsp;<replaceable>GID</replaceable>
</term> </term>
<listitem> <listitem>
<para>The numerical value of the group's ID. This value must be <para>The numerical value of the group's ID. <replaceable>GID</replaceable>
unique, unless the <option>-o</option> option is used. The value must be unique, unless the <option>-o</option> option is used. The value
must be non-negative. The default is to use the smallest ID must be non-negative. The default is to use the smallest ID
value greater than or equal to <option>GID_MIN</option> and value greater than or equal to <option>GID_MIN</option> and
greater than every other group. greater than every other group.
@ -135,7 +144,10 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This option permits to add a group with a non-unique GID. permits the creation of a group with an already used
numerical ID. As a result, for this
<replaceable>GID</replaceable>, the mapping towards group
<replaceable>NEWGROUP</replaceable> may not be unique.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -145,9 +157,15 @@
</term> </term>
<listitem> <listitem>
<para> <para>
The encrypted password, as returned by <citerefentry> defines an initial password for the group account. PASSWORD is expected to
<refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum> be encrypted, as returned by <citerefentry><refentrytitle>crypt
</citerefentry>. The default is to disable the password. </refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>
<para>
Without this option, the group account will be locked and
with no password defined, i.e. a single exclamation mark
in the respective field of ths system account file
<filename>/etc/group</filename> or <filename>/etc/gshadow</filename>.
</para> </para>
<para> <para>
<emphasis role="bold">Note:</emphasis> This option is not <emphasis role="bold">Note:</emphasis> This option is not
@ -194,13 +212,11 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Apply changes in the <replaceable>PREFIX_DIR</replaceable> Apply changes to configuration files under the root filesystem
directory and use the configuration files from the found under the directory <replaceable>PREFIX_DIR</replaceable>.
<replaceable>PREFIX_DIR</replaceable> directory. This option does not chroot and is intended for preparing a cross-compilation
This option does not chroot and is intended for preparing target. Some limitations: NIS and LDAP users/groups are
a cross-compilation target. not verified. PAM authentication is using the host files.
Some limitations: NIS and LDAP users/groups are not verified.
PAM authentication is using the host files.
No SELINUX support. No SELINUX support.
</para> </para>
</listitem> </listitem>
@ -264,15 +280,6 @@
<refsect1 id='caveats'> <refsect1 id='caveats'>
<title>CAVEATS</title> <title>CAVEATS</title>
<para>
Groupnames must start with a lower case letter or an underscore,
followed by lower case letters, digits, underscores, or dashes.
They can end with a dollar sign.
In regular expression terms: [a-z_][a-z0-9_-]*[$]?
</para>
<para>
Groupnames may only be up to &GROUP_NAME_MAX_LENGTH; characters long.
</para>
<para> <para>
You may not add a NIS or LDAP group. This must be performed on the You may not add a NIS or LDAP group. This must be performed on the
corresponding server. corresponding server.

12
man/useradd.8.xml
View File

@ -484,13 +484,11 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Apply changes in the <replaceable>PREFIX_DIR</replaceable> Apply changes to configuration files under the root filesystem
directory and use the configuration files from the found under the directory <replaceable>PREFIX_DIR</replaceable>.
<replaceable>PREFIX_DIR</replaceable> directory. This option does not chroot and is intended for preparing a cross-compilation
This option does not chroot and is intended for preparing target. Some limitations: NIS and LDAP users/groups are
a cross-compilation target. not verified. PAM authentication is using the host files.
Some limitations: NIS and LDAP users/groups are not verified.
PAM authentication is using the host files.
No SELINUX support. No SELINUX support.
</para> </para>
</listitem> </listitem>