summaryrefslogtreecommitdiffstats
path: root/doc/bin/mddc-add-block-sym.html
blob: 3d8b40d477c7579276b8168a13c0a2876a59fd32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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>