diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.html | 2 | ||||
| -rw-r--r-- | doc/mdevd.html | 14 | ||||
| -rw-r--r-- | doc/upgrade.html | 7 |
3 files changed, 21 insertions, 2 deletions
diff --git a/doc/index.html b/doc/index.html index 0d2c62b..9b6f46b 100644 --- a/doc/index.html +++ b/doc/index.html @@ -114,7 +114,7 @@ library. </li> <ul> <li> The current released version of mdevd is -<a href="mdevd-0.1.1.2.tar.gz">0.1.1.2</a>. </li> +<a href="mdevd-0.1.2.0.tar.gz">0.1.2.0</a>. </li> <li> Alternatively, you can checkout a copy of the <a href="//git.skarnet.org/cgi-bin/cgit.cgi/mdevd/">mdevd git repository</a>: diff --git a/doc/mdevd.html b/doc/mdevd.html index e7231e2..2ef2dfb 100644 --- a/doc/mdevd.html +++ b/doc/mdevd.html @@ -49,7 +49,7 @@ to running mdevd over mdev. </li> <h2> Interface </h2> <pre> - mdevd [ -v <em>verbosity</em> ] [ -D <em>notif</em> ] [ -b <em>kbufsz</em> ] [ -f <em>conffile</em> ] [ -n ] [ -s <em>slashsys</em> ] [ -d <em>slashdev</em> ] [ -F <em>fwbase</em> ] + mdevd [ -v <em>verbosity</em> ] [ -D <em>notif</em> ] [ -o <em>outputfd</em> ] [ -b <em>kbufsz</em> ] [ -f <em>conffile</em> ] [ -n ] [ -s <em>slashsys</em> ] [ -d <em>slashdev</em> ] [ -F <em>fwbase</em> ] </pre> <ul> @@ -92,6 +92,18 @@ This allows mdevd to use the <a href="//skarnet.org/software/s6/notifywhenup.html">s6 mechanism to notify readiness</a>. <em>notif</em> cannot be lesser than 3. If this option is not given, no readiness notification is sent. </li> + <li> <tt>-o</tt> <em>outputfd</em> : send a copy of the complete +uevent, with possible new fields, to file descriptor <em>outputfd</em>, +<strong>after</strong> mdevd has handled them. (This can serve as a +synchronization mechanism with an external program that needs a device to +have been properly configured by the device manager before acting on the +device.) +The uevent is sent with the kernel format: fields are separated by a null +character. The uevent is terminated by an additional null character. +<em>outputfd</em> cannot be lesser than 3 and cannot be the same as <em>notif</em>. +If for any reason, at any point, mdevd fails to write to <em>outputfd</em>, +it stops writing, until it is restarted. (This is to preserve mdevd's memory +stability guarantee.) By default, the uevents are not written anywhere. </li> <li> <tt>-b</tt> <em>kbufsz</em> : try and reserve a kernel buffer of <em>kbufsz</em> bytes for the netlink queue. Too large a buffer wastes kernel memory; too small a buffer risks losing events. The default is 500 kB, which should be diff --git a/doc/upgrade.html b/doc/upgrade.html index 138f277..d9a7d38 100644 --- a/doc/upgrade.html +++ b/doc/upgrade.html @@ -18,6 +18,13 @@ <h1> What has changed in mdevd </h1> +<h2> in 0.1.2.0 </h2> + +<ul> + <li> A <tt>-o <em>outputfd</em></tt> option has been added to +<a href="mdevd.html">mdevd</a>. </li> +</ul> + <h2> in 0.1.1.2 </h2> <ul> |