incorporate Steven Schultz's changes to make pwd_mkdb fast on big

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

diff --git a/usr/src/usr.sbin/pwd_mkdb/pwd_mkdb.8 b/usr/src/usr.sbin/pwd_mkdb/pwd_mkdb.8
index 26fe6d2..dd3a2ad 100644 (file)
--- a/usr/src/usr.sbin/pwd_mkdb/pwd_mkdb.8
+++ b/usr/src/usr.sbin/pwd_mkdb/pwd_mkdb.8
@@ -1,84 +1,102 @@
 .\" Copyright (c) 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" %sccs.include.redist.man%
+.\" %sccs.include.redist.roff%

 .\"
 .\"

-.\"    @(#)pwd_mkdb.8  5.2 (Berkeley) %G%
+.\"    @(#)pwd_mkdb.8  5.5 (Berkeley) %G%

 .\"
 .\"

-.TH PWD_MKDB 8 "
-.UC 7
-.SH NAME
-pwd_mkdb \- generate the password databases
-.SH SYNOPSIS
-.nf
-.ft B
-pwd_mkdb [ \-p ] file
-.SH DESCRIPTION
-.I Pwd_mkdb
+.Dd 
+.Dt PWD_MKDB 8
+.Os
+.Sh NAME
+.Nm pwd_mkdb
+.Nd "generate the password databases"
+.Sh SYNOPSIS
+.Nm pwd_mkdb
+.Op Fl p
+.Ar file
+.Sh DESCRIPTION
+.Nm Pwd_mkdb

 creates
 creates

-.IR db (3)
+.Xr db 3

 style secure and insecure databases for the specified file.
 style secure and insecure databases for the specified file.

-These databases are then installed into ``/var/db/spwd.db'' and
-``/var/db/pwd.db'' respectively.
-The file is installed into ``/etc/master.passwd''.
+These databases are then installed into
+.Dq Pa /etc/spwd.db
+and
+.Dq Pa /etc/pwd.db
+respectively.
+The file is installed into
+.Dq Pa /etc/master.passwd .

 The file must be in the correct format (see
 The file must be in the correct format (see

-.IR passwd (5)).
+.Xr passwd 5 ) .

 It is important to note that the format used in this system is
 different from the historic Version 7 style format.
 It is important to note that the format used in this system is
 different from the historic Version 7 style format.

-.PP
+.Pp

 The options are as follows:
 The options are as follows:

-.TP
-\-p
-Create a Version 7 style password file and install it into ``/etc/password''.
-.PP
+.Bl -tag -width flag
+.It Fl p
+Create a Version 7 style password file and install it into
+.Dq Pa /etc/passwd .
+.El
+.Pp

 The two databases differ in that the secure version contains the user's 
 encrypted password and the insecure version has an asterisk (``*'')
 The two databases differ in that the secure version contains the user's 
 encrypted password and the insecure version has an asterisk (``*'')

-.PP
+.Pp

 The databases are used by the C library password routines (see
 The databases are used by the C library password routines (see

-.IR getpwent (3)).
-.PP
-.I Pwd_mkdb
+.Xr getpwent 3 ) .
+.Pp
+.Nm Pwd_mkdb

 exits zero on success, non-zero on failure.
 exits zero on success, non-zero on failure.

-.SH FILES
-/var/db/pwd.db                 The insecure password database file
-.br
-/var/db/pwd.db.tmp             A temporary file
-.br
-/var/db/spwd.db                The secure password database file
-.br
-/var/db/spwd.db.tmp            A temporary file
-.br
-/etc/master.passwd             The current password file
-.br
-/etc/passwd                    A Version 7 format password file
-.SH BUGS
+.Sh FILES
+.Bl -tag -width Pa -compact
+.It Pa /var/db/pwd.db
+The insecure password database file.
+.It Pa /var/db/pwd.db.tmp
+A temporary file.
+.It Pa /var/db/spwd.db
+The secure password database file.
+.It Pa /var/db/spwd.db.tmp
+A temporary file.
+.It Pa /etc/master.passwd
+The current password file.
+.It Pa /etc/passwd
+A Version 7 format password file.
+.El
+.Sh BUGS

 Because of the necessity for atomic update of the password files,
 Because of the necessity for atomic update of the password files,

-.I pwd_mkdb
+.Nm pwd_mkdb

 uses
 uses

-.IR rename (2)
+.Xr rename 2

 to install them.
 This, however, requires that the file specified on the command line live
 to install them.
 This, however, requires that the file specified on the command line live

-on the same file system as the ``/etc'' directory.
-.PP
+on the same file system as the
+.Dq Pa /etc
+directory.
+.Pp

 There are the obvious races with multiple people running
 There are the obvious races with multiple people running

-.I pwd_mkdb
+.Nm pwd_mkdb

 on different password files at the same time.
 The front-ends to 
 on different password files at the same time.
 The front-ends to 

-.IR pwd_mkdb ,
-.IR chpass (1),
-.IR passwd (1)
+.Nm pwd_mkdb ,
+.Xr chpass 1 ,
+.Xr passwd 1

 and
 and

-.IR vipw (8),
+.Xr vipw 8 ,

 handle the locking necessary to avoid this problem.
 handle the locking necessary to avoid this problem.

-.SH COMPATIBILITY
+.Sh COMPATIBILITY

 Previous versions of the system had a program similar to
 Previous versions of the system had a program similar to

-.I pwd_mkdb, 
-.IR mkpasswd (8),
+.Nm pwd_mkdb ,
+.Xr mkpasswd 8 ,

 which built
 which built

-.I dbm (3)
+.Xr dbm 3

 style databases for the password file but depended on the calling programs
 to install them.
 The program was renamed in order that previous users of the program
 not be surprised by the changes in functionality.
 style databases for the password file but depended on the calling programs
 to install them.
 The program was renamed in order that previous users of the program
 not be surprised by the changes in functionality.

-.SH SEE ALSO
-chpass(1), passwd(1), db(3), getpwent(3), passwd(5), vipw(8)
+.Sh SEE ALSO
+.Xr chpass 1 ,
+.Xr passwd 1 ,
+.Xr db 3 ,
+.Xr getpwent 3 ,
+.Xr passwd 5 ,
+.Xr vipw 8