1.\" $NetBSD: util.3,v 1.19 2009/04/11 17:26:32 joerg 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.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd November 17, 2008 31.Dt UTIL 3 32.Os 33.Sh NAME 34.Nm util 35.Nd system utilities library 36.Sh LIBRARY 37.Lb libutil 38.Sh DESCRIPTION 39The 40.Nm 41library is the system utilities library and contains various 42system-dependent utility routines used in a wide variety of system daemons. 43The abstracted functions are mostly related to pseudo-terminals 44and login accounting. 45These routines are 46.Nx Ns -specific 47and are not portable. 48Their use should be restricted. 49Declarations for these functions may be obtained from the include file 50.Pa \*[Lt]util.h\*[Gt] . 51.Sh LIST OF FUNCTIONS 52.Bl -column ".Xr sockaddr_snprintf 3" -compact 53.It Sy Name Description 54.It Xr disklabel_dkcksum 3 Ta compute the checksum for a disklabel 55.It Xr disklabel_scan 3 Ta scan a buffer for a valid disklabel 56.It Xr forkpty 3 Ta tty utility function 57.It Xr getbootfile 3 Ta get the name of the booted kernel file 58.It Xr getlabeloffset 3 Ta get the sector number and offset of the disklabel 59.It Xr getlabelsector 3 Ta get the sector number and offset of the disklabel 60.It Xr getmaxpartitions 3 Ta get the maximum number of partitions allowed per disk 61.It Xr getrawpartition 3 Ta get the system ``raw'' partition 62.It Xr login 3 Ta login utility function 63.It Xr login_cap 3 Ta query login.conf database about a user class 64.It Xr login_close 3 Ta query login.conf database about a user class 65.It Xr login_getcapbool 3 Ta query login.conf database about a user class 66.It Xr login_getcapnum 3 Ta query login.conf database about a user class 67.It Xr login_getcapsize 3 Ta query login.conf database about a user class 68.It Xr login_getcapstr 3 Ta query login.conf database about a user class 69.It Xr login_getcaptime 3 Ta query login.conf database about a user class 70.It Xr login_getclass 3 Ta query login.conf database about a user class 71.It Xr login_tty 3 Ta tty utility function 72.It Xr loginx 3 Ta login utility function 73.It Xr logout 3 Ta login utility function 74.It Xr logoutx 3 Ta login utility function 75.It Xr logwtmp 3 Ta login utility function 76.It Xr logwtmpx 3 Ta login utility function 77.It Xr opendisk 3 Ta open a disk partition 78.It Xr openpty 3 Ta tty utility function 79.It Xr pidfile 3 Ta write a daemon pid file 80.It Xr pidlock 3 Ta locks based on files containing PIDs 81.It Xr pw_abort 3 Ta passwd file update function 82.It Xr pw_copy 3 Ta utility function for interactive passwd file updates 83.It Xr pw_edit 3 Ta utility function for interactive passwd file updates 84.It Xr pw_error 3 Ta utility function for interactive passwd file updates 85.It Xr pw_getconf 3 Ta password encryption configuration access function 86.It Xr pw_getprefix 3 Ta passwd file update function 87.It Xr pw_init 3 Ta utility function for interactive passwd file updates 88.It Xr pw_lock 3 Ta passwd file update function 89.It Xr pw_mkdb 3 Ta passwd file update function 90.It Xr pw_prompt 3 Ta utility function for interactive passwd file updates 91.It Xr pw_scan 3 Ta utility function for interactive passwd file updates 92.It Xr pw_setprefix 3 Ta passwd file update function 93.It Xr secure_path 3 Ta determine if a file appears to be ``secure'' 94.It Xr setclasscontext 3 Ta query login.conf database about a user class 95.It Xr setusercontext 3 Ta query login.conf database about a user class 96.It Xr snprintb 3 Ta bitmask output conversion 97.It Xr sockaddr_snprintf 3 Ta socket address formatting function 98.It Xr ttyaction 3 Ta ttyaction utility function 99.It Xr ttylock 3 Ta locks based on files containing PIDs 100.It Xr ttymsg 3 Ta ttymsg utility function 101.It Xr ttyunlock 3 Ta locks based on files containing PIDs 102.El 103.Sh FILES 104.Bl -tag -width /usr/lib/libutil_p.a -compact 105.It Pa /usr/lib/libutil.a 106static util library 107.It Pa /usr/lib/libutil.so 108dynamic util library 109.It Pa /usr/lib/libutil_p.a 110static util library compiled for profiling 111.El 112.Sh SEE ALSO 113.Xr efun 3 114