depmod.d

package: kmod

title: depmod.d(5)

text:
# depmod.d(5)

## NAME
depmod.d - Configuration directory for depmod

## SYNOPSIS
/etc/depmod.d/*.conf

/run/depmod.d/*.conf

/usr/local/lib/depmod.d/*.conf

/usr/lib/depmod.d/*.conf

/lib/depmod.d/*.conf

## DESCRIPTION
On execution depmod reads the configuration files from the above location and based on that it processes the available modules and their dependencies. For example: one can change the search order, exclude folders, override specific module's location and more.

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.

## CONFIGURATION FORMAT
The configuration files contain 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 files a bit neater.

See the COMMANDS section below for more.

## CONFIGURATION DIRECTORIES AND PRECEDENCE
Configuration files are read from directories in listed in SYNOPSIS in that order of precedence. Once a file of a given filename is loaded, any file of the same name in subsequent directories is ignored.

All configuration files are sorted in lexicographic order, regardless of the directory they reside in. Configuration files can either be completely replaced (by having a new configuration file with the same name in a directory of higher priority) or partially replaced (by having a configuration file that is ordered later).

## 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. Another special keyword external refers to the list of external directories, defined by the external command. 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.

external kernelversion absolutemodulesdirectory...

This specifies a list of directories, which will be checked according to the priorities in the search command. The order matters also, the first directory has the higher priority. The kernelversion is a POSIX regular expression or * wildcard, like in the override.

exclude excludedir

This specifies the trailing directories that will be excluded during the search for kernel modules. The excludedir is the trailing directory to exclude.

## COPYRIGHT
This manual page Copyright 2006-2010, Jon Masters, Red Hat, Inc.

## SEE ALSO
depmod(8)

## BUGS
Please direct any bug reports to kmod's issue tracker at https://github.com/kmod-project/kmod/issues/ alongside with version used, steps to reproduce the problem and the expected outcome.

## AUTHORS
Numerous contributions have come from the linux-modules mailing list <linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git itself, the output of git-shortlog(1) and git-blame(1) can show you the authors for specific parts of the project.

Lucas De Marchi <lucas.de.marchi@gmail.com> is the current maintainer of the project.

branch: sisyphus


modprobe.d

title: modprobe.d(5)

text:
# modprobe.d(5)

## NAME
modprobe.d - Configuration directory for modprobe

## SYNOPSIS
/etc/modprobe.d/*.conf

/run/modprobe.d/*.conf

/usr/local/lib/modprobe.d/*.conf

/usr/lib/modprobe.d/*.conf

/lib/modprobe.d/*.conf

## 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. One can also use them 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 interchangeable throughout all the module commands as underscore conversion happens automatically.

## CONFIGURATION FORMAT
The configuration files contain 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 files a bit neater.

See the COMMANDS section below for more.

## CONFIGURATION DIRECTORIES AND PRECEDENCE
Configuration files are read from directories in listed in SYNOPSIS in that order of precedence. Once a file of a given filename is loaded, any file of the same name in subsequent directories is ignored.

All configuration files are sorted in lexicographic order, regardless of the directory they reside in. Configuration files can either be completely replaced (by having a new configuration file with the same name in a directory of higher priority) or partially replaced (by having a configuration file that is ordered later).

NOTE: The configuration directories may be altered via the MODPROBE_OPTIONS environment variable. See the ENVIRONMENT section in modprobe(8).

## 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 --ignore-install, 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.

weakdep modulename modules...

The weakdep command allows you to specify weak module dependencies. Those are similar to pre softdep, with the difference that userspace doesn't attempt to load that dependency before the specified module. Instead the kernel may request one or multiple of them during module probe, depending on the hardware it's binding to. The purpose of weak module is to allow a driver to specify that a certain dependency may be needed, so it should be present in the filesystem (e.g. in initramfs) when that module is probed. Example: Assume "weakdep c a b". A program creating an initramfs knows it should add a, b, and c to the filesystem since a and b may be required/desired at runtime. When c is loaded and is being probed, it may issue calls to request_module() causing a or b to also be loaded.

## COMPATIBILITY
A future version of kmod 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.

## SEE ALSO
modprobe(8), modules.dep(5)

## BUGS
Please direct any bug reports to kmod's issue tracker at https://github.com/kmod-project/kmod/issues/ alongside with version used, steps to reproduce the problem and the expected outcome.

## AUTHORS
Numerous contributions have come from the linux-modules mailing list <linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git itself, the output of git-shortlog(1) and git-blame(1) can show you the authors for specific parts of the project.

Lucas De Marchi <lucas.de.marchi@gmail.com> is the current maintainer of the project.


modules.dep

title: modules.dep(5)

text:
# modules.dep(5)

## NAME
modules.dep, modules.dep.bin - Module dependency information

## SYNOPSIS
/lib/modules/modules.dep

/lib/modules/modules.dep.bin

## DESCRIPTION
modules.dep.bin is a binary file generated by depmod listing the dependencies for every module in the directories under /lib/modules/version. It is used by kmod tools such as modprobe and libkmod.

Its text counterpart is located in the same directory with the name modules.dep. The text version is maintained only for ease of reading by humans and is in no way used by any kmod tool.

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 modinfo(8) 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.

## SEE ALSO
depmod(8), modprobe(8)

## BUGS
Please direct any bug reports to kmod's issue tracker at https://github.com/kmod-project/kmod/issues/ alongside with version used, steps to reproduce the problem and the expected outcome.

## AUTHORS
Numerous contributions have come from the linux-modules mailing list <linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git itself, the output of git-shortlog(1) and git-blame(1) can show you the authors for specific parts of the project.

Lucas De Marchi <lucas.de.marchi@gmail.com> is the current maintainer of the project.


kmscon.conf

package: kmscon

title: kmscon.conf(5)

text:
# kmscon.conf(5)

## NAME
kmscon.conf - Configuration file for KMS/DRM based System Console

## DESCRIPTION
kmscon.conf is the configuration file to control the behavior of kmscon and adjust it to your system-setup. It allows to remap the bindings of keyboard-shortcuts, define the desired keyboard-layout, select font attributes for text-rendering, hardware-accelerationn, orientation of output and much more.

Below is a complete list of all recognized Options, their meaning and possible values. In section Example is a typical real-world sample of a configuration to guide you in creating your own.

## EXAMPLE
Here is a real-world example of a typical kmscon.conf file:

```
### General Options ###
verbose
### Seat Options ###
vt=1
switchvt
### Session Options ###
session-max=6
session-control
### Terminal Options ###
term=linux
### Input Options ###
xkb-model=pc102
xkb-layout=de
xkb-repeat-delay=200
xkb-repeat-rate=65
mouse
dpms-timeout=0
### Video Options ###
drm
hwaccel
gpus=all
render-engine=gltex
rotate=normal
### Font Options ###
font-engine=pango
font-size=18
font-name=Ubuntu Mono

```

Any line starting with a #-character is ignored and considered to be a comment.

## OPTIONS
Below is a complete list of all recognized options, their meaning and possible values.

\### General Options ###

verbose

Make kmscon be very chatty about what it is doing. It prints to stdout unless redirected. Off if not present in kmsconf.conf or commented out. (default: off)

debug

Let kmscon be even more chatty. The text-output goes to stdout or any file it was redirected to. Off if not present in kmsconf.conf or commented out. (default: off)

silent

Suppress notices and warnings. (default: off)

configdir

Path to config directory. (default: /etc/kmscon)

listen

Listen for new seats and spawn sessions accordingly. (default: off)

\### Seat Options ###

vt

Select which VT to run on. (default: auto)

switchvt

Automatically switch to VT. (default: on)

seats

Select seats to run on. (default: current)

\### Session Options ###

session-max

Maximum number of sessions. (default: 50)

session-control

Allow keyboard session-control. (default: off)

terminal-session

Enable terminal session. (default: on)

\### Terminal Options ###

login

Start the given login process instead of the default process; all arguments following '--' will be be parsed as argv to this process. No more options after '--' will be parsed so use it at the end of the argument string. (default: /bin/login -p)

term

Value of the TERM environment variable for the child process. (default: linux)

reset-env

Reset environment before running child process. (default: on)

backspace-delete

Send delete character when backspace is pressed. (default: on)

palette

Select the used color palette. (default: default)

sb-size

Size of the scrollback-buffer in lines. (default: 1000)

\### Input Options ###

xkb-model

Set XkbModel for input devices. (default: unset)

xkb-layout

Set XkbLayout for input devices. (default: unset)

xkb-variant

Set XkbVariant for input devices. (default: unset)

xkb-options

Set XkbOptions for input devices. (default: unset)

xkb-keymap

Use a predefined keymap for input devices. (default: unset)

xkb-repeat-delay

Initial delay for key-repeat in ms. (default: 250)

xkb-repeat-rate

Delay between two key-repeats in ms. (default: 50)

--mouse

Enable mouse/touchpad/trackpoint in kmscon (default: on). It allows to select, and copy/paste text with a pointing device, and also to scroll with the mouse wheel. It's still experimental, and may not work with specific devices.

--dpms-timeout

Set screen timeout in seconds (default: 0 = disabled). When enabled, the screen will automatically turn off (DPMS OFF) after the specified period of keyboard and mouse inactivity. Any keyboard or mouse input will turn the screen back on and reset the timer. This feature is useful for power saving on systems where the screen is not always needed.

\### Grabs/Keyboard-Shortcuts ###

grab-scroll-up

Shortcut to scroll up. (default: <Shift>Up)

grab-scroll-down

Shortcut to scroll down. (default: <Shift>Down)

grab-page-up

Shortcut to scroll page up. (default: <Shift>Prior)

grab-page-down

Shortcut to scroll page down. (default: <Shift>Next)

grab-zoom-in

Shortcut to increase font size. (default: <Ctrl>Plus)

grab-zoom-out

Shortcut to decrease font size. (default: <Ctrl>Minus)

grab-session-next

Switch to next session. (default: <Ctrl><Logo>Right)

grab-session-prev

Switch to previous session. (default: <Ctrl><Logo>Left)

grab-session-dummy

Switch to dummy session. (default: <Ctrl><Logo>Escape)

grab-session-close

Close current session. (default: <Ctrl><Logo>BackSpace)

grab-terminal-new

Create new terminal session. (default: <Ctrl><Logo>Return)

grab-rotate-cw

Rotate output clock-wise. (default: <Logo>Plus)

grab-rotate-ccw

Rotate output counter-clock-wise. (default: <Logo>Minus)

grab-reboot

Reboot the system when this keyboard shortcut is pressed. This option is disabled by default. The reboot behavior follows the system-wide setting in /proc/sys/kernel/ctrl-alt-del: when set to 0 (default), a graceful reboot is performed by sending SIGINT to init (PID 1); when set to a value greater than 0, an immediate hard reboot is performed after syncing disk buffers. Example: grab-reboot=<Ctrl><Alt>Delete (default: disabled)

\### Video Options ###

drm

Use DRM if available. (default: on)

hwaccel

Use 3D hardware-acceleration if available. (default: off)

gpus

GPU selection mode. (default: all)

use-original-mode

Use the original KMS video mode. (default: on)

mode

Set the resolution to {width}x{height}

rotate

Orientation of output to use. (default: normal)

\### Font Options ###

font-engine

Font engine to use. (default: pango)

font-size

Font size in points. (default: 12)

font-name

Font name to use. (default: monospace)

font-dpi

Force DPI value for all fonts. (default: 96)

## FILES
/etc/kmsconf.conf

## SEE ALSO
kmscon(1)