shadow/man/chfn.1.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
   Copyright (c) 1990 - 1994, Julianne Frances Haugh
   Copyright (c) 2007 - 2008, 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 CHFN_AUTH             SYSTEM "login.defs.d/CHFN_AUTH.xml">
<!ENTITY CHFN_RESTRICT         SYSTEM "login.defs.d/CHFN_RESTRICT.xml">
<!ENTITY LOGIN_STRING          SYSTEM "login.defs.d/LOGIN_STRING.xml">
<!-- SHADOW-CONFIG-HERE -->
]>

<refentry id='chfn.1'>
  <!-- $Id$ -->
  <refmeta>
    <refentrytitle>chfn</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>chfn</refname>
    <refpurpose>change real user name and information</refpurpose>
  </refnamediv>

  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>chfn</command>
      <arg choice='opt'>-f <replaceable>full_name</replaceable></arg>
      <arg choice='opt'>-r <replaceable>room_no</replaceable></arg>
      <arg choice='opt'>-w <replaceable>work_ph</replaceable></arg>
      <arg choice='opt'>-h <replaceable>home_ph</replaceable></arg>
      <arg choice='opt'>-o <replaceable>other</replaceable></arg>
      <arg choice='opt'><replaceable>user</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      The <command>chfn</command> command changes user fullname,
      office number, office extension, and home phone number information
      for a user's account. This information is typically printed by
      <citerefentry><refentrytitle>finger</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry> and similar programs. A normal user may only change
      the fields for her own account, subject to the restrictions in
      <filename>/etc/login.defs</filename>. (The default configuration is to
      prevent users from changing their fullname.) The superuser may change
      any field for any account. Additionally, only the superuser may use
      the <option>-o</option> option to change the undefined portions of the
      GECOS field.
    </para>

    <para>
      These fields must not contain any colons. Except for the
      <emphasis remap='I'>other</emphasis> field, they should not contain
      any comma or equal sign. It is also recommended to avoid
      non-US-ASCII characters, but this is only enforced for the phone
      numbers. The <emphasis remap='I'>other</emphasis> field is used to
      store accounting information used by other applications.
    </para>

    <para>
      If none of the options are selected, <command>chfn</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 remap='B'>[
      ]</emphasis> marks. Without options, <command>chfn</command>
      prompts for the current user account.
    </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>
      &CHFN_AUTH;
      &CHFN_RESTRICT;
      &LOGIN_STRING;
    </variablelist>
  </refsect1>

  <refsect1 id='files'>
    <title>FILES</title>
    <variablelist>
      <varlistentry>
	<term><filename>/etc/login.defs</filename></term>
	<listitem>
	  <para>Shadow password suite configuration.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><filename>/etc/passwd</filename></term>
	<listitem>
	  <para>User account information.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

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