1.\" $NetBSD: pw_lock.3,v 1.3 1998/01/09 04:12:23 perry 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 SYNOPSIS 47.Fd #include <util.h> 48.Ft int 49.Fn pw_lock "int retries" 50.Ft int 51.Fn pw_mkdb 52.Ft void 53.Fn pw_abort 54.Sh DESCRIPTION 55The 56.Fn pw_lock , 57.Fn pw_mkdb , 58and 59.Fn pw_abort 60functions allow a program to update the system passwd database. 61.Pp 62The 63.Fn pw_lock 64function attempts to lock the passwd database by creating the file 65.Pa /etc/ptmp , 66and returns the file descriptor of that file. If 67.Fa retries 68is greater than zero, 69.Fn pw_lock 70will try multiple times to open 71.Pa /etc/ptmp , 72waiting one second between tries. In addition to being a lock file, 73.Pa /etc/ptmp 74will also hold the contents of the new passwd file. 75.Pp 76The 77.Fn pw_mkdb 78function updates the passwd file from the contents of 79.Pa /etc/ptmp . 80You should finish writing to and close the file descriptor returned by 81.Fn pw_lock 82before calling 83.Fn pw_mkdb . 84If 85.Fn pw_mkdb 86fails and you do not wish to retry, you should make sure to call 87.Fn pw_abort 88to clean up the lock file. 89.Pp 90The 91.Fn pw_abort 92function aborts a passwd file update by deleting 93.Pa /etc/ptmp . 94The passwd database remains unchanged. 95.Sh RETURN VALUES 96The 97.Fn pw_lock 98and 99.Fn pw_mkdb 100functions return -1 if they are unable to complete properly. 101.Sh FILES 102.Bl -tag -width /etc/master.passwd -compact 103.It Pa /etc/master.passwd 104.It Pa /etc/ptmp 105.El 106.Sh SEE ALSO 107.Xr pw_init 3 108