Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sbin / kldconfig / kldconfig.8
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 .\"
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 The
43 .Nm
44 utility
45 displays or modifies the search path used by the kernel when loading modules
46 using the
47 .Xr kldload 8
48 utility or the
49 .Xr kldload 2
50 syscall.
51 .Pp
52 The following options are available:
53 .Bl -tag -width indent
54 .It Fl d
55 Remove the specified paths from the module search path.
56 .It Fl f
57 Do not display a diagnostic message if a path specified for adding is
58 already present in the search path, or if a path specified for removing
59 is not present in the search path.
60 This may be useful in startup/shutdown scripts for adding a path to
61 a file system which is still not mounted, or in shutdown scripts for
62 unconditionally removing a path that may have been added during startup.
63 .It Fl i
64 Add the specified paths to the beginning of the search path, not to the end.
65 This option can only be used when adding paths.
66 .It Fl m
67 Instead of replacing the module search path with the set of paths
68 specified,
69 .Dq merge
70 in the new entries.
71 .It Fl n
72 Do not actually change the module search path.
73 .It Fl r
74 Display the current search path.
75 This option cannot be used if any paths are also specified.
76 .It Fl S Ar name
77 Specify the sysctl name to use instead of the default
78 .Va kern.module_path .
79 .It Fl U
80 .Dq Unique-ify
81 the current search path - if any of the directories is repeated one
82 or more times, only the first occurrence remains.
83 This option implies
84 .Fl m .
85 .It Fl v
86 Verbose output: display the new module search path.
87 If the path has been changed, and the
88 .Fl v
89 flag 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
94 The default module search path used by the kernel.
95 .El
96 .Sh DIAGNOSTICS
97 The
98 .Nm
99 utility exits with a status of 0 on success
100 and with a nonzero status if an error occurs.
101 .Sh SEE ALSO
102 .Xr kldload 2 ,
103 .Xr kldload 8 ,
104 .Xr sysctl 8
105 .Sh HISTORY
106 The
107 .Nm
108 utility first appeared in
109 .Fx 4.4 .
110 .Sh AUTHORS
111 .An Peter Pentchev Aq roam@FreeBSD.org