From 87c5b2118efcee65eeda3f743d081ea9c2b866d9 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 15 Jan 2015 20:14:44 +0000 Subject: Move Unix domain utilities and access control utilites, as well as the accessrules library, from s6-networking to here --- doc/libs6/index.html | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 doc/libs6/index.html (limited to 'doc/libs6/index.html') diff --git a/doc/libs6/index.html b/doc/libs6/index.html new file mode 100644 index 0000000..9fe7e65 --- /dev/null +++ b/doc/libs6/index.html @@ -0,0 +1,72 @@ + + + + + s6: the s6 library interface + + + + + + +

+s6
+Software
+skarnet.org +

+ +

The `s6` library interface

+ +

General information

+ +

+ libs6 is a collection of utility +C interfaces, used in the s6 executables. +

+ +

Compiling

+ +

Make sure the s6 headers, as well as the skalibs headers, +are visible in your header search path.
Use #include <s6/s6.h>

+ +

Linking

+ +

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

+ +

Programming

+ +

+ The s6/s6.h header is actually a +concatenation of other headers: +the libs6net is separated into several modules, each of them with its +own header. +

+ +

The s6/accessrules.h header +provides functions to check credentials against configuration files.
The s6/ftrigr.h header provides +functions to subscribe to fifodirs and be notified of events.
The s6/ftrigw.h header provides +functions to manage fifodirs and send notifications to them.
The s6/s6lock.h header provides +functions to acquire locks with a timeout.

+ + + -- cgit v1.2.3

The s6 library interface

General information

Compiling

Linking

Programming

The `s6` library interface