lib/libc/sys/kldunload.2

   1 .\"
   2 .\" Copyright (c) 1999 Chris Costello
   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/lib/libc/sys/kldunload.2,v 1.6.2.6 2001/12/14 18:34:01 ru Exp $
  27 .\" $DragonFly: src/lib/libc/sys/kldunload.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  28 .\"
  29 .Dd March 3, 1999
  30 .Dt KLDUNLOAD 2
  31 .Os
  32 .Sh NAME
  33 .Nm kldunload
  34 .Nd unload kld files
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/linker.h
  40 .Ft int
  41 .Fn kldunload "int fileid"
  42 .Sh DESCRIPTION
  43 The function
  44 .Fn kldunload
  45 unloads a kld file from the kernel that was previously linked via
  46 .Xr kldload 2 .
  47 .Sh RETURN VALUES
  48 The function
  49 .Fn kldunload
  50 returns the fileid of the kld file which was previously loaded into memory via
  51 .Fn kldload .
  52 If an error occurs,
  53 .Fn kldunload
  54 will return -1 and set
  55 .Va errno
  56 to indicate the error.
  57 .Sh ERRORS
  58 The file referred to by
  59 .Fa fileid
  60 is unloaded unless:
  61 .Bl -tag -width Er
  62 .It Bq Er EPERM
  63 You don't have access to unlink the file from the kernel.
  64 .It Bq Er ENOENT
  65 The file was not found.
  66 .It Bq Er EBUSY
  67 You attempted to unload a file linked by the kernel.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr kldfind 2 ,
  71 .Xr kldfirstmod 2 ,
  72 .Xr kldload 2 ,
  73 .Xr kldnext 2 ,
  74 .Xr kldstat 2 ,
  75 .Xr kldsym 2 ,
  76 .Xr modfind 2 ,
  77 .Xr modfnext 2 ,
  78 .Xr modnext 2 ,
  79 .Xr modstat 2 ,
  80 .Xr kld 4 ,
  81 .Xr kldunload 8
  82 .Sh HISTORY
  83 The
  84 .Nm kld
  85 interface first appeared in
  86 .Fx 3.0 .