1.\" $NetBSD: util.3,v 1.13 2002/12/22 02:19:15 wiz 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 December 22, 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 for 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 69getlabeloffset.3 get the sector number and offset of the disklabel 70getlabelsector.3 get the sector number and offset of the disklabel 71getmaxpartitions.3 get the maximum number of partitions allowed per disk 72getrawpartition.3 get the system ``raw'' partition 73login.3 login utility function 74login_cap.3 query login.conf database about a user class 75login_close.3 query login.conf database about a user class 76login_getcapbool.3 query login.conf database about a user class 77login_getcapnum.3 query login.conf database about a user class 78login_getcapsize.3 query login.conf database about a user class 79login_getcapstr.3 query login.conf database about a user class 80login_getcaptime.3 query login.conf database about a user class 81login_getclass.3 query login.conf database about a user class 82login_tty.3 tty utility function 83loginx.3 login utility function 84logout.3 login utility function 85logoutx.3 login utility function 86logwtmp.3 login utility function 87logwtmpx.3 login utility function 88opendisk.3 open a disk partition 89openpty.3 tty utility function 90pidfile.3 write a daemon pid file 91pidlock.3 locks based on files containing PIDs 92pw_abort.3 passwd file update function 93pw_copy.3 utility function for interactive passwd file updates 94pw_edit.3 utility function for interactive passwd file updates 95pw_error.3 utility function for interactive passwd file updates 96pw_getconf.3 password encryption configuration access function 97pw_getprefix.3 passwd file update function 98pw_init.3 utility function for interactive passwd file updates 99pw_lock.3 passwd file update function 100pw_mkdb.3 passwd file update function 101pw_prompt.3 utility function for interactive passwd file updates 102pw_scan.3 utility function for interactive passwd file updates 103pw_setprefix.3 passwd file update function 104secure_path.3 determine if a file appears to be ``secure'' 105setclasscontext.3 query login.conf database about a user class 106setusercontext.3 query login.conf database about a user class 107snprintb.3 bitmask output conversion 108ttyaction.3 ttyaction utility function 109ttylock.3 locks based on files containing PIDs 110ttymsg.3 ttymsg utility function 111ttyunlock.3 locks based on files containing PIDs 112.fi 113.Sh FILES 114.Bl -tag -width /usr/lib/libutil_p.a -compact 115.It Pa /usr/lib/libutil.a 116static util library 117.It Pa /usr/lib/libutil.so 118dynamic util library 119.It Pa /usr/lib/libutil_p.a 120static util library compiled for profiling 121.El 122