From 63749b1a5fc68a44024dc6a4299b04a1f5d437e8 Mon Sep 17 00:00:00 2001 From: Kay Sievers Date: Mon, 24 May 2010 17:00:15 +0200 Subject: [PATCH] man: directly use 'refentry' And make Lennart happy! :) --- Makefile.am | 2 +- udev/udev.xml | 1342 +++++++++++++++++++++++----------------------- udev/udevadm.xml | 802 ++++++++++++++------------- udev/udevd.xml | 210 ++++---- 4 files changed, 1172 insertions(+), 1184 deletions(-) diff --git a/Makefile.am b/Makefile.am index 09cb56011..8406a6bc3 100644 --- a/Makefile.am +++ b/Makefile.am @@ -156,7 +156,7 @@ EXTRA_DIST += \ udev/udevd.xml %.7 %.8 : %.xml - $(XSLTPROC) -o $@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< + $(AM_V_GEN)$(XSLTPROC) -o $@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< # ------------------------------------------------------------------------------ # udev tests diff --git a/udev/udev.xml b/udev/udev.xml index 678023c37..adf531b37 100644 --- a/udev/udev.xml +++ b/udev/udev.xml @@ -1,677 +1,673 @@ - + -
-
+ + udev - - - udev - udev - - - - udev - 7 - - - - udev - Linux dynamic device management - - - DESCRIPTION - udev supplies the system software with device events, manages permissions - of device nodes and may create additional symlinks in the /dev - directory, or renames network interfaces. The kernel usually just assigns unpredictable - device names based on the order of discovery. Meaningful symlinks or network device - names provide a way to reliably identify devices based on their properties or - current configuration. - - The udev daemon udevd - 8 receives device uevents directly from - the kernel whenever a device is added or removed from the system, or it changes its - state. When udev receives a device event, it matches its configured set of rules - against various device attributes to identify the device. Rules that match, may - provide additional device information to be stored in the udev database, or information - to be used to create meaningful symlink names. - - All device information udev processes, is stored in the udev database and - sent out to possible event subscribers. Access to all stored data and the event - sources are provided by the library libudev. - - - CONFIGURATION - udev configuration files are placed in /etc/udev/ - and /lib/udev/. All empty lines, or lines beginning with - '#' will be ignored. - - Configuration file - udev expects its main configuration file at /etc/udev/udev.conf. - It consists of a set of variables allowing the user to override default udev values. - The following variables can be set: - - - - - Specifies where to place the device nodes in the filesystem. - The default value is /dev. - - - - - - - The logging priority. Valid values are the numerical syslog priorities - or their textual representations: , - and . - - - - - - Rules files - The udev rules are read from the files located in the - default rules directory /lib/udev/rules.d/, - the custom rules directory /etc/udev/rules.d/ - and the temporary rules directory /dev/.udev/rules.d/. - All rule files are sorted and processed in lexical order, regardless - in which of these directories they live. - - Rule files are required to have a unique name, duplicate file names - are ignored. Files in /etc/udev/rules.d/ have precedence - over files with the same name in /lib/udev/rules.d/. This - can be used to ignore a default rules file if needed. - - Every line in the rules file contains at least one key value pair. - There are two kind of keys, match and assignment keys. - If all match keys are matching against its value, the rule gets applied and the - assign keys get the specified value assigned. - - A matching rule may rename a network interface, add symlinks - pointing to the device node, or run a specified program as part of - the event handling. - - A rule consists of a list of one or more key value pairs separated by - a comma. Each key has a distinct operation, depending on the used operator. Valid - operators are: - - - - - Compare for equality. - - - - - - - Compare for inequality. - - - - - - - Assign a value to a key. Keys that represent a list, are reset - and only this single value is assigned. - - - - - - - Add the value to a key that holds a list of entries. - - - - - - - Assign a value to a key finally; disallow any later changes, - which may be used to prevent changes by any later rules. - - - - - The following key names can be used to match against device properties. - Some of the keys also match against properties of the parent devices in sysfs, - not only the device that has generated the event. If multiple keys that match - a parent device are specified in a single rule, all these keys must match at - one and the same parent device. - - - - - Match the name of the event action. - - - - - - - Match the devpath of the event device. - - - - - - - Match the name of the event device. - - - - - - - Match the name of the node or network interface. It can - be used once the NAME key has been set in one of the preceding - rules. - - - - - - - Match the name of a symlink targeting the node. It can - be used once a SYMLINK key has been set in one of the preceding - rules. There may be multiple symlinks; only one needs to match. - - - - - - - - Match the subsystem of the event device. - - - - - - Match the driver name of the event device. Only set for devices - which are bound to a driver at the time the event is generated. - - - - - - Match sysfs attribute values of the event device. Trailing - whitespace in the attribute values is ignored, if the specified match - value does not contain trailing whitespace itself. - - - - - - - - Search the devpath upwards for a matching device name. - - - - - - - Search the devpath upwards for a matching device subsystem name. - - - - - - - Search the devpath upwards for a matching device driver name. - - - - - - - Search the devpath upwards for a device with matching sysfs attribute values. - If multiple matches are specified, all of them - must match on the same device. Trailing whitespace in the attribute values is ignored, - if the specified match value does not contain trailing whitespace itself. - - - - - - - Match against a device property value. - - - - - - - Match against a device tag. - - - - - - - Test the existence of a file. An octal mode mask can be specified - if needed. - - - - - - - Execute a program. The key is true, if the program returns - successfully. The device properties are made available to the - executed program in the environment. The program's output printed to - stdout, is available in the RESULT key. - - - - - - - Match the returned string of the last PROGRAM call. This key can - be used in the same or in any later rule after a PROGRAM call. - - - - - Most of the fields support a shell style pattern matching. The following - pattern characters are supported: - - - - - Matches zero, or any number of characters. - - - - - - Matches any single character. - - - - - - Matches any single character specified within the brackets. For - example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'. - Ranges are also supported within this match with the '-' character. - For example, to match on the range of all digits, the pattern [0-9] would - be used. If the first character following the '[' is a '!', any characters - not enclosed are matched. - - - - - The following keys can get values assigned: - - - - - The name, a network interface should be renamed to. Or as - a temporary workaraound, the name a device node should be named. - Usually the kernel provides the defined node name, or even creates - and removes the node before udev even receives any event. Changing - the node name from the kernel's default creates inconsistencies - and is not supported. If the kernel and NAME specify different names, - an error will be logged. Udev is only expected to handle device node - permissions and to create additional symlinks, not to change - kernel-provided device node names. Instead of renaming a device node, - SYMLINK should be used. Symlink names must never conflict with - device node names, it will result in unpredictable behavior. - - - - - - - The name of a symlink targeting the node. Every matching rule will add - this value to the list of symlinks to be created. Multiple symlinks may be - specified by separating the names by the space character. In case multiple - devices claim the same name, the link will always point to the device with - the highest link_priority. If the current device goes away, the links will - be re-evaluated and the device with the next highest link_priority will own - the link. If no link_priority is specified, the order of the devices, and - which one of them will own the link, is undefined. Claiming the same name for - a symlink, which is or might be used for a device node, may result in - unexpected behavior and is not supported. - - - - - - - - The permissions for the device node. Every specified value overwrites - the compiled-in default value. - - - - - - - The value that should be written to a sysfs attribute of the - event device. - - - - - - - Set a device property value. Property names with a leading '.' - are not stored in the database or exported to external tool or events. - - - - - - - Attach a tag to a device. This is used to filter events for users - of libudev's monitor functionality, or to enumerate a group of tagged - devices. The implementation can only work efficiently if only a few - tags are attached to a device. It is only meant to be used in - contexts with specific device filter requirements, and not as a - general-purpose flag. Excessive use might result in inefficient event - handling. - - - - - - - Add a program to the list of programs to be executed for a specific - device. This can only be used for very short running tasks. Running an - event process for a long period of time may block all further events for - this or a dependent device. Long running tasks need to be immediately - detached from the event process itself. If the option - is - specified, and the executed program returns non-zero, the event will be - marked as failed for a possible later handling. - If no absolute path is given, the program is expected to live in - /lib/udev, otherwise the absolute path must be - specified. Program name and arguments are separated by spaces. Single quotes - can be used to specify arguments with spaces. - - - - - - - Named label where a GOTO can jump to. - - - - - - - Jumps to the next LABEL with a matching name - - - - - - - Import a set of variables as device properties, - depending on type: - - - - - Execute an external program specified as the assigned value and - import its output, which must be in environment key - format. Path specification, command/argument separation, - and quoting work like in . - - - - - - Import a text file specified as the assigned value, which must be in - environment key format. - - - - - - Import a single property specified as the assigned value from the - current device database. This works only if the database is already populated - by an earlier event. - - - - - - Import the stored keys from the parent device by reading - the database entry of the parent device. The value assigned to - is used as a filter of key names - to import (with the same shell-style pattern matching used for - comparisons). - - - - If no option is given, udev will choose between - and based on the executable bit of the file - permissions. - - - - - - - Wait for a file to become available or until a 10 - seconds timeout expires. - - - - - - - Rule and device options: - - - - - Specify the priority of the created symlinks. Devices with higher - priorities overwrite existing symlinks of other devices. The default is 0. - - - - - - Number of seconds an event will wait for operations to finish, before it - will terminate itself. - - - - - - Usually control and other possibly unsafe characters are replaced - in strings used for device naming. The mode of replacement can be specified - with this option. - - - - - - Watch the device node with inotify, when closed after being opened for - writing, a change uevent will be synthesised. - - - - - - - - The , , , - , , and - fields support simple printf-like string substitutions. The - format chars gets applied after all rules have been processed, right before the program - is executed. It allows the use of device properties set by earlier matching - rules. For all other fields, substitutions are applied while the individual rule is - being processed. The available substitutions are: - - - , - - The kernel name for this device. - - - - - , - - The kernel number for this device. For example, 'sda3' has - kernel number of '3' - - - - - , - - The devpath of the device. - - - - - , - - The name of the device matched while searching the devpath upwards for - , , and . - - - - - - - - The driver name of the device matched while searching the devpath upwards for - , , and . - - - - - - , - - The value of a sysfs attribute found at the device, where - all keys of the rule have matched. If the matching device does not have - such an attribute, follow the chain of parent devices and use the value - of the first attribute that matches. - If the attribute is a symlink, the last element of the symlink target is - returned as the value. - - - - - , - - A device property value. - - - - - , - - The kernel major number for the device. - - - - - , - - The kernel minor number for the device. - - - - - , - - The string returned by the external program requested with PROGRAM. - A single part of the string, separated by a space character may be selected - by specifying the part number as an attribute: . - If the number is followed by the '+' char this part plus all remaining parts - of the result string are substituted: - - - - - , - - The node name of the parent device. - - - - - - - The current name of the device node. If not changed by a rule, it is the - name of the kernel device. - - - - - - - The current list of symlinks, separated by a space character. The value is - only set if an earlier rule assigned a value, or during a remove events. - - - - - , - - The udev_root value. - - - - - , - - The sysfs mount point. - - - - - , - - The name of a created temporary device node to provide access to - the device from a external program before the real node is created. - - - - - - - The '%' character itself. - - - - - - - The '$' character itself. - - - - - - - AUTHOR - Written by Greg Kroah-Hartman greg@kroah.com and - Kay Sievers kay.sievers@vrfy.org. With much help from - Dan Stekloff and many others. - - - - SEE ALSO - - udevd8 - , - - udevadm8 - - - -
-
+ udev + + + + udev + 7 + + + + udev + Linux dynamic device management + + + Description + udev supplies the system software with device events, manages permissions + of device nodes and may create additional symlinks in the /dev + directory, or renames network interfaces. The kernel usually just assigns unpredictable + device names based on the order of discovery. Meaningful symlinks or network device + names provide a way to reliably identify devices based on their properties or + current configuration. + + The udev daemon udevd + 8 receives device uevents directly from + the kernel whenever a device is added or removed from the system, or it changes its + state. When udev receives a device event, it matches its configured set of rules + against various device attributes to identify the device. Rules that match, may + provide additional device information to be stored in the udev database, or information + to be used to create meaningful symlink names. + + All device information udev processes, is stored in the udev database and + sent out to possible event subscribers. Access to all stored data and the event + sources are provided by the library libudev. + + + Configuration + udev configuration files are placed in /etc/udev/ + and /lib/udev/. All empty lines, or lines beginning with + '#' will be ignored. + + Configuration file + udev expects its main configuration file at /etc/udev/udev.conf. + It consists of a set of variables allowing the user to override default udev values. + The following variables can be set: + + + + + Specifies where to place the device nodes in the filesystem. + The default value is /dev. + + + + + + + The logging priority. Valid values are the numerical syslog priorities + or their textual representations: , + and . + + + + + + Rules files + The udev rules are read from the files located in the + default rules directory /lib/udev/rules.d/, + the custom rules directory /etc/udev/rules.d/ + and the temporary rules directory /dev/.udev/rules.d/. + All rule files are sorted and processed in lexical order, regardless + in which of these directories they live. + + Rule files are required to have a unique name, duplicate file names + are ignored. Files in /etc/udev/rules.d/ have precedence + over files with the same name in /lib/udev/rules.d/. This + can be used to ignore a default rules file if needed. + + Every line in the rules file contains at least one key value pair. + There are two kind of keys, match and assignment keys. + If all match keys are matching against its value, the rule gets applied and the + assign keys get the specified value assigned. + + A matching rule may rename a network interface, add symlinks + pointing to the device node, or run a specified program as part of + the event handling. + + A rule consists of a list of one or more key value pairs separated by + a comma. Each key has a distinct operation, depending on the used operator. Valid + operators are: + + + + + Compare for equality. + + + + + + + Compare for inequality. + + + + + + + Assign a value to a key. Keys that represent a list, are reset + and only this single value is assigned. + + + + + + + Add the value to a key that holds a list of entries. + + + + + + + Assign a value to a key finally; disallow any later changes, + which may be used to prevent changes by any later rules. + + + + + The following key names can be used to match against device properties. + Some of the keys also match against properties of the parent devices in sysfs, + not only the device that has generated the event. If multiple keys that match + a parent device are specified in a single rule, all these keys must match at + one and the same parent device. + + + + + Match the name of the event action. + + + + + + + Match the devpath of the event device. + + + + + + + Match the name of the event device. + + + + + + + Match the name of the node or network interface. It can + be used once the NAME key has been set in one of the preceding + rules. + + + + + + + Match the name of a symlink targeting the node. It can + be used once a SYMLINK key has been set in one of the preceding + rules. There may be multiple symlinks; only one needs to match. + + + + + + + + Match the subsystem of the event device. + + + + + + Match the driver name of the event device. Only set for devices + which are bound to a driver at the time the event is generated. + + + + + + Match sysfs attribute values of the event device. Trailing + whitespace in the attribute values is ignored, if the specified match + value does not contain trailing whitespace itself. + + + + + + + + Search the devpath upwards for a matching device name. + + + + + + + Search the devpath upwards for a matching device subsystem name. + + + + + + + Search the devpath upwards for a matching device driver name. + + + + + + + Search the devpath upwards for a device with matching sysfs attribute values. + If multiple matches are specified, all of them + must match on the same device. Trailing whitespace in the attribute values is ignored, + if the specified match value does not contain trailing whitespace itself. + + + + + + + Match against a device property value. + + + + + + + Match against a device tag. + + + + + + + Test the existence of a file. An octal mode mask can be specified + if needed. + + + + + + + Execute a program. The key is true, if the program returns + successfully. The device properties are made available to the + executed program in the environment. The program's output printed to + stdout, is available in the RESULT key. + + + + + + + Match the returned string of the last PROGRAM call. This key can + be used in the same or in any later rule after a PROGRAM call. + + + + + Most of the fields support a shell style pattern matching. The following + pattern characters are supported: + + + + + Matches zero, or any number of characters. + + + + + + Matches any single character. + + + + + + Matches any single character specified within the brackets. For + example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'. + Ranges are also supported within this match with the '-' character. + For example, to match on the range of all digits, the pattern [0-9] would + be used. If the first character following the '[' is a '!', any characters + not enclosed are matched. + + + + + The following keys can get values assigned: + + + + + The name, a network interface should be renamed to. Or as + a temporary workaraound, the name a device node should be named. + Usually the kernel provides the defined node name, or even creates + and removes the node before udev even receives any event. Changing + the node name from the kernel's default creates inconsistencies + and is not supported. If the kernel and NAME specify different names, + an error will be logged. Udev is only expected to handle device node + permissions and to create additional symlinks, not to change + kernel-provided device node names. Instead of renaming a device node, + SYMLINK should be used. Symlink names must never conflict with + device node names, it will result in unpredictable behavior. + + + + + + + The name of a symlink targeting the node. Every matching rule will add + this value to the list of symlinks to be created. Multiple symlinks may be + specified by separating the names by the space character. In case multiple + devices claim the same name, the link will always point to the device with + the highest link_priority. If the current device goes away, the links will + be re-evaluated and the device with the next highest link_priority will own + the link. If no link_priority is specified, the order of the devices, and + which one of them will own the link, is undefined. Claiming the same name for + a symlink, which is or might be used for a device node, may result in + unexpected behavior and is not supported. + + + + + + + + The permissions for the device node. Every specified value overwrites + the compiled-in default value. + + + + + + + The value that should be written to a sysfs attribute of the + event device. + + + + + + + Set a device property value. Property names with a leading '.' + are not stored in the database or exported to external tool or events. + + + + + + + Attach a tag to a device. This is used to filter events for users + of libudev's monitor functionality, or to enumerate a group of tagged + devices. The implementation can only work efficiently if only a few + tags are attached to a device. It is only meant to be used in + contexts with specific device filter requirements, and not as a + general-purpose flag. Excessive use might result in inefficient event + handling. + + + + + + + Add a program to the list of programs to be executed for a specific + device. This can only be used for very short running tasks. Running an + event process for a long period of time may block all further events for + this or a dependent device. Long running tasks need to be immediately + detached from the event process itself. If the option + is + specified, and the executed program returns non-zero, the event will be + marked as failed for a possible later handling. + If no absolute path is given, the program is expected to live in + /lib/udev, otherwise the absolute path must be + specified. Program name and arguments are separated by spaces. Single quotes + can be used to specify arguments with spaces. + + + + + + + Named label where a GOTO can jump to. + + + + + + + Jumps to the next LABEL with a matching name + + + + + + + Import a set of variables as device properties, + depending on type: + + + + + Execute an external program specified as the assigned value and + import its output, which must be in environment key + format. Path specification, command/argument separation, + and quoting work like in . + + + + + + Import a text file specified as the assigned value, which must be in + environment key format. + + + + + + Import a single property specified as the assigned value from the + current device database. This works only if the database is already populated + by an earlier event. + + + + + + Import the stored keys from the parent device by reading + the database entry of the parent device. The value assigned to + is used as a filter of key names + to import (with the same shell-style pattern matching used for + comparisons). + + + + If no option is given, udev will choose between + and based on the executable bit of the file + permissions. + + + + + + + Wait for a file to become available or until a 10 + seconds timeout expires. + + + + + + + Rule and device options: + + + + + Specify the priority of the created symlinks. Devices with higher + priorities overwrite existing symlinks of other devices. The default is 0. + + + + + + Number of seconds an event will wait for operations to finish, before it + will terminate itself. + + + + + + Usually control and other possibly unsafe characters are replaced + in strings used for device naming. The mode of replacement can be specified + with this option. + + + + + + Watch the device node with inotify, when closed after being opened for + writing, a change uevent will be synthesised. + + + + + + + + The , , , + , , and + fields support simple printf-like string substitutions. The + format chars gets applied after all rules have been processed, right before the program + is executed. It allows the use of device properties set by earlier matching + rules. For all other fields, substitutions are applied while the individual rule is + being processed. The available substitutions are: + + + , + + The kernel name for this device. + + + + + , + + The kernel number for this device. For example, 'sda3' has + kernel number of '3' + + + + + , + + The devpath of the device. + + + + + , + + The name of the device matched while searching the devpath upwards for + , , and . + + + + + + + + The driver name of the device matched while searching the devpath upwards for + , , and . + + + + + + , + + The value of a sysfs attribute found at the device, where + all keys of the rule have matched. If the matching device does not have + such an attribute, follow the chain of parent devices and use the value + of the first attribute that matches. + If the attribute is a symlink, the last element of the symlink target is + returned as the value. + + + + + , + + A device property value. + + + + + , + + The kernel major number for the device. + + + + + , + + The kernel minor number for the device. + + + + + , + + The string returned by the external program requested with PROGRAM. + A single part of the string, separated by a space character may be selected + by specifying the part number as an attribute: . + If the number is followed by the '+' char this part plus all remaining parts + of the result string are substituted: + + + + + , + + The node name of the parent device. + + + + + + + The current name of the device node. If not changed by a rule, it is the + name of the kernel device. + + + + + + + The current list of symlinks, separated by a space character. The value is + only set if an earlier rule assigned a value, or during a remove events. + + + + + , + + The udev_root value. + + + + + , + + The sysfs mount point. + + + + + , + + The name of a created temporary device node to provide access to + the device from a external program before the real node is created. + + + + + + + The '%' character itself. + + + + + + + The '$' character itself. + + + + + + + Author + Written by Greg Kroah-Hartman greg@kroah.com and + Kay Sievers kay.sievers@vrfy.org. With much help from + Dan Stekloff and many others. + + + + See Also + + udevd8 + , + + udevadm8 + + + diff --git a/udev/udevadm.xml b/udev/udevadm.xml index 44e286bba..9a063f429 100644 --- a/udev/udevadm.xml +++ b/udev/udevadm.xml @@ -1,420 +1,416 @@ - + -
-
+ + udevadm - - - udevadm - udev - + udev + - - udevadm - 8 - - + + udevadm + 8 + + - - udevadmudev management tool - + + udevadmudev management tool + - - - udevadm - - - - - - udevadm info options - - - udevadm trigger options - - - udevadm settle options - - - udevadm control command - - - udevadm monitor options - - - udevadm test options devpath - - + + + udevadm + + + + + + udevadm info options + + + udevadm trigger options + + + udevadm settle options + + + udevadm control command + + + udevadm monitor options + + + udevadm test options devpath + + - DESCRIPTION - udevadm expects a command and command specific options. It - controls the runtime behavior of udev, requests kernel events, - manages the event queue, and provides simple debugging mechanisms. - + Description + udevadm expects a command and command specific options. It + controls the runtime behavior of udev, requests kernel events, + manages the event queue, and provides simple debugging mechanisms. + - OPTIONS - - - - - Print debug messages to stderr. - - - - - - Print version number. - - - - - - Print help text. - - - + OPTIONS + + + + + Print debug messages to stderr. + + + + + + Print version number. + + + + + + Print help text. + + + - udevadm info <replaceable>options</replaceable> - Queries the udev database for device information - stored in the udev database. It can also query the properties - of a device from its sysfs representation to help creating udev - rules that match this device. - - - - - Query the database for specified type of device data. It needs the - or to identify the specified - device. Valid queries are: - name, symlink, path, - property, all. - - - - - - The devpath of the device to query. - - - - - - The name of the device node or a symlink to query - - - - - - The udev root directory: /dev. If used in conjunction - with a name or symlink query, the - query returns the absolute path including the root directory. - - - - - - Print all sysfs properties of the specified device that can be used - in udev rules to match the specified device. It prints all devices - along the chain, up to the root of sysfs that can be used in udev rules. - - - - - - Print major/minor numbers of the underlying device, where the file - lives on. - - - - - - Export the content of the udev database. - - - - - - Print version. - - - - - - Print help text. - - - - + udevadm info <replaceable>options</replaceable> + Queries the udev database for device information + stored in the udev database. It can also query the properties + of a device from its sysfs representation to help creating udev + rules that match this device. + + + + + Query the database for specified type of device data. It needs the + or to identify the specified + device. Valid queries are: + name, symlink, path, + property, all. + + + + + + The devpath of the device to query. + + + + + + The name of the device node or a symlink to query + + + + + + The udev root directory: /dev. If used in conjunction + with a name or symlink query, the + query returns the absolute path including the root directory. + + + + + + Print all sysfs properties of the specified device that can be used + in udev rules to match the specified device. It prints all devices + along the chain, up to the root of sysfs that can be used in udev rules. + + + + + + Print major/minor numbers of the underlying device, where the file + lives on. + + + + + + Export the content of the udev database. + + + + + + Print version. + + + + + + Print help text. + + + + - udevadm trigger <optional>options</optional> - Request device events from the kernel. Primarily used to replay events at system coldplug time. - - - - - Print the list of devices which will be triggered. - - - - - - Do not actually trigger the event. - - - - - - Trigger a specific type of devices. Valid types are: - devices, subsystems, failed. - The default value is devices. - - - - - - Type of event to be triggered. The default value is change. - - - - - - Trigger events for devices which belong to a matching subsystem. This option - can be specified multiple times and supports shell style pattern matching. - - - - - - Do not trigger events for devices which belong to a matching subsystem. This option - can be specified multiple times and supports shell style pattern matching. - - - - - - Trigger events for devices with a matching sysfs attribute. If a value is specified - along with the attribute name, the content of the attribute is matched against the given - value using shell style pattern matching. If no value is specified, the existence of the - sysfs attribute is checked. This option can be specified multiple times. - - - - - - Do not trigger events for devices with a matching sysfs attribute. If a value is - specified along with the attribute name, the content of the attribute is matched against - the given value using shell style pattern matching. If no value is specified, the existence - of the sysfs attribute is checked. This option can be specified multiple times. - - - - - - Trigger events for devices with a matching property value. This option can be - specified multiple times and supports shell style pattern matching. - - - - - - Trigger events for devices with a matching tag. This option can be - specified multiple times. - - - - - - Trigger events for devices with a matching sys device name. This option can be - specified multiple times and supports shell style pattern matching. - - - - + udevadm trigger <optional>options</optional> + Request device events from the kernel. Primarily used to replay events at system coldplug time. + + + + + Print the list of devices which will be triggered. + + + + + + Do not actually trigger the event. + + + + + + Trigger a specific type of devices. Valid types are: + devices, subsystems, failed. + The default value is devices. + + + + + + Type of event to be triggered. The default value is change. + + + + + + Trigger events for devices which belong to a matching subsystem. This option + can be specified multiple times and supports shell style pattern matching. + + + + + + Do not trigger events for devices which belong to a matching subsystem. This option + can be specified multiple times and supports shell style pattern matching. + + + + + + Trigger events for devices with a matching sysfs attribute. If a value is specified + along with the attribute name, the content of the attribute is matched against the given + value using shell style pattern matching. If no value is specified, the existence of the + sysfs attribute is checked. This option can be specified multiple times. + + + + + + Do not trigger events for devices with a matching sysfs attribute. If a value is + specified along with the attribute name, the content of the attribute is matched against + the given value using shell style pattern matching. If no value is specified, the existence + of the sysfs attribute is checked. This option can be specified multiple times. + + + + + + Trigger events for devices with a matching property value. This option can be + specified multiple times and supports shell style pattern matching. + + + + + + Trigger events for devices with a matching tag. This option can be + specified multiple times. + + + + + + Trigger events for devices with a matching sys device name. This option can be + specified multiple times and supports shell style pattern matching. + + + + - udevadm settle <optional>options</optional> - Watches the udev event queue, and exits if all current events are handled. - - - - - Maximum number of seconds to wait for the event queue to become empty. - The default value is 180 seconds. A value of 0 will check if the queue is empty - and always return immediately. - - - - - - Wait only for events after the given sequence number. - - - - - - Wait only for events before the given sequence number. - - - - - - Stop waiting if file exists. - - - - - - Do not print any output, like the remaining queue entries when reaching the timeout. - - - - - - Print help text. - - - - + udevadm settle <optional>options</optional> + Watches the udev event queue, and exits if all current events are handled. + + + + + Maximum number of seconds to wait for the event queue to become empty. + The default value is 180 seconds. A value of 0 will check if the queue is empty + and always return immediately. + + + + + + Wait only for events after the given sequence number. + + + + + + Wait only for events before the given sequence number. + + + + + + Stop waiting if file exists. + + + + + + Do not print any output, like the remaining queue entries when reaching the timeout. + + + + + + Print help text. + + + + - udevadm control <replaceable>command</replaceable> - Modify the internal state of the running udev daemon. - - - - - Set the internal log level of udevd. Valid values are the numerical - syslog priorities or their textual representations: , - and . - - - - - - Signal udevd to stop executing new events. Incoming events - will be queued. - - - - - - Signal udevd to enable the execution of events. - - - - - - Signal udevd to reload the rules files. - The udev daemon detects changes automatically, this option is - usually not needed. Reloading rules does not apply any changes - to already existing devices. - - - - - - Set a global property for all events. - - - - value - - Set the maximum number of events, udevd will handle at the - same time. - - - - - - Print help text. - - - - + udevadm control <replaceable>command</replaceable> + Modify the internal state of the running udev daemon. + + + + + Set the internal log level of udevd. Valid values are the numerical + syslog priorities or their textual representations: , + and . + + + + + + Signal udevd to stop executing new events. Incoming events + will be queued. + + + + + + Signal udevd to enable the execution of events. + + + + + + Signal udevd to reload the rules files. + The udev daemon detects changes automatically, this option is + usually not needed. Reloading rules does not apply any changes + to already existing devices. + + + + + + Set a global property for all events. + + + + value + + Set the maximum number of events, udevd will handle at the + same time. + + + + + + Print help text. + + + + - udevadm monitor <optional>options</optional> - Listens to the kernel uevents and events sent out by a udev rule - and prints the devpath of the event to the console. It can be used to analyze the - event timing, by comparing the timestamps of the kernel uevent and the udev event. - - - - - - Print the kernel uevents. - - - - - - Print the udev event after the rule processing. - - - - - - Also print the properties of the event. - - - - - - Filter events by subsystem[/devtype]. Only udev events with a matching subsystem value will pass. - - - - - - Filter events by property. Only udev events with a given tag attached will pass. - - - - - - Print help text. - - - - + udevadm monitor <optional>options</optional> + Listens to the kernel uevents and events sent out by a udev rule + and prints the devpath of the event to the console. It can be used to analyze the + event timing, by comparing the timestamps of the kernel uevent and the udev event. + + + + + + Print the kernel uevents. + + + + + + Print the udev event after the rule processing. + + + + + + Also print the properties of the event. + + + + + + Filter events by subsystem[/devtype]. Only udev events with a matching subsystem value will pass. + + + + + + Filter events by property. Only udev events with a given tag attached will pass. + + + + + + Print help text. + + + + - udevadm test <optional>options</optional> <replaceable>devpath</replaceable> - Simulate a udev event run for the given device, and print debug output. - - - - - The action string. - - - - - - The subsystem string. - - - - - - Print help text. - - - - - + udevadm test <optional>options</optional> <replaceable>devpath</replaceable> + Simulate a udev event run for the given device, and print debug output. + + + + + The action string. + + + + + + The subsystem string. + + + + + + Print help text. + + + + + - AUTHOR - Written by Kay Sievers kay.sievers@vrfy.org. - + Author + Written by Kay Sievers kay.sievers@vrfy.org. + - - SEE ALSO - - udev7 - - - udevd8 - - - -
-
+ + See Also + + udev7 + + + udevd8 + + + diff --git a/udev/udevd.xml b/udev/udevd.xml index 5368f2814..1f81f0653 100644 --- a/udev/udevd.xml +++ b/udev/udevd.xml @@ -1,119 +1,115 @@ - + -
-
+ + udevd - - - udevd - udev - + udev + - - udevd - 8 - - + + udevd + 8 + + - - udevdevent managing daemon - + + udevdevent managing daemon + - - - udevd - - - - - - - - + + + udevd + + + + + + + + - DESCRIPTION - udevd listens to kernel uevents and passes the incoming events to - udev. It ensures the correct event order and takes care, that events for child - devices are delayed until the parent event has finished the device handling. - The behavior of the running daemon can be changed with - udevadm control. - + Description + udevd listens to kernel uevents and passes the incoming events to + udev. It ensures the correct event order and takes care, that events for child + devices are delayed until the parent event has finished the device handling. + The behavior of the running daemon can be changed with + udevadm control. + - OPTIONS - - - - - Detach and run in the background. - - - - - - Run all events completely serialized. This may be useful if udev triggers - actions or loads kernel modules which cause problems and a slow but continuous - operation is needed, where no events are processed in parallel. - - - - - - - Print debug messages to stderr. - - - - - - Specify when udevd should resolve names of users and groups. - When set to (the default) names will be - resolved when the rules are parsed. When set to - names will be resolved for every event. - When set to names will never be resolved - and all devices will be owned by root. - - - - - - Print version number. - - - - - - Print help text. - - - - + Options + + + + + Detach and run in the background. + + + + + + Run all events completely serialized. This may be useful if udev triggers + actions or loads kernel modules which cause problems and a slow but continuous + operation is needed, where no events are processed in parallel. + + + + + + + Print debug messages to stderr. + + + + + + Specify when udevd should resolve names of users and groups. + When set to (the default) names will be + resolved when the rules are parsed. When set to + names will be resolved for every event. + When set to names will never be resolved + and all devices will be owned by root. + + + + + + Print version number. + + + + + + Print help text. + + + + - ENVIRONMENT - - - - - Overrides the syslog priority specified in the config file. - - - - + Environment + + + + + Overrides the syslog priority specified in the config file. + + + + - AUTHOR - Written by Kay Sievers kay.sievers@vrfy.org. - + Author + Written by Kay Sievers kay.sievers@vrfy.org. + - - SEE ALSO - - udev7 - , - - udevadm8 - - - -
-
+ + See Also + + udev7 + , + + udevadm8 + + + -- 2.30.2