daandemeyer / rpms / systemd

Forked from rpms/systemd 2 years ago
Clone
572a44
From 52473fa9ee6d097431c48c0b9c4b4a51837c75eb Mon Sep 17 00:00:00 2001
572a44
From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= <zbyszek@in.waw.pl>
572a44
Date: Sun, 13 Oct 2013 19:43:19 -0400
572a44
Subject: [PATCH] man: add more markup to udevadm(8)
572a44
572a44
---
572a44
 man/udevadm.xml | 49 +++++++++++++++++++++++++++++++++----------------
572a44
 1 file changed, 33 insertions(+), 16 deletions(-)
572a44
572a44
diff --git a/man/udevadm.xml b/man/udevadm.xml
572a44
index b959216..a1ffe42 100644
572a44
--- a/man/udevadm.xml
572a44
+++ b/man/udevadm.xml
572a44
@@ -61,9 +61,10 @@
572a44
   </refsynopsisdiv>
572a44
 
572a44
   <refsect1><title>Description</title>
572a44
-    <para>udevadm expects a command and command specific options.  It
572a44
-    controls the runtime behavior of udev, requests kernel events,
572a44
-    manages the event queue, and provides simple debugging mechanisms.</para>
572a44
+    <para><command>udevadm</command> expects a command and command
572a44
+    specific options.  It controls the runtime behavior of
572a44
+    <command>systemd-udevd</command>, requests kernel events, manages
572a44
+    the event queue, and provides simple debugging mechanisms.</para>
572a44
   </refsect1>
572a44
 
572a44
   <refsect1><title>OPTIONS</title>
572a44
@@ -97,23 +98,37 @@
572a44
         <varlistentry>
572a44
           <term><option>--query=<replaceable>type</replaceable></option></term>
572a44
           <listitem>
572a44
-            <para>Query the database for specified type of device data. It needs the
572a44
-            <option>--path</option> or <option>--name</option> to identify the specified
572a44
-            device. Valid queries are:
572a44
-            <command>name</command>, <command>symlink</command>, <command>path</command>,
572a44
-            <command>property</command>, <command>all</command>.</para>
572a44
+            <para>Query the database for specified type of device
572a44
+            data. It needs the <option>--path</option> or
572a44
+            <option>--name</option> to identify the specified
572a44
+            device. Valid queries are: <constant>name</constant>,
572a44
+            <constant>symlink</constant>, <constant>path</constant>,
572a44
+            <constant>property</constant>,
572a44
+            <constant>all</constant>.</para>
572a44
           </listitem>
572a44
         </varlistentry>
572a44
         <varlistentry>
572a44
           <term><option>--path=<replaceable>devpath</replaceable></option></term>
572a44
           <listitem>
572a44
-            <para>The devpath of the device to query.</para>
572a44
+            <para>The <filename>/sys</filename> path of the device to
572a44
+            query, e.g.
572a44
+            <filename><optional>/sys</optional>/class/block/sda</filename>.
572a44
+            Note that this option usually isn't very useful, since
572a44
+            <command>udev</command> can guess the type of the
572a44
+            argument, so <command>udevadm
572a44
+            --devpath=/class/block/sda</command> is equivalent to
572a44
+            <command>udevadm /sys/class/block/sda</command>.</para>
572a44
           </listitem>
572a44
         </varlistentry>
572a44
         <varlistentry>
572a44
           <term><option>--name=<replaceable>file</replaceable></option></term>
572a44
           <listitem>
572a44
-            <para>The name of the device node or a symlink to query</para>
572a44
+            <para>The name of the device node or a symlink to query,
572a44
+            e.g. <filename><optional>/dev</optional>/sda</filename>.
572a44
+            Note that this option usually isn't very useful, since
572a44
+            <command>udev</command> can guess the type of the
572a44
+            argument, so <command>udevadm --name=sda</command> is
572a44
+            equivalent to <command>udevadm /dev/sda</command>.</para>
572a44
           </listitem>
572a44
         </varlistentry>
572a44
         <varlistentry>
572a44
@@ -462,13 +477,15 @@
572a44
           </listitem>
572a44
         </varlistentry>
572a44
         <varlistentry>
572a44
-          <term><option>--resolve-names=<replaceable>early|late|never</replaceable></option></term>
572a44
+          <term><option>--resolve-names=<constant>early</constant>|<constant>late</constant>|<constant>never</constant></option></term>
572a44
           <listitem>
572a44
-            <para>Specify when udevadm should resolve names of users and groups.
572a44
-              When set to early (the default) names will be resolved when the
572a44
-              rules are parsed. When set to late names will be resolved for
572a44
-              every event. When set to never names will never be resolved and
572a44
-              all devices will be owned by root.</para>
572a44
+            <para>Specify when udevadm should resolve names of users
572a44
+            and groups.  When set to <constant>early</constant> (the
572a44
+            default) names will be resolved when the rules are
572a44
+            parsed. When set to <constant>late</constant> names will
572a44
+            be resolved for every event. When set to
572a44
+            <constant>never</constant> names will never be resolved
572a44
+            and all devices will be owned by root.</para>
572a44
           </listitem>
572a44
         </varlistentry>
572a44
         <varlistentry>