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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)gethostname.3 8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/gen/getbootfile.3,v 1.6.2.3 2001/12/14 18:33:51 ru Exp $
  30 .\" $DragonFly: src/lib/libc/gen/getbootfile.3,v 1.6 2008/09/02 11:50:46 matthias Exp $
  31 .\"
  32 .Dd September 2, 2008
  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 .Va kern.bootfile .
  53 .Sh RETURN VALUES
  54 If the call succeeds a string giving the pathname is returned.  If it
  55 fails, a null pointer is returned and an error code is
  56 placed in the global location
  57 .Va errno .
  58 .Sh SEE ALSO
  59 .Xr sysctl 3
  60 .Sh HISTORY
  61 The
  62 .Fn getbootfile
  63 function call appeared in
  64 .Fx 2.0 .
  65 .Sh BUGS
  66 If the boot blocks have not been modified to pass this information into
  67 the kernel at boot time, the static string
  68 .Dq Pa /boot/kernel
  69 is returned instead of the real boot file.