From: Lucas De Marchi Date: Thu, 12 Jan 2012 16:12:27 +0000 (-0200) Subject: man: build modprobe man page X-Git-Tag: v4~29 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f57497cc9a309f532fed3850719ce5c59c7b638a;p=thirdparty%2Fkmod.git man: build modprobe man page --- diff --git a/man/Makefile.am b/man/Makefile.am index dbe11c70..f37bb206 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,5 +1,5 @@ MAN5 = depmod.d.5 modprobe.d.5 modules.dep.5 -MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 +MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 dist_man_MANS = $(MAN5) $(MAN8) $(MAN_STUB) diff --git a/man/modprobe.sgml b/man/modprobe.sgml deleted file mode 100644 index 9c3cdc93..00000000 --- a/man/modprobe.sgml +++ /dev/null @@ -1,455 +0,0 @@ -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 - -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 - (/etc/modprobe.d). - - - 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.d5 -. - - - - - - - - - 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. - - - - - - - - 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.d5 - , - - insmod8 - , - - rmmod8 - , - - lsmod8 - , - - modinfo8 - - - - - - diff --git a/man/modprobe.xml b/man/modprobe.xml new file mode 100644 index 00000000..0b3b01d7 --- /dev/null +++ b/man/modprobe.xml @@ -0,0 +1,460 @@ + + + + + + modprobe + kmod + + + + Developer + Jon + Masters + jcm@jonmasters.org + + + Developer + Robby + Workman + rworkman@slackware.com + + + Developer + Lucas + De Marchi + lucas.demarchi@profusion.mobi + + + + + + modprobe + 8 + + + + modprobe + Add and remove modules from the Linux Kernel + + + + + modprobe + + + + + + + + modulename + + + + modprobe + -r + + + + + + + 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 + (/etc/modprobe.d). + + + 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.d5 + . + + + + + + + + + + + + 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. + + + + + + + + + + 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.d5 + , + + insmod8 + , + + rmmod8 + , + + lsmod8 + , + + modinfo8 + + + +