From: Yu Watanabe <watanabe.yu+github@gmail.com>
Date: Tue, 27 May 2025 18:11:15 +0000 (+0900)
Subject: man/udevadm: update command arguments
X-Git-Tag: v258-rc1~425^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6a907a00be4de6c1cc2c86ef4f0a8a4198d18b68;p=thirdparty%2Fsystemd.git

man/udevadm: update command arguments
---

diff --git a/man/udevadm.xml b/man/udevadm.xml
index 5636d102b77..07ba2ff09de 100644
--- a/man/udevadm.xml
+++ b/man/udevadm.xml
@@ -28,41 +28,57 @@
       <arg><option>--help</option></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm info <optional>options</optional> <optional>devpath</optional></command>
+      <command>udevadm info</command>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+      <arg choice="opt" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>syspath</replaceable>|<replaceable>unit</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm trigger <optional>options</optional> <optional>devpath</optional></command>
+      <command>udevadm trigger</command>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+      <arg choice="opt" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>syspath</replaceable>|<replaceable>unit</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm settle <optional>options</optional></command>
+      <command>udevadm settle</command>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm control <replaceable>option</replaceable></command>
+      <command>udevadm control</command>
+      <arg choice="plain" rep="repeat"><replaceable>options</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm monitor <optional>options</optional></command>
+      <command>udevadm monitor</command>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command>
+      <command>udevadm test</command>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+      <arg choice="plain"><replaceable>devpath</replaceable>|<replaceable>syspath</replaceable>|<replaceable>unit</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm test-builtin <optional>options</optional> <replaceable>command</replaceable> <replaceable>devpath</replaceable></command>
+      <command>udevadm test-builtin</command>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+      <arg choice="plain"><replaceable>command</replaceable></arg>
+      <arg choice="plain"><replaceable>devpath</replaceable>|<replaceable>syspath</replaceable>|<replaceable>unit</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
       <command>udevadm verify</command>
-      <arg choice="opt" rep="repeat">options</arg>
-      <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+      <arg choice="opt" rep="repeat"><replaceable>files</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
       <command>udevadm cat</command>
-      <arg choice="opt" rep="repeat">options</arg>
-      <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+      <arg choice="opt" rep="repeat"><replaceable>files</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm wait <optional>options</optional> <replaceable>device|syspath</replaceable></command>
+      <command>udevadm wait</command>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+      <arg choice="plain" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>syspath</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
-      <command>udevadm lock <optional>options</optional> <replaceable>command</replaceable></command>
+      <command>udevadm lock</command>
+      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+      <arg choice="plain" rep="repeat"><replaceable>command</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -98,8 +114,8 @@
 
     <refsect2>
       <title>udevadm info
-      <optional><replaceable>options</replaceable></optional>
-      <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional>
+      <optional><replaceable>options</replaceable>…</optional>
+      <optional><replaceable>devpath</replaceable>|<replaceable>syspath</replaceable>|<replaceable>unit</replaceable>…</optional>
       </title>
 
       <para>Query the udev database for device information.</para>
@@ -410,14 +426,14 @@
 
     <refsect2>
       <title>udevadm trigger
-      <optional><replaceable>options</replaceable></optional>
-      <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional>
+      <optional><replaceable>options</replaceable>…</optional>
+      <optional><replaceable>devpath</replaceable>|<replaceable>syspath</replaceable>|<replaceable>unit</replaceable>…</optional>
       </title>
 
       <para>Request device events from the kernel. Primarily used to replay events at system coldplug time.</para>
 
-      <para>Takes device specifications as positional arguments. See the description of <command>info</command>
-      above.</para>
+      <para>Takes device specifications as positional arguments. See the description of
+      <command>udevadm info</command> above.</para>
 
       <variablelist>
         <varlistentry>
@@ -648,7 +664,7 @@
 
     <refsect2>
       <title>udevadm settle
-      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>options</replaceable>…</optional>
       </title>
 
       <para>Watches the udev event queue, and exits if all current events are handled.</para>
@@ -681,7 +697,7 @@
     </refsect2>
 
     <refsect2>
-      <title>udevadm control <replaceable>option</replaceable></title>
+      <title>udevadm control <replaceable>options</replaceable>…</title>
 
       <para>Modify the internal state of the running udev daemon.</para>
 
@@ -832,7 +848,7 @@
 
     <refsect2>
       <title>udevadm monitor
-      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>options</replaceable>…</optional>
       </title>
 
       <para>Listens to the kernel uevents and events sent out by a udev rule
@@ -885,8 +901,8 @@
 
     <refsect2>
       <title>udevadm test
-      <optional><replaceable>options</replaceable></optional>
-      <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional>
+      <optional><replaceable>options</replaceable>…</optional>
+      <replaceable>devpath</replaceable>|<replaceable>syspath</replaceable>|<replaceable>unit</replaceable>
       </title>
 
       <para>
@@ -950,9 +966,9 @@
 
     <refsect2>
       <title>udevadm test-builtin
-      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>options</replaceable>…</optional>
       <replaceable>command</replaceable>
-      <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional>
+      <replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable>
       </title>
 
       <para>Run a built-in command <replaceable>COMMAND</replaceable>
