macro and text revision (-mdoc version 3)

[unix-history] / usr / src / usr.sbin / vipw / vipw.8

diff --git a/usr/src/usr.sbin/vipw/vipw.8 b/usr/src/usr.sbin/vipw/vipw.8
index 71728a1..949e20d 100644 (file)
--- a/usr/src/usr.sbin/vipw/vipw.8
+++ b/usr/src/usr.sbin/vipw/vipw.8
@@ -1,55 +1,67 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"    @(#)vipw.8      6.6 (Berkeley) %G%
+.\"     @(#)vipw.8     6.7 (Berkeley) %G%

 .\"
 .\"

-.TH VIPW 8 ""
-.UC 4
-.SH NAME
-vipw \- edit the password file
-.SH SYNOPSIS
-.B vipw
-.SH DESCRIPTION
-.I Vipw
-locks the password file and makes a temporary copy of it for editing.
-The user's editor (or by default, 
-.IR vi (1))
-is run on the copied file.
-.PP
-Once the file has been edited,
-.I vipw
-runs the program
-.IR pwd_mkdb (8).
-.I Pwd_mkdb
-performs a number of consistency checks on the password entries, and will
-not allow a password file with a ``mangled'' entry to be installed.
+.Dd 
+.Dt VIPW 8
+.Os BSD 4
+.Sh NAME
+.Nm vipw
+.Nd edit the password file
+.Sh SYNOPSIS
+.Nm vipw
+.Sh DESCRIPTION
+.Nm Vipw
+edits the password file after setting the appropriate locks,
+and does any necessary processing after the password file is unlocked.
+If the password file is already locked for editing by another user,
+.Nm vipw
+will ask you
+to try again later. The default editor for
+.Nm vipw
+is
+.Xr vi 1 .
+.Pp
+.Nm Vipw
+performs a number of consistency checks on the password entries,
+and will not allow a password file with a
+.Dq mangled
+entry to be
+installed.

 If
 If

-.I pwd_mkdb
-rejects the new file, the user is prompted to re-enter the edit session.
-Once the file is found to be satisfactory,
-.I pwd_mkdb
-installs it as the new password file.
-.PP
-If the password file is already locked, you will be told to try again
-later.
-.SH FILES
-/var/db/pwd.db                 Insecure password database file
-.br
-/var/db/spwd.db                The secure password database file
-.br
-/etc/master.passwd             The current password file
-.br
-/etc/passwd                    A Version 7 format password file
-.br
-/etc/vipw.XXXXXX               Temporary copy of the password file
-.SH ENVIRONMENT
-.TP
-EDITOR
-The editor used; the default is
-.IR vi (1).
-Any user specified editor is expected to take the file name it will
-edit as its first argument.
-.SH SEE ALSO
-chpass(1), passwd(1), passwd(5), adduser(8), pwd_mkdb(8)
+.Nm vipw
+rejects the new password file, the user is prompted to re-enter
+the edit session.
+.Pp
+Once the information has been verified,
+.Nm vipw
+uses
+.Xr pwd_mkdb 8
+to update the user database.  This is run in the background, and,
+at very large sites could take several minutes.  Until this update
+is completed, the password file is unavailable for other updates
+and the new information is not available to programs.
+.Sh ENVIRONMENT
+If the following environment variable exists it will be utilized by
+.Nm vipw :
+.Bl -tag -width EDITOR
+.It Ev EDITOR
+The editor specified by the string
+.Ev EDITOR
+will be invoked instead of the default editor
+.Xr vi 1 .
+.El
+.Sh SEE ALSO
+.Xr chpass 1 ,
+.Xr passwd 1 ,
+.Xr passwd 5 ,
+.Xr adduser 8 ,
+.Xr pwd_mkdb 8
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.0 .