xref: /freebsd/sbin/kldconfig/kldconfig.8 (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
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 June 15, 2001
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 name
38.Op Ar path ...
39.Nm
40.Fl r
41.Sh DESCRIPTION
42.Nm
43displays or modifies the search path used by the kernel when loading modules
44using the
45.Xr kldload 8
46utility or the
47.Xr kldload 2
48syscall.
49.Pp
50The following options are available:
51.Bl -tag -width indent
52.It Fl d
53Remove the specified paths from the module search path.
54.It Fl f
55Do not display a diagnostic message if a path specified for adding is
56already present in the search path, or if a path specified for removing
57is not present in the search path.
58This may be useful in startup/shutdown scripts for adding a path to
59a filesystem which is still not mounted, or in shutdown scripts for
60unconditionally removing a path that may have been added during startup.
61.It Fl i
62Add the specified paths to the beginning of the search path, not to the end.
63This option can only be used when adding paths.
64.It Fl m
65Instead of replacing the module search path with the set of paths
66specified,
67.Dq merge
68in the new entries.
69.It Fl n
70Do not actually change the module search path.
71.It Fl r
72Display the current search path.
73This option cannot be used if any paths are also specified.
74.It Fl S Ar name
75Specify the sysctl name to use instead of the default
76.Va kern.module_path .
77.It Fl U
78.Dq Unique-ify
79the current search path - if any of the directories is repeated one
80or more times, only the first occurrence remains.
81This option implies
82.Fl m .
83.It Fl v
84Verbose output: display the new module search path.
85If the path has been changed, and the
86.Fl v
87flag is specified more than once, the old path is displayed as well.
88.El
89.Sh FILES
90.Bl -tag -width indent
91.It Pa /boot/kernel , /boot/modules , /modules
92The default module search path used by the kernel.
93.El
94.Sh DIAGNOSTICS
95The
96.Nm
97utility exits with a status of 0 on success
98and with a nonzero status if an error occurs.
99.Sh SEE ALSO
100.Xr kldload 2 ,
101.Xr kldload 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 roam@FreeBSD.org
110