udevadm: introduce cat command

This introduces 'udevadm cat' command, that shows udev rules files or
udev.conf, which may be useful for debugging.

Closes #35818.
This commit is contained in:
Yu Watanabe
2025-01-07 16:58:37 +09:00
parent bbe1ba5e87
commit 7f2175eabb
8 changed files with 225 additions and 1 deletions

View File

@@ -53,6 +53,11 @@
<arg choice="opt" rep="repeat">options</arg>
<arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>udevadm cat</command>
<arg choice="opt" rep="repeat">options</arg>
<arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>udevadm wait <optional>options</optional> <replaceable>device|syspath</replaceable></command>
</cmdsynopsis>
@@ -1019,6 +1024,65 @@
</variablelist>
</refsect2>
<refsect2>
<title>udevadm cat
<optional><replaceable>options</replaceable></optional>
<optional><replaceable>file</replaceable></optional>
</title>
<para>Show udev rules files or udev.conf.</para>
<para>Positional arguments can be used to specify one or more files to show. Each argument must be an
absolute path to a udev rules file or a directory that contains rules files, or a file name of udev
rules file (e.g. <filename>99-systemd.rules</filename>). If a file name is specified, the file will be
searched in the <filename>udev/rules.d</filename> directories that are processed by
<command>systemd-udevd</command>, and searched in the current working directory if not found. If no
files are specified, the udev rules are read from the files located in the same
<filename>udev/rules.d</filename> directories that are processed by <command>systemd-udevd</command>.
See <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> for more
details about the search paths.</para>
<variablelist>
<varlistentry>
<term><option>--root=<replaceable>PATH</replaceable></option></term>
<listitem>
<para>When looking for udev rules files located in the <filename>udev/rules.d</filename>
directories, operate on files underneath the specified root path <replaceable>PATH</replaceable>.
When a file name is specified, and it is not found in the <filename>udev/rules.d</filename>
directories, the file will be searched in the specified root path
<replaceable>PATH</replaceable>, rather than the current working directory.</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--tldr</option></term>
<listitem>
<para>Only print the "interesting" parts of the configuration files, skipping comments and empty
lines and section headers followed only by comments and empty lines.</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--config</option></term>
<listitem>
<para>Shows
<citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
files, rather than udev rules files. When specified, no udev rules file cannot be specified.
</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<xi:include href="standard-options.xml" xpointer="help" />
</variablelist>
</refsect2>
<refsect2>
<title>udevadm wait
<optional><replaceable>options</replaceable></optional>