[Pkg-shadow-devel] Bug#1004688: shadow: Improved version of manual page chfn
Markus Hiereth
translation at hiereth.de
Mon Jan 31 19:32:43 GMT 2022
Source: shadow
Version: 4.8.1
Severity: normal
Hi Serge,
attached here, the edited xml file of the manual page and a diff file. In
the first phrase of the description section I introduced/mentioned the
file /etc/passwd to help understanding why we refer to the input data
as "fields". I hope this is OK.
Best regards
Markus
---
"Serge E. Hallyn" <serge at hallyn.com> schrieb am 31. Januar 2022 um 05:03
> On Tue, Jan 25, 2022 at 03:47:09PM +0100, Markus Hiereth wrote:
> > Hi Serge,
> >
> > attached four strings from chfn. There is one error, the others are
> > minor points where things could be improved when eliminating the error in the xml file for the manpage.
> >
> > Best regards
> > Markus
>
> > #MH111 As "real name" is only used once and even the command's description
> > #uses "full name" instead of "real name" and chfn focusses on the GECOS field:
> > s/real user name and information /full user name and other GECOS data
>
> Good point, and switching 'real name' for 'full name' seems sensible
> given that 'chfn' (AFAIK) stands for 'change full name' :)
>
> Many users won't know what GECOS means, so in the command's description
> I'd rather leave it as "and information".
OK
> > #MH170:
> > #Called by any user with the exeption of the system administrator, chfn expects
> > #authentification with the user's password, therefore: add somewhere
> > #"A normal user needs to authentficate himself to change personal data."
> > #Called by the system administrator without specifying an account, changes affect his own account
> > #Called by the system adiminstrator and with a specified username, changes will affect this users account
> > #FIXME
> > #s/Without options, /Without <replaceable>LOGIN</replaceable> as argument.
>
> I would prefer "If LOGIN is not specified,"
Just the phrase dealing with no LOGIN has gone up to the section DESCRIPTION
> > #MH
> > #move this paragraph which does not deal with options away from section
> > #OPTIONS towards section DESCRIPTION
> > #: chfn.1.xml:181(para)
> > msgid ""
> > "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."
>
> If you move that, please make it "If no options are specified,"
The rest remained at place with no changes except starting for "If
none of the options IS selected ..." I assumed none needs singular
form of the verb.
-------------- next part --------------
<?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 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$ -->
<refentryinfo>
<author>
<firstname>Julianne Frances</firstname>
<surname>Haugh</surname>
<contrib>Creation, 1990</contrib>
</author>
<author>
<firstname>Thomas</firstname>
<surname>K?oczko</surname>
<email>kloczek at pld.org.pl</email>
<contrib>shadow-utils maintainer, 2000 - 2007</contrib>
</author>
<author>
<firstname>Nicolas</firstname>
<surname>Fran?ois</surname>
<email>nicolas.francois at centraliens.net</email>
<contrib>shadow-utils maintainer, 2007 - now</contrib>
</author>
</refentryinfo>
<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 full user name and information</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>chfn</command>
<arg choice='opt'>
<replaceable>options</replaceable>
</arg>
<arg choice='opt'>
<replaceable>LOGIN</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
The <command>chfn</command> command changes the user's full name,
office room number, office phone number, and home phone number information
for an account in the respective fields of <filename>/etc/passwd</filename>.
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 <replaceable>LOGIN</replaceable> is not specified, <command>chfn</command>
prompts for the current user account.
</para>
</refsect1>
<refsect1 id='options'>
<title>OPTIONS</title>
<para>
The options which apply to the <command>chfn</command> command are:
</para>
<variablelist remap='IP'>
<varlistentry>
<term>
<option>-f</option>, <option>--full-name</option> <replaceable>FULL_NAME</replaceable>
</term>
<listitem>
<para>Change the user's full name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-h</option>, <option>--home-phone</option> <replaceable>HOME_PHONE</replaceable>
</term>
<listitem>
<para>Change the user's home phone number.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-o</option>, <option>--other</option> <replaceable>OTHER</replaceable>
</term>
<listitem>
<para>
Change the user's other GECOS information. This field is used to
store accounting information used by other applications, and can
be changed only by a superuser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-r</option>, <option>--room</option> <replaceable>ROOM_NUMBER</replaceable>
</term>
<listitem>
<para>Change the user's room number.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-R</option>, <option>--root</option> <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>-u</option>, <option>--help</option>
</term>
<listitem>
<para>Display help message and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-w</option>, <option>--work-phone</option> <replaceable>WORK_PHONE</replaceable>
</term>
<listitem>
<para>Change the user's office phone number.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
If none of the options is 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.
</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>
More information about the Pkg-shadow-devel
mailing list