usr.sbin/kldxref/kldxref.8

   1 .\"-
   2 .\" Copyright (c) 2001 Boris Popov
   3 .\" Copyright (c) 2001 Dag-Erling Coïdan Smørgrav
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd October 9, 2001
  30 .Dt KLDXREF 8
  31 .Os
  32 .Sh NAME
  33 .Nm kldxref
  34 .Nd generate hints for the kernel loader
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl Rdv
  38 .Op Fl f Ar hintsfile
  39 .Ar path ...
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility is used to generate hint files which list modules, their
  44 version numbers, and the files that contain them.
  45 These hints are used by the kernel loader to determine where to find a
  46 particular KLD module.
  47 .Pp
  48 A separate hint file is generated for each directory listed on the
  49 command line that contains modules.
  50 If no hint records are generated for a particular directory, no hint
  51 file is created, and the preexisting hint file (if there was one in
  52 that directory) is removed.
  53 .Pp
  54 The following options are available:
  55 .Bl -tag -width indent
  56 .It Fl R
  57 Recurse into subdirectories.
  58 .It Fl d
  59 Do not generate a hint file, but print module metadata on standard
  60 output.
  61 .It Fl f Ar hintsfile
  62 Specify a different name for the hints files than
  63 .Pa linker.hints .
  64 .It Fl v
  65 Operate in verbose mode.
  66 .El
  67 .Sh EXAMPLES
  68 To build hint files for both standard and add-on modules:
  69 .Pp
  70 .Dl "kldxref /boot/kernel /boot/modules"
  71 .Pp
  72 To build hint files for all installed kernels:
  73 .Pp
  74 .Dl "kldxref -R /boot"
  75 .Sh SEE ALSO
  76 .Xr kld 4 ,
  77 .Xr kldconfig 8 ,
  78 .Xr kldload 8 ,
  79 .Xr kldstat 8 ,
  80 .Xr kldunload 8
  81 .Sh HISTORY
  82 The
  83 .Nm
  84 utility first appeared in
  85 .Fx 5.0 .
  86 .Sh AUTHORS
  87 .An -nosplit
  88 The
  89 .Nm
  90 utility was implemented by
  91 .An Boris Popov Aq bp@FreeBSD.org .
  92 This manual page was written by
  93 .An Boris Popov Aq bp@FreeBSD.org
  94 and
  95 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .