File module-init-tools-manpages.diff of Package module-init-tools
This patch updates the generated manpages to avoid dependency on docbook2man --- a/modprobe.8 +++ b/modprobe.8 @@ -1,18 +1,28 @@ -.\\" auto-generated by docbook2man-spec $Revision: 1.2 $ -.TH "MODPROBE" "8" "2010-03-01" "" "" +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "MODPROBE" "8" "27 August 2010" "" "" + .SH NAME modprobe \- program to add and remove modules from the Linux Kernel .SH SYNOPSIS -.sp -\fBmodprobe\fR [ \fB-v\fR ] [ \fB-V\fR ] [ \fB-C \fIconfig-file\fB\fR ] [ \fB-n\fR ] [ \fB-i\fR ] [ \fB-q\fR ] [ \fB-b\fR ] [ \fB\fImodulename\fB\fR ] [ \fB\fImodule parameters\fB\fR\fI...\fR ] -.sp -\fBmodprobe\fR [ \fB-r\fR ] [ \fB-v\fR ] [ \fB-n\fR ] [ \fB-i\fR ] [ \fB\fImodulename\fB\fR\fI...\fR ] -.sp -\fBmodprobe\fR [ \fB-l\fR ] [ \fB-t \fIdirname\fB\fR ] [ \fB\fIwildcard\fB\fR ] -.sp -\fBmodprobe\fR [ \fB-c\fR ] -.sp -\fBmodprobe\fR [ \fB--dump-modversions\fR ] [ \fB\fIfilename\fB\fR ] + +\fBmodprobe\fR [ \fB-v\fR ] [ \fB-V\fR ] [ \fB-C \fIconfig-file\fB\fR ] [ \fB-n\fR ] [ \fB-i\fR ] [ \fB-q\fR ] [ \fB-b\fR ] [ \fB\fImodulename\fB\fR ] [ \fB\fImodule parameters\fB\fR\fI ...\fR ] + + +\fBmodprobe\fR [ \fB-r\fR ] [ \fB-v\fR ] [ \fB-n\fR ] [ \fB-i\fR ] [ \fB\fImodulename\fB\fR\fI ...\fR ] + + +\fBmodprobe\fR [ \fB-l\fR ] [ \fB-t \fIdirname\fB\fR ] [ \fB\fIwildcard\fB\fR ] + + +\fBmodprobe\fR [ \fB-c\fR ] + + +\fBmodprobe\fR [ \fB--dump-modversions\fR ] [ \fB\fIfilename\fB\fR ] + .SH "DESCRIPTION" .PP \fBmodprobe\fR intelligently adds or removes a @@ -31,7 +41,7 @@ Note that unlike in 2.4 series Linux kernels (which are not supported by this tool) this version of \fBmodprobe\fR does not do anything to the module itself: the work of resolving symbols -and understanding parameters is done inside the kernel. So +and understanding parameters is done inside the kernel. So module failure is sometimes accompanied by a kernel message: see \fBdmesg\fR(8)\&. .PP @@ -40,7 +50,7 @@ readable \fImodules.dep\fR file), as generated by the corresponding \fBdepmod\fR utility shipped along with \fBmodprobe\fR (see -\fBdepmod\fR(8)). This file lists what other modules each +\fBdepmod\fR(8)). This file lists what other modules each module needs (if any), and \fBmodprobe\fR uses this to add or remove these dependencies automatically. .PP @@ -50,16 +60,16 @@ file). .SH "OPTIONS" .TP -\fB-a --all\fR +\fB-a --all \fR Insert all module names on the command line. .TP -\fB-b --use-blacklist\fR +\fB-b --use-blacklist \fR This option causes \fBmodprobe\fR to apply the \fBblacklist\fR commands in the configuration files -(if any) to module names as well. It is usually used by +(if any) to module names as well. It is usually used by \fBudev\fR(7)\&. .TP -\fB-C --config\fR +\fB-C --config \fR This option overrides the default configuration directory/file (\fI/etc/modprobe.d\fR or \fI/etc/modprobe.conf\fR). @@ -69,67 +79,67 @@ \fBmodprobe\fR commands in the MODPROBE_OPTIONS environment variable. .TP -\fB-c --showconfig\fR +\fB-c --showconfig \fR Dump out the effective configuration from the config directory and exit. .TP -\fB--dump-modversions\fR +\fB--dump-modversions \fR 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. .TP -\fB-d --dirname\fR +\fB-d --dirname \fR Directory where modules can be found, \fI/lib/modules/RELEASE\fR by default. .TP -\fB--first-time\fR +\fB--first-time \fR Normally, \fBmodprobe\fR 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 +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 \fBmodprobe\fR really did something: this option makes modprobe fail in the case that it actually didn't do anything. .TP -\fB--force-vermagic\fR +\fB--force-vermagic \fR Every module contains a small string containing important -information, such as the kernel and compiler versions. If +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 +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. .TP -\fB--force-modversion\fR +\fB--force-modversion \fR 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 +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 +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. .TP -\fB-f --force\fR +\fB-f --force \fR Try to strip any versioning information from the module which might otherwise stop it from loading: this is the same as using both \fB--force-vermagic\fR and -\fB--force-modversion\fR\&. Naturally, these +\fB--force-modversion\fR\&. 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. .TP -\fB-i --ignore-install --ignore-remove\fR +\fB-i --ignore-install --ignore-remove \fR This option causes \fBmodprobe\fR to ignore \fBinstall\fR and \fBremove\fR commands in the @@ -144,22 +154,22 @@ \fB--ignore-remove\fR\&. See \fBmodprobe.conf\fR(5)\&. .TP -\fB-l --list\fR +\fB-l --list \fR List all modules matching the given wildcard (or "*" -if no wildcard is given). This option is provided for +if no wildcard is given). This option is provided for backwards compatibility and may go away in future: see \fBfind\fR(1) and \fBbasename\fR(1) for a more flexible alternative. .TP -\fB-n --dry-run\fR +\fB-n --dry-run --show \fR This option does everything but actually insert or delete the modules (or run the install or remove -commands). Combined with \fB-v\fR, it is +commands). Combined with \fB-v\fR, it is useful for debugging problems. For historical reasons both \fB--dry-run\fR and \fB--show\fR actually mean the same thing and are interchangeable. .TP -\fB-q --quiet\fR +\fB-q --quiet \fR With this flag, \fBmodprobe\fR 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 @@ -168,43 +178,43 @@ kernel uses this to opportunistically probe for modules which might exist using request_module. .TP -\fB-R --resolve-alias\fR +\fB-R --resolve-alias \fR Print all module names matching an alias. This can be useful for debugging module alias problems. .TP -\fB-r --remove\fR +\fB-r --remove \fR This option causes \fBmodprobe\fR to remove -rather than insert a module. If the modules it depends on +rather than insert a module. If the modules it depends on are also unused, \fBmodprobe\fR will try to -remove them too. Unlike insertion, more than one module +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 +buggy modules require it. Your distribution kernel may not have been built to support removal of modules at all. .TP -\fB-S --set-version\fR +\fB-S --set-version \fR Set the kernel version, rather than using \fBuname\fR(2) to decide on the kernel version (which dictates where to find the modules). .TP -\fB--show-depends\fR +\fB--show-depends \fR List the dependencies of a module (or alias), including -the module itself. This produces a (possibly empty) set +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. \fBInstall\fR commands which apply are shown prefixed by -"install". It does not run any of the install commands. Note that +"install". It does not run any of the install commands. Note that \fBmodinfo\fR(8) can be used to extract dependencies of a module from the module itself, but knows nothing of aliases or install commands. .TP -\fB-s --syslog\fR +\fB-s --syslog \fR 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 +rather than to standard error. This is also automatically enabled when stderr is unavailable. This option is passed through \fBinstall\fR @@ -212,21 +222,21 @@ \fBmodprobe\fR commands in the MODPROBE_OPTIONS environment variable. .TP -\fB-t --type\fR +\fB-t --type \fR Restrict \fB-l\fR to modules in directories matching the -\fIdirname\fR given. This option +\fIdirname\fR given. This option is provided for backwards compatibility and may go away in future: see \fBfind\fR(1) and \fBbasename\fR(1) for a more flexible alternative. .TP -\fB-V --version\fR +\fB-V --version \fR Show version of program and exit. .TP -\fB-v --verbose\fR -Print messages about what the program is doing. Usually +\fB-v --verbose \fR +Print messages about what the program is doing. Usually \fBmodprobe\fR only prints messages if something goes wrong. @@ -234,6 +244,15 @@ or \fBremove\fR commands to other \fBmodprobe\fR commands in the MODPROBE_OPTIONS environment variable. +.TP +\fB--allow-unsupported-modules \fR +Load unsupported modules even if disabled in configuration. +.SH "RETURN VALUE" +.PP +\fBmodprobe\fR returns 0 on success, 1 on an unspecified +error and 2 if the module is not supported. Use the +\fB--allow-unsupported-modules\fR option to force +using an unsupported module. .SH "ENVIRONMENT" .PP The MODPROBE_OPTIONS environment variable can also be used to --- a/modprobe.conf.5 +++ b/modprobe.conf.5 @@ -1,5 +1,10 @@ -.\\" auto-generated by docbook2man-spec $Revision: 1.2 $ -.TH "MODPROBE.CONF" "5" "2010-03-09" "" "" +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "MODPROBE.CONF" "5" "27 August 2010" "" "" + .SH NAME modprobe.d, modprobe.conf \- Configuration directory/file for modprobe .SH "DESCRIPTION" @@ -7,12 +12,12 @@ Because the \fBmodprobe\fR 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 +those modules. All files underneath the \fI/etc/modprobe.d\fR directory which end with the \fI\&.conf\fR extension specify those options as required. (the \fI/etc/modprobe.conf\fR 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: +version). They can also be used to create convenient aliases: alternate names for a module, or they can override the normal \fBmodprobe\fR behavior altogether for those with special requirements (such as inserting more than one module). @@ -24,50 +29,50 @@ The format of and files under \fImodprobe.d\fR and \fI/etc/modprobe.conf\fR 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 +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. .SH "COMMANDS" .TP -\fBalias \fIwildcard\fB \fImodulename\fB\fR -This allows you to give alternate names for a module. For +\fBalias \fIwildcard\fB \fImodulename\fB \fR +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 +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 +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 \fBmodinfo\fR\&. These +which you can see using \fBmodinfo\fR\&. These aliases are used as a last resort (ie. if there is no real module, \fBinstall\fR, \fBremove\fR, or \fBalias\fR command in the configuration). .TP -\fBblacklist \fImodulename\fB\fR +\fBblacklist \fImodulename\fB \fR 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 +"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 \fBblacklist\fR keyword indicates that all of that particular module's internal aliases are to be ignored. .TP -\fBinstall \fImodulename\fB \fIcommand...\fB\fR +\fBinstall \fImodulename\fB \fIcommand...\fB \fR This command instructs \fBmodprobe\fR 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 +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 \fBmodprobe\fR 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 \fB--ignore-install\fR, +you wanted. Note the \fB--ignore-install\fR, which stops the second \fBmodprobe\fR from running the same \fBinstall\fR command again. See also \fBremove\fR below. @@ -86,14 +91,14 @@ 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 +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 +configuration file. So our above example becomes "install fred /sbin/modprobe barney; /sbin/modprobe --ignore-install fred $CMDLINE_OPTS" .TP -\fBoptions \fImodulename\fB \fIoption...\fB\fR +\fBoptions \fImodulename\fB \fIoption...\fB \fR This command allows you to add options to the module \fImodulename\fR (which might be an alias) every time it is inserted into the kernel: whether @@ -105,11 +110,11 @@ \fBoption\fR for the module itself, for an alias, and on the command line. .TP -\fBremove \fImodulename\fB \fIcommand...\fB\fR +\fBremove \fImodulename\fB \fIcommand...\fB \fR This is similar to the \fBinstall\fR command above, except it is invoked when "modprobe -r" is run. .TP -\fBsoftdep \fImodulename\fB pre: \fImodules...\fB post: \fImodules...\fB\fR +\fBsoftdep \fImodulename\fB pre: \fImodules...\fB post: \fImodules...\fB \fR The \fBsoftdep\fR command allows you to specify soft, or optional, module dependencies. \fImodulename\fR can be used without these optional modules installed, but usually with @@ -131,6 +136,13 @@ \fBremove\fR commands with the same \fImodulename\fR argument, \fBsoftdep\fR takes precedence. +.TP +\fBallow_unsupported_modules \fI[0|1]\fB \fR +In SUSE kernels, every kernel module has a flag 'supported'. If +this flag is not set loading this module will taint your kernel. +Setting this option to 0 disables loading of unsupported modules +and avoids tainting the kernel. This is typically set in +\fI/etc/modprobe.d/unsupported-modules\fR\&. .SH "COMPATIBILITY" .PP A future version of module-init-tools will come with a strong warning
