shadow/man/chage.1.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
   Copyright (c) 1990 - 1994, Julianne Frances Haugh
   Copyright (c) 2007 - 2011, Nicolas François
   All rights reserved.
  
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
   3. The name of the copyright holders or contributors may not be used to
      endorse or promote products derived from this software without
      specific prior written permission.
  
   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
   PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
   HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY USE_TCB               SYSTEM "login.defs.d/USE_TCB.xml">
<!-- SHADOW-CONFIG-HERE -->
]>
<refentry id='chage.1'>
  <!--  $Id$  -->
  <refentryinfo>
    <author>
      <firstname>Julianne Frances</firstname>
      <surname>Haugh</surname>
      <contrib>Creation, 1990</contrib>
    </author>
    <author>
      <firstname>Thomas</firstname>
      <surname>Kłoczko</surname>
      <email>kloczek@pld.org.pl</email>
      <contrib>shadow-utils maintainer, 2000 - 2007</contrib>
    </author>
    <author>
      <firstname>Nicolas</firstname>
      <surname>François</surname>
      <email>nicolas.francois@centraliens.net</email>
      <contrib>shadow-utils maintainer, 2007 - now</contrib>
    </author>
  </refentryinfo>
  <refmeta>
    <refentrytitle>chage</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="sectdesc">User Commands</refmiscinfo>
    <refmiscinfo class="source">shadow-utils</refmiscinfo>
    <refmiscinfo class="version">&SHADOW_UTILS_VERSION;</refmiscinfo>
  </refmeta>
  <refnamediv id='name'>
    <refname>chage</refname>
    <refpurpose>change user password expiry information</refpurpose>
  </refnamediv>
  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>chage</command>
      <arg choice='opt'>
	<replaceable>options</replaceable>
      </arg>
      <arg choice='plain'>
	<replaceable>LOGIN</replaceable>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      The <command>chage</command> command changes the number of days between
      password changes and the date of the last password change. This
      information is used by the system to determine when a user must change
      his/her password.
    </para>
  </refsect1>

  <refsect1 id='options'>
    <title>OPTIONS</title>
    <para>
      The options which apply to the <command>chage</command> command are:
    </para>
    <variablelist remap='IP'>
      <varlistentry>
	<term>
	  <option>-d</option>, <option>--lastday</option>&nbsp;<replaceable>LAST_DAY</replaceable>
	</term>
	<listitem>
	  <para>
	    Set the number of days since January 1st, 1970 when the password
	    was last changed. The date may also be expressed in the format
	    YYYY-MM-DD (or the format more commonly used in your area).
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>-E</option>, <option>--expiredate</option>&nbsp;<replaceable>EXPIRE_DATE</replaceable>
	</term>
	<listitem>
	  <para>
	    Set the date or number of days since January 1, 1970 on which the
	    user's account will no longer be accessible. The date may also
	    be expressed in the format YYYY-MM-DD (or the format more
	    commonly used in your area). A user whose account is locked must
	    contact the system administrator before being able to use the
	    system again.
	  </para>
	  <para>
	    Passing the number <emphasis remap='I'>-1</emphasis> as the
	    <replaceable>EXPIRE_DATE</replaceable> will remove an account
	    expiration date.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-h</option>, <option>--help</option></term>
	<listitem>
	  <para>Display help message and exit.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>-I</option>, <option>--inactive</option>&nbsp;<replaceable>INACTIVE</replaceable>
	</term>
	<listitem>
	  <para>
	    Set the number of days of inactivity after a password has
	    expired before the account is locked. The
	    <replaceable>INACTIVE</replaceable> option is the number of days
	    of inactivity. A user whose account is locked must contact the
	    system administrator before being able to use the system again.
	  </para>
	  <para>
	    Passing the number <emphasis remap='I'>-1</emphasis> as the
	    <replaceable>INACTIVE</replaceable> will remove an account's
	    inactivity.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>-l</option>, <option>--list</option>
	</term>
	<listitem>
	  <para>
	  Show account aging information.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>-m</option>, <option>--mindays</option>&nbsp;<replaceable>MIN_DAYS</replaceable>
	</term>
	<listitem>
	  <para>
	    Set the minimum number of days between password changes to
	    <replaceable>MIN_DAYS</replaceable>. A value of zero for this field
	    indicates that the user may change his/her password at any time.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>-M</option>, <option>--maxdays</option>&nbsp;<replaceable>MAX_DAYS</replaceable>
	</term>
	<listitem>
	  <para>
	    Set the maximum number of days during which a password is valid. 
	    When <replaceable>MAX_DAYS</replaceable> plus
	    <replaceable>LAST_DAY</replaceable> is less than the current
	    day, the user will be required to change his/her password before
	    being able to use his/her account. This occurrence can be planned for
	    in advance by use of the <option>-W</option> option, which
	    provides the user with advance warning.
	  </para>
	  <para>
	    Passing the number <emphasis remap='I'>-1</emphasis> as
	    <replaceable>MAX_DAYS</replaceable> will remove checking a
	    password's validity.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>-R</option>, <option>--root</option>&nbsp;<replaceable>CHROOT_DIR</replaceable>
	</term>
	<listitem>
	  <para>
	    Apply changes in the <replaceable>CHROOT_DIR</replaceable>
	    directory and use the configuration files from the
	    <replaceable>CHROOT_DIR</replaceable> directory.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>-W</option>, <option>--warndays</option>&nbsp;<replaceable>WARN_DAYS</replaceable>
	</term>
	<listitem>
	  <para>
	    Set the number of days of warning before a password change is
	    required. The <replaceable>WARN_DAYS</replaceable> option is the
	    number of days prior to the password expiring that a user will
	    be warned his/her password is about to expire.
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
    <para>
      If none of the options are selected, <command>chage</command> operates
      in an interactive fashion, prompting the user with the current values
      for all of the fields. Enter the new value to change the field, or
      leave the line blank to use the current value. The current value is
      displayed between a pair of <emphasis>[ ]</emphasis> marks.
    </para>
  </refsect1>
  <refsect1 id='note'>
    <title>NOTE</title>
    <para>
      The <command>chage</command> program requires a shadow password file to
      be available.
    </para>
    <para>The <command>chage</command> command is restricted to the root
      user, except for the <option>-l</option> option, which may be used by
      an unprivileged user to determine when his/her password or account is due
      to expire.
    </para>
  </refsect1>

  <refsect1 id='configuration'>
    <title>CONFIGURATION</title>
    <para>
      The following configuration variables in
      <filename>/etc/login.defs</filename> change the behavior of this
      tool:
    </para>
    <variablelist>
      &USE_TCB;
    </variablelist>
  </refsect1>

  <refsect1 id='files'>
    <title>FILES</title>
    <variablelist>
      <varlistentry>
	<term>
	  <filename>/etc/passwd</filename>
	</term>
	<listitem>
	  <para>User account information.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <filename>/etc/shadow</filename>
	</term>
	<listitem>
	  <para>Secure user account information.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id='exit_values'>
    <title>EXIT VALUES</title>
    <para>
      The <command>chage</command> command exits with the following values:
      <variablelist>
	<varlistentry>
	  <term><replaceable>0</replaceable></term>
	  <listitem>
	    <para>success</para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><replaceable>1</replaceable></term>
	  <listitem>
	    <para>permission denied</para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><replaceable>2</replaceable></term>
	  <listitem>
	    <para>invalid command syntax</para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><replaceable>15</replaceable></term>
	  <listitem>
	    <para>can't find the shadow password file</para>
	  </listitem>
	</varlistentry>
      </variablelist>
    </para>
  </refsect1>

  <refsect1 id='see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>
</refentry>