1.\" $NetBSD: util.3,v 1.12 2002/11/30 03:04:46 lukem Exp $ 2.\" 3.\" Copyright (c) 2001 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Gregory McGarry. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd August 8, 2002 38.Dt UTIL 3 39.Os 40.Sh NAME 41.Nm util 42.Nd system utilities library 43.Sh LIBRARY 44.Lb libutil 45.Sh DESCRIPTION 46The 47.Nm 48library is the system utilities library and contains various 49system-dependent utility routines used in a wide variety of system daemons. 50The abstracted functions are mostly related to pseudo-terminals 51and login accounting. 52These routines are 53.Nx Ns -specific 54and are not portable. 55Their use should be restricted. 56Declarations for these functions may be obtained from the include file 57.Pa \*[Lt]util.h\*[Gt] . 58.Sh LIST OF FUNCTIONS 59.sp 2 60.nf 61.ta \w'getmaxpartitions.3'u+2n +\w'get the maximum number of partitions allowed per disk'u 62\fIName/Page\fP \fIDescription\fP 63.ta \w'getmaxpartitions.3'u+2n +\w'get the maximum number of partitions allowed per disk'u+6nC 64.sp 5p 65disklabel_dkcksum.3 compute the checksum of a disklabel 66disklabel_scan.3 scan a buffer for a valid disklabel 67forkpty.3 tty utility function 68getbootfile.3 get the name of the booted kernel file 69getmaxpartitions.3 get the maximum number of partitions allowed per disk 70getrawpartition.3 get the system ``raw'' partition 71login.3 login utility function 72login_close.3 query login.conf database about a user class 73login_getcapbool.3 query login.conf database about a user class 74login_getcapnum.3 query login.conf database about a user class 75login_getcapsize.3 query login.conf database about a user class 76login_getcapstr.3 query login.conf database about a user class 77login_getcaptime.3 query login.conf database about a user class 78login_getclass.3 query login.conf database about a user class 79login_tty.3 tty utility function 80logout.3 login utility function 81logwtmp.3 login utility function 82opendisk.3 open a disk's ``raw'' partition 83openpty.3 tty utility function 84pidfile.3 write a daemon pid file 85pidlock.3 locks based on files containing PIDs 86pw_abort.3 passwd file update function 87pw_copy.3 utility function for interactive passwd file updates 88pw_edit.3 utility function for interactive passwd file updates 89pw_error.3 utility function for interactive passwd file updates 90pw_getconf.3 password encryption configuration access function 91pw_getprefix.3 passwd file update function 92pw_init.3 utility function for interactive passwd file updates 93pw_lock.3 passwd file update function 94pw_mkdb.3 passwd file update function 95pw_prompt.3 utility function for interactive passwd file updates 96pw_scan.3 utility function for interactive passwd file updates 97pw_setprefix.3 passwd file update function 98secure_path.3 determine if a file appears to be ``secure'' 99setclasscontext.3 query login.conf database about a user class 100setusercontext.3 query login.conf database about a user class 101ttyaction.3 ttyaction utility function 102ttylock.3 locks based on files containing PIDs 103ttymsg.3 ttymsg utility function 104ttyunlock.3 locks based on files containing PIDs 105.fi 106.Sh FILES 107.Bl -tag -width /usr/lib/libutil_p.a -compact 108.It Pa /usr/lib/libutil.a 109static util library 110.It Pa /usr/lib/libutil.so 111dynamic util library 112.It Pa /usr/lib/libutil_p.a 113static util library compiled for profiling 114.El 115