xref: /netbsd-src/lib/libutil/util.3 (revision 08c81a9c2dc8c7300e893321eb65c0925d60871c)
1.\"     $NetBSD: util.3,v 1.9 2002/08/22 17:24:11 abs 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
50daemons.  The abstracted functions are mostly related to pseudo-terminals
51and login accounting.  These routines are
52.Nx Ns -specific
53and are not portable.  Their use should be restricted.  Declarations
54for these functions may be obtained from the include file
55.Pa \*[Lt]util.h\*[Gt] .
56.Sh LIST OF FUNCTIONS
57.sp 2
58.nf
59.ta \w'getmaxpartitions.3'u+2n +\w'get the maximum number of partitions allowed per disk'u
60\fIName/Page\fP	\fIDescription\fP
61.ta \w'getmaxpartitions.3'u+2n +\w'get the maximum number of partitions allowed per disk'u+6nC
62.sp 5p
63forkpty.3	tty utility function
64fparseln.3	return the next logical line from a stream
65getbootfile.3	get the name of the booted kernel file
66getmaxpartitions.3	get the maximum number of partitions allowed per disk
67getrawpartition.3	get the system ``raw'' partition
68login.3	login utility function
69login_close.3	query login.conf database about a user class
70login_getcapbool.3	query login.conf database about a user class
71login_getcapnum.3	query login.conf database about a user class
72login_getcapsize.3	query login.conf database about a user class
73login_getcapstr.3	query login.conf database about a user class
74login_getcaptime.3	query login.conf database about a user class
75login_getclass.3	query login.conf database about a user class
76login_tty.3	tty utility function
77logout.3	login utility function
78logwtmp.3	login utility function
79opendisk.3	open a disk's ``raw'' partition
80openpty.3	tty utility function
81pidfile.3	write a daemon pid file
82pidlock.3	locks based on files containing PIDs
83pw_abort.3	passwd file update function
84pw_copy.3	utility function for interactive passwd file updates
85pw_edit.3	utility function for interactive passwd file updates
86pw_error.3	utility function for interactive passwd file updates
87pw_getconf.3	password encryption configuration access function
88pw_getprefix.3	passwd file update function
89pw_init.3	utility function for interactive passwd file updates
90pw_lock.3	passwd file update function
91pw_mkdb.3	passwd file update function
92pw_prompt.3	utility function for interactive passwd file updates
93pw_scan.3	utility function for interactive passwd file updates
94pw_setprefix.3	passwd file update function
95secure_path.3	determine if a file appears to be ``secure''
96setclasscontext.3	query login.conf database about a user class
97setusercontext.3	query login.conf database about a user class
98ttyaction.3	ttyaction utility function
99ttylock.3	locks based on files containing PIDs
100ttymsg.3	ttymsg utility function
101ttyunlock.3	locks based on files containing PIDs
102.fi
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