From 8bffa1c19fd05f4f04dad4b5b98f85b94f23113c Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Mon, 26 Jan 2015 22:26:57 +0000 Subject: - added s6-fdholder-delete(c) - small s6-fdholder-* fixes - s6-fdholder documentation (in review) - s6_svstatus_* bugfix (thanks Olivier Brunel) --- doc/s6-fdholder-getdumpc.html | 91 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 doc/s6-fdholder-getdumpc.html (limited to 'doc/s6-fdholder-getdumpc.html') diff --git a/doc/s6-fdholder-getdumpc.html b/doc/s6-fdholder-getdumpc.html new file mode 100644 index 0000000..acaf31a --- /dev/null +++ b/doc/s6-fdholder-getdumpc.html @@ -0,0 +1,91 @@ + + + + + s6: the s6-fdholder-getdumpc program + + + + + + +

+s6
+Software
+skarnet.org +

+ +

The `s6-fdholder-getdumpc` program

+ +

+s6-fdholder-getdumpc talks to a +fd-holding daemon on its open +descriptors 6 and 7, and retrieves its whole state, +then executes a program with as many more file descriptors open +as were given by the daemon, plus a modified environment to +describe the retrieved state. +

+ +

Interface

+ +

+     s6-fdholder-retrievec [ -t timeout ] prog...
+

+ +

s6-fdholder-retrievec expects to talk to a listening +s6-fdholderd program on its descriptors 6 and 7.
It retrieves a copy of the whole set of file descriptors +stored in that daemon, including their identifiers and expiration dates.
It then executes into prog... with the additional descriptors +and environment.

+ +

Options

+ +

-t timeout : if the operation cannot be +processed in timeout milliseconds, then fail with an error message. +Communications with the server should be near-instant, so this option is +only here to protect users against programming errors.

+ +

Environment format

+ +

+ prog... is executed with the following environment variables +set: +

+ +

S6_FD# : contains the number n of file +descriptors retrieved from the server.
Then, for every i between 0 and n-1 inclusive: +
- S6_FD_i : contains the number of the ith +open file descriptor.
- S6_FDID_i : contains the identifier of the +ith open file descriptor.
- S6_FDLIMIT_i : contains the expiration date of +the ith open file descriptor, if applicable. That date is stored in +external TAI64N +format.

+ +

Notes

+ +

s6-fdholder-getdumpc is the "internal" version of +s6-fdholder-getdump. It simply +expects to be run as a UCSPI client, i.e. talking to the server +over descriptors 6 and 7, instead of connecting to the server +itself.
The error messages for the s6-fdholder suite are explained +here.

+ + + -- cgit v1.3.1

The s6-fdholder-getdumpc program

Interface

Options

Environment format

Notes

The `s6-fdholder-getdumpc` program