aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPS <p@0x53.net>2026-02-07 10:40:28 +0100
committerPS <p@0x53.net>2026-02-07 10:40:28 +0100
commit56daa1ebc4cf4a245b10e931372c5a04d15e5253 (patch)
tree08e094aa2cfac2202d888ad5e890d47a25d649aa
parent049d80ae0e2b5f6370411207ed27fe423f5ff451 (diff)
downloadmdevd-conf-56daa1ebc4cf4a245b10e931372c5a04d15e5253.tar.gz
mdevd-conf-56daa1ebc4cf4a245b10e931372c5a04d15e5253.tar.bz2
mdevd-conf-56daa1ebc4cf4a245b10e931372c5a04d15e5253.zip
Add doc
Diffstat
-rw-r--r--Makefile1
-rw-r--r--doc/bin/mddc-add-block-sym.html92
-rw-r--r--doc/bin/mddc-del-block-sym.html72
-rw-r--r--doc/index.html122
-rw-r--r--doc/mdevd-conf-0.1.0.0.tar.gzbin0 -> 8120 bytes
-rw-r--r--doc/mdevd-conf-0.1.0.0.tar.gz.sha2561
-rw-r--r--doc/setup.html47
-rw-r--r--package/info2
8 files changed, 336 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 0e68c25..283c397 100644
--- a/Makefile
+++ b/Makefile
@@ -40,6 +40,7 @@ tgz: distclean
cp -a . /tmp/$$package-$$version && \
cd /tmp && \
tar -zpcv --owner=0 --group=0 --numeric-owner --exclude=.git* -f /tmp/$$package-$$version.tar.gz $$package-$$version && \
+ sha256sum $$package-$$version.tar.gz > $$package-$$version.tar.gz.sha256 && \
exec rm -rf /tmp/$$package-$$version
install: $(INSTALL_BINS) $(INSTALL_LIBS) $(INSTALL_EXTRAS)
diff --git a/doc/bin/mddc-add-block-sym.html b/doc/bin/mddc-add-block-sym.html
new file mode 100644
index 0000000..3d8b40d
--- /dev/null
+++ b/doc/bin/mddc-add-block-sym.html
@@ -0,0 +1,92 @@
+<!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>mddc-add-block-sym</title>
+ <meta name="Description" content="Reference of the mddc-add-block-sym program." />
+ <meta name="Keywords" content="mdevd-conf dev blockdev symlink disk" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/mdevd-conf">mdevd-conf</a>
+ <br />
+ <a href="//0x53.net/software">Software</a>
+ <br />
+ <a href="//0x53.net">0x53.net</a>
+ </p>
+ </header>
+ <body>
+ <h1>The mddc-add-block-sym program</h1>
+ <p>
+ mddc-add-block-sym is a helper script to create
+ symlinks at <code>/dev/disk/by-*</code>.
+ </p>
+ <h2>Interface</h2>
+ <pre> mddc-add-block-sym</pre>
+ <ul>
+ <li>
+ mddc-add-block-sym takes no arguments.
+ </li>
+ <li>
+ It reads the <code>MDEV</code> environment variable,
+ if it is empty it exits 100.
+ </li>
+ <li>
+ It creates PARTUUID symlinks at <code>/dev/disk/by-partuuid/</code>,
+ using <code>/sys/block</code> to get the PARTUUID.
+ </li>
+ <li>
+ It creates DISKSEQ symlinks at <code>/dev/disk/by-diskseq/</code>,
+ using <code>/sys/block</code> to get the DISKSEQ.
+ </li>
+ <li>
+ It creates hardware ID symlinks at <code>/dev/disk/by-id/</code>,
+ using <code>/sys/block</code> to get the ID.
+ </li>
+ <li>
+ It checks whether it can execute <code>blkid</code>.
+ If this is the case:
+ </li>
+ <ul>
+ <li>
+ It creates UUID symlinks at <code>/dev/disk/by-uuid/</code>,
+ using <code>blkid</code> to get the UUID.
+ </li>
+ <li>
+ It creates LABEL symlinks at <code>/dev/disk/by-label/</code>,
+ using <code>blkid</code> to get the LABEL.
+ </li>
+ </ul>
+ </ul>
+ <h2>Exit codes</h2>
+ <ul>
+ <li>
+ 100 if a critical environment variable is missing.
+ </li>
+ <li>
+ Since mddc-add-block-sym is an
+ <a href="https://skarnet.org/software/execline/">execline</a>
+ script, it exits with an approximation
+ of employed program that failed.
+ </li>
+ <li>
+ mddc-add-block-sym mostly uses
+ <a href="https://skarnet.org/software/execline/">execline</a>
+ software, the exit behaviour of which can be looked up on
+ their respective pages.
+ </li>
+ <li>
+ See also:
+ <a href="https://skarnet.org/software/execline/exitcodes.html">execline exit code handling</a>.
+ </li>
+ </ul>
+ <h2>Options</h2>
+ <ul>
+ <li>
+ There are no options to mddc-add-block-sym.
+ </li>
+ </ul>
+ </body>
+</html>
diff --git a/doc/bin/mddc-del-block-sym.html b/doc/bin/mddc-del-block-sym.html
new file mode 100644
index 0000000..be8caca
--- /dev/null
+++ b/doc/bin/mddc-del-block-sym.html
@@ -0,0 +1,72 @@
+<!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>mddc-del-block-sym</title>
+ <meta name="Description" content="Reference of the mddc-del-block-sym program." />
+ <meta name="Keywords" content="mdevd-conf dev blockdev symlink disk" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/mdevd-conf">mdevd-conf</a>
+ <br />
+ <a href="//0x53.net/software">Software</a>
+ <br />
+ <a href="//0x53.net">0x53.net</a>
+ </p>
+ </header>
+ <body>
+ <h1>The mddc-del-block-sym program</h1>
+ <p>
+ mddc-del-block-sym is a helper script to create
+ symlinks at <code>/dev/disk/by-*</code>.
+ </p>
+ <h2>Interface</h2>
+ <pre> mddc-del-block-sym</pre>
+ <ul>
+ <li>
+ mddc-del-block-sym takes no arguments.
+ </li>
+ <li>
+ It reads the <code>MDEV</code> environment variable,
+ if it is empty it exits 100.
+ </li>
+ <li>
+ for each <code><var>${FILE}</var></code> in <code>/dev/disk/*/</code>
+ it checks whether it is a symlink to <code><var>${MDEV}</var></code>
+ or its partition and, if this is the case,
+ deletes <code><var>${FILE}</var></code>.
+ </li>
+ </ul>
+ <h2>Exit codes</h2>
+ <ul>
+ <li>
+ 100 if a critical environment variable is missing.
+ </li>
+ <li>
+ Since mddc-del-block-sym is an
+ <a href="https://skarnet.org/software/execline/">execline</a>
+ script, it exits with an approximation
+ of employed program that failed.
+ </li>
+ <li>
+ mddc-del-block-sym mostly uses
+ <a href="https://skarnet.org/software/execline/">execline</a>
+ software, the exit behaviour of which can be looked up on
+ their respective pages.
+ </li>
+ <li>
+ See also:
+ <a href="https://skarnet.org/software/execline/exitcodes.html">execline exit code handling</a>.
+ </li>
+ </ul>
+ <h2>Options</h2>
+ <ul>
+ <li>
+ There are no options to mddc-del-block-sym.
+ </li>
+ </ul>
+ </body>
+</html>
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>
diff --git a/doc/mdevd-conf-0.1.0.0.tar.gz b/doc/mdevd-conf-0.1.0.0.tar.gz
new file mode 100644
index 0000000..1251546
--- /dev/null
+++ b/doc/mdevd-conf-0.1.0.0.tar.gz
Binary files differ
diff --git a/doc/mdevd-conf-0.1.0.0.tar.gz.sha256 b/doc/mdevd-conf-0.1.0.0.tar.gz.sha256
new file mode 100644
index 0000000..f0491c1
--- /dev/null
+++ b/doc/mdevd-conf-0.1.0.0.tar.gz.sha256
@@ -0,0 +1 @@
+13e6cdac5e80bd9637549c319724f7f1d5429d2a386371c4676dbd4611bc59e5 mdevd-conf-0.1.0.0.tar.gz
diff --git a/doc/setup.html b/doc/setup.html
new file mode 100644
index 0000000..c46205f
--- /dev/null
+++ b/doc/setup.html
@@ -0,0 +1,47 @@
+<!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 setup</title>
+ <meta name="Description" content="Setup of mdevd-conf." />
+ <meta name="Keywords" content="mdevd mdevd-conf setup" />
+ </head>
+ <header>
+ <p>
+ <a href="./">mdevd-conf</a>
+ <br />
+ <a href="../">Software</a>
+ <br />
+ <a href="/">0x53.net</a>
+ </p>
+ </header>
+ <body>
+ <h1>mdevd-conf setup</h1>
+ <ul>
+ <li>
+ Install mdevd-conf.
+ </li>
+ <li>
+ symlink or copy <code>mdev.conf</code>
+ from the directory of installation
+ (usually <code>/usr/local/lib/mdevd-conf/etc/mdev.conf</code>
+ or <code>/package/admin/mdevd-conf/etc/mdev.conf</code>)
+ to <code>/etc/mdev.conf</code>.
+ </li>
+ <li>
+ Start
+ <code><a href="https://skarnet.org/software/mdevd/mdevd.html">mdevd</a></code>,
+ preferable through a service managere like
+ <a href="../goetia/">goetia</a>.
+ </li>
+ <li>
+ Run
+ <code><a href="https://skarnet.org/software/mdevd/mdevd-coldplug.html">mdevd-coldplug</a></code>
+ to have <code>mdevd</code> apply <code>/etc/mdev.conf</code>
+ to <code>/dev</code>.
+ </li>
+ </ul>
+ </body>
+</html>
diff --git a/package/info b/package/info
index 5e659fb..f83461f 100644
--- a/package/info
+++ b/package/info
@@ -1,4 +1,4 @@
package=mdevd-conf
-version=0.0.0.1
+version=0.1.0.0
category=admin
package_macro_name=MDEVD-CONF
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-14 07:32:43 +0000