usr.sbin/vipw/vipw.8

   1 .\" Copyright (c) 1983, 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 .\"     @(#)vipw.8      8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD: src/usr.sbin/vipw/vipw.8,v 1.7.2.4 2003/03/11 22:31:34 trhodes Exp $
  34 .\" $DragonFly: src/usr.sbin/vipw/vipw.8,v 1.2 2003/06/17 04:30:04 dillon Exp $
  35 .\"
  36 .Dd June 6, 1993
  37 .Dt VIPW 8
  38 .Os
  39 .Sh NAME
  40 .Nm vipw
  41 .Nd edit the password file
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl d Ar directory
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility edits the password file after setting the appropriate locks,
  49 and does any necessary processing after the password file is unlocked.
  50 If the password file is already locked for editing by another user,
  51 .Nm
  52 will ask you
  53 to try again later.
  54 The default editor for
  55 .Nm
  56 is
  57 .Xr vi 1 .
  58 .Pp
  59 When run without options,
  60 .Nm
  61 will work with the password files in
  62 .Pa /etc .
  63 The
  64 .Fl d
  65 option may be used to specify an alternative
  66 .Ar directory
  67 to work with.
  68 .Pp
  69 The
  70 .Nm
  71 utility performs a number of consistency checks on the password entries,
  72 and will not allow a password file with a
  73 .Dq mangled
  74 entry to be
  75 installed.
  76 If
  77 .Nm
  78 rejects the new password file, the user is prompted to re-enter
  79 the edit session.
  80 .Pp
  81 Once the information has been verified,
  82 .Nm
  83 uses
  84 .Xr pwd_mkdb 8
  85 to update the user database.  This is run in the background, and,
  86 at very large sites could take several minutes.  Until this update
  87 is completed, the password file is unavailable for other updates
  88 and the new information is not available to programs.
  89 .Sh ENVIRONMENT
  90 If the following environment variable exists it will be utilized by
  91 .Nm :
  92 .Bl -tag -width PW_SCAN_BIG_IDS
  93 .It Ev EDITOR
  94 The editor specified by the string
  95 .Ev EDITOR
  96 will be invoked instead of the default editor
  97 .Xr vi 1 .
  98 .It Ev PW_SCAN_BIG_IDS
  99 See
 100 .Xr pwd_mkdb 8 .
 101 .El
 102 .Sh SEE ALSO
 103 .Xr chpass 1 ,
 104 .Xr passwd 1 ,
 105 .Xr passwd 5 ,
 106 .Xr adduser 8 ,
 107 .Xr pwd_mkdb 8
 108 .Sh HISTORY
 109 The
 110 .Nm
 111 utility appeared in
 112 .Bx 4.0 .