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