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   <section>
   7     <title>udevinfo</title>
   8     <refentry>
   9       <refentryinfo>
  10         <title>udevinfo</title>
  11         <date>August 2005</date>
  12         <productname>udev</productname>
  13       </refentryinfo>
  14
  15       <refmeta>
  16         <refentrytitle>udevinfo</refentrytitle>
  17         <manvolnum>8</manvolnum>
  18         <refmiscinfo class="version"></refmiscinfo>
  19       </refmeta>
  20
  21       <refnamediv>
  22         <refname>udevinfo</refname><refpurpose>query device information from the udev database</refpurpose>
  23       </refnamediv>
  24
  25       <refsynopsisdiv>
  26         <cmdsynopsis>
  27           <command>udevinfo</command>
  28           <arg><option>--query=<replaceable>query-type</replaceable></option></arg>
  29           <arg><option>--path=<replaceable>devpath</replaceable></option></arg>
  30           <arg><option>--name=<replaceable>node</replaceable></option></arg>
  31           <arg><option>--root</option></arg>
  32           <arg><option>--attribute-walk</option></arg>
  33           <arg><option>--export-db</option></arg>
  34           <arg><option>--version</option></arg>
  35           <arg><option>--help</option></arg>
  36         </cmdsynopsis>
  37       </refsynopsisdiv>
  38
  39       <refsect1><title>DESCRIPTION</title>
  40         <para>udevinfo queries the udev database for device information
  41         stored in the udev database. It can also query the properties
  42         of a device from its sysfs representation to help creating udev
  43         rules that match this device.</para>
  44       </refsect1>
  45
  46       <refsect1><title>OPTIONS</title>
  47         <variablelist>
  48           <varlistentry>
  49             <term><option>--query=<replaceable>type</replaceable></option></term>
  50             <listitem>
  51               <para>Query the database for specified type of device data. It needs the
  52               <option>--path</option> or <option>--name</option> to identify the specified
  53               device. Valid queries are:
  54               <command>name</command>, <command>symlink</command>, <command>path</command>,
  55               <command>env</command>, <command>all</command>.</para>
  56             </listitem>
  57           </varlistentry>
  58           <varlistentry>
  59             <term><option>--path=<replaceable>devpath</replaceable></option></term>
  60             <listitem>
  61               <para>The devpath of the device to query.</para>
  62             </listitem>
  63           </varlistentry>
  64           <varlistentry>
  65             <term><option>--name=<replaceable>node</replaceable></option></term>
  66             <listitem>
  67               <para>The name of the device node or a symlink to query</para>
  68             </listitem>
  69           </varlistentry>
  70           <varlistentry>
  71             <term><option>--root</option></term>
  72             <listitem>
  73               <para>The udev root directory: <filename>/dev</filename>. If used in conjunction
  74               with a <command>name</command> or <command>symlink</command> query, the
  75               query returns the absolute path including the root directory.</para>
  76             </listitem>
  77           </varlistentry>
  78           <varlistentry>
  79             <term><option>--attribute-walk</option></term>
  80             <listitem>
  81               <para>Print all sysfs properties of the specified device that can be used
  82               in udev rules to match the specified device. It prints all devices
  83               along the chain, up to the root of sysfs that can be used in udev rules.</para>
  84             </listitem>
  85           </varlistentry>
  86           <varlistentry>
  87             <term><option>--export</option></term>
  88             <listitem>
  89               <para>Export the content of the udev database.</para>
  90             </listitem>
  91           </varlistentry>
  92
  93           <varlistentry>
  94             <term><option>--help</option></term>
  95             <listitem>
  96               <para>Print help text.</para>
  97             </listitem>
  98           </varlistentry>
  99         </variablelist>
 100       </refsect1>
 101
 102       <refsect1><title>AUTHOR</title>
 103         <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email>.</para>
 104       </refsect1>
 105
 106       <refsect1>
 107         <title>SEE ALSO</title>
 108         <para><citerefentry>
 109             <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
 110         </citerefentry></para>
 111       </refsect1>
 112     </refentry>
 113   </section>
 114 </article>