diff --git a/man/depmod.8.scd b/man/depmod.8.scd index 51fd4c5..67476fb 100644 --- a/man/depmod.8.scd +++ b/man/depmod.8.scd @@ -37,19 +37,16 @@ rather than the current kernel version (as returned by *uname -r*). # OPTIONS -*-a* -*--all* +*-a*, *--all* Probe all modules. This option is enabled by default if no file names are given in the command-line. -*-A* -*--quick* +*-A*, *--quick* 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. -*-b* _basedir_ -*--basedir* _basedir_ +*-b* _basedir_, *--basedir* _basedir_ Override the base directory where modules are located. If your modules are not currently in the (normal) directory @MODULE_DIRECTORY@/_version_, but in a staging area, you can specify a @@ -66,8 +63,7 @@ rather than the current kernel version (as returned by *uname -r*). _/my/build/staging/dir@MODULE_DIRECTORY@/$(uname -r)_ and generates index files under that same directory. -*-m* _moduledir_ -*--moduledir* _moduledir_ +*-m* _moduledir_, *--moduledir* _moduledir_ Override the module directory , which defaults to @MODULE_DIRECTORY@ prefix set at build time. This is useful when building *modules.dep* file in _basedir_ for a system that uses a @@ -80,8 +76,7 @@ rather than the current kernel version (as returned by *uname -r*). _/tmp/build/kernel-modules/$(uname -r)_ and generates index files under that same directory. -*-o* _outdir_ -*--outdir* _outdir_ +*-o* _outdir_, *--outdir* _outdir_ Set the output directory where *depmod* will store any generated file. _outdir_ serves as a root to that location, similar to how _basedir_ is used. Also this setting takes precedence and if used together with @@ -95,13 +90,11 @@ rather than the current kernel version (as returned by *uname -r*). _@MODULE_DIRECTORY@/$(uname -r)_ and generates index files under _/my/build/staging/dir@MODULE_DIRECTORY@/$(uname -r)_. -*-C* _file_ _or_ _directory_ -*--config* _file_ _or_ _directory_ +*-C* _file_ _or_ _directory_, *--config* _file_ _or_ _directory_ This option overrides the default configuration files. See *depmod.d*(5). -*-e* -*--errsyms* +*-e*, *--errsyms* When combined with the *-F* 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 @@ -109,26 +102,21 @@ rather than the current kernel version (as returned by *uname -r*). assumption can break especially when additionally updated third party drivers are not correctly installed or were built incorrectly. -*-E* _Module.symvers_ -*--symvers* _Module.symvers_ +*-E* _Module.symvers_, *--symvers* _Module.symvers_ When combined with the *-e* 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 *-F*. -*-F* _System.map_ -*--filesyms* _System.map_ +*-F* _System.map_, *--filesyms* _System.map_ Supplied with the _System.map_ produced when the kernel was built, this allows the *-e* option to report unresolved symbols. This option is mutually incompatible with *-E*. -*-h* -*--help* +*-h*, *--help* Print the help message and exit. -*-n* -*--show* -*--dry-run* +*-n*, *--show*, *--dry-run* This sends the resulting *modules.dep* and the various map files to standard output rather than writing them into the module directory. @@ -136,13 +124,11 @@ rather than the current kernel version (as returned by *uname -r*). Some architectures prefix symbols with an extraneous character. This specifies a prefix character (for example '\_') to ignore. -*-v* -*--verbose* +*-v*, *--verbose* 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. -*-V* -*--version* +*-V*, *--version* Show version of program and exit. See below for caveats when run on older kernels. diff --git a/man/insmod.8.scd b/man/insmod.8.scd index bca79db..e45cefd 100644 --- a/man/insmod.8.scd +++ b/man/insmod.8.scd @@ -20,27 +20,22 @@ information about errors. # OPTIONS -*-f* -*--force* +*-f*, *--force* This option can be extremely dangerous: it tells the kernel to ignore the module version and vermagic fields when loading. With this option, you can load modules build locally or by third parties, although this can lead to memory corruption, system crashes and data loss. -*-s* -*--syslog* +*-s*, *--syslog* Send errors to syslog instead of standard error. -*-v* -*--verbose* +*-v*, *--verbose* Print messages about what the program is doing. Usually *insmod* prints messages only if something goes wrong. -*-V* -*--version* +*-V*, *--version* Show version of program and exit. -*-h* -*--help* +*-h*, *--help* Print the help message and exit. # COPYRIGHT diff --git a/man/kmod.8.scd b/man/kmod.8.scd index 5401fbd..5490716 100644 --- a/man/kmod.8.scd +++ b/man/kmod.8.scd @@ -15,12 +15,10 @@ Linux Kernel modules. Most users will only run it using its other names. # OPTIONS -*-V* -*--version* +*-V*, *--version* Show the program version and exit. -*-h* -*--help* +*-h*, *--help* Show the help message. # COMMANDS diff --git a/man/lsmod.8.scd b/man/lsmod.8.scd index cb43ff1..d859717 100644 --- a/man/lsmod.8.scd +++ b/man/lsmod.8.scd @@ -15,21 +15,17 @@ _/proc/modules_, showing what kernel modules are currently loaded. # OPTIONS -*-s* -*--syslog* +*-s*, *--syslog* Send errors to syslog instead of standard error. -*-v* -*--verbose* +*-v*, *--verbose* Print messages about what the program is doing. Usually *lsmod* prints messages only if something goes wrong. -*-V* -*--version* +*-V*, *--version* Show version of program and exit. -*-h* -*--help* +*-h*, *--help* Print the help message and exit. # COPYRIGHT diff --git a/man/modinfo.8.scd b/man/modinfo.8.scd index fab37b0..7e6f029 100644 --- a/man/modinfo.8.scd +++ b/man/modinfo.8.scd @@ -28,20 +28,17 @@ architecture. # OPTIONS -*-V* -*--version* +*-V*, *--version* Print the *modinfo* version. -*-F* _field_ -*--field* _field_ +*-F* _field_, *--field* _field_ Only print this _field_ value, one per line. This is most useful for scripts. Field names are case-insensitive. 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. -*-b* _basedir_ -*--basedir* _basedir_ +*-b* _basedir_, *--basedir* _basedir_ Root directory for modules, / by default. *-k* _kernel_ @@ -52,17 +49,12 @@ architecture. modules in a new kernel for which you must make an initrd/initramfs image prior to booting. -*-0* -*--null* +*-0*, *--null* 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_. -*-a* *--author* -*-d* *--description* -*-l* *--license* -*-p* *--parameters* -*-n* *--filename* +*-a* *--author*, *-d* *--description*, *-l* *--license*, *-p* *--parameters*, *-n* *--filename* These are shortcuts for the *--field* flag's author, description, license, parm and filename arguments, to ease the transition from the old modutils *modinfo*. diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd index 5fb2d73..6d1f16a 100644 --- a/man/modprobe.8.scd +++ b/man/modprobe.8.scd @@ -46,26 +46,22 @@ database. # OPTIONS -*-a* -*--all* +*-a*, *--all* Insert all module names on the command line. -*-b* -*--use-blacklist* +*-b*, *--use-blacklist* 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 *udev*(7). -*-C* _directory_ -*--config* _directory_ +*-C* _directory_, *--config* _directory_ This option overrides the default configuration directory. See *modprobe.d*(5). This option is passed through *install* or *remove* commands to other *modprobe* commands in the MODPROBE_OPTIONS environment variable. -*-c* -*--showconfig* +*-c*, *--showconfig* Dump out the effective configuration from the config directory and exit. *--dump-modversions* @@ -73,8 +69,7 @@ database. This option is commonly used by distributions in order to package up a Linux kernel module using module versioning deps. -*-d* -*--dirname* +*-d*, *--dirname* Root directory for modules, / by default. *--first-time* @@ -108,8 +103,7 @@ database. This applies to any modules inserted: both the module (or alias) on the command line and any modules on which it depends. -*-f* -*--force* +*-f*, *--force* Try to strip any versioning information from the module which might otherwise stop it from loading: this is the same as using both *--force-vermagic* and *--force-modversion*. Naturally, these checks are @@ -119,9 +113,7 @@ database. This applies to any modules inserted: both the module (or alias) on the command line and any modules on which it depends. -*-i* -*--ignore-install* -*--ignore-remove* +*-i*, *--ignore-install*, *--ignore-remove* 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 @@ -130,29 +122,24 @@ database. the request was more specifically made with only one or other (and not both) of *--ignore-install* or *--ignore-remove*. See *modprobe.d*(5). -*-n* -*--dry-run* -*--show* +*-n*, *--dry-run*, *--show* This option does everything but actually insert or delete the modules (or run the install or remove commands). Combined with *-v*, it is useful for debugging problems. For historical reasons both *--dry-run* and *--show* actually mean the same thing and are interchangeable. -*-q* -*--quiet* +*-q*, *--quiet* 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. -*-R* -*--resolve-alias* +*-R*, *--resolve-alias* Print all module names matching an alias. This can be useful for debugging module alias problems. -***-r* -*--remove* +***-r*, *--remove* 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 @@ -163,16 +150,14 @@ database. require it. Your distribution kernel may not have been built to support removal of modules at all. -*-w* _TIMEOUT_MSEC_ -*--wait* _TIMEOUT_MSEC_ +*-w* _TIMEOUT_MSEC_, *--wait* _TIMEOUT_MSEC_ This option causes *modprobe -r *to continue trying to remove a module if it fails due to the module being busy, i.e. its refcount is not 0 at the time the call is made. Modprobe tries to remove the module with an incremental sleep time between each tentative up until the maximum wait time in milliseconds passed in this option. -*-S* _version_ -*--set-version* _version_ +*-S* _version_, *--set-version* _version_ Set the kernel version, rather than using *uname*(2) to decide on the kernel version (which dictates where to find the modules). @@ -186,8 +171,7 @@ database. that *modinfo*(8) can be used to extract dependencies of a module from the module itself, but knows nothing of aliases or install commands. -*-s* -*--syslog* +*-s*, *--syslog* 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. @@ -195,12 +179,10 @@ database. This option is passed through *install* or *remove* commands to other *modprobe* commands in the MODPROBE_OPTIONS environment variable. -*-V* -*--version* +*-V*, *--version* Show version of program and exit. -*-v* -*--verbose* +*-v*, *--verbose* Print messages about what the program is doing. Usually *modprobe* only prints messages if something goes wrong. diff --git a/man/rmmod.8.scd b/man/rmmod.8.scd index 7ccf03c..f508503 100644 --- a/man/rmmod.8.scd +++ b/man/rmmod.8.scd @@ -16,28 +16,23 @@ is provided) from the kernel. Most users will want to use *modprobe*(8) with the # OPTIONS -*-f* -*--force* +*-f*, *--force* 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 *lsmod*(8)). -*-s* -*--syslog* +*-s*, *--syslog* Send errors to syslog instead of standard error. -*-v* -*--verbose* +*-v*, *--verbose* Print messages about what the program is doing. Usually *rmmod* prints messages only if something goes wrong. -*-V* -*--version* +*-V*, *--version* Show version of program and exit. -*-h* -*--help* +*-h*, *--help* Print the help message and exit. # COPYRIGHT