1.\" $NetBSD: pw_lock.3,v 1.5 2000/07/10 11:19:16 ad Exp $ 2.\" 3.\" Copyright (c) 1995 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software developed by the Computer Systems 7.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract 8.\" BG 91-66 and contributed to Berkeley. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. All advertising materials mentioning features or use of this software 19.\" must display the following acknowledgement: 20.\" This product includes software developed by the University of 21.\" California, Berkeley and its contributors. 22.\" 4. Neither the name of the University nor the names of its contributors 23.\" may be used to endorse or promote products derived from this software 24.\" without specific prior written permission. 25.\" 26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36.\" SUCH DAMAGE. 37.\" 38.Dd December 15, 1995 39.Dt PW_LOCK 3 40.Os 41.Sh NAME 42.Nm pw_lock , 43.Nm pw_mkdb , 44.Nm pw_abort 45.Nd passwd file update functions 46.Sh LIBRARY 47.Lb libutil 48.Sh SYNOPSIS 49.Fd #include <util.h> 50.Ft int 51.Fn pw_lock "int retries" 52.Ft int 53.Fn pw_mkdb "void" 54.Ft void 55.Fn pw_abort "void" 56.Sh DESCRIPTION 57The 58.Fn pw_lock , 59.Fn pw_mkdb , 60and 61.Fn pw_abort 62functions allow a program to update the system passwd database. 63.Pp 64The 65.Fn pw_lock 66function attempts to lock the passwd database by creating the file 67.Pa /etc/ptmp , 68and returns the file descriptor of that file. If 69.Fa retries 70is greater than zero, 71.Fn pw_lock 72will try multiple times to open 73.Pa /etc/ptmp , 74waiting one second between tries. In addition to being a lock file, 75.Pa /etc/ptmp 76will also hold the contents of the new passwd file. 77.Pp 78The 79.Fn pw_mkdb 80function updates the passwd file from the contents of 81.Pa /etc/ptmp . 82You should finish writing to and close the file descriptor returned by 83.Fn pw_lock 84before calling 85.Fn pw_mkdb . 86If 87.Fn pw_mkdb 88fails and you do not wish to retry, you should make sure to call 89.Fn pw_abort 90to clean up the lock file. 91.Pp 92The 93.Fn pw_abort 94function aborts a passwd file update by deleting 95.Pa /etc/ptmp . 96The passwd database remains unchanged. 97.Sh RETURN VALUES 98The 99.Fn pw_lock 100and 101.Fn pw_mkdb 102functions return -1 if they are unable to complete properly. 103.Sh FILES 104.Bl -tag -width /etc/master.passwd -compact 105.It Pa /etc/master.passwd 106.It Pa /etc/ptmp 107.El 108.Sh SEE ALSO 109.Xr pw_init 3 110