| 1 |
.\" $MidnightBSD$ |
| 2 |
.\" Copyright (c) 1983, 1991, 1993 |
| 3 |
.\" The Regents of the University of California. All rights reserved. |
| 4 |
.\" |
| 5 |
.\" Redistribution and use in source and binary forms, with or without |
| 6 |
.\" modification, are permitted provided that the following conditions |
| 7 |
.\" are met: |
| 8 |
.\" 1. Redistributions of source code must retain the above copyright |
| 9 |
.\" notice, this list of conditions and the following disclaimer. |
| 10 |
.\" 2. Redistributions in binary form must reproduce the above copyright |
| 11 |
.\" notice, this list of conditions and the following disclaimer in the |
| 12 |
.\" documentation and/or other materials provided with the distribution. |
| 13 |
.\" 4. Neither the name of the University nor the names of its contributors |
| 14 |
.\" may be used to endorse or promote products derived from this software |
| 15 |
.\" without specific prior written permission. |
| 16 |
.\" |
| 17 |
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
| 18 |
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 19 |
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 20 |
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
| 21 |
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 22 |
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 23 |
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 24 |
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 25 |
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 26 |
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 27 |
.\" SUCH DAMAGE. |
| 28 |
.\" |
| 29 |
.\" From: @(#)gethostname.3 8.1 (Berkeley) 6/4/93 |
| 30 |
.\" $FreeBSD: stable/10/lib/libc/gen/getbootfile.3 165903 2007-01-09 00:28:16Z imp $ |
| 31 |
.\" |
| 32 |
.Dd September 23, 1994 |
| 33 |
.Dt GETBOOTFILE 3 |
| 34 |
.Os |
| 35 |
.Sh NAME |
| 36 |
.Nm getbootfile |
| 37 |
.Nd get kernel boot file name |
| 38 |
.Sh LIBRARY |
| 39 |
.Lb libc |
| 40 |
.Sh SYNOPSIS |
| 41 |
.In paths.h |
| 42 |
.Ft const char * |
| 43 |
.Fn getbootfile void |
| 44 |
.Sh DESCRIPTION |
| 45 |
The |
| 46 |
.Fn getbootfile |
| 47 |
function retrieves the full pathname of the file from which the |
| 48 |
current kernel was loaded, and returns a static pointer to the name. |
| 49 |
A read/write interface to this information is available via the |
| 50 |
.Xr sysctl 3 |
| 51 |
MIB variable |
| 52 |
.Dq Li kern.bootfile . |
| 53 |
.Sh RETURN VALUES |
| 54 |
If the call succeeds a string giving the pathname is returned. |
| 55 |
If it |
| 56 |
fails, a null pointer is returned and an error code is |
| 57 |
placed in the global location |
| 58 |
.Va errno . |
| 59 |
.Sh SEE ALSO |
| 60 |
.Xr sysctl 3 |
| 61 |
.Sh HISTORY |
| 62 |
The |
| 63 |
.Fn getbootfile |
| 64 |
function appeared in |
| 65 |
.Fx 2.0 . |
| 66 |
.Sh BUGS |
| 67 |
If the boot blocks have not been modified to pass this information into |
| 68 |
the kernel at boot time, the static string |
| 69 |
.Dq Pa /boot/kernel/kernel |
| 70 |
is returned instead of the real boot file. |
