diff options
Diffstat (limited to 'doc/index.html')
| -rw-r--r-- | doc/index.html | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..5cb1cd0 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,122 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>mdevd-conf</title> + <meta name="Description" content="A policy and helper scripts for mdevd." /> + <meta name="Keywords" content="unix linux bsd skarnet mdevd" /> + </head> + <header> + <p> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>mdevd-conf</h1> + <h2>What is it?</h2> + <p> + mdevd-conf is a ready to use set of + a configuration file and + helper scripts for + <a href="https://skarnet.org/software/mdevd/">mdevd</a> + to set up + basic userspace device management. + </p> + <p> + It aims to allow replacing + <a href="https://github.com/systemd/systemd/tree/main/src/udev">systemd-udevd</a> + with the caveat of lacking libudev. + This lack can be partially compensated for by using + <a href="https://github.com/illiliti/libudev-zero">libudev-zero</a>. + It is currently very hard to switch away from + <a href="https://github.com/systemd/systemd/tree/main/src/udev">systemd-udevd</a> + on desktop machines using a + <a href="https://www.freedesktop.org/wiki/">freedesktop.org</a> + based + <a href="https://wayland.freedesktop.org/">Wayland</a> + or + <a href="https://www.x.org/wiki/">X.Org</a> + software stack. + </p> + <p> + On desktops based on + <a href="https://arcan-fe.com/">Arcan</a> + or on a server systems, however, it is possible + to switch from systemd-udevd to mdevd(-conf). + </p> + <hr> + <ul> + <li> + <a href="./setup.html">setup</a> + </li> + </ul> + <hr> + <h2>Installation</h2> + <h3>Requirements</h3> + <ul> + <li> + A set of POSIX tools + as well as + a set of Linux specific tools. + As described on the + <a href="//0x53.net/software/requirements.html">POSIX and kernel specific requirements page</a>. + </li> + <li> + A POSIX-compliant implementation of make, or GNU make + </li> + <li> + <a href="https://skarnet.org/software/execline/">execline</a>. + It is a run-time requirement. + </li> + <li> + <a href="https://skarnet.org/software/mdevd/">mdevd</a> + compiled with + <a href="https://skarnet.org/software/execline/">execline</a> + support. + It is a run-time requirement. + </li> + </ul> + <h3>Licensing</h3> + <p> + mdevd-conf is free software. It is available under the + <a href="https://opensource.org/licenses/ISC">ISC license</a>. + </p> + <h3>Download</h3> + <ul> + <li> + The current released version of mdevd-conf is + <a href="mdevd-conf-0.1.0.0.tar.gz">0.1.0.0</a>. + You can access its checksum + <a href="./mdevd-conf-0.1.0.0.tar.gz.sha256">here</a>. + </li> + <li> + Alternatively, you can checkout a copy of the + <a href="https://git.0x53.net/mdevd-conf">mdevd-conf git repository</a>: + <pre>git clone git://git.0x53.net/mdevd-conf</pre> + </li> + </ul> + <h3>Compilation</h3> + <ul> + <li> + See the enclosed INSTALL file for installation details. + </li> + </ul> + <hr> + <h2>Reference</h2> + <section id="bin"> + <h3>Commands</h3> + <ul> + <li> + <a href="./bin/mddc-add-block-sym.html">mddc-add-block-sym</a> + </li> + <li> + <a href="./bin/mddc-del-block-sym.html">mddc-del-block-sym</a> + </li> + </ul> + </section> + </body> +</html> |