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