xref: /freebsd/sbin/kldconfig/kldconfig.8 (revision 53e6653d108da78b2ee957b70c44d0298a796958)
148c8fe68SPeter Pentchev.\"
248c8fe68SPeter Pentchev.\" Copyright (c) 2001 Peter Pentchev
348c8fe68SPeter Pentchev.\" All rights reserved.
448c8fe68SPeter Pentchev.\"
548c8fe68SPeter Pentchev.\" Redistribution and use in source and binary forms, with or without
648c8fe68SPeter Pentchev.\" modification, are permitted provided that the following conditions
748c8fe68SPeter Pentchev.\" are met:
848c8fe68SPeter Pentchev.\" 1. Redistributions of source code must retain the above copyright
948c8fe68SPeter Pentchev.\"    notice, this list of conditions and the following disclaimer.
1048c8fe68SPeter Pentchev.\" 2. Redistributions in binary form must reproduce the above copyright
1148c8fe68SPeter Pentchev.\"    notice, this list of conditions and the following disclaimer in the
1248c8fe68SPeter Pentchev.\"    documentation and/or other materials provided with the distribution.
1348c8fe68SPeter Pentchev.\"
1448c8fe68SPeter Pentchev.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1548c8fe68SPeter Pentchev.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1648c8fe68SPeter Pentchev.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1748c8fe68SPeter Pentchev.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1848c8fe68SPeter Pentchev.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1948c8fe68SPeter Pentchev.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2048c8fe68SPeter Pentchev.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2148c8fe68SPeter Pentchev.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2248c8fe68SPeter Pentchev.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2348c8fe68SPeter Pentchev.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2448c8fe68SPeter Pentchev.\" SUCH DAMAGE.
2548c8fe68SPeter Pentchev.\"
2648c8fe68SPeter Pentchev.\" $FreeBSD$
2748c8fe68SPeter Pentchev.\"
2848c8fe68SPeter Pentchev.Dd June 15, 2001
2948c8fe68SPeter Pentchev.Dt KLDCONFIG 8
3048c8fe68SPeter Pentchev.Os
3148c8fe68SPeter Pentchev.Sh NAME
3248c8fe68SPeter Pentchev.Nm kldconfig
3348c8fe68SPeter Pentchev.Nd display or modify the kernel module search path
3448c8fe68SPeter Pentchev.Sh SYNOPSIS
3548c8fe68SPeter Pentchev.Nm
3648c8fe68SPeter Pentchev.Op Fl dfimnUv
3748c8fe68SPeter Pentchev.Op Fl S Ar name
3848c8fe68SPeter Pentchev.Op Ar path ...
3948c8fe68SPeter Pentchev.Nm
4048c8fe68SPeter Pentchev.Fl r
4148c8fe68SPeter Pentchev.Sh DESCRIPTION
4248c8fe68SPeter Pentchev.Nm
4348c8fe68SPeter Pentchevdisplays or modifies the search path used by the kernel when loading modules
4448c8fe68SPeter Pentchevusing the
4548c8fe68SPeter Pentchev.Xr kldload 8
4648c8fe68SPeter Pentchevutility or the
4748c8fe68SPeter Pentchev.Xr kldload 2
4848c8fe68SPeter Pentchevsyscall.
4948c8fe68SPeter Pentchev.Pp
5048c8fe68SPeter PentchevThe following options are available:
5148c8fe68SPeter Pentchev.Bl -tag -width indent
5248c8fe68SPeter Pentchev.It Fl d
5348c8fe68SPeter PentchevRemove the specified paths from the module search path.
5448c8fe68SPeter Pentchev.It Fl f
5548c8fe68SPeter PentchevDo not display a diagnostic message if a path specified for adding is
5648c8fe68SPeter Pentchevalready present in the search path, or if a path specified for removing
5748c8fe68SPeter Pentchevis not present in the search path.
5848c8fe68SPeter PentchevThis may be useful in startup/shutdown scripts for adding a path to
5948c8fe68SPeter Pentcheva filesystem which is still not mounted, or in shutdown scripts for
6048c8fe68SPeter Pentchevunconditionally removing a path that may have been added during startup.
6148c8fe68SPeter Pentchev.It Fl i
6248c8fe68SPeter PentchevAdd the specified paths to the beginning of the search path, not to the end.
6348c8fe68SPeter PentchevThis option can only be used when adding paths.
6448c8fe68SPeter Pentchev.It Fl m
6548c8fe68SPeter PentchevInstead of replacing the module search path with the set of paths
6648c8fe68SPeter Pentchevspecified,
6748c8fe68SPeter Pentchev.Dq merge
6848c8fe68SPeter Pentchevin the new entries.
6948c8fe68SPeter Pentchev.It Fl n
7048c8fe68SPeter PentchevDo not actually change the module search path.
7148c8fe68SPeter Pentchev.It Fl r
7248c8fe68SPeter PentchevDisplay the current search path.
7348c8fe68SPeter PentchevThis option cannot be used if any paths are also specified.
7448c8fe68SPeter Pentchev.It Fl S Ar name
7548c8fe68SPeter PentchevSpecify the sysctl name to use instead of the default
7648c8fe68SPeter Pentchev.Va kern.module_path .
7748c8fe68SPeter Pentchev.It Fl U
7848c8fe68SPeter Pentchev.Dq Unique-ify
7948c8fe68SPeter Pentchevthe current search path - if any of the directories is repeated one
8048c8fe68SPeter Pentchevor more times, only the first occurrence remains.
8148c8fe68SPeter PentchevThis option implies
8248c8fe68SPeter Pentchev.Fl m .
8348c8fe68SPeter Pentchev.It Fl v
8448c8fe68SPeter PentchevVerbose output: display the new module search path.
8548c8fe68SPeter PentchevIf the path has been changed, and the
8648c8fe68SPeter Pentchev.Fl v
8748c8fe68SPeter Pentchevflag is specified more than once, the old path is displayed as well.
8848c8fe68SPeter Pentchev.El
8948c8fe68SPeter Pentchev.Sh FILES
9048c8fe68SPeter Pentchev.Bl -tag -width indent
9153e6653dSRuslan Ermilov.It Pa /boot/kernel , /boot/modules , /modules
9248c8fe68SPeter PentchevThe default module search path used by the kernel.
9348c8fe68SPeter Pentchev.El
9448c8fe68SPeter Pentchev.Sh DIAGNOSTICS
9548c8fe68SPeter PentchevThe
9648c8fe68SPeter Pentchev.Nm
9748c8fe68SPeter Pentchevutility exits with a status of 0 on success
9848c8fe68SPeter Pentchevand with a nonzero status if an error occurs.
9948c8fe68SPeter Pentchev.Sh SEE ALSO
10048c8fe68SPeter Pentchev.Xr kldload 2 ,
10148c8fe68SPeter Pentchev.Xr kldload 8 ,
10248c8fe68SPeter Pentchev.Xr sysctl 8
10348c8fe68SPeter Pentchev.Sh HISTORY
10448c8fe68SPeter PentchevThe
10548c8fe68SPeter Pentchev.Nm
10648c8fe68SPeter Pentchevutility first appeared in
10748c8fe68SPeter Pentchev.Fx 5.0 .
10848c8fe68SPeter Pentchev.Sh AUTHORS
10948c8fe68SPeter Pentchev.An Peter Pentchev Aq roam@FreeBSD.org
110