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