Skip site navigation (1)Skip section navigation (2)
Date:      06 Oct 2002 21:41:02 -0700
From:      "Gary W. Swearingen" <swear@attbi.com>
To:        FreeBSD-gnats-submit@FreeBSD.org
Subject:   docs/43756: chpass(1) manual unclear about alternate name behavior
Message-ID:  <f2r8f27tep.8f2@localhost.localdomain>

next in thread | raw e-mail | index | archive | help

>Number:         43756
>Category:       docs
>Synopsis:       chpass(1) manual unclear about alternate name behavior
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Oct 06 21:40:02 PDT 2002
>Closed-Date:
>Last-Modified:
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 4.6-STABLE i386
>Organization:
none
>Environment:
n/a
================
>Description:

The chpass(1) manual is unclear about whether, for example, chfn(1) and
chsh(1) behave the same as each other and chpass(1), or if the manual is
just incomplete about their possible differing behavior.  (It's rather
hard to believe that "chfn" and "chsh" do the same thing, without it being
stated more explicitly than just that they are linked to chpass.)

Also, the descriptions of most of the commands in the "NAME" section are
inappropriately relegated to a "NOTES" section near the end of the
manual, instead of in the "DESCRIPTIONS" section.

================
>How-To-Repeat:
n/a
================
>Fix:

In
$FreeBSD: src/usr.bin/chpass/chpass.1,v 1.23.2.8 2002/06/20 23:45:22 charnier Exp $
move the description and say that the commands behave identically.

--- /tmp/chpass..orig.1	Sun Oct  6 20:25:55 2002
+++ /tmp/chpass.1	Sun Oct  6 21:30:39 2002
@@ -63,11 +63,23 @@
 .Sh DESCRIPTION
 The
 .Nm
-program
+command
 allows editing of the user database information associated
 with
 .Ar user
 or, by default, the current user.
+.Pp
+The
+.Xr chfn 1 ,
+.Xr chsh 1 ,
+.Xr ypchpass 1 ,
+.Xr ypchfn 1
+and
+.Xr ypchsh 1
+commands behave identically to
+.Nm .
+.Pq There is only one program.
+.Pp
 The information is formatted and supplied to an editor for changes.
 .Pp
 Only the information that the user is allowed to change is displayed.
@@ -469,16 +481,6 @@
 .%A Ken Thompson
 .%T "UNIX Password security"
 .Re
-.Sh NOTES
-The
-.Xr chfn 1 ,
-.Xr chsh 1 ,
-.Xr ypchpass 1 ,
-.Xr ypchfn 1
-and
-.Xr ypchsh 1
-commands are really only links to
-.Nm .
 .Sh BUGS
 User information should (and eventually will) be stored elsewhere.
 .Sh HISTORY
>Release-Note:
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?f2r8f27tep.8f2>