summaryrefslogtreecommitdiff
path: root/doc/mdevd-coldplug.html
blob: 8355df3684905ce4c20cc36b476ca64542114698 (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
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>mdevd: the mdevd-coldplug program</title>
    <meta name="Description" content="mdevd: the mdevd-coldplug program" />
    <meta name="Keywords" content="mdevd linux administration root utilities devd mdev-s uevent netlink coldplug boot" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">mdevd</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>mdevd-coldplug</tt> program </h1>

<p>
<tt>mdevd-coldplug</tt> performs a <em>coldplug</em>: it scans
<tt>/sys</tt> for all registered devices an uevent manager would
want to perform actions on, and generates uevents for all these
devices.
</p>

<h2> Interface </h2>

<pre>
     mdevd-coldplug [ -s <em>slashsys</em> ]
</pre>

<ul>
 <li> mdevd-coldplug scans <tt>/sys</tt> for devices. </li>
 <li> For every suitable device it finds, it generates an
uevent and writes it to its stdout, using the same format
as <a href="mdevd-netlink.html">mdevd-netlink</a>. </li>
 <li> It exits when it has finished scanning. </li>
</ul>

<p>
 This implies that the <tt>mdevd-coldplug | mdevd</tt> command line
will function as a coldplug manager, just like <tt>mdev -s</tt>.
</p>

<h2> Options </h2>

<ul>
 <li> <tt>-s</tt>&nbsp;<em>slashsys</em>&nbsp;: assume the sysfs
pseudo-filesystem is mounted on <em>slashsys</em>. Default is <tt>/sys</tt>. </li>
</ul>

<h2> Exit codes </h2>

<ul>
 <li> 0: success </li>
 <li> 111: system call failed </li>
</ul>

<h2> Notes </h2>

<ul>
 <li> mdevd-coldplug is a short-lived program, just like
<tt>mdev -s</tt>. </li>
 <li> Unlike <tt>mdev -s</tt>, however, mdevd-coldplug does
not act on the uevents it generates. It simply prints them.
This allows for easy debugging. </li>
 <li> To act on the uevents, simply pipe the output of
<tt>mdevd-coldplug</tt> into <a href="mdevd.html">mdevd</a>. </li>
</ul>

</body>
</html>