lib/libc/gen/getbootfile.3

   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: src/lib/libc/gen/getbootfile.3,v 1.6.2.3 2001/12/14 18:33:51 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/getbootfile.3,v 1.6 2008/09/02 11:50:46 matthias Exp $
  35 .\"
  36 .Dd September 2, 2008
  37 .Dt GETBOOTFILE 3
  38 .Os
  39 .Sh NAME
  40 .Nm getbootfile
  41 .Nd get kernel boot file name
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In paths.h
  46 .Ft const char *
  47 .Fn getbootfile void
  48 .Sh DESCRIPTION
  49 The
  50 .Fn getbootfile
  51 function retrieves the full pathname of the file from which the
  52 current kernel was loaded, and returns a static pointer to the name.
  53 A read/write interface to this information is available via the
  54 .Xr sysctl 3
  55 MIB variable
  56 .Va kern.bootfile .
  57 .Sh RETURN VALUES
  58 If the call succeeds a string giving the pathname is returned.  If it
  59 fails, a null pointer is returned and an error code is
  60 placed in the global location
  61 .Va errno .
  62 .Sh SEE ALSO
  63 .Xr sysctl 3
  64 .Sh HISTORY
  65 The
  66 .Fn getbootfile
  67 function call appeared in
  68 .Fx 2.0 .
  69 .Sh BUGS
  70 If the boot blocks have not been modified to pass this information into
  71 the kernel at boot time, the static string
  72 .Dq Pa /boot/kernel
  73 is returned instead of the real boot file.