summaryrefslogtreecommitdiff
path: root/doc/index.html
blob: b4ce87fba0553beff0bd4eb5b15fc0d2dad95671 (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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>skabus - a Unix bus system</title>
    <meta name="Description" content="skabus - a Unix bus system" />
    <meta name="Keywords" content="skabus bus unix linux laurent bercot ska skarnet dbus ubus" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> skabus </h1>

<h2> What is it&nbsp;? </h2>

<p>
 skabus is a suite of programs and libraries for Unix systems
that aim to implement a bus, i.e. a many-to-many interprocess
communication mechanism.
</p>

<p>
 It is very much a work in progress, and won't be complete for a long time.
For now, it looks like a random collection of tools, even though there is
a consistent vision behind them.
</p>

<hr />

<!--
<ul>
 <li> <a href="why.html">Why skabus&nbsp;?</a> Why not just use D-Bus&nbsp;?</li>
 <li> <a href="overview.html">An overview of skabus</a> </li>
</ul>

<hr />
-->

<h2> Installation </h2>

<h3> Requirements </h3>

<ul>
 <li> A POSIX-compliant system with a standard C development environment </li>
 <li> GNU make, version 3.81 or later </li>
 <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
2.13.0.0 or later </li>
 <li> <a href="//skarnet.org/software/execline/">execline</a> version
2.9.1.0 or later </li>
 <li> <a href="//skarnet.org/software/s6/">s6</a> version
2.11.2.0 or later </li>

</ul>

<h3> Licensing </h3>

<p>
 skabus is free software. It is available under the
<a href="http://opensource.org/licenses/ISC">ISC license</a>.
</p>

<h3> Download </h3>

<ul>
 <!-- <li> The current released version of skabus is <a href="skabus-0.0.1.0.tar.gz">0.0.1.0</a>. -->
 <li> There is no official numbered release version of skabus at the moment. </li>
 <li> But you can checkout a copy of the skabus git repository:
<pre> git clone git://git.skarnet.org/skabus </pre> </li>
</ul>

<h3> Compilation </h3>

<ul>
 <li> See the enclosed INSTALL file for installation details. </li>
</ul>

<h3> Upgrade notes </h3>

<ul>
 <li> <a href="upgrade.html">This page</a> lists the differences to be aware of between
the previous versions of skabus and the current one. </li>
</ul>

<hr />

<h2> Reference </h2>

<h3> Commands </h3>

<p>
 All these commands exit 111 if they encounter a temporary error or
hardware error, and
100 if they encounter a permanent error - such as a misuse. Short-lived
commands exit 0 on success. Other exit codes are documented in the
relevant page.
</p>

<h4> Publication/subscription </h4>

<ul>
 <li> The <a href="skabus-dyntee.html">skabus-dyntee</a> program </li>
 <li> The <a href="skabus-dynteed.html">skabus-dynteed</a> program </li>
 <li> The <a href="skabus-dyntee-client.html">skabus-dyntee-client</a> program </li>
</ul>

<h4> Remote procedure calls </h4>

<ul>
 <li> The <a href="skabus-rpc-daemon.html">skabus-rpc-daemon</a> program </li>
 <li> The <a href="skabus-rpcd.html">skabus-rpcd</a> program </li>
</ul>

<h3> Libraries </h3>

<ul>
 <li> The <a href="libskabus/">skabus</a> library interface </li>
</ul>

<hr />

<a name="related">
<h2> Related resources </h2>
</a>

<h3> skabus discussion </h3>

<ul>
 <li> <tt>skabus</tt> is discussed on the
<a href="//skarnet.org/lists/#skaware">skaware</a> mailing-list. </li>
</ul>

<h3> Similar work </h3>

<ul>
 <li> <a href="http://www.freedesktop.org/wiki/Software/dbus/">D-Bus</a> is
the most widely used Linux bus. It's also a horrible, inefficient mess. </li>
 <li> <a href="https://openwrt.org/docs/techref/ubus">ubus</a> is
OpenWrt's micro-bus architecture. </li>
</ul>

</body>
</html>