By popular demand, have adduser preserve comments at the top of the

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

diff --git a/chpass/chpass.1 b/chpass/chpass.1
index 41595e1458e4768112c06798c48338fc4e2408a2..889efc75d1886d4308f9629f48ec55790c702715 100644 (file)
--- a/chpass/chpass.1
+++ b/chpass/chpass.1
@@ -44,11 +44,22 @@
 .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 a Ar list
 .Op Fl p Ar encpass

+.Op Fl e Ar expiretime

 .Op Fl s Ar newshell
 .Op user
 .Op Fl s Ar newshell
 .Op user

+.Pp
+.Nm
+.Op Fl oly
+.Op Fl a Ar list
+.Op Fl p Ar encpass
+.Op Fl e Ar expiretime
+.Op Fl s Ar newshell
+.Op Fl d Ar domain
+.Op Fl h Ar host
+.Op user

 .Sh DESCRIPTION
 The
 .Nm
 .Sh DESCRIPTION
 The
 .Nm


@@ -69,7 +80,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


@@ -77,6 +88,10 @@ The super-user is allowed to directly supply an encrypted password field,
 in the format used by
 .Xr crypt 3 ,
 as an argument.
 in the format used by
 .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
+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
 .Ar newshell .
 .It Fl s Ar newshell
 Attempt to change the user's shell to
 .Ar newshell .


@@ -152,7 +167,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


@@ -245,7 +260,8 @@ Currently,
 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
 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 )


@@ -256,7 +272,8 @@ add new records to the NIS passwd maps.
 Furthermore,
 .Xr rpc.yppasswdd 8
 requires password authentication before it will make any
 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.


@@ -294,11 +311,13 @@ change any field.
 .Em "Password authentication is required" .
 .Nm Chpass
 will prompt for the user's NIS password before effecting
 .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
+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.)
 choose to turn off this feature using the
 .Fl o
 flag, described below.)


@@ -331,7 +350,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


@@ -343,7 +363,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


@@ -367,20 +387,24 @@ Specify a particular NIS domain.
 .Nm Chpass
 uses the system domain name by default, as set by the
 .Xr domainname 1
 .Nm Chpass
 uses the system domain name by default, as set by the
 .Xr domainname 1

-command. The
+command.
+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
 not be that of the NIS master server; the name of any server, master or
 slave, in a given NIS domain will do.
 .Pp


@@ -408,7 +432,8 @@ 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
 .Pp
 mainly for testing purposes.
 .El
 .Pp


@@ -447,11 +472,11 @@ The
 and
 .Xr ypchsh 1
 commands are really only links to
 and
 .Xr ypchsh 1
 commands are really only links to

-.Nm Ns .
+.Nm .

 .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
+.Nm

 command appeared in 
 .Bx 4.3 Reno .
 command appeared in 
 .Bx 4.3 Reno .