Write a real man page.
This commit is contained in:
parent
a2f2b3afcd
commit
3d4630a415
@ -2,6 +2,6 @@
|
||||
|
||||
PROG= kldxref
|
||||
SRCS= kldxref.c ef.c
|
||||
NOMAN=
|
||||
MAN= kldxref.8
|
||||
|
||||
.include <bsd.prog.mk>
|
||||
|
@ -1,25 +1,94 @@
|
||||
$FreeBSD$
|
||||
|
||||
[DRAFT]
|
||||
|
||||
kldxref(8) used to generate linker.hints file which contains list of
|
||||
modules, their version numbers and container KLDs. This file used by loader
|
||||
and kernel linker.
|
||||
|
||||
Each directory with KLDs should have its own linker.hints file.
|
||||
|
||||
Typical invocation of kldxref utility may look like this:
|
||||
|
||||
kldxref /boot/kernel /modules
|
||||
|
||||
which will build hints file in both directories.
|
||||
|
||||
A recursive behaviour can be specified with -R option:
|
||||
|
||||
kldxref /boot
|
||||
|
||||
If no hint records written, hints file will not be created and old file
|
||||
will be removed.
|
||||
|
||||
If -d flag specified then no files generated and program prints metadata
|
||||
records to stdout.
|
||||
.\"-
|
||||
.\" Copyright (c) 2001 Boris Popov
|
||||
.\" Copyright (c) 2001 Dag-Erling Coïdan Smørgrav
|
||||
.\" 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
|
||||
.Nd genereate hints for the kernel loader
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl Rdv
|
||||
.Op Fl f Ar file
|
||||
.Op Ar path ...
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
command is used to generate hint files which list modules, their
|
||||
version numbers, and the files that contains them.
|
||||
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:
|
||||
.Bl -tag -width Fl
|
||||
.It Fl R
|
||||
Recurse into subdirectories.
|
||||
.It Fl d
|
||||
Don't generate a hint file, but print module metadata on standard
|
||||
output.
|
||||
.It Fl f Ar file
|
||||
Specify a different name for the hint files than
|
||||
.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
|
||||
.Dl kldxref /boot/kernel /modules
|
||||
.Pp
|
||||
To build hint files for all installed kernels:
|
||||
.Pp
|
||||
.Dl kldxref -R /boot
|
||||
.Sh SEE ALSO
|
||||
.Xr kld 4 ,
|
||||
.Xr kldconfig 8 ,
|
||||
.Xr kldload 8 ,
|
||||
.Xr kldstat 8 ,
|
||||
.Xr kldunload 8
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
command first appeared in
|
||||
.Fx 5.0 .
|
||||
.Sh AUTHORS
|
||||
The
|
||||
.Nm
|
||||
command was implemented by
|
||||
.An Boris Popov Aq bp@FreeBSD.org .
|
||||
This manual page was written by
|
||||
.An Boris Popov Aq bp@FreeBSD.org
|
||||
and
|
||||
.An Dag-Erling Co\(:idan Sm\(/orgrav Aq des@FreeBSD.org .
|
||||
|
Loading…
Reference in New Issue
Block a user