diff options
Diffstat (limited to 'doc/bin')
| -rw-r--r-- | doc/bin/mddc-add-block-sym.html | 92 | ||||
| -rw-r--r-- | doc/bin/mddc-del-block-sym.html | 72 |
2 files changed, 164 insertions, 0 deletions
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> |