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>jcm@jonmasters.org</email>
  16     </address>
  17     <author>
  18       <firstname>Jon</firstname>
  19       <surname>Masters</surname>
  20     </author>
  21     <date>2010-03-01</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 (when module unloading support is provided) from the kernel.
  45       Most users will want to use
  46       <citerefentry>
  47         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
  48       </citerefentry> with the <option>-r</option> option instead.
  49     </para>
  50   </refsect1>
  51   <refsect1>
  52     <title>OPTIONS</title>
  53     <variablelist>
  54       <varlistentry>
  55         <term><option>-v</option> <option>--verbose</option>
  56         </term>
  57         <listitem>
  58           <para>
  59             Print messages about what the program is doing.
  60             Usually <command>rmmod</command> prints messages
  61             only if something goes wrong.
  62           </para>
  63         </listitem>
  64       </varlistentry>
  65       <varlistentry>
  66         <term><option>-f</option> <option>--force</option>
  67         </term>
  68         <listitem>
  69           <para>
  70             This option can be extremely dangerous: it has no effect unless
  71             CONFIG_MODULE_FORCE_UNLOAD was set when the kernel was
  72             compiled.  With this option, you can remove modules which are
  73             being used, or which are not designed to be removed, or have
  74             been marked as unsafe (see <citerefentry>
  75         <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
  76       </citerefentry>).
  77           </para>
  78         </listitem>
  79       </varlistentry>
  80       <varlistentry>
  81         <term><option>-w</option> <option>--wait</option>
  82         </term>
  83         <listitem>
  84           <para>
  85             Normally, <command>rmmod</command> will refuse to
  86             unload modules which are in use.  With this option,
  87             <command>rmmod</command> will isolate the module, and
  88             wait until the module is no longer used.  Nothing new
  89             will be able to use the module, but it's up to you to
  90             make sure the current users eventually finish with it.
  91             See <citerefentry>
  92         <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
  93       </citerefentry>) for information on usage counts.
  94           </para>
  95         </listitem>
  96       </varlistentry>
  97       <varlistentry>
  98         <term><option>-s</option> <option>--syslog</option>
  99         </term>
 100         <listitem>
 101           <para>
 102             Send errors to syslog instead of standard error.
 103           </para>
 104         </listitem>
 105       </varlistentry>
 106       <varlistentry>
 107         <term><option>-V</option> <option>--version</option>
 108         </term>
 109         <listitem>
 110           <para>
 111             Show version of program and exit.
 112           </para>
 113         </listitem>
 114       </varlistentry>
 115     </variablelist>
 116   </refsect1>
 117   <refsect1>
 118     <title>COPYRIGHT</title>
 119     <para>
 120       This manual page originally Copyright 2002, Rusty Russell, IBM
 121       Corporation. Maintained by Jon Masters and others.
 122     </para>
 123   </refsect1>
 124   <refsect1>
 125     <title>SEE ALSO</title>
 126
 127     <para>
 128       <citerefentry>
 129         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
 130       </citerefentry>,
 131       <citerefentry>
 132         <refentrytitle>insmod</refentrytitle><manvolnum>8</manvolnum>
 133       </citerefentry>,
 134       <citerefentry>
 135         <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
 136       </citerefentry>
 137       <citerefentry>
 138         <refentrytitle>modinfo</refentrytitle><manvolnum>8</manvolnum>
 139       </citerefentry>
 140     </para>
 141   </refsect1>
 142 </refentry>
 143
 144 <!-- Keep this comment at the end of the file
 145 Local variables:
 146 mode: sgml
 147 sgml-omittag:t
 148 sgml-shorttag:t
 149 sgml-minimize-attributes:nil
 150 sgml-always-quote-attributes:t
 151 sgml-indent-step:2
 152 sgml-indent-data:t
 153 sgml-parent-document:nil
 154 sgml-default-dtd-file:nil
 155 sgml-exposed-tags:nil
 156 sgml-local-catalogs:nil
 157 sgml-local-ecat-files:nil
 158 End:
 159 -->