man/chfn.1.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    Copyright (c) 1990 - 1994, Julianne Frances Haugh
   4    Copyright (c) 2007 - 2008, 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 CHFN_AUTH             SYSTEM "login.defs.d/CHFN_AUTH.xml">
  34 <!ENTITY CHFN_RESTRICT         SYSTEM "login.defs.d/CHFN_RESTRICT.xml">
  35 <!ENTITY LOGIN_STRING          SYSTEM "login.defs.d/LOGIN_STRING.xml">
  36 ]>
  37
  38 <refentry id='chfn.1'>
  39   <!-- $Id: chfn.1.xml 2435 2008-10-11 11:44:43Z nekral-guest $ -->
  40   <refmeta>
  41     <refentrytitle>chfn</refentrytitle>
  42     <manvolnum>1</manvolnum>
  43     <refmiscinfo class="sectdesc">User Commands</refmiscinfo>
  44   </refmeta>
  45   <refnamediv id='name'>
  46     <refname>chfn</refname>
  47     <refpurpose>change real user name and information</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv id='synopsis'>
  51     <cmdsynopsis>
  52       <command>chfn</command>
  53       <arg choice='opt'>-f <replaceable>full_name</replaceable></arg>
  54       <arg choice='opt'>-r <replaceable>room_no</replaceable></arg>
  55       <arg choice='opt'>-w <replaceable>work_ph</replaceable></arg>
  56       <arg choice='opt'>-h <replaceable>home_ph</replaceable></arg>
  57       <arg choice='opt'>-o <replaceable>other</replaceable></arg>
  58       <arg choice='opt'><replaceable>user</replaceable></arg>
  59     </cmdsynopsis>
  60   </refsynopsisdiv>
  61
  62   <refsect1 id='description'>
  63     <title>DESCRIPTION</title>
  64     <para>
  65       The <command>chfn</command> command changes user fullname,
  66       office number, office extension, and home phone number information
  67       for a user's account. This information is typically printed by
  68       <citerefentry><refentrytitle>finger</refentrytitle><manvolnum>1</manvolnum>
  69       </citerefentry> and similar programs. A normal user may only change
  70       the fields for her own account, subject to the restrictions in
  71       <filename>/etc/login.defs</filename>. (The default configuration is to
  72       prevent users from changing their fullname.) The superuser may change
  73       any field for any account. Additionally, only the superuser may use
  74       the <option>-o</option> option to change the undefined portions of the
  75       GECOS field.
  76     </para>
  77
  78     <para>
  79       These fields must not contain any colons. Except for the
  80       <emphasis remap='I'>other</emphasis> field, they should not contain
  81       any comma or equal sign. It is also recommended to avoid
  82       non-US-ASCII characters, but this is only enforced for the phone
  83       numbers. The <emphasis remap='I'>other</emphasis> field is used to
  84       store accounting information used by other applications.
  85     </para>
  86
  87     <para>
  88       If none of the options are selected, <command>chfn</command>
  89       operates in an interactive fashion, prompting the user with the
  90       current values for all of the fields. Enter the new value to change
  91       the field, or leave the line blank to use the current value. The
  92       current value is displayed between a pair of <emphasis remap='B'>[
  93       ]</emphasis> marks. Without options, <command>chfn</command>
  94       prompts for the current user account.
  95     </para>
  96   </refsect1>
  97
  98   <refsect1 id='configuration'>
  99     <title>CONFIGURATION</title>
 100     <para>
 101       The following configuration variables in
 102       <filename>/etc/login.defs</filename> change the behavior of this
 103       tool:
 104     </para>
 105     <variablelist>
 106       &CHFN_AUTH;
 107       &CHFN_RESTRICT;
 108       &LOGIN_STRING;
 109     </variablelist>
 110   </refsect1>
 111
 112   <refsect1 id='files'>
 113     <title>FILES</title>
 114     <variablelist>
 115       <varlistentry>
 116         <term><filename>/etc/login.defs</filename></term>
 117         <listitem>
 118           <para>Shadow password suite configuration.</para>
 119         </listitem>
 120       </varlistentry>
 121       <varlistentry>
 122         <term><filename>/etc/passwd</filename></term>
 123         <listitem>
 124           <para>User account information.</para>
 125         </listitem>
 126       </varlistentry>
 127     </variablelist>
 128   </refsect1>
 129
 130   <refsect1 id='see_also'>
 131     <title>SEE ALSO</title>
 132     <para>
 133       <citerefentry>
 134         <refentrytitle>chsh</refentrytitle><manvolnum>1</manvolnum>
 135       </citerefentry>,
 136       <citerefentry>
 137         <refentrytitle>login.defs</refentrytitle><manvolnum>5</manvolnum>
 138       </citerefentry>,
 139       <citerefentry>
 140         <refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum>
 141       </citerefentry>.
 142     </para>
 143   </refsect1>
 144 </refentry>