man/rmmod.xml

   1 <?xml version='1.0'?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5 <refentry id="rmmod">
   6   <refentryinfo>
   7     <title>rmmod</title>
   8     <productname>kmod</productname>
   9
  10     <authorgroup>
  11       <author>
  12         <contrib>Developer</contrib>
  13         <firstname>Jon</firstname>
  14         <surname>Masters</surname>
  15         <email>jcm@jonmasters.org</email>
  16       </author>
  17       <author>
  18         <contrib>Developer</contrib>
  19         <firstname>Lucas</firstname>
  20         <surname>De Marchi</surname>
  21         <email>lucas.de.marchi@gmail.com</email>
  22       </author>
  23     </authorgroup>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle>rmmod</refentrytitle>
  28     <manvolnum>8</manvolnum>
  29   </refmeta>
  30
  31   <refnamediv>
  32     <refname>rmmod</refname>
  33     <refpurpose>
  34       Simple program to remove a module from the Linux Kernel
  35     </refpurpose>
  36   </refnamediv>
  37
  38   <refsynopsisdiv>
  39     <cmdsynopsis>
  40       <command>rmmod</command>
  41       <arg><option>-f</option></arg>
  42       <arg><option>-s</option></arg>
  43       <arg><option>-v</option></arg>
  44       <arg><replaceable>modulename</replaceable></arg>
  45     </cmdsynopsis>
  46   </refsynopsisdiv>
  47
  48   <refsect1><title>DESCRIPTION</title>
  49     <para>
  50       <command>rmmod</command> is a trivial program to remove a module (when
  51       module unloading support is provided) from the kernel.  Most users will
  52       want to use
  53       <citerefentry>
  54         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
  55       </citerefentry> with the <option>-r</option> option instead
  56       since it removes unused dependent modules as well.
  57     </para>
  58   </refsect1>
  59
  60   <refsect1><title>OPTIONS</title>
  61     <variablelist>
  62       <varlistentry>
  63         <term>
  64           <option>-v</option>
  65         </term>
  66         <term>
  67           <option>--verbose</option>
  68         </term>
  69         <listitem>
  70           <para>
  71             Print messages about what the program is doing.
  72             Usually <command>rmmod</command> prints messages
  73             only if something goes wrong.
  74           </para>
  75         </listitem>
  76       </varlistentry>
  77       <varlistentry>
  78         <term>
  79           <option>-f</option>
  80         </term>
  81         <term>
  82           <option>--force</option>
  83         </term>
  84         <listitem>
  85           <para>
  86             This option can be extremely dangerous: it has no effect unless
  87             CONFIG_MODULE_FORCE_UNLOAD was set when the kernel was compiled.
  88             With this option, you can remove modules which are being used, or
  89             which are not designed to be removed, or have been marked as unsafe
  90             (see <citerefentry>
  91               <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
  92             </citerefentry>).
  93           </para>
  94         </listitem>
  95       </varlistentry>
  96       <varlistentry>
  97         <term>
  98           <option>-s</option>
  99         </term>
 100         <term>
 101           <option>--syslog</option>
 102         </term>
 103         <listitem>
 104           <para>
 105             Send errors to syslog instead of standard error.
 106           </para>
 107         </listitem>
 108       </varlistentry>
 109       <varlistentry>
 110         <term><option>-V</option> <option>--version</option>
 111         </term>
 112         <listitem>
 113           <para>
 114             Show version of program and exit.
 115           </para>
 116         </listitem>
 117       </varlistentry>
 118     </variablelist>
 119   </refsect1>
 120
 121   <refsect1>
 122     <title>COPYRIGHT</title>
 123     <para>
 124       This manual page originally Copyright 2002, Rusty Russell, IBM
 125       Corporation. Maintained by Jon Masters and others.
 126     </para>
 127   </refsect1>
 128
 129   <refsect1><title>SEE ALSO</title>
 130     <para>
 131       <citerefentry>
 132         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
 133       </citerefentry>,
 134       <citerefentry>
 135         <refentrytitle>insmod</refentrytitle><manvolnum>8</manvolnum>
 136       </citerefentry>,
 137       <citerefentry>
 138         <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
 139       </citerefentry>,
 140       <citerefentry>
 141         <refentrytitle>modinfo</refentrytitle><manvolnum>8</manvolnum>
 142       </citerefentry>
 143       <citerefentry>
 144         <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum>
 145       </citerefentry>
 146     </para>
 147   </refsect1>
 148 </refentry>