[src/trunk]: src/lib/libutil Add a catch-all man page for libutil.

[gmcgarry <gmcgarry%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/453ad28ed6fd
branches:  trunk
changeset: 518002:453ad28ed6fd
user:      gmcgarry <gmcgarry%NetBSD.org@localhost>
date:      Fri Nov 23 06:20:37 2001 +0000

description:
Add a catch-all man page for libutil.

diffstat:

 lib/libutil/Makefile |    4 +-
 lib/libutil/util.3   |  110 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 112 insertions(+), 2 deletions(-)

diffs (132 lines):

diff -r 070838d38910 -r 453ad28ed6fd lib/libutil/Makefile
--- a/lib/libutil/Makefile      Fri Nov 23 05:18:59 2001 +0000
+++ b/lib/libutil/Makefile      Fri Nov 23 06:20:37 2001 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.30 2001/08/20 14:47:49 wiz Exp $
+#      $NetBSD: Makefile,v 1.31 2001/11/23 06:20:37 gmcgarry Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/4/93
 
 LIB=   util
@@ -11,7 +11,7 @@
 MAN=   fparseln.3 getbootfile.3 getmaxpartitions.3 getrawpartition.3 \
        login.3 login_cap.3 opendisk.3 \
        openpty.3 pidfile.3 pidlock.3 pw_getconf.3 pw_init.3 pw_lock.3 \
-       secure_path.3 ttyaction.3 ttymsg.3
+       secure_path.3 ttyaction.3 ttymsg.3 util.3
 
 .PATH: ${.CURDIR}/../libc/gen
 
diff -r 070838d38910 -r 453ad28ed6fd lib/libutil/util.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libutil/util.3        Fri Nov 23 06:20:37 2001 +0000
@@ -0,0 +1,110 @@
+.\"     $NetBSD: util.3,v 1.1 2001/11/23 06:20:37 gmcgarry Exp $
+.\"
+.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Gregory McGarry.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd November 23, 2001
+.Dt UTIL 3
+.Os
+.Sh NAME
+.Nm util
+.Nd system utilities library
+.Sh LIBRARY
+.Lb libutil
+.Sh DESCRIPTION
+The
+.Nm
+library is the system utilities library and contains various
+system-dependent utility routines mostly related to pseudo-terminals
+and login accounting.  These routines are
+.Nx -specific
+and are not portable.  Their use should be restricted.  Declarations
+for these functions may be obtained from the include file
+.Pa <util.h> .
+.Sh LIST OF FUNCTIONS
+.sp 2
+.nf
+.ta \w'getmaxpartitions.3'u+2n +\w'get the maximum number of partitions allowed per disk'u
+\fIName/Page\fP        \fIDescription\fP
+.ta \w'getmaxpartitions.3'u+2n +\w'get the maximum number of partitions allowed per disk'u+6nC
+.sp 5p
+forkpty.3      tty utility function
+fparseln.3     return the next logical line from a stream
+getbootfile.3  get the name of the booted kernel file
+getmaxpartitions.3     get the maximum number of partitions allowed per disk
+getrawpartition.3      get the system ``raw'' partition
+login.3        login utility function
+login_close.3  query login.conf database about a user class
+login_getcapbool.3     query login.conf database about a user class
+login_getcapnum.3      query login.conf database about a user class
+login_getcapsize.3     query login.conf database about a user class
+login_getcapstr.3      query login.conf database about a user class
+login_getcaptime.3     query login.conf database about a user class
+login_getclass.3       query login.conf database about a user class
+login_tty.3    tty utility function
+logout.3       login utility function
+logwtmp.3      login utility function
+opendisk.3     open a disk's ``raw'' partition
+openpty.3      tty utility function
+pidfile.3      write a daemon pid file
+pidlock.3      locks based on files containing PIDs
+pw_abort.3     passwd file update function
+pw_copy.3      utility function for interactive passwd file updates
+pw_edit.3      utility function for interactive passwd file upda
+pw_error.3     utility function for interactive passwd file upda
+pw_getconf.3   password encryption configuration access function
+pw_getprefix.3 passwd file update function
+pw_init.3      utility function for interactive passwd file upda
+pw_lock.3      passwd file update function
+pw_mkdb.3      passwd file update function
+pw_prompt.3    utility function for interactive passwd file upda
+pw_scan.3      utility function for interactive passwd file upda
+pw_setprefix.3 passwd file update function
+secure_path.3  determine if a file appears to be ``secure''
+setclasscontext.3      query login.conf database about a user class
+setusercontext.3       query login.conf database about a user class
+ttyaction.3    ttyaction utility function
+ttylock.3      locks based on files containing PIDs
+ttymsg.3       ttymsg utility function
+ttyunlock.3    locks based on files containing PIDs
+.fi
+.Sh FILES
+.Bl -tag -width /usr/lib/libutil_p.a -compact
+.It Pa /usr/lib/libutil.a
+static util library
+.It Pa /usr/lib/libutil.so
+dynamic util library
+.It Pa /usr/lib/libutil_p.a
+static util library compiled for profiling
+.El