usr.sbin/pwd_mkdb/pwd_mkdb.8

   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.3 2006/02/17 19:40:22 swildner 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
  52 The
  53 .Nm
  54 utility creates
  55 .Xr db 3
  56 style secure and insecure databases for the specified file.
  57 These databases are then installed into
  58 .Pa /etc/spwd.db
  59 and
  60 .Pa /etc/pwd.db
  61 respectively.
  62 The file is installed into
  63 .Pa /etc/master.passwd .
  64 The file must be in the correct format (see
  65 .Xr passwd 5 ) .
  66 It is important to note that the format used in this system is
  67 different from the historic Version 7 style format.
  68 .Pp
  69 The options are as follows:
  70 .Bl -tag -width flag
  71 .It Fl C
  72 Check if the password file is in the correct format.
  73 Do not
  74 change, add, or remove any files.
  75 .It Fl N
  76 Tell
  77 .Nm
  78 to exit with an error if it cannot obtain a lock on the file.  By default,
  79 we block waiting for a lock on the source file.  The lock is held through
  80 the rebuilding of the database.
  81 .It Fl p
  82 Create a Version 7 style password file and install it into
  83 .Pa /etc/passwd .
  84 .It Fl d Ar directory
  85 Store databases into specified destination directory instead of
  86 .Pa /etc .
  87 .It Fl u Ar username
  88 Only update the record for the specified user.  Utilities that
  89 operate on a single user can use this option to avoid the
  90 overhead of rebuilding the entire database.
  91 .It Fl s Ar cachesize
  92 Specify in megabytes the size of the memory cache used by the
  93 hashing library.  On systems with a large user base, a small cache
  94 size can lead to prohibitively long database file rebuild times.
  95 As a rough guide, the memory usage of
  96 .Nm
  97 in megabytes will be a little bit more than twice the figure
  98 specified here.  The default is 2 megabytes.
  99 .El
 100 .Pp
 101 The two databases differ in that the secure version contains the user's
 102 encrypted password and the insecure version has an asterisk (``*'')
 103 .Pp
 104 The databases are used by the C library password routines (see
 105 .Xr getpwent 3 ) .
 106 .Pp
 107 The
 108 .Nm
 109 utility exits zero on success, non-zero on failure.
 110 .Sh ENVIRONMENT
 111 If the
 112 .Ev PW_SCAN_BIG_IDS
 113 environment variable is set,
 114 .Nm
 115 will suppress the warning messages that are
 116 normally generated for large user and group IDs.
 117 Such IDs can cause serious problems with software
 118 that makes assumptions about the values of IDs.
 119 .Sh FILES
 120 .Bl -tag -width Pa -compact
 121 .It Pa /etc/pwd.db
 122 The insecure password database file.
 123 .It Pa /etc/pwd.db.tmp
 124 A temporary file.
 125 .It Pa /etc/spwd.db
 126 The secure password database file.
 127 .It Pa /etc/spwd.db.tmp
 128 A temporary file.
 129 .It Pa /etc/master.passwd
 130 The current password file.
 131 .It Pa /etc/passwd
 132 A Version 7 format password file.
 133 .El
 134 .Sh COMPATIBILITY
 135 Previous versions of the system had a program similar to
 136 .Nm ,
 137 .Xr mkpasswd 8 ,
 138 which built
 139 .Xr dbm 3
 140 style databases for the password file but depended on the calling programs
 141 to install them.
 142 The program was renamed in order that previous users of the program
 143 not be surprised by the changes in functionality.
 144 .Sh SEE ALSO
 145 .Xr chpass 1 ,
 146 .Xr passwd 1 ,
 147 .Xr db 3 ,
 148 .Xr getpwent 3 ,
 149 .Xr passwd 5 ,
 150 .Xr vipw 8
 151 .Sh BUGS
 152 Because of the necessity for atomic update of the password files,
 153 .Nm
 154 uses
 155 .Xr rename 2
 156 to install them.
 157 This, however, requires that the file specified on the command line live
 158 on the same file system as the
 159 .Pa /etc
 160 directory.
 161 .Pp
 162 There are the obvious races with multiple people running
 163 .Nm
 164 on different password files at the same time.
 165 The front-ends to
 166 .Nm ,
 167 .Xr chpass 1 ,
 168 .Xr passwd 1
 169 and
 170 .Xr vipw 8 ,
 171 handle the locking necessary to avoid this problem.