summaryrefslogtreecommitdiff
path: root/udevinfo.xml
blob: bb3571cc23afb75abe94c699f33912545cd8e0c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<?xml version='1.0'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article>
  <section>
    <title>udevinfo</title>
    <refentry>
      <refentryinfo>
        <title>udevinfo</title>
        <date>August 2005</date>
        <productname>udev</productname>
      </refentryinfo>

      <refmeta>
        <refentrytitle>udevinfo</refentrytitle>
        <manvolnum>8</manvolnum>
        <refmiscinfo class="version"></refmiscinfo>
      </refmeta>

      <refnamediv>
        <refname>udevinfo</refname>
        <refpurpose>query udev device information</refpurpose>
      </refnamediv>

      <refsynopsisdiv>
        <cmdsynopsis>
          <command>udevinfo</command>
          <arg><option>--query=<replaceable>query-type</replaceable></option></arg>
          <arg><option>--path=<replaceable>devpath</replaceable></option></arg>
          <arg><option>--name=<replaceable>node</replaceable></option></arg>
          <arg><option>--root</option></arg>
          <arg><option>--attribute-walk</option></arg>
          <arg><option>--export-db</option></arg>
          <arg><option>--version</option></arg>
          <arg><option>--help</option></arg>
        </cmdsynopsis>
      </refsynopsisdiv>

      <refsect1><title>DESCRIPTION</title>
        <para>udevinfo queries the udev database for device information
        stored in the udev database. It can also query the properties
        of a device from its sysfs representation to help creating udev
        rules that match this device.</para>
      </refsect1>

      <refsect1><title>OPTIONS</title>
        <variablelist>
          <varlistentry>
            <term><option>--query=<replaceable>type</replaceable></option></term>
            <listitem>
              <para>Query the database for specified type of device data. It needs the
              <option>--path</option> or <option>--name</option> to identify the specified
              device. Valid queries are:
              <command>name</command>, <command>symlink</command>, <command>path</command>,
              <command>env</command>, <command>all</command>.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--path=<replaceable>devpath</replaceable></option></term>
            <listitem>
              <para>The devpath of the device to query.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--name=<replaceable>node</replaceable></option></term>
            <listitem>
              <para>The name of the device node or a symlink to query</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--root</option></term>
            <listitem>
              <para>The udev root directory: <filename>/dev</filename>. If used in conjunction
              with a <command>name</command> or <command>symlink</command> query, the
              query returns the absolute path including the root directory.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--attribute-walk</option></term>
            <listitem>
              <para>Print all sysfs properties of the specified device that can be used
              in udev rules to match the specified device. It prints all devices
              along the chain, up to the root of sysfs that can be used in udev rules.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--export-db</option></term>
            <listitem>
              <para>Export the content of the udev database.</para>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term><option>--version</option></term>
            <listitem>
              <para>Print version.</para>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term><option>--help</option></term>
            <listitem>
              <para>Print help text.</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </refsect1>

      <refsect1><title>AUTHOR</title>
        <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email>.</para>
      </refsect1>

      <refsect1>
        <title>SEE ALSO</title>
        <para><citerefentry>
            <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
        </citerefentry></para>
      </refsect1>
    </refentry>
  </section>
</article>