From 56daa1ebc4cf4a245b10e931372c5a04d15e5253 Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:40:28 +0100 Subject: Add doc --- doc/bin/mddc-add-block-sym.html | 92 ++++++++++++++++++++++++++ doc/bin/mddc-del-block-sym.html | 72 +++++++++++++++++++++ doc/index.html | 122 +++++++++++++++++++++++++++++++++++ doc/mdevd-conf-0.1.0.0.tar.gz | Bin 0 -> 8120 bytes doc/mdevd-conf-0.1.0.0.tar.gz.sha256 | 1 + doc/setup.html | 47 ++++++++++++++ 6 files changed, 334 insertions(+) create mode 100644 doc/bin/mddc-add-block-sym.html create mode 100644 doc/bin/mddc-del-block-sym.html create mode 100644 doc/index.html create mode 100644 doc/mdevd-conf-0.1.0.0.tar.gz create mode 100644 doc/mdevd-conf-0.1.0.0.tar.gz.sha256 create mode 100644 doc/setup.html (limited to 'doc') 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 @@ + + + + + + + mddc-add-block-sym + + + +

+ mdevd-conf +
+ Software +
+ 0x53.net +

+ +

The mddc-add-block-sym program

+ mddc-add-block-sym is a helper script to create + symlinks at /dev/disk/by-*. +

Interface

     mddc-add-block-sym

+ mddc-add-block-sym takes no arguments. +
+ It reads the MDEV environment variable, + if it is empty it exits 100. +
+ It creates PARTUUID symlinks at /dev/disk/by-partuuid/, + using /sys/block to get the PARTUUID. +
+ It creates DISKSEQ symlinks at /dev/disk/by-diskseq/, + using /sys/block to get the DISKSEQ. +
+ It creates hardware ID symlinks at /dev/disk/by-id/, + using /sys/block to get the ID. +
+ It checks whether it can execute blkid. + If this is the case: +

+ It creates UUID symlinks at /dev/disk/by-uuid/, + using blkid to get the UUID. +
+ It creates LABEL symlinks at /dev/disk/by-label/, + using blkid to get the LABEL. +

Exit codes

+ 100 if a critical environment variable is missing. +
+ Since mddc-add-block-sym is an + execline + script, it exits with an approximation + of employed program that failed. +
+ mddc-add-block-sym mostly uses + execline + software, the exit behaviour of which can be looked up on + their respective pages. +
+ See also: + execline exit code handling. +

Options

+ There are no options to mddc-add-block-sym. +

+ + 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 @@ + + + + + + + mddc-del-block-sym + + + +

+ mdevd-conf +
+ Software +
+ 0x53.net +

+ +

The mddc-del-block-sym program

+ mddc-del-block-sym is a helper script to create + symlinks at /dev/disk/by-*. +

Interface

     mddc-del-block-sym

+ mddc-del-block-sym takes no arguments. +
+ It reads the MDEV environment variable, + if it is empty it exits 100. +
+ for each ${FILE} in /dev/disk/*/ + it checks whether it is a symlink to ${MDEV} + or its partition and, if this is the case, + deletes ${FILE}. +

Exit codes

+ 100 if a critical environment variable is missing. +
+ Since mddc-del-block-sym is an + execline + script, it exits with an approximation + of employed program that failed. +
+ mddc-del-block-sym mostly uses + execline + software, the exit behaviour of which can be looked up on + their respective pages. +
+ See also: + execline exit code handling. +

Options

+ There are no options to mddc-del-block-sym. +

+ + 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 @@ + + + + + + + mdevd-conf + + + +

+ Software +
+ 0x53.net +

+ +

mdevd-conf

What is it?

+ mdevd-conf is a ready to use set of + a configuration file and + helper scripts for + mdevd + to set up + basic userspace device management. +

+ It aims to allow replacing + systemd-udevd + with the caveat of lacking libudev. + This lack can be partially compensated for by using + libudev-zero. + It is currently very hard to switch away from + systemd-udevd + on desktop machines using a + freedesktop.org + based + Wayland + or + X.Org + software stack. +

+ On desktops based on + Arcan + or on a server systems, however, it is possible + to switch from systemd-udevd to mdevd(-conf). +

+ setup +

Installation

Requirements

+ A set of POSIX tools + as well as + a set of Linux specific tools. + As described on the + POSIX and kernel specific requirements page. +
+ A POSIX-compliant implementation of make, or GNU make +
+ execline. + It is a run-time requirement. +
+ mdevd + compiled with + execline + support. + It is a run-time requirement. +

Licensing

+ mdevd-conf is free software. It is available under the + ISC license. +

Download

+ The current released version of mdevd-conf is + 0.1.0.0. + You can access its checksum + here. +
+ Alternatively, you can checkout a copy of the + mdevd-conf git repository: +
```
git clone git://git.0x53.net/mdevd-conf
```
+

Compilation

+ See the enclosed INSTALL file for installation details. +

Reference

Commands

+ mddc-add-block-sym +
+ mddc-del-block-sym +

+ + 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 Binary files /dev/null and b/doc/mdevd-conf-0.1.0.0.tar.gz 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 @@ + + + + + + + mdevd-conf setup + + + +

+ mdevd-conf +
+ Software +
+ 0x53.net +

+ +

mdevd-conf setup

+ Install mdevd-conf. +
+ symlink or copy mdev.conf + from the directory of installation + (usually /usr/local/lib/mdevd-conf/etc/mdev.conf + or /package/admin/mdevd-conf/etc/mdev.conf) + to /etc/mdev.conf. +
+ Start + mdevd, + preferable through a service managere like + goetia. +
+ Run + mdevd-coldplug + to have mdevd apply /etc/mdev.conf + to /dev. +

+ + -- cgit v1.2.3