From: Robby Workman Date: Thu, 12 Jan 2012 06:04:57 +0000 (-0600) Subject: doc: Import sgml manpages from module-init-tools repo X-Git-Tag: v4~45 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=923590709d20f45c33ca7ea857fa84d3a9b4955a;p=thirdparty%2Fkmod.git doc: Import sgml manpages from module-init-tools repo --- diff --git a/doc/depmod.d.sgml b/doc/depmod.d.sgml new file mode 100644 index 00000000..d055db11 --- /dev/null +++ b/doc/depmod.d.sgml @@ -0,0 +1,130 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2010-03-01 +
+ + depmod.conf + 5 + + + depmod.confdepmod.d Configuration file/directory for depmod + + + DESCRIPTION + + The order in which modules are processed by the + depmod command can be altered on a global or + per-module basis. This is typically useful in cases where built-in + kernel modules are complemented by custom built versions of the + same and the user wishes to affect the priority of processing in + order to override the module version supplied by the kernel. + + + The format of depmod.conf and files under depmod.d is simple: one + command per line, with blank lines and lines starting with '#' + ignored (useful for adding comments). A '\' at the end of a line + causes it to continue on the next line, which makes the file a + bit neater. + + + + COMMANDS + + + search subdirectory... + + + + This allows you to specify the order in which /lib/modules + (or other configured module location) subdirectories will + be processed by depmod. Directories are + listed in order, with the highest priority given to the + first listed directory and the lowest priority given to the last + directory listed. The special keyword built-in + refers to the standard module directories installed by the kernel. + + + By default, depmod will give a higher priority to + a directory with the name updates + using this built-in search string: "updates built-in" + but more complex arrangements are possible and are + used in several popular distributions. + + + + + override modulename kernelversion modulesubdirectory + + + + This command allows you to override which version of a + specific module will be used when more than one module + sharing the same name is processed by the + depmod command. It is possible to + specify one kernel or all kernels using the * wildcard. + modulesubdirectory is the + name of the subdirectory under /lib/modules (or other + module location) where the target module is installed. + + + For example, it is possible to override the priority of + an updated test module called kmod by + specifying the following command: "override kmod * extra". + This will ensure that any matching module name installed + under the extra subdirectory within + /lib/modules (or other module location) will take priority + over any likenamed module already provided by the kernel. + + + + + + + COPYRIGHT + + This manual page Copyright 2006-2010, Jon Masters, Red Hat, Inc. + + + + SEE ALSO + + depmod8 + + + +
+ + diff --git a/doc/depmod.sgml b/doc/depmod.sgml new file mode 100644 index 00000000..4f3783e9 --- /dev/null +++ b/doc/depmod.sgml @@ -0,0 +1,306 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2011-05-31 +
+ + depmod + 8 + + + depmod program to generate modules.dep and map files. + + + + depmod + + + + + + + + + + + + + + depmod + + + + + + + + + + + + + + DESCRIPTION + + Linux kernel modules can provide services (called "symbols") for + other modules to use (using one of the EXPORT_SYMBOL variants in the + code). If a second module uses this symbol, that second module clearly + depends on the first module. These dependencies can get quite complex. + + + depmod creates a list of module dependencies + by reading each module under + /lib/modules/version + and determining what symbols it exports and what symbols it + needs. By default, this list is written to + modules.dep, and a binary hashed version named + modules.dep.bin, in the same directory. If + filenames are given on the command line, only those modules are + examined (which is rarely useful unless all modules are listed). + depmod also creates a list of symbols provided + by modules in the file named modules.symbols + and its binary hashed version, modules.symbols.bin. + Finally, depmod will output a file named + modules.devname if modules supply special + device names (devname) that should be populated in /dev on boot + (by a utility such as udev). + + + If a version is provided, then that + kernel version's module directory is used rather than the + current kernel version (as returned by uname -r). + + + depmod will also generate various legacy map + files in the output directory for use by the older hotplug + infrastructure. These map files are largely deprecated. + + + + OPTIONS + + + + + + + Probe all modules. This option is enabled by default if no + file names are given in the command-line. + + + + + + + + + This option scans to see if any modules are newer than the + modules.dep file before any work is done: + if not, it silently exits rather than regenerating the files. + + + + + + + + + If your modules are not currently in the (normal) + directory + /lib/modules/version, + but in a staging area, you can specify a + basedir which is prepended to + the directory name. This + basedir is stripped from the + resulting modules.dep file, so it + is ready to be moved into the normal location. Use this option + if you are a distribution vendor who needs to pre-generate the + meta-data files rather than running depmod again later. + + + + + + + + + This option overrides the default configuration file at + /etc/depmod.conf (or the + /etc/depmod.d/ directory if that is not found). + + + + + + + + + When combined with the option, this + reports any symbols which a module needs which are not + supplied by other modules or the kernel. Normally, any + symbols not provided by modules are assumed to be + provided by the kernel (which should be true in a + perfect world), but this assumption can break espencially + when additionally updated third party drivers are not + correctly installed or were built incorrectly. + + + + + + + + + When combined with the option, this + reports any symbol versions supplied by modules that do + not match with the symbol versions provided by the + kernel in its Module.symvers. + This option is mutually incompatible with . + + + + + + + + + Supplied with the System.map produced + when the kernel was built, this allows the + option to report unresolved symbols. + This option is mutually incompatible with . + + + + + + + + + Print the help message and exit. + + + + + + + + + This overrides any possible configuration file setting of + and forces the generation + of legacy map files, such as modules.pcimap. + + + + + + + + + This sends the resulting modules.dep and the various + map files to standard output rather than writing them into + the module directory. + + + + + + + + + Some architectures prefix symbols with an extraneous character. + This specifies a prefix character (for example '_') to ignore. + + + + + + + + + In verbose mode, depmod will print (to stdout) + all the symbols each module depends on and the module's file name + which provides that symbol. + + + + + + + + + Show version of program and exit. See below for caveats when + run on older kernels. + + + + + + + + + Warn on duplicate dependencies, aliases, symbol versions, etc. + + + + + + + COPYRIGHT + + + This manual page originally Copyright 2002, Rusty Russell, + IBM Corporation. Portions Copyright Jon Masters, and others. + + + + SEE ALSO + + + depmod.conf5 + , + + depmod.d5 + , + + modprobe8 + , + + modules.dep5 + + + +
+ + diff --git a/doc/insmod.sgml b/doc/insmod.sgml new file mode 100644 index 00000000..ab3a4e87 --- /dev/null +++ b/doc/insmod.sgml @@ -0,0 +1,94 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2010-03-01 +
+ + insmod + 8 + + + insmod simple program to insert a module into the Linux Kernel + + + + insmod + filename + module options + + + + DESCRIPTION + + insmod is a trivial program to insert a + module into the kernel: if the + filename is a hyphen, the module is + taken from standard input. Most users will want to use + modprobe + 8 instead, which is + more clever and can handle module dependencies. + + Only the most general of error messages are reported: as the + work of trying to link the module is now done inside the kernel, + the dmesg usually gives more information + about errors. + + + COPYRIGHT + + This manual page originally Copyright 2002, Rusty Russell, IBM + Corporation. Maintained by Jon Masters and others. + + + + SEE ALSO + + + modprobe8 + , + + rmmod8 + , + + lsmod8 + + + modinfo8 + + + +
+ + diff --git a/doc/lsmod.sgml b/doc/lsmod.sgml new file mode 100644 index 00000000..0267451c --- /dev/null +++ b/doc/lsmod.sgml @@ -0,0 +1,83 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2010-03-01 +
+ + lsmod + 8 + + + lsmod program to show the status of modules in the Linux Kernel + + + + lsmod + + + + DESCRIPTION + + lsmod is a trivial program which nicely + formats the contents of the /proc/modules, + showing what kernel modules are currently loaded. + + + + + COPYRIGHT + + This manual page originally Copyright 2002, Rusty Russell, IBM + Corporation. Maintained by Jon Masters and others. + + + + SEE ALSO + + + + insmod8 + , + + modprobe8 + , + + modinfo8 + + + +
+ + diff --git a/doc/modinfo.sgml b/doc/modinfo.sgml new file mode 100644 index 00000000..8c72eef7 --- /dev/null +++ b/doc/modinfo.sgml @@ -0,0 +1,169 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2010-03-01 +
+ + modinfo + 8 + + + modinfo program to show information about a Linux Kernel module + + + + modinfo + + + + modulename|filename + + + modinfo -V + + + modinfo -h + + + + DESCRIPTION + + modinfo extracts information from the Linux + Kernel modules given on the command line. If the module name is + not a filename, then the + /lib/modules/version + directory is searched, as is also done by + modprobe8 when loading kernel modules. + + + modinfo by default lists each attribute + of the module in form fieldname : + value, for easy reading. The + filename is listed the same way (although it's not really an + attribute). + + + This version of modinfo can understand + modules of any Linux Kernel architecture. + + + OPTIONS + + + + + + + Print the modinfo version. + + + + + + + + + Only print this field value, one per line. This is most + useful for scripts. Field names are case-insenitive. + Common fields (which may not be in every module) include + author, description, + license, parm, + depends, and alias. + There are often multiple parm, + alias and depends + fields. The special field filename + lists the filename of the module. + + + + + + + + + Provide information about a kernel other than the running one. This + is particularly useful for distributions needing to extract + information from a newly installed (but not yet running) set of + kernel modules. For example, you wish to find which firmware files + are needed by various modules in a new kernel for which you must + make an initrd/initramfs image prior to booting. + + + + + + + + + Use the ASCII zero character to separate field values, + instead of a new line. This is useful for scripts, since + a new line can theoretically appear inside a field. + + + + + + + + + These are shortcuts for author, + description, + license. parm and + filename respectively, to ease the + transition from the old modutils + modinfo. + + + + + + + COPYRIGHT + + This manual page originally Copyright 2003, Rusty Russell, IBM + Corporation. Maintained by Jon Masters and others. + + + + SEE ALSO + + + modprobe8 + + + +
+ + diff --git a/doc/modprobe.d.sgml b/doc/modprobe.d.sgml new file mode 100644 index 00000000..74fdb7c1 --- /dev/null +++ b/doc/modprobe.d.sgml @@ -0,0 +1,255 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2010-03-09 +
+ + modprobe.conf + 5 + + + modprobe.dmodprobe.conf Configuration directory/file for modprobe + + + DESCRIPTION + + Because the modprobe command can add or + remove more than one module, due to modules having dependencies, + we need a method of specifying what options are to be used with + those modules. All files underneath the + /etc/modprobe.d directory which end with the + .conf extension specify those options as + required. (the /etc/modprobe.conf file can + also be used if it exists, but that will be removed in a future + version). They can also be used to create convenient aliases: + alternate names for a module, or they can override the normal + modprobe behavior altogether for those with + special requirements (such as inserting more than one module). + + + Note that module and alias names (like other module names) can + have - or _ in them: both are interchangable throughout all the + module commands as underscore conversion happens automatically. + + + The format of and files under modprobe.d and + /etc/modprobe.conf is simple: one + command per line, with blank lines and lines starting with '#' + ignored (useful for adding comments). A '\' at the end of a line + causes it to continue on the next line, which makes the file a + bit neater. + + + + COMMANDS + + + alias wildcard modulename + + + + This allows you to give alternate names for a module. For + example: "alias my-mod really_long_modulename" + means you can use "modprobe my-mod" instead of "modprobe + really_long_modulename". You can also use shell-style + wildcards, so "alias my-mod* really_long_modulename" + means that "modprobe my-mod-something" has the same + effect. You can't have aliases to other aliases (that + way lies madness), but aliases can have options, which + will be added to any other options. + + + Note that modules can also contain their own aliases, + which you can see using modinfo. These + aliases are used as a last resort (ie. if there is no real + module, install, + remove, or alias + command in the configuration). + + + + + blacklist modulename + + + + Modules can contain their own aliases: usually these are + aliases describing the devices they support, such as + "pci:123...". These "internal" aliases can be overridden + by normal "alias" keywords, but there are cases where two + or more modules both support the same devices, or a module + invalidly claims to support a device that it does not: the + blacklist keyword indicates that all of + that particular module's internal aliases are to be ignored. + + + + + install modulename command... + + + + This command instructs modprobe to run your + command instead of inserting the module in the kernel as normal. + The command can be any shell command: this allows you to do any + kind of complex processing you might wish. For example, if the + module "fred" works better with the module "barney" + already installed (but it doesn't depend on it, so + modprobe won't automatically load it), + you could say "install fred /sbin/modprobe barney; + /sbin/modprobe --ignore-install fred", which would do what + you wanted. Note the , + which stops the second modprobe from + running the same install command again. + See also remove below. + + The long term future of this command as a solution to the + problem of providing additional module dependencies is not assured + and it is intended to replace this command with a warning about + its eventual removal or deprecation at some point in a future + release. Its use complicates the automated determination of module + dependencies by distribution utilities, such as mkinitrd (because + these now need to somehow interpret what the + install commands might be doing. + In a perfect world, modules would provide all dependency + information without the use of this command and work is underway + to implement soft dependency support within the Linux kernel. + + + If you use the string "$CMDLINE_OPTS" in the command, it + will be replaced by any options specified on the modprobe + command line. This can be useful because users expect + "modprobe fred opt=1" to pass the "opt=1" arg to the + module, even if there's an install command in the + configuration file. So our above example becomes "install + fred /sbin/modprobe barney; /sbin/modprobe + --ignore-install fred $CMDLINE_OPTS" + + + + + options modulename option... + + + + This command allows you to add options to the module + modulename (which might be an + alias) every time it is inserted into the kernel: whether + directly (using modprobe + modulename or because the + module being inserted depends on this module. + + + All options are added together: they can come from an + option for the module itself, for an + alias, and on the command line. + + + + + remove modulename command... + + + + This is similar to the install command + above, except it is invoked when "modprobe -r" is run. + + + + + softdep modulename pre: modules... post: modules... + + + + The softdep command allows you to specify soft, + or optional, module dependencies. modulename + can be used without these optional modules installed, but usually with + some features missing. For example, a driver for a storage HBA might + require another module be loaded in order to use management features. + + + pre-deps and post-deps modules are lists of names and/or aliases of other + modules that modprobe will attempt to install (or remove) in order + before and after the main module given in the + modulename argument. + + + Example: Assume "softdep c pre: a b post: d e" is provided in the + configuration. Running "modprobe c" is now equivalent to + "modprobe a b c d e" without the softdep. + Flags such as --use-blacklist are applied to all the specified + modules, while module parameters only apply to module c. + + + Note: if there are install or + remove commands with the same + modulename argument, + softdep takes precedence. + + + + + + + COMPATIBILITY + + A future version of module-init-tools will come with a strong warning + to avoid use of the install as explained above. This + will happen once support for soft dependencies in the kernel is complete. + That support will complement the existing softdep support within this + utility by providing such dependencies directly within the modules. + + + + COPYRIGHT + + This manual page originally Copyright 2004, Rusty Russell, IBM + Corporation. Maintained by Jon Masters and others. + + + + SEE ALSO + + + modprobe8 + , + + modules.dep5 + + + +
+ + diff --git a/doc/modprobe.sgml b/doc/modprobe.sgml new file mode 100644 index 00000000..85330e16 --- /dev/null +++ b/doc/modprobe.sgml @@ -0,0 +1,500 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2010-03-01 +
+ + modprobe + 8 + + + modprobe program to add and remove modules from the Linux Kernel + + + + modprobe + + + + + + + + modulename + + + + modprobe + -r + + + + + + + modprobe + -l + -t dirname + + + + modprobe + -c + + + modprobe + --dump-modversions filename + + + + Description + + + modprobe intelligently adds or removes a + module from the Linux kernel: note that for convenience, there + is no difference between _ and - in module names (automatic + underscore conversion is performed). + modprobe looks in the module directory + /lib/modules/`uname -r` for all + the modules and other files, except for the optional + /etc/modprobe.conf configuration file and + /etc/modprobe.d directory + (see + modprobe.conf5 + ). modprobe will also use module + options specified on the kernel command line in the form of + <module>.<option>. + + + Note that unlike in 2.4 series Linux kernels (which are not supported + by this tool) this version of modprobe does not + do anything to the module itself: the work of resolving symbols + and understanding parameters is done inside the kernel. So + module failure is sometimes accompanied by a kernel message: see + + dmesg8 + . + + + modprobe expects an up-to-date + modules.dep.bin file (or fallback human + readable modules.dep file), as generated + by the corresponding depmod utility shipped + along with modprobe (see + depmod8 + ). This file lists what other modules each + module needs (if any), and modprobe uses this + to add or remove these dependencies automatically. + + + If any arguments are given after the + modulename, they are passed to the + kernel (in addition to any options listed in the configuration + file). + + + + OPTIONS + + + + + + Insert all module names on the command line. + + + + + + + + + This option causes modprobe to apply the + blacklist commands in the configuration files + (if any) to module names as well. It is usually used by + + udev7 + . + + + + + + + + This option overrides the default configuration directory/file + (/etc/modprobe.d or + /etc/modprobe.conf). + + + This option is passed through install + or remove commands to other + modprobe commands in the + MODPROBE_OPTIONS environment variable. + + + + + + + + Dump out the effective configuration from the config directory + and exit. + + + + + + + + + Print out a list of module versioning information required by a + module. This option is commonly used by distributions in order to + package up a Linux kernel module using module versioning deps. + + + + + + + + + Directory where modules can be found, + /lib/modules/RELEASE + by default. + + + + + + + + + Normally, modprobe will succeed (and do + nothing) if told to insert a module which is already + present or to remove a module which isn't present. This is + ideal for simple scripts; however, more complicated scripts often + want to know whether modprobe really + did something: this option makes modprobe fail in the + case that it actually didn't do anything. + + + + + + + + + Every module contains a small string containing important + information, such as the kernel and compiler versions. If + a module fails to load and the kernel complains that the + "version magic" doesn't match, you can use this option to + remove it. Naturally, this check is there for your + protection, so this using option is dangerous unless + you know what you're doing. + + + This applies to any modules inserted: both the module (or + alias) on the command line and any modules on which it depends. + + + + + + + + + When modules are compiled with CONFIG_MODVERSIONS set, a + section detailing the versions of every interfaced used + by (or supplied by) the module is created. If a + module fails to load and the kernel complains that the + module disagrees about a version of some interface, you + can use "--force-modversion" to remove the version + information altogether. Naturally, this check is there + for your protection, so using this option is dangerous + unless you know what you're doing. + + + This applies any modules inserted: both the module (or + alias) on the command line and any modules on which it depends. + + + + + + + + + Try to strip any versioning information from the module + which might otherwise stop it from loading: this is the + same as using both and + . Naturally, these + checks are there for your protection, so using this option + is dangerous unless you know what you are doing. + + + This applies to any modules inserted: both the module (or + alias) on the command line and any modules it on which it depends. + + + + + + + + This option causes modprobe to + ignore install and + remove commands in the + configuration file (if any) for the module specified on the + command line (any dependent modules are still subject + to commands set for them in the configuration file). Both + install and remove + commands will currently be ignored when this option is used + regardless of whether the request was more specifically + made with only one or other (and not both) of + or + . + See +modprobe.conf5 +. + + + + + + + + List all modules matching the given wildcard (or "*" + if no wildcard is given). This option is provided for + backwards compatibility and may go away in future: see + + find1 + and + + basename1 + for a more flexible alternative. + + + + + + + + + This option does everything but actually insert or + delete the modules (or run the install or remove + commands). Combined with , it is + useful for debugging problems. For historical reasons + both and + actually mean the same thing and are interchangeable. + + + + + + + + + With this flag, modprobe won't print an error + message if you try to remove or insert a module it can't find (and + isn't an alias or + install/remove command). + However, it will still return with a non-zero exit status. The + kernel uses this to opportunistically probe for modules which might + exist using request_module. + + + + + + + + + Print all module names matching an alias. This can be useful + for debugging module alias problems. + + + + + + + + + This option causes modprobe to remove + rather than insert a module. If the modules it depends on + are also unused, modprobe will try to + remove them too. Unlike insertion, more than one module + can be specified on the command line (it does not make + sense to specify module parameters when removing modules). + + + There is usually no reason to remove modules, but some + buggy modules require it. Your distribution kernel may not + have been built to support removal of modules at all. + + + + + + + + + Set the kernel version, rather than using + uname2 to decide on the kernel version (which dictates where to + find the modules). + + + + + + + + + List the dependencies of a module (or alias), including + the module itself. This produces a (possibly empty) set + of module filenames, one per line, each starting with + "insmod" and is typically used by distributions to determine + which modules to include when generating initrd/initramfs images. + Install commands which apply are shown prefixed by + "install". It does not run any of the install commands. Note that + modinfo8 + can be used to extract dependencies of a module from the + module itself, but knows nothing of aliases or install commands. + + + + + + + + + This option causes any error messages to go through the + syslog mechanism (as LOG_DAEMON with level LOG_NOTICE) + rather than to standard error. This is also automatically + enabled when stderr is unavailable. + + + This option is passed through install + or remove commands to other + modprobe commands in the + MODPROBE_OPTIONS environment variable. + + + + + + + + Restrict to modules + in directories matching the + dirname given. This option + is provided for backwards compatibility and may go + away in future: see + + find1 + + and + + basename1 + for a more flexible alternative. + + + + + + + + Show version of program and exit. + + + + + + + + Print messages about what the program is doing. Usually + modprobe only prints messages if + something goes wrong. + + + This option is passed through install + or remove commands to other + modprobe commands in the + MODPROBE_OPTIONS environment variable. + + + + + + + ENVIRONMENT + + The MODPROBE_OPTIONS environment variable can also be used to + pass arguments to modprobe. + + + + COPYRIGHT + + This manual page originally Copyright 2002, Rusty Russell, IBM + Corporation. Maintained by Jon Masters and others. + + + + SEE ALSO + + + modprobe.conf5 + , + + modprobe.d5 + , + + insmod8 + , + + rmmod8 + , + + lsmod8 + , + + modinfo8 + + + +
+ + diff --git a/doc/modules.dep.sgml b/doc/modules.dep.sgml new file mode 100644 index 00000000..a0b68ede --- /dev/null +++ b/doc/modules.dep.sgml @@ -0,0 +1,89 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2010-03-01 +
+ + modules.dep + 5 + + + modules.dep.binmodules.dep Module dependency information + + + DESCRIPTION + + + The modules.dep.bin as generated by + module-init-tools depmod, lists the + dependencies for every module in the directories under + /lib/modules/version, + where modules.dep.bin (or the human readable + version modules.dep) is also located. It is + used by utilities such as modprobe. The + binary version will be used by default, if it was generated by + a compatible version of depmod, with fallback + to the generic modules.dep. + + + These files are not intended for editing or use by any additional + utilities as their format is subject to change in the future. You + should use the + modinfo8 command to obtain information about modules in a future + proof and compatible fashion rather than touching these files. + + + + COPYRIGHT + + This manual page originally Copyright 2002, Rusty Russell, IBM + Corporation. Maintained by Jon Masters and others. + + + + SEE ALSO + + + + depmod8 + , + + modprobe8 + + + +
+ + diff --git a/doc/rmmod.sgml b/doc/rmmod.sgml new file mode 100644 index 00000000..bd009b73 --- /dev/null +++ b/doc/rmmod.sgml @@ -0,0 +1,159 @@ +Debian GNU/Linux"> + DocBook"> + SGML"> +]> + + + + + +
+ jcm@jonmasters.org +
+ + Jon + Masters + + 2010-03-01 +
+ + rmmod + 8 + + + rmmod simple program to remove a module from the Linux Kernel + + + + rmmod + + + + + modulename + + + + DESCRIPTION + + rmmod is a trivial program to remove a + module (when module unloading support is provided) from the kernel. + Most users will want to use + + modprobe8 + with the option instead. + + + + OPTIONS + + + + + + + Print messages about what the program is doing. + Usually rmmod prints messages + only if something goes wrong. + + + + + + + + + This option can be extremely dangerous: it has no effect unless + CONFIG_MODULE_FORCE_UNLOAD was set when the kernel was + compiled. With this option, you can remove modules which are + being used, or which are not designed to be removed, or have + been marked as unsafe (see + lsmod8 + ). + + + + + + + + + Normally, rmmod will refuse to + unload modules which are in use. With this option, + rmmod will isolate the module, and + wait until the module is no longer used. Nothing new + will be able to use the module, but it's up to you to + make sure the current users eventually finish with it. + See + lsmod8 + ) for information on usage counts. + + + + + + + + + Send errors to syslog instead of standard error. + + + + + + + + + Show version of program and exit. + + + + + + + COPYRIGHT + + This manual page originally Copyright 2002, Rusty Russell, IBM + Corporation. Maintained by Jon Masters and others. + + + + SEE ALSO + + + + modprobe8 + , + + insmod8 + , + + lsmod8 + + + modinfo8 + + + +
+ +