summaryrefslogtreecommitdiffstats
path: root/doc/index.html
blob: 5cb1cd0e1484c72719daba41feca9ce96d77d837 (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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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>