{ "mode": "man", "parameter": "dkms", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/dkms/8/json", "generated": "2026-10-04T12:23:23Z", "synopsis": "dkms [action] [options] [module/module-version] [/path/to/source-tree] [/path/to/tarball.tar]\n[/path/to/driver.rpm]", "sections": { "NAME": { "content": "dkms - Dynamic Kernel Module Support\n", "subsections": [] }, "SYNOPSIS": { "content": "dkms [action] [options] [module/module-version] [/path/to/source-tree] [/path/to/tarball.tar]\n[/path/to/driver.rpm]\n", "subsections": [] }, "DESCRIPTION": { "content": "dkms is a framework which allows kernel modules to be dynamically built for each kernel on\nyour system in a simplified and organized fashion.\n", "subsections": [] }, "ACTIONS": { "content": "add [module/module-version|/path/to/source-tree|/path/to/tarball.tar]\n\nAdds a module/module-version combination to the tree for builds and installs. If mod‐\nule/module-version, -m module/module-version, or -m module -v module-version are passed\nas options, this command requires source in /usr/src/-/ as well\nas a properly formatted dkms.conf file. If /path/to/source-tree is passed as an option,\nand source-tree contains a dkms.conf file, it will copy /path/to/source-tree to\n/usr/src/module-module-version. If /path/to/tarball.tar is passed, this command behaves\nlike the ldtarball command.\n\nremove [module/module-version] [-k kernel/arch] [--all]\n\nRemoves a module/version or module/version/kernel/arch combination from the tree. If the\nmodule is currently installed, it first uninstalls it and if applicable, will replace it\nwith its originalmodule. Use the --all option in order to remove all instances for every\nkernel at once.\n\nbuild [module/module-version] [-k kernel/arch] [--force]\n\nBuilds the specified module/version combo for the specified kernel/arch. If the -k option\nis not specified it builds for the currently running kernel and arch. All builds occur in\nthe directory /var/lib/dkms///build/. If the module/module-ver‐\nsion combo has not been added, dkms will try to add it, and in that case build can take\nthe same arguments that add can. If the module is already built, it will not be rebuilt\nagain by default, and the --force option should be used to override this.\n\nunbuild [module/module-version] [-k kernel/arch] [--all]\n\nUndoes the build for a module/version or module/version/kernel/arch combination from the\ntree. If the module is currently installed, it first uninstalls it and if applicable,\nwill replace it with its originalmodule. Finally all binary kernel modules are removed.\nUse the --all option in order to remove all instances for every kernel at once.\n\ninstall [module/module-version] [-k kernel/arch] [--force] [/path/to/driver.rpm]\n\nInstalls a built module/version combo onto the kernel it was built for. If the kernel op‐\ntion is not specified it assumes the currently running kernel. If the module has not\nbeen built, dkms will try to build it. If the module has not been added, dkms will try\nto add it. In both cases, the install command can then take the same arguments as the\nbuild or add commands. If the module is already installed, it will not be reinstalled\nagain by default, and the --force option should be used to override this. If you pass a\n.rpm file, dkms will try to install that file with rpm -Uvh, and it will perform an au‐\ntoinstall action to be sure that everything is built for your kernel if the RPM installed\nsuccessfully.\n\nuninstall [module/module-version] [-k kernel/arch] [--all]\n\nUninstalls an installed module/module-version combo from the kernel/arch passed in the -k\noption, or the current kernel if the -k option was not passed. Use the --all option in\norder to uninstall all instances for every kernel at once. After uninstall completion,\nthe driver will be left in the built state. To completely remove a driver, the remove\naction should be utilized.\n\nmatch [--templatekernel kernel/arch] [-k kernel/arch]\n\nMatch installs modules onto the specified kernel by looking at the configuration of the\nspecified templatekernel. Every module that is installed on the templatekernel within\ndkms is then installed on that specified kernel.\n\nmktarball [module/module-version] [-k kernel/arch] [--archive /path/to/tarball.tar]\n[--source-only] [--binaries-only]\n\nCreates a tarball archive for the specified module/version of all files in the DKMS tree\nfor that module/version combination. This includes the source and any built modules for\nkernels in the tree (as specified). Otherwise, you can specify a singular kernel to\narchive only, or multiple kernels to archive (-k kernel1/arch1 -k kernel2/arch2). Option‐\nally, you can use --archive to specify the file that you would like to save this tarball\nto. You can also specify --binaries-only if you want the resultant tarball not to include\nthe module source. Likewise, --source-only can be used to specify that no prebuilt bina‐\nries should be included in the tarball. In general, mktarball is great for systems man‐\nagement purposes as you can build your driver on just one system and then use ldtarball\non all of your other systems to get the same built modules loaded without having to wait\nfor anything to compile.\n\nldtarball [/path/to/tarball.tar] [--force]\n\nThis takes a tarball made from the mktarball command and loads it into your DKMS tree.\nThis will leave any newly added modules in the built state and dkms install should then\nbe called to install any of them. If files already exist where ldtarball is attempting to\nplace them, it will warn and not copy over them. The --force option should be used to\noverride this.\n\nstatus [module/module-version] [-k kernel/arch]\n\nReturns the current status of modules, versions and kernels within the tree as well as\nwhether they have been added, built or installed. Status can be shown for just a certain\nmodule, a certain kernel, a module/version combination or a module/version/kernel combi‐\nnation.\n", "subsections": [ { "name": "autoinstall", "content": "Attempt to install the latest revision of all modules that have been installed for other\nkernel revisions. dkmsautoinstaller is a stub that uses this action to perform its\nwork.\n" } ] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-m /", "content": "The name of the module and module version you want to operate on. The -m part of this\noption is optional, and can be omitted in virtually all circumstances.\n", "flag": "-m" }, { "name": "-v ", "content": "The version of the module to execute the specified action upon. This option only has\nto be specified if you pass a -m option without a component of its\nown.\n", "flag": "-v", "arg": "" }, { "name": "-k /", "content": "The kernel and arch to perform the action upon. You can specify multiple kernel ver‐\nsion/arch pairs on the command line by repeating the -k argument with a different ker‐\nnel version and arch. However, not all actions support multiple kernel versions (it\nwill error out in this case). The arch part can be omitted, and DKMS will assume you\nwant it to be the arch of the currently running system.\n", "flag": "-k" }, { "name": "-a, --arch", "content": "The system architecture to perform the action upon. It is optional if you pass it as\npart of the -k option. If not specified, it assumes the arch of the currently running\nsystem (`uname -m`). You can specify multiple arch parameters on the same command line\nby repeating the -a argument with a different arch name. When multiple architectures\nare specified, there must be a 1:1 relationship between -k arguments to -a arguments.\nDKMS will then assume the first -a argument aligns with the first -k kernel and so on\nfor the second, third, etc.\n\nFor example, if you were to specify: -k kernel1 -k kernel2 -a i386 -k kernel3 -a i686\n-a x8664, DKMS would process this as: kernel1-i386, kernel2-i686, kernel3-x8664.\n", "flag": "-a", "long": "--arch" }, { "name": "-q, --quiet", "content": "Quiet.\n", "flag": "-q", "long": "--quiet" }, { "name": "-V, --version", "content": "Prints the currently installed version of dkms and exits.\n", "flag": "-V", "long": "--version" }, { "name": "-c ", "content": "The location of the dkms.conf file. This is needed for the add action and if not spec‐\nified, it is assumed to be located in /usr/src/-/. See below\nfor more information on the format of dkms.conf.\n", "flag": "-c", "arg": "" }, { "name": "--config ", "content": "During a build this option is used to specify an alternate location for the kernel\n.config file which was used to compile that kernel. Normally, dkms uses the Red Hat\nstandard location and config filenames located in /usr/src/linux-/configs/.\nIf the config for the kernel that you are building a module for is not located here or\ndoes not have the expected name in this location, you will need to tell dkms where the\nnecessary .config can be found so that your kernel can be properly prepared for the\nmodule build.\n", "long": "--config", "arg": "" }, { "name": "--archive ", "content": "This option is used during a ldtarball action to specify the location of the tarball\nyou wish to load into your DKMS tree. You only have to specify the --archive part of\nthis option if does not already exist as a file.\n", "long": "--archive", "arg": "" }, { "name": "--templatekernel ", "content": "This option is required for the action: match. Match will look at the templatekernel\nspecified and install all of the same module/version combinations on the other kernel.\n", "long": "--templatekernel", "arg": "" }, { "name": "--force", "content": "This option can be used in conjunction with ldtarball to force copying over of extant\nfiles.\n", "long": "--force" }, { "name": "--binaries-only", "content": "This option can be used in conjunction with mktarball in order to create a DKMS tar‐\nball which does not contain the source for the module within it. This can be helpful\nin reducing the size of the tarball if you know that the system which this tarball\nwill be loaded upon already has the source installed. In order to load a tarball made\nas binaries-only you must have the module source in that systems DKMS tree. If you do\nnot, DKMS will refuse to load a binaries-only tarball.\n", "long": "--binaries-only" }, { "name": "--source-only", "content": "This option can be used in conjunction with mktarball but do not want the tarball you\ncreate to have any prebuilt modules within it, passing this option will keep its in‐\nternal DKMS tarball from containing any prebuilt modules.\n\n--all This option can be used to automatically specify all relevant kernels/arches for a\nmodule/module-version. This can be used for things like remove, unbuild and uninstall.\nThis saves the trouble of having to actually specify -k kernel1 -a arch1 -k kernel2 -a\narch2 for every kernel you have built your module for.\n", "long": "--source-only" }, { "name": "--no-depmod", "content": "This option prevents DKMS from running the depmod command during install and uninstall\nwhich will avoid (re)calculating module dependencies and thereby save time.\n", "long": "--no-depmod" }, { "name": "--modprobe-on-install", "content": "This option executes modprobe on the modules upon successful installation.\n", "long": "--modprobe-on-install" }, { "name": "--kernelsourcedir ", "content": "Using this option you can specify the location of your kernel source directory. Most\nlikely you will not need to set this if your kernel source is accessible via /lib/mod‐\nules/$kernelversion/build.\n", "long": "--kernelsourcedir", "arg": "" }, { "name": "--directive <\"cli-directive=cli-value\">", "content": "Using this option, you can specify additional directives from the command line. The\n--directive option can be used multiple times on the same command-line to specify mul‐\ntiple additional command line directives.\n", "long": "--directive", "arg": "<\"cli-directive=cli-value\">" }, { "name": "--rpm_safe_upgrade", "content": "This flag should be used when packaging DKMS enabled modules in RPMs. It should be\nspecified during both the add and remove actions in the RPM spec to ensure that DKMS\nand RPM behave correctly in all scenarios when upgrading between various versions of a\ndkms enabled module RPM package.\n", "long": "--rpm_safe_upgrade" }, { "name": "--dkmstree path/to/place", "content": "Provides a destination tree for building and installing modules to. Useful in cases\nthat you don't want to contaminate a system when using solely for building.\n", "long": "--dkmstree" }, { "name": "--sourcetree path/to/place", "content": "Provides a location to build a DKMS package from. Useful for systems that you may not\nhave root access, but would still like to be able to build DKMS packages.\n", "long": "--sourcetree" }, { "name": "--installtree path/to/place", "content": "Provides a location to place modules when a dkms install command is issued.\n", "long": "--installtree" }, { "name": "-j number", "content": "Run no more than number jobs in parallel; see the -j option of make(1). Defaults to\nthe number of CPUs in the system, detected by nproc(1). Specify 0 to impose no limit\non the number of parallel jobs.\n", "flag": "-j" } ] }, "ORIGINAL MODULES": { "content": "During the first install of a module for a , dkms will search /lib/mod‐\nules/ for a pre-existing module of the same name. If one is found, it will au‐\ntomatically be saved as an \"originalmodule\" so that if the newer module is later removed,\ndkms will put the original module back in its place. Currently, DKMS searches for these orig‐\ninal modules with first preference going to modules located in /lib/modules//updates/ followed by $DESTMODULELOCATION (as specified in dkms.conf ). If one cannot\nbe found in either location, a find will be used to locate one for that kernel. If none are\nfound, then during a later uninstall, your kernel will not have that module replaced.\n\nIf more than one is found, then the first one located (by preference indicated above) will be\nconsidered the \"originalmodule\". As well, all copies of the same-named module will be re‐\nmoved from your kernel tree and placed into /var/lib/dkms//originalmodule/$ker‐\nnelver/collisions so that they can be *manually* accessible later. DKMS will never actually\ndo anything with the modules found underneath the /collisions directory, and they will be\nstored there until you manually delete them.\n\nDKMS.CONF\nWhen performing an add, a proper dkms.conf file must be found. A properly formatted conf file\nis essential for communicating to dkms how and where the module should be installed. While\nnot all the directives are required, providing as many as possible helps to limit any ambigu‐\nity. Note that the dkms.conf is really only a shell-script of variable definitions which are\nthen sourced in by the dkms executable (of the format, DIRECTIVE=\"directive text goes here\").\nAs well, the directives are case-sensitive and should be given in ALL CAPS.\n\nIt is important to understand that many of the DKMS directives are arrays whose index values\nare tied together. These array associations can be considered families, and there are cur‐\nrently three such families of directive arrays. MAKE[#] and MAKEMATCH[#] make up one family.\nPATCH[#] and PATCHMATCH[#] make up the second family. The third and largest family consists\nof BUILTMODULENAME[#], BUILTMODULELOCATION[#], DESTMODULENAME[#], DESTMODULELOCA‐\nTION[#] and STRIP[#]. When indexing these arrays when creating your dkms.conf, each family\nshould start at index value 0.\n", "subsections": [ { "name": "PACKAGE_NAME=", "content": "This directive is used to give the name associated with the entire package of modules.\nThis is the same name that is used with the -m option when building, adding, etc. and\nmay not necessarily be the same as the MODULENAME. This directive must be present in\nevery dkms.conf.\n" }, { "name": "PACKAGE_VERSION=", "content": "This directive is used to give the version associated with the entire package of mod‐\nules being installed within that dkms package. This directive must be present in every\ndkms.conf.\n" }, { "name": "BUILT_MODULE_NAME[#]=", "content": "This directive gives the name of the module just after it is built. If your DKMS mod‐\nule package contains more than one module to install, this is a required directive for\nall of the modules. This directive should explicitly not contain any trailing \".o\" or\n\".ko\". Note that for each module within a dkms package, the numeric value of # must\nbe the same for each of BUILTMODULENAME, BUILTMODULELOCATION, DESTMODULENAME and\nDESTMODULELOCATION and that the numbering should start at 0 (eg. BUILTMOD‐\nULENAME[0]=\"qla2200\" BUILTMODULENAME[1]=\"qla2300\").\n" }, { "name": "BUILT_MODULE_LOCATION[#]=", "content": "This directive tells DKMS where to find your built module after it has been built.\nThis pathname should be given relative to the root directory of your source files\n(where your dkms.conf file can be found). If unset, DKMS expects to find your\nBUILTMODULENAME[#] in the root directory of your source files. Note that for each\nmodule within a dkms package, the numeric value of # must be the same for each of\nBUILTMODULENAME, BUILTMODULELOCATION, DESTMODULENAME and DESTMODULELOCATION\nand that the numbering should start at 0 (eg. BUILTMODULELOCATION[0]=\"some/dir/\"\nBUILTMODULELOCATION[1]=\"other/dir/\").\n" }, { "name": "DEST_MODULE_NAME[#]=", "content": "This directive can be used to specify the name of the module as it should be in‐\nstalled. This will rename the module from BUILTMODULENAME[#] to DESTMODULENAME[#].\nThis directive should explicitly not contain any trailing \".o\" or \".ko\". If unset, it\nis assumed to be the same value as BUILTMODULENAME[#]. Note that for each module\nwithin a dkms package, the numeric value of # must be the same for each of BUILTMOD‐\nULENAME, BUILTMODULELOCATION, DESTMODULENAME and DESTMODULELOCATION and that\nthe numbering should start at 0 (eg. DESTMODULENAME[0]=\"qla22006x\" DESTMOD‐\nULENAME[1]=\"qla23006x\").\n" }, { "name": "DEST_MODULE_LOCATION[#]=", "content": "This directive specifies the destination where a module should be installed to, once\ncompiled. It also is used for finding originalmodules. This is a required directive,\nexcept as noted below. This directive must start with the text \"/kernel\" which is in\nreference to /lib/modules//kernel. Note that for each module within a\ndkms package, the numeric value of # must be the same for each of BUILTMODULENAME,\nBUILTMODULELOCATION, DESTMODULENAME and DESTMODULELOCATION and that the number‐\ning should start at 0 (eg. DESTMODULELOCATION[0]=\"/kernel/drivers/something/\"\nDESTMODULELOCATION[1]=\"/kernel/drivers/other/\").\n\nDESTMODULELOCATION is ignored on Fedora and Red Hat Enterprise Linux, Novell SuSE\nLinux Enterprise Server 10 and higher, Novell SuSE Linux 10.0 and higher, and Ubuntu.\nInstead, the proper distribution-specific directory is used.\n" }, { "name": "STRIP[#]=", "content": "By default strip is considered to be \"yes\". If set to \"no\", DKMS will not run strip -g\nagainst your built module to remove debug symbols from it. STRIP[0] is used as the\ndefault for any unset entries in the STRIP array.\n" }, { "name": "MAKE[#]=", "content": "The MAKE directive array tells DKMS which make command should be used for building\nyour module. The default make command should be put into MAKE[0]. Other entries in\nthe MAKE array will only be used if their corresponding entry in MAKEMATCH[#]\nmatches, as a regular expression (using grep -E), the kernel that the module is being\nbuilt for. Note that if no value is placed in MAKEMATCH[#] for any MAKE[#] where # >\n0, then that MAKE directive is ignored. MAKEMATCH[0] is optional and if it is popu‐\nlated, it will be used to determine if MAKE[0] should be used to build the module for\nthat kernel. If multiple MAKEMATCH directives match against the kernel being built\nfor, the last matching MAKE[#] will be used to build your module. If no MAKE directive\nis specified or if no MAKEMATCH matches the kernel being built for, DKMS will attempt\nto use a generic MAKE command to build your module.\n\nKERNELRELEASE will be automatically appended to MAKE[#]. If you want to suppress this\nbehavior, you can quote the make command: 'make'.\n" }, { "name": "MAKE_MATCH[#]=", "content": "See the above entry on MAKE[#] directives. This array should be populated with regular\nexpressions which, when matched against the kernel being built for, will tell DKMS to\nuse the corresponding make command in the MAKE[#] directive array to build your mod‐\nule.\n\nCLEAN= CLEAN specifies the make clean command to be used to clean up both before and after\nbuilding the module. If unset, it is assumed to be \"make clean\".\n" }, { "name": "NO_WEAK_MODULES=", "content": "The NOWEAKMODULES parameter prevents dkms from creating a symlink into the weak-up‐\ndates directory, which is the default on Red Hat derivatives. The weak modules facil‐\nity was designed to eliminate the need to rebuild kernel modules when kernel upgrades\noccur and relies on the symbols within the kABI.\n\nFedora does not guaranteed a stable kABI so it should be disabled in the specific mod‐\nule override by setting it to \"yes\". For example, for an Nvidia DKMS module you would\nset the following in /etc/dkms/nvidia.conf:\n\nNOWEAKMODULES=\"yes\"\n" }, { "name": "OBSOLETE_BY=", "content": "This directive allows you to specify a kernel version that obsoletes the necessity for\nthis particular DKMS module. This can be specified as a particular upstream kernel or\nan ABI bump of a kernel. For example, \"2.6.24\" would be an upstream kernel and\n\"2.6.24-16\" would represent an ABI bump for a kernel. Both are valid in this area.\n\nPlease avoid the use of OBSOLETEBY wherever possible. It's use indicates a lack of\nproper module versioning using MODULEVERSION() tags in the module source itself. It\nis better to fix the MODULEVERSION() tags than use OBSOLETEBY. This also introduces\na implicit distribution/version dependency on the package, as the value of OBSOLETEBY\nis meaningful only in the context of a single distribution/version.\n\nIf you feel you must use it, please use as such in dkms.conf:\n\nubuntu804=\"Ubuntu\n8.04\"\nif [ -x /usr/bin/lsbrelease ]; then\nif [ \"$(/usr/bin/lsbrelease -sir)\" == \"${ubuntu804}\" ]; then\nOBSOLETEBY=\"2.6.25\"\nfi\nfi\n\n" }, { "name": "PATCH[#]=", "content": "Use the PATCH directive array to specify patches which should be applied to your\nsource before a build occurs. All patches are expected to be in -p1 format and are\napplied with the patch -p1 command. Each directive should specify the filename of the\npatch to apply, and all patches must be located in the patches subdirectory of your\nsource directory ( /usr/src/-/patches/ ). If any patch fails\nto apply, the build will be halted and the rejections can be inspected in\n/var/lib/dkms///build/. If a PATCH should only be applied\nconditionally, the PATCHMATCH[#] array should be used, and a corresponding regular\nexpression should be placed in PATCHMATCH[#] which will alert dkms to only use that\nPATCH[#] if the regular expression matches the kernel which the module is currently\nbeing built for.\n" }, { "name": "PATCH_MATCH[#]=", "content": "See the above description for PATCH[#] directives. If you only want a patch applied in\ncertain scenarios, the PATCHMATCH array should be utilized by giving a regular ex‐\npression which matches the kernels you intend the corresponding PATCH[#] to be applied\nto before building that module.\n" }, { "name": "AUTOINSTALL=", "content": "If this directive is set to yes then the service /etc/rc.d/init.d/dkmsautoinstaller\nwill automatically try to install this module on any kernel you boot into. See the\nsection on dkmsautoinstaller for more information.\n" }, { "name": "BUILD_DEPENDS[#]=", "content": "This optional directive is an array that allows you to specify other modules as depen‐\ndencies for your module. Each array element should be the PACKAGENAME of another mod‐\nule that is managed by dkms. Do not specify a version or architecture in the depen‐\ndency. Note that this directive is only advisory; missing or broken dependencies cause\nnon-fatal warnings.\n" }, { "name": "BUILD_EXCLUSIVE_KERNEL=", "content": "This optional directive allows you to specify a regular expression which defines the\nsubset of kernels which DKMS is allowed to build your module for. If the kernel being\nbuilt for does not match against this regular expression (or does not the satisfy the\nconstraints of any other BUILDEXCLUSIVE* directive), the dkms build will error out\nwith exit code 77. Note that dkms autoinstall will ignore this type of error condi‐\ntion and simply skip the respective modules. For example, if you set it as =\"^2.4.*\",\nyour module would not be built for 2.6 or later kernels.\n" }, { "name": "BUILD_EXCLUSIVE_KERNEL_MIN=", "content": "and BUILDEXCLUSIVEKERNELMAX= These optional directives allow one to specify the\nminimal and maximal kernel versions supported by the module. If one (or both) of these\nare defined, the module will not be built for kernels outside the specified version\nlimits. For example, if you set BUILDEXCLUSIVEKERNELMIN as \"=3.5\", your module\nwould be built for e.g. \"3.5-rc2\", \"3.6.18\" or other later versions but not for\n\"3.4.999\" or earlier kernels. Similarly, if you set BUILDEXCLUSIVEKERNELMAX as\n=\"4.12\", your module would be built for e.g. \"4.11.999\", \"3.9-rc5\" or other earlier\nversions, but not for \"4.12-rc1\" or later kernels.\n" }, { "name": "BUILD_EXCLUSIVE_ARCH=", "content": "This optional directive functions very similarly to BUILDEXCLUSIVEKERNEL except that\nit matches against the kernel architecture. For example, if you set it to =\"i.86\",\nyour module would not be built for ia32e, x8664, amd64, s390, etc.\n" }, { "name": "BUILD_EXCLUSIVE_CONFIG=", "content": "This optional directive allows you to specify a space separated list of kernel config‐\nuration options (\"CONFIGFOO\") that must be enabled in the targeted kernels \".config\"\nfile (either to be compiled in or to be built as a module) or absent (if prefixed with\nan exclamation mark, e.g. \"!CONFIGBAR\") in order to build the module. For example,\nif you set it as =\"CONFIGPCI !CONFIGPREEMPTRT\", your module would only be built for\nkernels that have PCI enabled, but the RT patchset disabled.\n" }, { "name": "POST_ADD=", "content": "The name of the script to be run after an add is performed. The path should be given\nrelative to the root directory of your source.\n" }, { "name": "POST_BUILD=", "content": "The name of the script to be run after a build is performed. The path should be given\nrelative to the root directory of your source.\n" }, { "name": "POST_INSTALL=", "content": "The name of the script to be run after an install is performed. The path should be\ngiven relative to the root directory of your source.\n" }, { "name": "POST_REMOVE=", "content": "The name of the script to be run after a remove is performed. The path should be given\nrelative to the root directory of your source.\n" }, { "name": "PRE_BUILD=", "content": "The name of the script to be run before a build is performed. The path should be given\nrelative to the root directory of your source.\n" }, { "name": "PRE_INSTALL=", "content": "The name of the script to be run before an install is performed. The path should be\ngiven relative to the root directory of your source. If the script exits with a\nnon-zero value, the install will be aborted. This is typically used to perform a cus‐\ntom version comparison.\n" }, { "name": "DKMS.CONF VARIABLES", "content": "Within your dkms.conf file, you can use certain variables which will be replaced at\nrun-time with their values.\n" }, { "name": "$kernelver", "content": "This variable can be used within a directive definition and during use, the actual\nkernel version in question will be substituted in its place. This is especially useful\nin MAKE commands when specifying which INCLUDE statements should be used when compil‐\ning your module (eg. MAKE=\"make all INCLUDEDIR=/lib/modules/${kernelver}/build/in‐\nclude\").\n" }, { "name": "$kernel_source_dir", "content": "This variable holds the value of the location of your kernel source directory. Usu‐\nally, this will be /lib/modules/$kernelver/build, unless otherwise specified with the\n--kernelsourcedir option.\n\nDKMS.CONF OVERRIDES\nYou can override the module-provided dkms.conf files. Every time after a dkms.conf file is\nread, dkms will look for and read the following files in order:\n\n/etc/dkms/.conf\n/etc/dkms/-.conf\n/etc/dkms/--.conf\n/etc/dkms/---.conf\n\nYou can use these files to override settings in the module-provided dkms.conf files.\n\n/etc/dkms/framework.conf\nThis configuration file controls how the overall DKMS framework handles. It is sourced in\nevery time the dkms command is run. Mainly it can currently be used to set different default\nvalues for the variables.\n\nThe file contains descriptions for each directive it supports.\n\nAdditionally to /etc/dkms/framework.conf, any file matching the glob /etc/dkms/frame‐\nwork.conf.d/*.conf will be loaded as well.\n" }, { "name": "$dkms_tree, $source_tree, $install_tree, $tmp_location", "content": "Control which folders DKMS uses for components and artifacts.\n" }, { "name": "$verbose", "content": "Can be set to anything but a null value to enable verbose output in DKMS.\n" }, { "name": "$symlink_modules", "content": "Controls whether binary modules are copied to /lib/modules or if only symlinks are\ncreated there. Note that these variables can also be manipulated on the command line\nwith --dkmstree, --sourcetree, --installtree and --symlink-modules options.\n" }, { "name": "$autoinstall_all_kernels", "content": "Used by the common postinst for DKMS modules. It controls if the build should be done\nfor all installed kernels or only for the current and latest installed kernel. It has\nno command line equivalent.\n" }, { "name": "$sign_file", "content": "This is the path of the sign-file kernel binary that is used to sign the kernel mod‐\nules. The variable $kernelver can be used in path to represent the target kernel ver‐\nsion. The path for the binary depends on the distribution.\n" }, { "name": "$mok_signing_key, $mok_certificate", "content": "Location of the key and certificate files used for Secure boot. The variable $ker‐\nnelver can be used in path to represent the target kernel version. moksigningkey\ncan also be a \"pkcs11:...\" string for PKCS#11 engine, as long as the signfile program\nsupports it.\n" }, { "name": "$modprobe_on_install", "content": "Automatically load the built modules upon successful installation.\n\ndkmsautoinstaller\nThis boot-time service automatically installs any module which has AUTOINSTALL=\"yes\" set in\nits dkms.conf file. The service works quite simply and if multiple versions of a module are\nin your system's DKMS tree, it will not do anything and instead explain that manual interven‐\ntion is required.\n" } ] }, "AUTHOR": { "content": "Gary Lerhaupt, Emil Velikov, Simone Caronni, Xu Zhen\n", "subsections": [] }, "WEBPAGE": { "content": "https://github.com/dell/dkms\n\ndkms-3.0.11 27 April 2023 DKMS(8)", "subsections": [] } }, "summary": "dkms - Dynamic Kernel Module Support", "flags": [ { "flag": "-m", "long": null, "arg": null, "description": "The name of the module and module version you want to operate on. The -m part of this option is optional, and can be omitted in virtually all circumstances." }, { "flag": "-v", "long": null, "arg": "", "description": "The version of the module to execute the specified action upon. This option only has to be specified if you pass a -m option without a component of its own." }, { "flag": "-k", "long": null, "arg": null, "description": "The kernel and arch to perform the action upon. You can specify multiple kernel ver‐ sion/arch pairs on the command line by repeating the -k argument with a different ker‐ nel version and arch. However, not all actions support multiple kernel versions (it will error out in this case). The arch part can be omitted, and DKMS will assume you want it to be the arch of the currently running system." }, { "flag": "-a", "long": "--arch", "arg": null, "description": "The system architecture to perform the action upon. It is optional if you pass it as part of the -k option. If not specified, it assumes the arch of the currently running system (`uname -m`). You can specify multiple arch parameters on the same command line by repeating the -a argument with a different arch name. When multiple architectures are specified, there must be a 1:1 relationship between -k arguments to -a arguments. DKMS will then assume the first -a argument aligns with the first -k kernel and so on for the second, third, etc. For example, if you were to specify: -k kernel1 -k kernel2 -a i386 -k kernel3 -a i686 -a x8664, DKMS would process this as: kernel1-i386, kernel2-i686, kernel3-x8664." }, { "flag": "-q", "long": "--quiet", "arg": null, "description": "Quiet." }, { "flag": "-V", "long": "--version", "arg": null, "description": "Prints the currently installed version of dkms and exits." }, { "flag": "-c", "long": null, "arg": "", "description": "The location of the dkms.conf file. This is needed for the add action and if not spec‐ ified, it is assumed to be located in /usr/src/-/. See below for more information on the format of dkms.conf." }, { "flag": "", "long": "--config", "arg": "", "description": "During a build this option is used to specify an alternate location for the kernel .config file which was used to compile that kernel. Normally, dkms uses the Red Hat standard location and config filenames located in /usr/src/linux-/configs/. If the config for the kernel that you are building a module for is not located here or does not have the expected name in this location, you will need to tell dkms where the necessary .config can be found so that your kernel can be properly prepared for the module build." }, { "flag": "", "long": "--archive", "arg": "", "description": "This option is used during a ldtarball action to specify the location of the tarball you wish to load into your DKMS tree. You only have to specify the --archive part of this option if does not already exist as a file." }, { "flag": "", "long": "--templatekernel", "arg": "", "description": "This option is required for the action: match. Match will look at the templatekernel specified and install all of the same module/version combinations on the other kernel." }, { "flag": "", "long": "--force", "arg": null, "description": "This option can be used in conjunction with ldtarball to force copying over of extant files." }, { "flag": "", "long": "--binaries-only", "arg": null, "description": "This option can be used in conjunction with mktarball in order to create a DKMS tar‐ ball which does not contain the source for the module within it. This can be helpful in reducing the size of the tarball if you know that the system which this tarball will be loaded upon already has the source installed. In order to load a tarball made as binaries-only you must have the module source in that systems DKMS tree. If you do not, DKMS will refuse to load a binaries-only tarball." }, { "flag": "", "long": "--source-only", "arg": null, "description": "This option can be used in conjunction with mktarball but do not want the tarball you create to have any prebuilt modules within it, passing this option will keep its in‐ ternal DKMS tarball from containing any prebuilt modules. --all This option can be used to automatically specify all relevant kernels/arches for a module/module-version. This can be used for things like remove, unbuild and uninstall. This saves the trouble of having to actually specify -k kernel1 -a arch1 -k kernel2 -a arch2 for every kernel you have built your module for." }, { "flag": "", "long": "--no-depmod", "arg": null, "description": "This option prevents DKMS from running the depmod command during install and uninstall which will avoid (re)calculating module dependencies and thereby save time." }, { "flag": "", "long": "--modprobe-on-install", "arg": null, "description": "This option executes modprobe on the modules upon successful installation." }, { "flag": "", "long": "--kernelsourcedir", "arg": "", "description": "Using this option you can specify the location of your kernel source directory. Most likely you will not need to set this if your kernel source is accessible via /lib/mod‐ ules/$kernelversion/build." }, { "flag": "", "long": "--directive", "arg": "<\"cli-directive=cli-value\">", "description": "Using this option, you can specify additional directives from the command line. The --directive option can be used multiple times on the same command-line to specify mul‐ tiple additional command line directives." }, { "flag": "", "long": "--rpm_safe_upgrade", "arg": null, "description": "This flag should be used when packaging DKMS enabled modules in RPMs. It should be specified during both the add and remove actions in the RPM spec to ensure that DKMS and RPM behave correctly in all scenarios when upgrading between various versions of a dkms enabled module RPM package." }, { "flag": "", "long": "--dkmstree", "arg": null, "description": "Provides a destination tree for building and installing modules to. Useful in cases that you don't want to contaminate a system when using solely for building." }, { "flag": "", "long": "--sourcetree", "arg": null, "description": "Provides a location to build a DKMS package from. Useful for systems that you may not have root access, but would still like to be able to build DKMS packages." }, { "flag": "", "long": "--installtree", "arg": null, "description": "Provides a location to place modules when a dkms install command is issued." }, { "flag": "-j", "long": null, "arg": null, "description": "Run no more than number jobs in parallel; see the -j option of make(1). Defaults to the number of CPUs in the system, detected by nproc(1). Specify 0 to impose no limit on the number of parallel jobs." } ], "examples": [], "see_also": [] }