2001-10-12 02:06:34 +00:00
|
|
|
.\"-
|
|
|
|
|
.\" Copyright (c) 2001 Boris Popov
|
2011-12-30 00:59:08 +00:00
|
|
|
.\" Copyright (c) 2001 Dag-Erling Coïdan Smørgrav
|
2001-10-12 02:06:34 +00:00
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
|
|
|
|
.Dd October 9, 2001
|
|
|
|
|
.Dt KLDXREF 8
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm kldxref
|
2001-11-22 12:08:35 +00:00
|
|
|
.Nd generate hints for the kernel loader
|
2001-10-12 02:06:34 +00:00
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Nm
|
|
|
|
|
.Op Fl Rdv
|
2004-06-01 09:34:04 +00:00
|
|
|
.Op Fl f Ar hintsfile
|
|
|
|
|
.Ar path ...
|
2001-10-12 02:06:34 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
2002-07-14 14:47:15 +00:00
|
|
|
utility is used to generate hint files which list modules, their
|
2001-11-22 12:03:31 +00:00
|
|
|
version numbers, and the files that contain them.
|
2001-10-12 02:06:34 +00:00
|
|
|
These hints are used by the kernel loader to determine where to find a
|
|
|
|
|
particular KLD module.
|
|
|
|
|
.Pp
|
|
|
|
|
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.
|
|
|
|
|
.Pp
|
|
|
|
|
The following options are available:
|
2004-06-01 09:34:04 +00:00
|
|
|
.Bl -tag -width indent
|
2001-10-12 02:06:34 +00:00
|
|
|
.It Fl R
|
|
|
|
|
Recurse into subdirectories.
|
|
|
|
|
.It Fl d
|
2001-11-22 12:03:31 +00:00
|
|
|
Do not generate a hint file, but print module metadata on standard
|
2001-10-12 02:06:34 +00:00
|
|
|
output.
|
2004-06-01 09:34:04 +00:00
|
|
|
.It Fl f Ar hintsfile
|
|
|
|
|
Specify a different name for the hints files than
|
2001-10-12 02:06:34 +00:00
|
|
|
.Pa linker.hints .
|
|
|
|
|
.It Fl v
|
|
|
|
|
Operate in verbose mode.
|
|
|
|
|
.El
|
|
|
|
|
.Sh EXAMPLES
|
|
|
|
|
To build hint files for both standard and add-on modules:
|
|
|
|
|
.Pp
|
2003-03-03 22:49:21 +00:00
|
|
|
.Dl "kldxref /boot/kernel /boot/modules"
|
2001-10-12 02:06:34 +00:00
|
|
|
.Pp
|
|
|
|
|
To build hint files for all installed kernels:
|
|
|
|
|
.Pp
|
2001-11-22 12:03:31 +00:00
|
|
|
.Dl "kldxref -R /boot"
|
2001-10-12 02:06:34 +00:00
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr kld 4 ,
|
|
|
|
|
.Xr kldconfig 8 ,
|
|
|
|
|
.Xr kldload 8 ,
|
|
|
|
|
.Xr kldstat 8 ,
|
|
|
|
|
.Xr kldunload 8
|
|
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
2002-07-14 14:47:15 +00:00
|
|
|
utility first appeared in
|
2001-10-12 02:06:34 +00:00
|
|
|
.Fx 5.0 .
|
|
|
|
|
.Sh AUTHORS
|
2001-11-22 12:03:31 +00:00
|
|
|
.An -nosplit
|
2001-10-12 02:06:34 +00:00
|
|
|
The
|
|
|
|
|
.Nm
|
2002-07-14 14:47:15 +00:00
|
|
|
utility was implemented by
|
2014-06-20 09:57:27 +00:00
|
|
|
.An Boris Popov Aq Mt bp@FreeBSD.org .
|
2001-10-12 02:06:34 +00:00
|
|
|
This manual page was written by
|
2014-06-20 09:57:27 +00:00
|
|
|
.An Boris Popov Aq Mt bp@FreeBSD.org
|
2001-10-12 02:06:34 +00:00
|
|
|
and
|
2014-06-20 09:57:27 +00:00
|
|
|
.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
|
