xref: /dragonfly/sbin/kldconfig/kldconfig.8 (revision 19fe1c42)
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: src/sbin/kldconfig/kldconfig.8,v 1.2.2.2 2003/02/23 20:17:15 trhodes Exp $
27.\" $DragonFly: src/sbin/kldconfig/kldconfig.8,v 1.4 2008/09/02 11:50:45 matthias Exp $
28.\"
29.Dd September 2, 2008
30.Dt KLDCONFIG 8
31.Os
32.Sh NAME
33.Nm kldconfig
34.Nd display or modify the kernel module search path
35.Sh SYNOPSIS
36.Nm
37.Op Fl dfimnUv
38.Op Fl S Ar name
39.Op Ar path ...
40.Nm
41.Fl r
42.Sh DESCRIPTION
43The
44.Nm
45utility
46displays or modifies the search path used by the kernel when loading modules
47using the
48.Xr kldload 8
49utility or the
50.Xr kldload 2
51syscall.
52.Pp
53The following options are available:
54.Bl -tag -width indent
55.It Fl d
56Remove the specified paths from the module search path.
57.It Fl f
58Do not display a diagnostic message if a path specified for adding is
59already present in the search path, or if a path specified for removing
60is not present in the search path.
61This may be useful in startup/shutdown scripts for adding a path to
62a file system which is still not mounted, or in shutdown scripts for
63unconditionally removing a path that may have been added during startup.
64.It Fl i
65Add the specified paths to the beginning of the search path, not to the end.
66This option can only be used when adding paths.
67.It Fl m
68Instead of replacing the module search path with the set of paths
69specified,
70.Dq merge
71in the new entries.
72.It Fl n
73Do not actually change the module search path.
74.It Fl r
75Display the current search path.
76This option cannot be used if any paths are also specified.
77.It Fl S Ar name
78Specify the sysctl name to use instead of the default
79.Va kern.module_path .
80.It Fl U
81.Dq Unique-ify
82the current search path - if any of the directories is repeated one
83or more times, only the first occurrence remains.
84This option implies
85.Fl m .
86.It Fl v
87Verbose output: display the new module search path.
88If the path has been changed, and the
89.Fl v
90flag is specified more than once, the old path is displayed as well.
91.El
92.Sh FILES
93.Bl -tag -width indent
94.It Pa / , /boot , /boot/modules
95The default module search path used by the kernel.
96.El
97.Sh DIAGNOSTICS
98The
99.Nm
100utility exits with a status of 0 on success
101and with a nonzero status if an error occurs.
102.Sh SEE ALSO
103.Xr kldload 2 ,
104.Xr kldload 8 ,
105.Xr sysctl 8
106.Sh HISTORY
107The
108.Nm
109utility first appeared in
110.Fx 4.4 .
111.Sh AUTHORS
112.An Peter Pentchev Aq roam@FreeBSD.org
113