kldxref(8)

kldxref8

Generate hints for the kernel loader

Usage

kldxref [-Rdv] [-f hintsfile] path ...

kldxref -m module

Overview

The kldxref utility is used to generate hint files which list modules, their version numbers, and the files that contain them. These hints are used by the kernel loader to determine where to find a particular KLD module.

A separate hint file is generated for each directory listed on the command line that contains modules. If no hint records are generated for a particular directory, no hint file is created, and the preexisting hint file (if there was one in that directory) is removed.

kldxref only processes files that either have no dots in their name like kernel or that end in “.ko” like foo.ko.

The following options are available:

-R

Recurse into subdirectories.

-d

Do not generate a hint file, but print module metadata on standard output.

-f hintsfile

Specify a different name for the hints files than linker.hints.

-m module

Print information about the modules in the file module.

-v

Operate in verbose mode.

Examples

To build hint files for both standard and add-on modules:

kldxref /boot/kernel /boot/modules

To build hint files for all installed kernels:

kldxref -R /boot

Releases

56 releases since FreeBSD 5.0-RELEASE; the text changed 37 times.

  1. 5.0
  2. 5.1–5.2.1
  3. 5.3–6.3
  4. 6.4
  5. 7.0
  6. 7.1
  7. 7.2
  8. 7.3
  9. 7.4
  10. 8.0
  11. 8.1
  12. 8.2
  13. 8.3
  14. 8.4
  15. 9.0
  16. 9.1
  17. 9.2
  18. 9.3
  19. 10.0
  20. 10.1
  21. 10.2
  22. 10.3
  23. 10.4
  24. 11.0
  25. 11.1
  26. 11.2
  27. 11.3
  28. 11.4
  29. 12.0
  30. 12.1
  31. 12.2
  32. 12.3
  33. 12.4
  34. 13.0–13.2
  35. 13.3–13.5
  36. 14.0–14.5
  37. 15.0–15.1
  38. 16.0

-m since FreeBSD 16.0-CURRENT (2026-10-27).

History

The kldxref utility first appeared in FreeBSD 5.0.

Authors

The kldxref utility was implemented by Boris Popov ⟨[email protected]⟩. This manual page was written by Boris Popov ⟨[email protected]⟩ and Dag-Erling Smørgrav ⟨[email protected]⟩.

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.