[apple/system_cmds.git] / kmodload.tproj / kmodload.8

.\"
.\" Copyright (c) 1997 Doug Rabson
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	$Id: kmodload.8,v 1.4 2002/01/30 22:44:21 lindak Exp $
.\"
.Dd April 8, 1999
.Dt KMODLOAD 8
.Os FreeBSD
.Sh NAME
.Nm kmodload
.Nd loads and starts a kernel module
.Sh SYNOPSIS
.Nm kmodload
.Op Fl v
.Op Fl k Ar kernel_file
.Op Fl d Ar dependency_file
.Op Fl o Ar symbol_file
.Ar module_file
.Sh DESCRIPTION
.Nm kmodload
is deprecated; use
.Xr kextload 8 ,
instead.
.Pp
The
.Nm kmodload
command loads the file 
.Ar module_file
into the kernel and starts its execution.
.Pp
The following options are available:
.Bl -tag -width indent
.\" ==========
.It Fl d Ar dependency_file
Add symbols from
.Ar dependency_file
to kernel symbols, prior to linking of
.Ar module_file .
The file 
.Ar dependency_file
must already be loaded.
.\" ==========
.It Fl k Ar kernel_file
Use an alternate file
.Ar kernel_file ,
instead of the default file (/mach), for linking
.Ar module_file .
.\" ==========
.It Fl o Ar symbol_file
Create a file named
.Ar symbol_file
that contains statically-linked output suitable
for remote debugging use with
.Xr gdb 1 .
.\" ==========
.It Fl v
Be more verbose.
.El
.Sh FILES
.Bl -tag -width /modules -compact
.It Pa /System/Library/Extensions
directory containing loadable kernel modules.
.Sh DIAGNOSTICS
The
.Nm kmodload
utility exits with a status of 0 on success.
A status of 1 indicates a usage error.
A status of 2 indicates a indicates a permissions error.
A status of 3 indicates a problem with linking the module.
A status of 4 indicates a internal or system error.
A status of 5 indicates the module has already been loaded. 
.Sh SEE ALSO
.Xr gdb 1 ,
.Xr kmodstat 8 ,
.Xr kmodsyms 8 ,
.Xr kmodunload 8
.Sh HISTORY
The
.Nm kmodload
command is based on the command kldload written by
.An Doug Rabson Aq dfr@FreeBSD.org
Commit	Line	Data
916eb79e 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.4 2002/01/30 22:44:21 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 kernel_file
	38	.Op Fl d Ar dependency_file
	39	.Op Fl o Ar symbol_file
	40	.Ar module_file
	41	.Sh DESCRIPTION
	42	.Nm kmodload
	43	is deprecated; use
	44	.Xr kextload 8 ,
	45	instead.
	46	.Pp
	47	The
	48	.Nm kmodload
	49	command loads the file
	50	.Ar module_file
	51	into the kernel and starts its execution.
	52	.Pp
	53	The following options are available:
	54	.Bl -tag -width indent
	55	.\" ==========
	56	.It Fl d Ar dependency_file
	57	Add symbols from
	58	.Ar dependency_file
	59	to kernel symbols, prior to linking of
	60	.Ar module_file .
	61	The file
	62	.Ar dependency_file
	63	must already be loaded.
	64	.\" ==========
65	.It Fl k Ar kernel_file
66	Use an alternate file
67	.Ar kernel_file ,
68	instead of the default file (/mach), for linking
69	.Ar module_file .
70	.\" ==========
71	.It Fl o Ar symbol_file
72	Create a file named
73	.Ar symbol_file
74	that contains statically-linked output suitable
75	for remote debugging use with
76	.Xr gdb 1 .
77	.\" ==========
78	.It Fl v
79	Be more verbose.
80	.El
81	.Sh FILES
82	.Bl -tag -width /modules -compact
83	.It Pa /System/Library/Extensions
84	directory containing loadable kernel modules.
85	.Sh DIAGNOSTICS
86	The
87	.Nm kmodload
88	utility exits with a status of 0 on success.
89	A status of 1 indicates a usage error.
90	A status of 2 indicates a indicates a permissions error.
91	A status of 3 indicates a problem with linking the module.
92	A status of 4 indicates a internal or system error.
93	A status of 5 indicates the module has already been loaded.
94	.Sh SEE ALSO
95	.Xr gdb 1 ,
96	.Xr kmodstat 8 ,
97	.Xr kmodsyms 8 ,
98	.Xr kmodunload 8
99	.Sh HISTORY
100	The
101	.Nm kmodload
102	command is based on the command kldload written by
103	.An Doug Rabson Aq dfr@FreeBSD.org