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 ++++++++++++++++++++++++++++++++ 2 files changed, 164 insertions(+) create mode 100644 doc/bin/mddc-add-block-sym.html create mode 100644 doc/bin/mddc-del-block-sym.html (limited to 'doc/bin') 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. +

+ + -- cgit v1.2.3