freebsd-skq/lib/libc/gen/getbootfile.3
mpp 3aeb7f1d49 Correct a bunch of man page cross references and generally
try and silence "manck".

ncurses, rpc, and some of the gnu stuff are still a big mess, however.
1996-02-11 22:38:05 +00:00

72 lines
2.8 KiB
Groff

.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" 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 University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University 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 REGENTS 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 REGENTS 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.
.\"
.\" From: @(#)gethostname.3 8.1 (Berkeley) 6/4/93
.\" $Id: getbootfile.3,v 1.1 1994/09/23 20:21:59 wollman Exp $
.\"
.Dd September 23, 1994
.Dt GETBOOTFILE 3
.Os
.Sh NAME
.Nm getbootfile
.Nd get kernel boot file name
.Sh SYNOPSIS
.Fd #include <paths.h>
.Ft const char *
.Fn getbootfile void
.Sh DESCRIPTION
The
.Nm getbootfile
function retrieves the full pathname of the file from which the
current kernel was loaded, and returns a static pointer to the name.
A read/write interface to this information is available via the
.Xr sysctl 3
MIB variable
.Dq Li kern.bootfile .
.Sh RETURN VALUES
If the call succeeds a string giving the pathname is returned. If it
fails, a a null pointer is returned and an error code is
placed in the global location
.Va errno .
.Sh SEE ALSO
.Xr sysctl 3
.Sh BUGS
If the boot blocks have not been modified to pass this information into
the kernel at boot time, the static string
.Dq Pa /kernel
is returned instead of the real boot file.
.Sh HISTORY
The
.Nm
function call appeared in
.Tn FreeBSD
2.0.