doc/rmmod.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2   <!ENTITY debian  "<productname>Debian GNU/Linux</productname>">
   3   <!ENTITY docbook "<productname>DocBook</productname>">
   4   <!ENTITY sgml    "<abbrev>SGML</abbrev>">
   5 ]>
   6
   7 <!-- Stolen from manual page for docbook-to-man, DocBook source file
   8      (C) 1999 W. Borgert debacle@debian.org
   9
  10      $Id: docbook-to-man.sgml,v 1.8 2002/04/27 15:28:02 debacle Exp $ -->
  11
  12 <refentry>
  13   <refentryinfo>
  14     <address>
  15       <email>rusty@rustcorp.com.au</email>
  16     </address>
  17     <author>
  18       <firstname>Rusty</firstname>
  19       <surname>Russell</surname>
  20     </author>
  21     <date>2002-12-27</date>
  22   </refentryinfo>
  23   <refmeta>
  24     <refentrytitle>rmmod</refentrytitle>
  25     <manvolnum>8</manvolnum>
  26   </refmeta>
  27   <refnamediv>
  28     <refname>rmmod</refname> <refpurpose>simple program to remove a module from the Linux Kernel</refpurpose>
  29   </refnamediv>
  30   <refsynopsisdiv>
  31     <cmdsynopsis>
  32       <command>rmmod</command>
  33       <arg><option>-f</option></arg>
  34       <arg><option>-w</option></arg>
  35       <arg><option>-s</option></arg>
  36       <arg><option>-v</option></arg>
  37       <arg><replaceable>modulename</replaceable></arg>
  38     </cmdsynopsis>
  39   </refsynopsisdiv>
  40   <refsect1>
  41     <title>DESCRIPTION</title>
  42
  43     <para><command>rmmod</command> is a trivial program to remove a
  44       module from the kernel.  Most users will want to use
  45       <citerefentry>
  46         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
  47       </citerefentry> instead, with the <option>-r</option> option.
  48     </para>
  49   </refsect1>
  50   <refsect1>
  51     <title>OPTIONS</title>
  52     <variablelist>
  53       <varlistentry>
  54         <term><option>-v</option> <option>--verbose</option>
  55         </term>
  56         <listitem>
  57           <para>
  58             Print messages about what the program is doing.
  59             Usually <command>rmmod</command> only prints messages
  60             if something goes wrong.
  61           </para>
  62         </listitem>
  63       </varlistentry>
  64       <varlistentry>
  65         <term><option>-f</option> <option>--force</option>
  66         </term>
  67         <listitem>
  68           <para>
  69             This option can be extremely dangerous: it has no effect unless
  70             CONFIG_MODULE_FORCE_UNLOAD was set when the kernel was
  71             compiled.  With this option, you can remove modules which are
  72             being used, or which are not designed to be removed, or have
  73             been marked as unsafe (see <citerefentry>
  74         <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
  75       </citerefentry>).
  76           </para>
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term><option>-w</option> <option>--wait</option>
  81         </term>
  82         <listitem>
  83           <para>
  84             Normally, <command>rmmod</command> will refuse to
  85             unload modules which are in use.  With this option,
  86             <command>rmmod</command> will isolate the module, and
  87             wait until the module is no longer used.  Noone new
  88             will be able to use the module, but it's up to you to
  89             make sure the current users eventually finish with it.
  90             See <citerefentry>
  91         <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
  92       </citerefentry>) for information on usage counts.
  93           </para>
  94         </listitem>
  95       </varlistentry>
  96       <varlistentry>
  97         <term><option>-s</option> <option>--syslog</option>
  98         </term>
  99         <listitem>
 100           <para>
 101             Send errors to the syslog, instead of standard error.
 102           </para>
 103         </listitem>
 104       </varlistentry>
 105       <varlistentry>
 106         <term><option>-V</option> <option>--version</option>
 107         </term>
 108         <listitem>
 109           <para>
 110             Show version of program, and exit.  See below for caveats
 111             when run on older kernels.
 112           </para>
 113         </listitem>
 114       </varlistentry>
 115     </variablelist>
 116   </refsect1>
 117   <refsect1>
 118     <title>BACKWARDS COMPATIBILITY</title>
 119
 120     <para>
 121       This version of <command>rmmod</command> is for kernels
 122       <literal>2.5.48</literal> and above.  If it detects a kernel
 123       with support for old-style modules (for which much of the work
 124       was done in userspace), it will attempt to run
 125       <command>rmmod.old</command> in its place, so it is completely
 126       transparent to the user.
 127     </para>
 128   </refsect1>
 129   <refsect1>
 130     <title>COPYRIGHT</title>
 131     <para>
 132       This manual page Copyright 2002, Rusty Russell, IBM Corporation.
 133     </para>
 134   </refsect1>
 135   <refsect1>
 136     <title>SEE ALSO</title>
 137
 138     <para>
 139       <citerefentry>
 140         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
 141       </citerefentry>,
 142       <citerefentry>
 143         <refentrytitle>insmod</refentrytitle><manvolnum>8</manvolnum>
 144       </citerefentry>,
 145       <citerefentry>
 146         <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
 147       </citerefentry>,
 148       <citerefentry>
 149         <refentrytitle>rmmod.old</refentrytitle><manvolnum>8</manvolnum>
 150       </citerefentry>
 151     </para>
 152   </refsect1>
 153 </refentry>
 154
 155 <!-- Keep this comment at the end of the file
 156 Local variables:
 157 mode: sgml
 158 sgml-omittag:t
 159 sgml-shorttag:t
 160 sgml-minimize-attributes:nil
 161 sgml-always-quote-attributes:t
 162 sgml-indent-step:2
 163 sgml-indent-data:t
 164 sgml-parent-document:nil
 165 sgml-default-dtd-file:nil
 166 sgml-exposed-tags:nil
 167 sgml-local-catalogs:nil
 168 sgml-local-ecat-files:nil
 169 End:
 170 -->