Mechanically kill hard sentence breaks.

[pw-darwin.git] / chpass / chpass.1

diff --git a/chpass/chpass.1 b/chpass/chpass.1
index 615751b4dd29a008fa75fa0d120e0748dd847b3c..e6c9e18db032ecb6429dd2515b241b97e72c190e 100644 (file)
--- a/chpass/chpass.1
+++ b/chpass/chpass.1
@@ -44,14 +44,14 @@
 .Nm ypchsh
 .Nd add or change user database information
 .Sh SYNOPSIS
 .Nm ypchsh
 .Nd add or change user database information
 .Sh SYNOPSIS

-.Nm chpass
+.Nm

 .Op Fl a Ar list
 .Op Fl p Ar encpass
 .Op Fl e Ar expiretime
 .Op Fl s Ar newshell
 .Op user
 .Pp
 .Op Fl a Ar list
 .Op Fl p Ar encpass
 .Op Fl e Ar expiretime
 .Op Fl s Ar newshell
 .Op user
 .Pp

-.Nm chpass
+.Nm

 .Op Fl oly
 .Op Fl a Ar list
 .Op Fl p Ar encpass
 .Op Fl oly
 .Op Fl a Ar list
 .Op Fl p Ar encpass


@@ -63,11 +63,23 @@
 .Sh DESCRIPTION
 The
 .Nm
 .Sh DESCRIPTION
 The
 .Nm

-program
+utility

 allows editing of the user database information associated
 with
 .Ar user
 or, by default, the current user.
 allows editing of the user database information associated
 with
 .Ar user
 or, by default, the current user.

+.Pp
+The
+.Nm chfn ,
+.Nm chsh ,
+.Nm ypchpass ,
+.Nm ypchfn
+and
+.Nm ypchsh
+utilities behave identically to
+.Nm .
+(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.
 The information is formatted and supplied to an editor for changes.
 .Pp
 Only the information that the user is allowed to change is displayed.


@@ -80,7 +92,7 @@ entry, in the format specified by
 .Xr passwd 5 ,
 as an argument.
 This argument must be a colon
 .Xr passwd 5 ,
 as an argument.
 This argument must be a colon

-.Pq Dq \:
+.Pq Dq \&:

 separated list of all the
 user database fields, although they may be empty.
 .It Fl p
 separated list of all the
 user database fields, although they may be empty.
 .It Fl p


@@ -89,7 +101,8 @@ in the format used by
 .Xr crypt 3 ,
 as an argument.
 .It Fl e Ar expiretime
 .Xr crypt 3 ,
 as an argument.
 .It Fl e Ar expiretime

-Change the account expire time. This option is used to set the expire time
+Change the account expire time.
+This option is used to set the expire time

 from a script as if it was done in the interactive editor.
 .It Fl s Ar newshell
 Attempt to change the user's shell to
 from a script as if it was done in the interactive editor.
 .It Fl s Ar newshell
 Attempt to change the user's shell to


@@ -150,14 +163,17 @@ Both of these fields should be unique across the system (and often
 across a group of systems) as they control file access.
 .Pp
 While it is possible to have multiple entries with identical login names
 across a group of systems) as they control file access.
 .Pp
 While it is possible to have multiple entries with identical login names

-and/or identical user id's, it is usually a mistake to do so.  Routines
+and/or identical user id's, it is usually a mistake to do so.
+Routines

 that manipulate these files will often return only one of the multiple
 entries, and that one by random selection.
 .Pp
 The
 .Ar group
 field is the group that the user will be placed in at login.
 that manipulate these files will often return only one of the multiple
 entries, and that one by random selection.
 .Pp
 The
 .Ar group
 field is the group that the user will be placed in at login.

