udevinfo.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <article>
   6   <articleinfo>
   7     <title>xmlto</title>
   8     <author>
   9       <firstname>Kay</firstname>
  10       <surname>Sievers</surname>
  11       <email>kay.sievers@vrfy.org</email>
  12     </author>
  13     <copyright>
  14       <year>2005</year>
  15       <holder>Kay Sievers</holder>
  16     </copyright>
  17   </articleinfo>
  18
  19   <section>
  20     <title>udevinfo</title>
  21     <refentry>
  22       <refentryinfo>
  23         <title>udevinfo</title>
  24         <date>August 2005</date>
  25         <productname>udev</productname>
  26       </refentryinfo>
  27
  28       <refmeta>
  29         <refentrytitle>udevinfo</refentrytitle>
  30         <manvolnum>8</manvolnum>
  31       </refmeta>
  32
  33       <refnamediv>
  34         <refname>udevinfo</refname><refpurpose>query device information from the udev database</refpurpose>
  35       </refnamediv>
  36
  37       <refsynopsisdiv>
  38         <cmdsynopsis>
  39           <command>udevinfo</command>
  40           <arg><option>-q <replaceable>query-type</replaceable></option></arg>
  41           <arg><option>-a </option></arg>
  42           <arg><option>-p <replaceable>device-path</replaceable></option></arg>
  43           <arg><option>-n <replaceable>node-name</replaceable></option></arg>
  44           <arg><option>-r</option></arg>
  45           <arg><option>-e</option></arg>
  46           <arg><option>-V</option></arg>
  47           <arg><option>-h</option></arg>
  48         </cmdsynopsis>
  49       </refsynopsisdiv>
  50
  51       <refsect1><title>DESCRIPTION</title>
  52         <para>udevinfo queries the udev database for device information
  53         stored in the udev database. It can also query the properties
  54         of a device from its sysfs representation to help creating udev
  55         rules that match this device.</para>
  56       </refsect1>
  57
  58       <refsect1><title>OPTIONS</title>
  59         <variablelist>
  60           <varlistentry>
  61             <term><option>-q</option></term>
  62             <listitem>
  63               <para>Query the database for specified type of device data. It needs the
  64               <option>-p</option> or <option>-n</option> to identify the specified
  65               device. Valid queries are:
  66               <command>name</command>, <command>symlink</command>, <command>path</command>,
  67               <command>env</command>, <command>all</command>.</para>
  68             </listitem>
  69           </varlistentry>
  70
  71           <varlistentry>
  72             <term><option>-a</option></term>
  73             <listitem>
  74               <para>Print all sysfs properties of the specified device that can be used
  75               in udev rules to match the specified device. It prints all devices
  76               along the chain, up to the root of sysfs that can be used in udev rules.</para>
  77             </listitem>
  78           </varlistentry>
  79
  80           <varlistentry>
  81             <term><option>-p <replaceable>device-path</replaceable></option></term>
  82             <listitem>
  83               <para>The sysfs path of the device to query.</para>
  84             </listitem>
  85           </varlistentry>
  86
  87           <varlistentry>
  88             <term><option>-n <replaceable>node-name</replaceable></option></term>
  89             <listitem>
  90               <para>The name of the device node or a symlink to query</para>
  91             </listitem>
  92           </varlistentry>
  93
  94           <varlistentry>
  95             <term><option>-r</option></term>
  96             <listitem>
  97               <para>The udev root directory: <filename>/dev</filename>. If used in conjunction
  98               with a <command>name</command> or <command>symlink</command> query, the
  99               query returns the absolute path.</para>
 100             </listitem>
 101           </varlistentry>
 102
 103           <varlistentry>
 104             <term><option>-e</option></term>
 105             <listitem>
 106               <para>Export the content of the udev database.</para>
 107             </listitem>
 108           </varlistentry>
 109
 110           <varlistentry>
 111             <term><option>-h</option></term>
 112             <listitem>
 113               <para>Print help text.</para>
 114             </listitem>
 115           </varlistentry>
 116         </variablelist>
 117       </refsect1>
 118
 119       <refsect1><title>AUTHOR</title>
 120         <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email>.</para>
 121       </refsect1>
 122
 123       <refsect1>
 124         <title>SEE ALSO</title>
 125         <para><citerefentry>
 126             <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
 127         </citerefentry></para>
 128       </refsect1>
 129     </refentry>
 130   </section>
 131 </article>