home *** CD-ROM | disk | FTP | other *** search
/ Login Magazine 68 / LoginMagazineNo68.bin / modules / insmod.txt < prev    next >
Text File  |  1999-11-07  |  4KB  |  133 lines
  1.  
  2.  
  3.  
  4. INSMOD(1)              Linux Module Support             INSMOD(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        insmod - install loadable kernel module
  9.  
  10. SSYYNNOOPPSSIISS
  11.        iinnssmmoodd [ -fkmpsxXv ] [ -o module_name ] object_file [ sym-
  12.        bol=value ... ]
  13.  
  14. DDEESSCCRRIIPPTTIIOONN
  15.        IInnssmmoodd installs a loadable module in the running kernel.
  16.  
  17.        IInnssmmoodd tries to link a module into the running  kernel  by
  18.        resolving  all  symbols  from the kernel's exported symbol
  19.        table.
  20.  
  21.        If the object file name is given without extension, iinnssmmoodd
  22.        will search for the module in some common default directo-
  23.        ries.  The environment variable MODPATH  can  be  used  to
  24.        override this default.
  25.  
  26.    OOPPTTIIOONNSS
  27.        _-_f     Attempt  load the module even if the version of the
  28.               running kernel and the version of  the  kernel  for
  29.               which the module was compiled do not match.
  30.  
  31.        _-_k     Set  the  auto-clean flag on the module.  This flag
  32.               will be used by kkeerrnneelldd(8) to remove  modules  that
  33.               have  not  been used in some period of time -- usu-
  34.               ally one minute.
  35.  
  36.        _-_m     Output a load map, making it easier  to  debug  the
  37.               module in the event of a kernel panic.
  38.  
  39.        _-_o     Explicitly  name  the  module, rather than deriving
  40.               the name from the base name of  the  source  object
  41.               file.
  42.  
  43.        _-_p     Probe the module to see if it could be successfully
  44.               loaded.  This includes locating the object file  in
  45.               the  module  path,  checking  version  numbers, and
  46.               resolving symbols.
  47.  
  48.        _-_s     Output everything to ssyysslloogg(3) instead of the  ter-
  49.               minal.
  50.  
  51.        _-_v     Be verbose.
  52.  
  53.        _-_X_, _-_x Do  and  do not export all of the module's external
  54.               symbols, respectively.  The default is for the sym-
  55.               bols to be exported.  This option is only effective
  56.               if the module does not explicitly  export  its  own
  57.               controled symbol table, and thus is depreciated.
  58.  
  59.    MMOODDUULLEE PPAARRAAMMEETTEERRSS
  60.        Some  modules  accept  load-time  parameters  to customize
  61.  
  62.  
  63.  
  64. Linux                      26 Dec 1996                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. INSMOD(1)              Linux Module Support             INSMOD(1)
  71.  
  72.  
  73.        their operation.  These parameters are often I/O port  and
  74.        IRQ  numbers  that vary from machine to machine and cannot
  75.        be determined from the hardware.
  76.  
  77.        In modules built for 2.0 series kernels,  any  integer  or
  78.        character pointer symbol may be treated as a parameter and
  79.        modified.  Beginning in the 2.1  series  kernels,  symbols
  80.        are  explicitly marked as parameters so that only specific
  81.        values may be chagned.  Furthermore  type  information  is
  82.        provied for checking the values provided at load time.
  83.  
  84.        In  the  case  of  integers, all values may be in decimal,
  85.        octal or hexadecimal a la C: 17, 021 or 0x11.  Array  ele-
  86.        ments  are  specified  sequence separrated by commas; ele-
  87.        ments can be skipped by omitting the value.
  88.  
  89.        In 2.0 series modules, values that do  not  begin  with  a
  90.        number  are  considered  strings.   Beginning  in 2.1, the
  91.        parameter's type information indicates whether  to  inter-
  92.        pret the value as a string.  If the value begins with dou-
  93.        ble-quotes (_"), the string is interpreted as in C,  escape
  94.        sequences  and  all.   Do note that from the shell prompt,
  95.        the quotes themselves may need to be protected from  shell
  96.        interpretation.
  97.  
  98. SSEEEE AALLSSOO
  99.        rrmmmmoodd(1), mmooddpprroobbee(1), ddeeppmmoodd(1), llssmmoodd(1), kkssyymmss(1), mmoodd--
  100.        uulleess(2), ggeennkkssyymmss(8), kkeerrnneelldd(8).
  101.  
  102. HHIISSTTOORRYY
  103.        Module support was first concieved by Anonymous
  104.        Initial Linux version by Bas Laarhoven <bas@vimec.nl>
  105.        Version 0.99.14 by Jon Tombs <jon@gtex02.us.es>
  106.        Extended by Bjorn Ekwall <bj0rn@blox.se>
  107.        Original ELF help from Eric Youngdale <eric@aib.com>
  108.        Rewritten for 2.1.17 by Richard Henderson <rth@tamu.edu>
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. Linux                      26 Dec 1996                          2
  131.  
  132.  
  133.