xref: /freebsd/sbin/kldconfig/kldconfig.8 (revision d93a896ef95946b0bf1219866fcb324b78543444)
1.\"
2.\" Copyright (c) 2001 Peter Pentchev
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd April 27, 2017
29.Dt KLDCONFIG 8
30.Os
31.Sh NAME
32.Nm kldconfig
33.Nd display or modify the kernel module search path
34.Sh SYNOPSIS
35.Nm
36.Op Fl dfimnUv
37.Op Fl S Ar sysctlname
38.Op Ar path ...
39.Nm
40.Fl r
41.Sh DESCRIPTION
42The
43.Nm
44utility
45displays or modifies the search path used by the kernel when loading modules
46using the
47.Xr kldload 8
48utility or the
49.Xr kldload 2
50syscall.
51.Pp
52The following options are available:
53.Bl -tag -width indent
54.It Fl d
55Remove the specified paths from the module search path.
56.It Fl f
57Do not display a diagnostic message if a path specified for adding is
58already present in the search path, or if a path specified for removing
59is not present in the search path.
60This may be useful in startup/shutdown scripts for adding a path to
61a file system which is still not mounted, or in shutdown scripts for
62unconditionally removing a path that may have been added during startup.
63.It Fl i
64Add the specified paths to the beginning of the search path, not to the end.
65This option can only be used when adding paths.
66.It Fl m
67Instead of replacing the module search path with the set of paths
68specified,
69.Dq merge
70in the new entries.
71.It Fl n
72Do not actually change the module search path.
73.It Fl r
74Display the current search path.
75This option cannot be used if any paths are also specified.
76.It Fl S Ar sysctlname
77Specify the sysctl name to use instead of the default
78.Va kern.module_path .
79.It Fl U
80.Dq Unique-ify
81the current search path - if any of the directories is repeated one
82or more times, only the first occurrence remains.
83This option implies
84.Fl m .
85.It Fl v
86Verbose output: display the new module search path.
87If the path has been changed, and the
88.Fl v
89flag is specified more than once, the old path is displayed as well.
90.El
91.Sh FILES
92.Bl -tag -width indent
93.It Pa /boot/kernel , /boot/modules , /modules
94The default module search path used by the kernel.
95.El
96.Sh EXIT STATUS
97.Ex -std
98.Sh SEE ALSO
99.Xr kldload 2 ,
100.Xr kldload 8 ,
101.Xr kldxref 8 ,
102.Xr sysctl 8
103.Sh HISTORY
104The
105.Nm
106utility first appeared in
107.Fx 4.4 .
108.Sh AUTHORS
109.An Peter Pentchev Aq Mt roam@FreeBSD.org
110