-Since BSD supports multiple groups (see
+Since
+.Bx
+supports multiple groups (see

 .Xr groups 1 )
 this field currently has little special meaning.
 This field may be filled in with either a number or a group name (see
 .Xr groups 1 )
 this field currently has little special meaning.
 This field may be filled in with either a number or a group name (see


@@ -166,7 +182,7 @@ This field may be filled in with either a number or a group name (see
 The
 .Ar class
 field references class descriptions in
 The
 .Ar class
 field references class descriptions in

-.Ar /etc/login.conf
+.Pa /etc/login.conf

 and is typically used to initialize the user's system resource limits
 when they login.
 .Pp
 and is typically used to initialize the user's system resource limits
 when they login.
 .Pp


@@ -204,7 +220,7 @@ gcos fields (typically used for site specific user information).
 Note that
 .Xr finger 1
 will display the office location and office phone together under the
 Note that
 .Xr finger 1
 will display the office location and office phone together under the

-heading 
+heading

 .Ar Office: .
 .Pp
 The user's
 .Ar Office: .
 .Pp
 The user's


@@ -251,26 +267,29 @@ for an explanation of the impact of setting the
 .Ev PW_SCAN_BIG_IDS
 environment variable.
 .Sh NIS INTERACTION
 .Ev PW_SCAN_BIG_IDS
 environment variable.
 .Sh NIS INTERACTION

-.Nm Chpass
-can also be used in conjunction with NIS, however some restrictions
+The
+.Nm
+utility can also be used in conjunction with NIS, however some restrictions

 apply.
 Currently,
 .Nm
 can only make changes to the NIS passwd maps through
 .Xr rpc.yppasswdd 8 ,
 which normally only permits changes to a user's password, shell and GECOS
 apply.
 Currently,
 .Nm
 can only make changes to the NIS passwd maps through
 .Xr rpc.yppasswdd 8 ,
 which normally only permits changes to a user's password, shell and GECOS

-fields. Except when invoked by the super-user on the NIS master server,
+fields.
+Except when invoked by the super-user on the NIS master server,

 .Nm
 (and, similarly,
 .Xr passwd 1 )
 .Nm
 (and, similarly,
 .Xr passwd 1 )

-can not use the
+cannot use the

 .Xr rpc.yppasswdd 8
 server to change other user information or
 add new records to the NIS passwd maps.
 Furthermore,
 .Xr rpc.yppasswdd 8
 requires password authentication before it will make any
 .Xr rpc.yppasswdd 8
 server to change other user information or
 add new records to the NIS passwd maps.
 Furthermore,
 .Xr rpc.yppasswdd 8
 requires password authentication before it will make any

-changes. The only user allowed to submit changes without supplying
+changes.
+The only user allowed to submit changes without supplying

 a password is the super-user on the NIS master server; all other users,
 including those with root privileges on NIS clients (and NIS slave
 servers) must enter a password.
 a password is the super-user on the NIS master server; all other users,
 including those with root privileges on NIS clients (and NIS slave
 servers) must enter a password.


@@ -306,20 +325,24 @@ change any field.
 .Pp
 .It
 .Em "Password authentication is required" .
 .Pp
 .It
 .Em "Password authentication is required" .

-.Nm Chpass
-will prompt for the user's NIS password before effecting
-any changes. If the password is invalid, all changes will be
+The
+.Nm
+utility will prompt for the user's NIS password before effecting
+any changes.
+If the password is invalid, all changes will be

 discarded.
 .Pp
 Exception: the super-user on the NIS master server is allowed to
 discarded.
 .Pp
 Exception: the super-user on the NIS master server is allowed to

-submit changes without supplying a password. (The super-user may
+submit changes without supplying a password.
+(The super-user may

 choose to turn off this feature using the
 .Fl o
 flag, described below.)
 .It
 .Em "Adding new records to the local password database is discouraged" .
 choose to turn off this feature using the
 .Fl o
 flag, described below.)
 .It
 .Em "Adding new records to the local password database is discouraged" .

-.Nm Chpass
-will allow the administrator to add new records to the
+The
+.Nm
+utility will allow the administrator to add new records to the

 local password database while NIS is enabled, but this can lead to
 some confusion since the new records are appended to the end of
 the master password file, usually after the special NIS '+' entries.
 local password database while NIS is enabled, but this can lead to
 some confusion since the new records are appended to the end of
 the master password file, usually after the special NIS '+' entries.


@@ -334,8 +357,9 @@ to the NIS password maps, provided the
 server has been started with the
 .Fl a
 flag to permitted additions (it refuses them by default).
 server has been started with the
 .Fl a
 flag to permitted additions (it refuses them by default).

-.Nm Chpass
-tries to update the local password database by default; to update the
+The
+.Nm
+utility tries to update the local password database by default; to update the

 NIS maps instead, invoke chpass with the
 .Fl y
 flag.
 NIS maps instead, invoke chpass with the
 .Fl y
 flag.


@@ -345,7 +369,8 @@ Users should use
 .Xr passwd 1
 or
 .Xr yppasswd 1
 .Xr passwd 1
 or
 .Xr yppasswd 1

-to change their NIS passwords. The super-user is allowed to specify
+to change their NIS passwords.
+The super-user is allowed to specify

 a new password (even though the
 .Dq Password:
 field does not show
 a new password (even though the
 .Dq Password:
 field does not show


@@ -357,7 +382,7 @@ will refuse to update the NIS maps.
 .Pp
 Exception: the super-user on the NIS master server is permitted to
 change a user's NIS password with
 .Pp
 Exception: the super-user on the NIS master server is permitted to
 change a user's NIS password with

-.Nm Ns .
+.Nm .

 .El
 .Pp
 There are also a few extra option flags that are available when
 .El
 .Pp
 There are also a few extra option flags that are available when


@@ -368,7 +393,7 @@ is compiled with NIS support:
 Force
 .Nm
 to modify the local copy of a user's password
 Force
 .Nm
 to modify the local copy of a user's password

-information in the even that a user exists in both
+information in the event that a user exists in both

 the local and NIS databases.
 .It Fl y
 Opposite effect of
 the local and NIS databases.
 .It Fl y
 Opposite effect of


@@ -378,29 +403,34 @@ This flag is largely redundant since
 operates on NIS entries by default if NIS is enabled.
 .It Fl d Ar domain
 Specify a particular NIS domain.
 operates on NIS entries by default if NIS is enabled.
 .It Fl d Ar domain
 Specify a particular NIS domain.

-.Nm Chpass
-uses the system domain name by default, as set by the
+The
+.Nm
+utility uses the system domain name by default, as set by the

 .Xr domainname 1
 .Xr domainname 1

-command. The
+utility.
+The

 .Fl d
 option can be used to override a default, or to specify a domain
 when the system domain name is not set.
 .It Fl h Ar host
 .Fl d
 option can be used to override a default, or to specify a domain
 when the system domain name is not set.
 .It Fl h Ar host

-Specify the name or address of an NIS server to query. Normally,
+Specify the name or address of an NIS server to query.
+Normally,

 .Nm
 will communicate with the NIS master host specified in the
 .Pa master.passwd
 or
 .Pa passwd
 .Nm
 will communicate with the NIS master host specified in the
 .Pa master.passwd
 or
 .Pa passwd

-maps. On hosts that have not been configured as NIS clients, there is
+maps.
+On hosts that have not been configured as NIS clients, there is

 no way for the program to determine this information unless the user
 no way for the program to determine this information unless the user

-provides the hostname of a server. Note that the specified hostname need
+provides the hostname of a server.
+Note that the specified hostname need

 not be that of the NIS master server; the name of any server, master or
 slave, in a given NIS domain will do.
 .Pp
 When using the
 .Fl d
 not be that of the NIS master server; the name of any server, master or
 slave, in a given NIS domain will do.
 .Pp
 When using the
 .Fl d

-option, the hostname defaults to 
+option, the hostname defaults to

 .Dq localhost .
 The
 .Fl h
 .Dq localhost .
 The
 .Fl h


@@ -418,14 +448,15 @@ When invoked by the super-user on the NIS master server,
 allows unrestricted changes to the NIS passwd maps using dedicated,
 non-RPC-based mechanism (in this case, a
 .Ux
 allows unrestricted changes to the NIS passwd maps using dedicated,
 non-RPC-based mechanism (in this case, a
 .Ux

-domain socket). The
+domain socket).
+The

 .Fl o
 flag can be used to force
 .Nm
 .Fl o
 flag can be used to force
 .Nm

-to use the standard update mechanism instead. This option is provided
+to use the standard update mechanism instead.
+This option is provided

 mainly for testing purposes.
 .El
 mainly for testing purposes.
 .El

-.Pp

 .Sh FILES
 .Bl -tag -width /etc/master.passwd -compact
 .It Pa /etc/master.passwd
 .Sh FILES
 .Bl -tag -width /etc/master.passwd -compact
 .It Pa /etc/master.passwd


@@ -452,20 +483,10 @@ and
 .%A Ken Thompson
 .%T "UNIX Password security"
 .Re
 .%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 Ns .

 .Sh BUGS
 User information should (and eventually will) be stored elsewhere.
 .Sh HISTORY
 The
 .Sh BUGS
 User information should (and eventually will) be stored elsewhere.
 .Sh HISTORY
 The

-.Nm chpass
-command appeared in 
+.Nm
+utility appeared in

 .Bx 4.3 Reno .
 .Bx 4.3 Reno .