doc/libs6/index.html


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

<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>s6: the s6 library interface</title>
    <meta name="Description" content="s6: the s6 library interface" />
    <meta name="Keywords" content="s6 s6 libs6 library" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

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

<h1> The <tt>s6</tt> library interface </h1>

<h2> General information </h2>

<p>
 <tt>libs6</tt> is a collection of utility
C interfaces, used in the s6 executables.
</p>

<h2> Compiling </h2>

<ul>
 <li> Make sure the s6 headers, as well as the skalibs headers,
are visible in your header search path. </li>
 <li> Use <tt>#include &lt;s6/s6.h&gt;</tt> </li>
</ul>

<h2> Linking </h2>

<ul>
 <li> Make sure the s6 libraries, as well as the skalibs
libraries, are visible in your library search path. </li>
 <li> Link against <tt>-ls6</tt> and <tt>-lskarnet</tt>.
If you're using socket functions (which is the case with
<a href="ftrigr.html">libftrigr</a>, for instance, add
<tt>`cat $sysdeps/socket.lib`</tt> to your command line.
If you're using timed functions involving TAI timestamps
(which is also the case with <a href="ftrigr.html">libftrigr</a>
for instance), add
<tt>`cat $sysdeps/sysclock.lib`</tt>. <tt>$sysdeps</tt>
stands for your skalibs sysdeps directory. </li>
</ul>

<h2> Programming </h2>

<p>
 The <tt>s6/s6.h</tt> header is actually a
concatenation of other headers:
the libs6 is separated into several modules, each of them with its
own header.
</p>

<ul>
 <li> The <a href="accessrules.html">s6/accessrules.h</a> header
provides functions to check credentials against configuration files. </li>
 <li> The <a href="ftrigr.html">s6/ftrigr.h</a> header provides
functions to subscribe to fifodirs and be notified of events. </li>
 <li> The <a href="ftrigw.html">s6/ftrigw.h</a> header provides
functions to manage fifodirs and send notifications to them. </li>
 <li> The <a href="fdholder.html">s6/fdholder.h</a> header provides
functions to communicate with a
<a href="../s6-fdholderd.html">s6-fdholderd</a> server and exchange
file descriptors with it. </li>
</ul>

</body>
</html>