doc/insmod.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>insmod</refentrytitle>
  25     <manvolnum>8</manvolnum>
  26   </refmeta>
  27   <refnamediv>
  28     <refname>insmod</refname> <refpurpose>simple program to insert a module into the Linux Kernel</refpurpose>
  29   </refnamediv>
  30   <refsynopsisdiv>
  31     <cmdsynopsis>
  32       <command>insmod</command>
  33       <arg><replaceable>filename</replaceable></arg>
  34       <arg rep='repeat'><replaceable>module options</replaceable></arg>
  35     </cmdsynopsis>
  36   </refsynopsisdiv>
  37   <refsect1>
  38     <title>DESCRIPTION</title>
  39
  40     <para><command>insmod</command> is a trivial program to insert a
  41         module into the kernel: if the
  42         <replaceable>filename</replaceable> is a hyphen, the module is
  43         taken from standard input. Most users will want to use
  44         <citerefentry><refentrytitle>modprobe</refentrytitle>
  45         <manvolnum>8</manvolnum> </citerefentry> instead, which is
  46         cleverer.</para>
  47
  48     <para>Only the most general of error messages are reported: as the
  49         work of trying to link the module is now done inside the kernel,
  50         the <command>dmesg</command> usually gives more information
  51         about errors.</para>
  52   </refsect1>
  53   <refsect1>
  54     <title>BACKWARDS COMPATIBILITY</title>
  55
  56     <para>This version of <command>insmod</command> is for kernels
  57         <literal>2.5.48</literal> and above.  If it detects a kernel
  58         with support for old-style modules (for which much of the work
  59         was done in userspace), it will attempt to run
  60         <command>insmod.old</command> in its place, so it is
  61         completely transparent to the user.</para>
  62   </refsect1>
  63   <refsect1>
  64     <title>COPYRIGHT</title>
  65     <para>
  66       This manual page Copyright 2002, Rusty Russell, IBM Corporation.
  67     </para>
  68   </refsect1>
  69   <refsect1>
  70     <title>SEE ALSO</title>
  71
  72     <para><citerefentry>
  73         <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
  74       </citerefentry>,
  75       <citerefentry>
  76         <refentrytitle>rmmod</refentrytitle><manvolnum>8</manvolnum>
  77       </citerefentry>,
  78       <citerefentry>
  79         <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
  80       </citerefentry>,
  81       <citerefentry>
  82         <refentrytitle>insmod.old</refentrytitle><manvolnum>8</manvolnum>
  83       </citerefentry>
  84     </para>
  85   </refsect1>
  86 </refentry>
  87
  88 <!-- Keep this comment at the end of the file
  89 Local variables:
  90 mode: sgml
  91 sgml-omittag:t
  92 sgml-shorttag:t
  93 sgml-minimize-attributes:nil
  94 sgml-always-quote-attributes:t
  95 sgml-indent-step:2
  96 sgml-indent-data:t
  97 sgml-parent-document:nil
  98 sgml-default-dtd-file:nil
  99 sgml-exposed-tags:nil
 100 sgml-local-catalogs:nil
 101 sgml-local-ecat-files:nil
 102 End:
 103 -->