granicus.if.org Git - shadow/blob - man/usermod.8.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    Copyright (c) 1991 - 1994, Julianne Frances Haugh
   4    Copyright (c) 2007 - 2009, Nicolas François
   5    All rights reserved.
   6
   7    Redistribution and use in source and binary forms, with or without
   8    modification, are permitted provided that the following conditions
   9    are met:
  10    1. Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15    3. The name of the copyright holders or contributors may not be used to
  16       endorse or promote products derived from this software without
  17       specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
  23    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 -->
  31 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  32   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  33 <!ENTITY MAIL_DIR              SYSTEM "login.defs.d/MAIL_DIR.xml">
  34 <!ENTITY MAX_MEMBERS_PER_GROUP SYSTEM "login.defs.d/MAX_MEMBERS_PER_GROUP.xml">
  35 <!ENTITY TCB_SYMLINKS          SYSTEM "login.defs.d/TCB_SYMLINKS.xml">
  36 <!ENTITY USE_TCB               SYSTEM "login.defs.d/USE_TCB.xml">
  37 ]>
  38 <refentry id='usermod.8'>
  39   <!--  $Id$  -->
  40   <refmeta>
  41     <refentrytitle>usermod</refentrytitle>
  42     <manvolnum>8</manvolnum>
  43     <refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
  44   </refmeta>
  45   <refnamediv id='name'>
  46     <refname>usermod</refname>
  47     <refpurpose>modify a user account</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv id='synopsis'>
  51     <cmdsynopsis>
  52       <command>usermod</command>
  53       <arg choice='opt'>
  54         <replaceable>options</replaceable>
  55       </arg>
  56       <arg choice='plain'><replaceable>LOGIN</replaceable></arg>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59
  60   <refsect1 id='description'>
  61     <title>DESCRIPTION</title>
  62     <para>
  63       The <command>usermod</command> command modifies the system account
  64       files to reflect the changes that are specified on the command line.
  65     </para>
  66   </refsect1>
  67
  68   <refsect1 id='options'>
  69     <title>OPTIONS</title>
  70     <para>
  71       The options which apply to the <command>usermod</command> command
  72       are:
  73     </para>
  74     <variablelist>
  75       <varlistentry>
  76         <term>
  77           <option>-a</option>, <option>--append</option>
  78         </term>
  79         <listitem>
  80           <para>
  81             Add the user to the supplementary group(s). Use only with the
  82             <option>-G</option> option.
  83           </para>
  84         </listitem>
  85       </varlistentry>
  86       <varlistentry>
  87         <term>
  88           <option>-c</option>, <option>--comment</option>
  89           <replaceable>COMMENT</replaceable>
  90         </term>
  91         <listitem>
  92           <para>
  93             The new value of the user's password file comment field. It is
  94             normally modified using the <citerefentry>
  95             <refentrytitle>chfn</refentrytitle><manvolnum>1</manvolnum>
  96             </citerefentry> utility.
  97           </para>
  98         </listitem>
  99       </varlistentry>
 100       <varlistentry>
 101         <term>
 102           <option>-d</option>, <option>--home</option>
 103           <replaceable>HOME_DIR</replaceable>
 104         </term>
 105         <listitem>
 106           <para>
 107             The user's new login directory.
 108           </para>
 109           <para>
 110             If the <option>-m</option>
 111             option is given, the contents of the current home directory will
 112             be moved to the new home directory, which is created if it does
 113             not already exist.
 114           </para>
 115         </listitem>
 116       </varlistentry>
 117       <varlistentry>
 118         <term>
 119           <option>-e</option>, <option>--expiredate</option>
 120           <replaceable>EXPIRE_DATE</replaceable>
 121         </term>
 122         <listitem>
 123           <para>
 124             The date on which the user account will be disabled. The date is
 125             specified in the format <emphasis remap='I'>YYYY-MM-DD</emphasis>.
 126           </para>
 127         </listitem>
 128       </varlistentry>
 129       <varlistentry>
 130         <term>
 131           <option>-f</option>, <option>--inactive</option>
 132           <replaceable>INACTIVE</replaceable>
 133         </term>
 134         <listitem>
 135           <para>
 136             The number of days after a password expires until the account is
 137             permanently disabled.
 138           </para>
 139           <para>
 140             A value of 0 disables the account as soon
 141             as the password has expired, and a value of -1 disables the
 142             feature.
 143           </para>
 144         </listitem>
 145       </varlistentry>
 146       <varlistentry>
 147         <term>
 148           <option>-g</option>, <option>--gid</option>
 149           <replaceable>GROUP</replaceable>
 150         </term>
 151         <listitem>
 152           <para>
 153             The group name or number of the user's new initial login group.
 154             The group must exist.
 155           </para>
 156         </listitem>
 157       </varlistentry>
 158       <varlistentry>
 159         <term>
 160           <option>-G</option>, <option>--groups</option>
 161           <replaceable>GROUP1</replaceable>[<emphasis remap='I'>,GROUP2,...</emphasis>[<emphasis remap='I'>,GROUPN</emphasis>]]]
 162         </term>
 163         <listitem>
 164           <para>
 165             A list of supplementary groups which the user is also a member
 166             of. Each group is separated from the next by a comma, with no
 167             intervening whitespace. The groups are subject to the same
 168             restrictions as the group given with the <option>-g</option>
 169             option.
 170           </para>
 171           <para>
 172             If the user is currently a member of a group which is
 173             not listed, the user will be removed from the group. This
 174             behaviour can be changed via the <option>-a</option> option, which
 175             appends the user to the current supplementary group list.
 176           </para>
 177         </listitem>
 178       </varlistentry>
 179       <varlistentry>
 180         <term>
 181           <option>-l</option>, <option>--login</option>
 182           <replaceable>NEW_LOGIN</replaceable>
 183         </term>
 184         <listitem>
 185           <para>
 186             The name of the user will be changed from
 187             <replaceable>LOGIN</replaceable> to
 188             <replaceable>NEW_LOGIN</replaceable>. Nothing else is changed. In
 189             particular, the user's home directory name should probably be
 190             changed manually to reflect the new login name.
 191           </para>
 192         </listitem>
 193       </varlistentry>
 194       <varlistentry>
 195         <term>
 196           <option>-L</option>, <option>--lock</option>
 197         </term>
 198         <listitem>
 199           <para>
 200             Lock a user's password. This puts a '!' in front of the
 201             encrypted password, effectively disabling the password. You
 202             can't use this option with <option>-p</option> or
 203             <option>-U</option>.
 204           </para>
 205           <para>
 206             Note: if you wish to lock the account (not only access with a
 207             password), you should also set the
 208             <replaceable>EXPIRE_DATE</replaceable> to
 209             <replaceable>1</replaceable>.
 210           </para>
 211         </listitem>
 212       </varlistentry>
 213       <varlistentry>
 214         <term>
 215           <option>-m</option>, <option>--move-home</option>
 216         </term>
 217         <listitem>
 218           <para>
 219             Move the content of the user's home directory to the new
 220             location.
 221           </para>
 222           <para>
 223             This option is only valid in combination with the
 224             <option>-d</option> (or <option>--home</option>) option.
 225           </para>
 226           <para>
 227             <command>usermod</command> will try to adapt the ownership of the
 228             files and to copy the modes, ACL and extended attributes, but
 229             manual changes might be needed afterwards.
 230           </para>
 231         </listitem>
 232       </varlistentry>
 233       <varlistentry>
 234         <term>
 235           <option>-o</option>, <option>--non-unique</option>
 236         </term>
 237         <listitem>
 238           <para>
 239             When used with the <option>-u</option> option, this option
 240             allows to change the user ID to a non-unique value.
 241           </para>
 242         </listitem>
 243       </varlistentry>
 244       <varlistentry>
 245         <term>
 246           <option>-p</option>, <option>--password</option>
 247           <replaceable>PASSWORD</replaceable>
 248         </term>
 249         <listitem>
 250           <para>
 251             The encrypted password, as returned by <citerefentry>
 252             <refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum>
 253             </citerefentry>.
 254           </para>
 255           <para>
 256             <emphasis role="bold">Note:</emphasis> This option is not
 257             recommended because the password (or encrypted password) will
 258             be visible by users listing the processes.
 259           </para>
 260           <para condition="pam">
 261             The password will be written in the local
 262             <filename>/etc/passwd</filename> or
 263             <filename>/etc/shadow</filename> file. This might differ from the
 264             password database configured in your PAM configuration.
 265           </para>
 266           <para>
 267             You should make sure the password respects the system's
 268             password policy.
 269           </para>
 270         </listitem>
 271       </varlistentry>
 272       <varlistentry>
 273         <term>
 274           <option>-s</option>, <option>--shell</option>
 275           <replaceable>SHELL</replaceable>
 276         </term>
 277         <listitem>
 278           <para>
 279             The name of the user's new login shell. Setting this field to
 280             blank causes the system to select the default login shell.
 281           </para>
 282         </listitem>
 283       </varlistentry>
 284       <varlistentry>
 285         <term>
 286           <option>-u</option>, <option>--uid</option>
 287           <replaceable>UID</replaceable>
 288         </term>
 289         <listitem>
 290           <para>
 291             The new numerical value of the user's ID.
 292           </para>
 293           <para>
 294             This value must be unique,
 295             unless the <option>-o</option> option is used. The value must be
 296             non-negative. Values between 0 and 999 are typically reserved
 297             for system accounts.
 298           </para>
 299           <para>
 300             The user's mailbox, and any files which the user owns and which are
 301             located in the user's home
 302             directory will have the file user ID changed automatically.
 303           </para>
 304           <para>
 305             The ownership of files outside of the user's home directory
 306             must be fixed manually.
 307           </para>
 308         </listitem>
 309       </varlistentry>
 310       <varlistentry>
 311         <term>
 312           <option>-U</option>, <option>--unlock</option>
 313         </term>
 314         <listitem>
 315           <para>
 316             Unlock a user's password. This removes the '!' in front of the
 317             encrypted password. You can't use this option with
 318             <option>-p</option> or <option>-L</option>.
 319           </para>
 320           <para>
 321             Note: if you wish to unlock the account (not only access with a
 322             password), you should also set the
 323             <replaceable>EXPIRE_DATE</replaceable> (for example to
 324             <replaceable>99999</replaceable>, or to the
 325             <option>EXPIRE</option> value from
 326             <filename>/etc/default/useradd</filename>).
 327           </para>
 328         </listitem>
 329       </varlistentry>
 330         <varlistentry>
 331           <term>
 332             <option>-Z</option>, <option>--selinux-user</option>
 333             <replaceable>SEUSER</replaceable>
 334           </term>
 335           <listitem>
 336             <para>
 337               The SELinux user for the user's login. The default is to leave
 338               this field the blank, which causes the system to select the
 339               default SELinux user.
 340             </para>
 341           </listitem>
 342         </varlistentry>
 343     </variablelist>
 344   </refsect1>
 345
 346   <refsect1 id='caveats'>
 347     <title>CAVEATS</title>
 348     <para>
 349       You must make certain that the named user is
 350       not executing any processes when this command is being executed if the
 351       user's numerical user ID, the user's name, or the user's home
 352       directory is being changed. <command>usermod</command> checks this
 353       on Linux, but only check if the user is logged in according to utmp
 354       on other architectures.
 355     </para>
 356     <para>
 357       You must change the owner of any <command>crontab</command> files or
 358       <command>at</command> jobs manually.
 359     </para>
 360     <para>
 361       You must make any changes involving NIS on the NIS server.
 362     </para>
 363   </refsect1>
 364
 365   <refsect1 id='configuration'>
 366     <title>CONFIGURATION</title>
 367     <para>
 368       The following configuration variables in
 369       <filename>/etc/login.defs</filename> change the behavior of this
 370       tool:
 371     </para>
 372     <variablelist>
 373       &MAIL_DIR; <!-- documents also MAIL_FILE -->
 374       &MAX_MEMBERS_PER_GROUP;
 375       &TCB_SYMLINKS;
 376       &USE_TCB;
 377     </variablelist>
 378   </refsect1>
 379
 380   <refsect1 id='files'>
 381     <title>FILES</title>
 382     <variablelist>
 383       <varlistentry>
 384         <term><filename>/etc/group</filename></term>
 385         <listitem>
 386           <para>Group account information.</para>
 387         </listitem>
 388       </varlistentry>
 389       <varlistentry condition="gshadow">
 390         <term><filename>/etc/gshadow</filename></term>
 391         <listitem>
 392           <para>Secure group account information.</para>
 393         </listitem>
 394       </varlistentry>
 395       <varlistentry>
 396         <term><filename>/etc/passwd</filename></term>
 397         <listitem>
 398           <para>User account information.</para>
 399         </listitem>
 400       </varlistentry>
 401       <varlistentry>
 402         <term><filename>/etc/shadow</filename></term>
 403         <listitem>
 404           <para>Secure user account information.</para>
 405         </listitem>
 406       </varlistentry>
 407     </variablelist>
 408   </refsect1>
 409
 410   <refsect1 id='see_also'>
 411     <title>SEE ALSO</title>
 412     <para>
 413       <citerefentry>
 414         <refentrytitle>chfn</refentrytitle><manvolnum>1</manvolnum>
 415       </citerefentry>,
 416       <citerefentry>
 417         <refentrytitle>chsh</refentrytitle><manvolnum>1</manvolnum>
 418       </citerefentry>,
 419       <citerefentry>
 420         <refentrytitle>passwd</refentrytitle><manvolnum>1</manvolnum>
 421       </citerefentry>,
 422       <citerefentry>
 423         <refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum>
 424       </citerefentry>,
 425       <citerefentry>
 426         <refentrytitle>gpasswd</refentrytitle><manvolnum>8</manvolnum>
 427       </citerefentry>,
 428       <citerefentry>
 429         <refentrytitle>groupadd</refentrytitle><manvolnum>8</manvolnum>
 430       </citerefentry>,
 431       <citerefentry>
 432         <refentrytitle>groupdel</refentrytitle><manvolnum>8</manvolnum>
 433       </citerefentry>,
 434       <citerefentry>
 435         <refentrytitle>groupmod</refentrytitle><manvolnum>8</manvolnum>
 436       </citerefentry>,
 437       <citerefentry>
 438         <refentrytitle>login.defs</refentrytitle><manvolnum>5</manvolnum>
 439       </citerefentry>,
 440       <citerefentry>
 441         <refentrytitle>useradd</refentrytitle><manvolnum>8</manvolnum>
 442       </citerefentry>,
 443       <citerefentry>
 444         <refentrytitle>userdel</refentrytitle><manvolnum>8</manvolnum>
 445       </citerefentry>.
 446     </para>
 447   </refsect1>
 448 </refentry>