]> git.saurik.com Git - apple/system_cmds.git/blame - kmodload.tproj/kmodload.8
system_cmds-175.2.tar.gz
[apple/system_cmds.git] / kmodload.tproj / kmodload.8
CommitLineData
1815bff5
A
1.\"
2.\" Copyright (c) 1997 Doug Rabson
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.\" $Id: kmodload.8,v 1.3 2000/12/15 05:33:01 lindak Exp $
27.\"
28.Dd April 8, 1999
29.Dt KMODLOAD 8
30.Os FreeBSD
31.Sh NAME
32.Nm kmodload
33.Nd loads and starts a kernel module
34.Sh SYNOPSIS
35.Nm kmodload
36.Op Fl v
37.Op Fl k Ar kernelfile
38.Op Fl d Ar dependencyfile
39.Op Fl o Ar symbolfile
40.Ar modulefile
41.Sh DESCRIPTION
42The
43.Nm
44loads the file
45.Ar modulefile
46into the kernel and starts its execution.
47.Pp
48The following options are available:
49.Bl -tag -width indent
50.It Fl v
51Be more verbose.
52.It Fl k Ar kernelfile
53Use alternate file
54.Ar kernelfile
55instead of default file /mach for linking
56.Ar modulefile .
57.It Fl d Ar dependencyfile
58Add symbols from
59.Ar dependencyfile
60to kernel symbols prior to linking of
61.Ar modulefile .
62The file
63.Ar dependencyfile
64must already be loaded.
65.It Fl o Ar symbolfile
66Creates file named
67.Ar symbolfile
68that contains statically linked output suitable to use with
69.Xr gdb 1
70for remote debugging.
71.El
72.Sh FILES
73.Bl -tag -width /modules -compact
74.It Pa /System/Library/Extensions
75directory containing loadable kernel modules.
76.Sh DIAGNOSTICS
77The
78.Nm
79utility exits with a status of 0 on success.
80A status of 1 indicates a usage error.
81A status of 2 indicates a indicates a permissions error.
82A status of 3 indicates a problem with linking the module.
83A status of 4 indicates a internal or system error.
84A status of 5 indicates the module has already been loaded.
85.Sh SEE ALSO
86.Xr kmodstat 8 ,
87.Xr kmodsyms 8 ,
88.Xr kmodunload 8
89.Sh HISTORY
90The
91.Nm
92command is based on the command kldload written by
93.An Doug Rabson Aq dfr@FreeBSD.org