1.\" Copyright (c) 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)pwd_mkdb.8 8.1 (Berkeley) 6/6/93 33.\" $FreeBSD: src/usr.sbin/pwd_mkdb/pwd_mkdb.8,v 1.15.2.4 2003/03/11 22:31:31 trhodes Exp $ 34.\" $DragonFly: src/usr.sbin/pwd_mkdb/pwd_mkdb.8,v 1.2 2003/06/17 04:30:02 dillon Exp $ 35.\" 36.Dd June 6, 1993 37.Dt PWD_MKDB 8 38.Os 39.Sh NAME 40.Nm pwd_mkdb 41.Nd "generate the password databases" 42.Sh SYNOPSIS 43.Nm 44.Op Fl C 45.Op Fl N 46.Op Fl p 47.Op Fl d Ar directory 48.Op Fl s Ar cachesize 49.Op Fl u Ar username 50.Ar file 51.Sh DESCRIPTION 52The 53.Nm 54utility creates 55.Xr db 3 56style secure and insecure databases for the specified file. 57These databases are then installed into 58.Pa /etc/spwd.db 59and 60.Pa /etc/pwd.db 61respectively. 62The file is installed into 63.Pa /etc/master.passwd . 64The file must be in the correct format (see 65.Xr passwd 5 ) . 66It is important to note that the format used in this system is 67different from the historic Version 7 style format. 68.Pp 69The options are as follows: 70.Bl -tag -width flag 71.It Fl C 72Check if the password file is in the correct format. 73Do not 74change, add, or remove any files. 75.It Fl N 76Tell 77.Nm 78to exit with an error if it cannot obtain a lock on the file. By default, 79we block waiting for a lock on the source file. The lock is held through 80the rebuilding of the database. 81.It Fl p 82Create a Version 7 style password file and install it into 83.Pa /etc/passwd . 84.It Fl d Ar directory 85Store databases into specified destination directory instead of 86.Pa /etc . 87.It Fl u Ar username 88Only update the record for the specified user. Utilities that 89operate on a single user can use this option to avoid the 90overhead of rebuilding the entire database. 91.It Fl s Ar cachesize 92Specify in megabytes the size of the memory cache used by the 93hashing library. On systems with a large user base, a small cache 94size can lead to prohibitively long database file rebuild times. 95As a rough guide, the memory usage of 96.Nm 97in megabytes will be a little bit more than twice the figure 98specified here. The default is 2 megabytes. 99.El 100.Pp 101The two databases differ in that the secure version contains the user's 102encrypted password and the insecure version has an asterisk (``*'') 103.Pp 104The databases are used by the C library password routines (see 105.Xr getpwent 3 ) . 106.Pp 107The 108.Nm 109utility exits zero on success, non-zero on failure. 110.Sh ENVIRONMENT 111If the 112.Ev PW_SCAN_BIG_IDS 113environment variable is set, 114.Nm 115will suppress the warning messages that are 116normally generated for large user and group IDs. 117Such IDs can cause serious problems with software 118that makes assumptions about the values of IDs. 119.Sh FILES 120.Bl -tag -width Pa -compact 121.It Pa /etc/pwd.db 122The insecure password database file. 123.It Pa /etc/pwd.db.tmp 124A temporary file. 125.It Pa /etc/spwd.db 126The secure password database file. 127.It Pa /etc/spwd.db.tmp 128A temporary file. 129.It Pa /etc/master.passwd 130The current password file. 131.It Pa /etc/passwd 132A Version 7 format password file. 133.El 134.Sh BUGS 135Because of the necessity for atomic update of the password files, 136.Nm 137uses 138.Xr rename 2 139to install them. 140This, however, requires that the file specified on the command line live 141on the same file system as the 142.Pa /etc 143directory. 144.Pp 145There are the obvious races with multiple people running 146.Nm 147on different password files at the same time. 148The front-ends to 149.Nm , 150.Xr chpass 1 , 151.Xr passwd 1 152and 153.Xr vipw 8 , 154handle the locking necessary to avoid this problem. 155.Sh COMPATIBILITY 156Previous versions of the system had a program similar to 157.Nm , 158.Xr mkpasswd 8 , 159which built 160.Xr dbm 3 161style databases for the password file but depended on the calling programs 162to install them. 163The program was renamed in order that previous users of the program 164not be surprised by the changes in functionality. 165.Sh SEE ALSO 166.Xr chpass 1 , 167.Xr passwd 1 , 168.Xr db 3 , 169.Xr getpwent 3 , 170.Xr passwd 5 , 171.Xr vipw 8 172