@@ -978,9 +994,8 @@
 
     <refsect2>
       <title>udevadm verify
-      <optional><replaceable>options</replaceable></optional>
-      <optional><replaceable>file</replaceable></optional>
-      …
+      <optional><replaceable>options</replaceable>…</optional>
+      <optional><replaceable>files</replaceable>…</optional>
       </title>
 
       <para>Verify syntactic, semantic, and stylistic correctness of udev rules files.</para>
@@ -1051,9 +1066,8 @@
 
     <refsect2>
       <title>udevadm cat
-      <optional><replaceable>options</replaceable></optional>
-      <optional><replaceable>file</replaceable></optional>
-      …
+      <optional><replaceable>options</replaceable>…</optional>
+      <optional><replaceable>file</replaceable>…</optional>
       </title>
 
       <para>Show udev rules files or udev.conf.</para>
@@ -1108,9 +1122,8 @@
 
     <refsect2>
       <title>udevadm wait
-      <optional><replaceable>options</replaceable></optional>
-      <optional><replaceable>device|syspath</replaceable></optional>
-      …
+      <optional><replaceable>options</replaceable>…</optional>
+      <replaceable>devpath|syspath</replaceable>…
       </title>
 
       <para>Wait for devices or device symlinks being created and initialized by
@@ -1170,9 +1183,8 @@
 
     <refsect2>
       <title>udevadm lock
-      <optional><replaceable>options</replaceable></optional>
-      <optional><replaceable>command</replaceable></optional>
-      …
+      <optional><replaceable>options</replaceable>…</optional>
+      <replaceable>command</replaceable>…
       </title>
 
       <para><command>udevadm lock</command> takes an (advisory) exclusive lock on a block device (or all
diff --git a/tools/command_ignorelist b/tools/command_ignorelist
index 0159054b8d4..b8a4084d264 100644
--- a/tools/command_ignorelist
+++ b/tools/command_ignorelist
@@ -494,44 +494,44 @@ udev.xml ./refsect1[title="Rules Files"]/refsect2[title="Keys"]/variablelist[4]/
 udev.xml ./refsect1[title="Rules Files"]/refsect2[title="Keys"]/variablelist[4]/varlistentry[term="$$"]
 udevadm.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="-d"]
 udevadm.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="-V"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-q"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-p"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-n"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-r"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-a"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-x"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-P"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-d"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-e"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-c"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-v"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-n"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-t"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-c"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-s"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-S"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-a"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-A"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-p"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-g"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-y"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-b"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm settle\n      options\n      "]/variablelist/varlistentry[term="-t"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm settle\n      options\n      "]/variablelist/varlistentry[term="-E"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control option"]/variablelist/varlistentry[term="-e"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control option"]/variablelist/varlistentry[term="-l"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control option"]/variablelist/varlistentry[term="-s"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control option"]/variablelist/varlistentry[term="-S"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control option"]/variablelist/varlistentry[term="-R"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control option"]/variablelist/varlistentry[term="-p"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control option"]/variablelist/varlistentry[term="-m"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control option"]/variablelist/varlistentry[term="-t"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options\n      "]/variablelist/varlistentry[term="-k"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options\n      "]/variablelist/varlistentry[term="-u"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options\n      "]/variablelist/varlistentry[term="-p"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options\n      "]/variablelist/varlistentry[term="-s"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options\n      "]/variablelist/varlistentry[term="-t"]
-udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm test\n      options\n      devpath|file|unit\n      "]/variablelist/varlistentry[term="-a"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-q"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-p"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-n"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-r"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-a"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-x"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-P"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-d"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-e"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm info\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-c"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-v"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-n"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-t"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-c"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-s"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-S"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-a"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-A"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-p"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-g"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-y"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm trigger\n      options…\n      devpath|syspath|unit…\n      "]/variablelist/varlistentry[term="-b"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm settle\n      options…\n      "]/variablelist/varlistentry[term="-t"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm settle\n      options…\n      "]/variablelist/varlistentry[term="-E"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control options…"]/variablelist/varlistentry[term="-e"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control options…"]/variablelist/varlistentry[term="-l"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control options…"]/variablelist/varlistentry[term="-s"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control options…"]/variablelist/varlistentry[term="-S"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control options…"]/variablelist/varlistentry[term="-R"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control options…"]/variablelist/varlistentry[term="-p"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control options…"]/variablelist/varlistentry[term="-m"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm control options…"]/variablelist/varlistentry[term="-t"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options…\n      "]/variablelist/varlistentry[term="-k"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options…\n      "]/variablelist/varlistentry[term="-u"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options…\n      "]/variablelist/varlistentry[term="-p"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options…\n      "]/variablelist/varlistentry[term="-s"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm monitor\n      options…\n      "]/variablelist/varlistentry[term="-t"]
+udevadm.xml ./refsect1[title="Options"]/refsect2[title="udevadm test\n      options…\n      devpath|syspath|unit\n      "]/variablelist/varlistentry[term="-a"]
 vconsole.conf.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="KEYMAP="]
 vconsole.conf.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="FONT="]
 file-hierarchy.xml ./refsect1[title="General Structure"]/variablelist/varlistentry[term="/"]