freebsd-dev/lib/libc/sys/kldunload.2

.\"
.\" Copyright (c) 1999 Chris Costello
.\" 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.
.\"
.\" $FreeBSD$
.\"
.Dd March 3, 1999
.Dt KLDUNLOAD 2
.Os
.Sh NAME
.Nm kldunload
.Nd unload kld files
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/param.h
.In sys/linker.h
.Ft int
.Fn kldunload "int fileid"
.Sh DESCRIPTION
The
.Fn kldunload
system call
unloads a kld file from the kernel that was previously linked via
.Xr kldload 2 .
.Sh RETURN VALUES
.Rv -std
.Sh ERRORS
The file referred to by
.Fa fileid
is unloaded unless:
.Bl -tag -width Er
.It Bq Er EPERM
You do not have access to unlink the file from the kernel.
.It Bq Er ENOENT
The file was not found.
.It Bq Er EBUSY
You attempted to unload a file linked by the kernel.
.El
.Sh SEE ALSO
.Xr kldfind 2 ,
.Xr kldfirstmod 2 ,
.Xr kldload 2 ,
.Xr kldnext 2 ,
.Xr kldstat 2 ,
.Xr kldsym 2 ,
.Xr modfind 2 ,
.Xr modfnext 2 ,
.Xr modnext 2 ,
.Xr modstat 2 ,
.Xr kld 4 ,
.Xr kldunload 8
.Sh HISTORY
The
.Nm kld
interface first appeared in
.Fx 3.0 .
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.\"`
			`.\" Copyright (c) 1999 Chris Costello`
			`.\" 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$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.\"`
			`.Dd March 3, 1999`
			`.Dt KLDUNLOAD 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh NAME`
			`.Nm kldunload`
			`.Nd unload kld files`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/param.h`
			`.In sys/linker.h`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Ft int`
			`.Fn kldunload "int fileid"`
			`.Sh DESCRIPTION`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Fn kldunload`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`unloads a kld file from the kernel that was previously linked via`
Change reference from kldload(3) to kldload(2) 1999-08-13 21:02:39 +00:00			`.Xr kldload 2 .`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh RETURN VALUES`
Don't claim to return the fileid which we unloaded. The kernel doesn't do this, and it wouldn't be very useful if it did, since the caller supplies us with that number. PR: 41329 Submitted by: Michael Galassi <nerd@xyz.com> 2002-10-01 23:53:51 +00:00			`.Rv -std`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh ERRORS`
			`The file referred to by`
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd'' 2000-06-23 05:05:44 +00:00			`.Fa fileid`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`is unloaded unless:`
			`.Bl -tag -width Er`
			`.It Bq Er EPERM`
Expand *n't contractions. 2005-02-13 22:25:33 +00:00			`You do not have access to unlink the file from the kernel.`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.It Bq Er ENOENT`
			`The file was not found.`
			`.It Bq Er EBUSY`
			`You attempted to unload a file linked by the kernel.`
Prepare for mdoc(7)NG. 2000-12-29 14:08:20 +00:00			`.El`
Fix the NAME section of the kldload.2 manpage, which made reference to kldunload. Add proper cross-references to the whole family. PR: 12472 Submitted by: Chris Costello <chris@calldei.com> 1999-07-01 12:16:06 +00:00			`.Sh SEE ALSO`
			`.Xr kldfind 2 ,`
			`.Xr kldfirstmod 2 ,`
			`.Xr kldload 2 ,`
			`.Xr kldnext 2 ,`
			`.Xr kldstat 2 ,`
Add cross-references for the new kldsym(2) man page. 2001-07-27 03:03:36 +00:00			`.Xr kldsym 2 ,`
Add man pages for mod(2). Shamelessly cut/pasted from the kld(2) man pages by Chris Costello. 2000-09-28 22:39:59 +00:00			`.Xr modfind 2 ,`
Unify SEE ALSO sections of the kld.2 and mod.2 manpages. Previously, some useful xrefs were missing. Now each of the pages refers to all remaining section 2 pages, to the kld(4) page, and to a related utility's (section 8) page. 2001-07-24 07:59:54 +00:00			`.Xr modfnext 2 ,`
Add man pages for mod(2). Shamelessly cut/pasted from the kld(2) man pages by Chris Costello. 2000-09-28 22:39:59 +00:00			`.Xr modnext 2 ,`
			`.Xr modstat 2 ,`
Fix the NAME section of the kldload.2 manpage, which made reference to kldunload. Add proper cross-references to the whole family. PR: 12472 Submitted by: Chris Costello <chris@calldei.com> 1999-07-01 12:16:06 +00:00			`.Xr kld 4 ,`
			`.Xr kldunload 8`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh HISTORY`
			`The`
			`.Nm kld`
mdoc(7) style fix: FreeBSD -> .Fx Reviewed by: mpp 1999-09-05 06:47:01 +00:00			`interface first appeared in`
			`.Fx 3.0 .`