S6-FDHOLDER-GETDUMP(8)

NAME
s6-fdholder-getdump - connect to an s6-fdholderd daemon listening on a Unix domain socket, and retrieves its entire state: file descriptors with their identifiers and expiration dates

SYNOPSIS
s6-fdholder-getdump [-t timeout] path prog...

DESCRIPTION
s6-fdholder-getdump connects to an s6-fdholderd(8) server process listening on path.

It retrieves a copy of the whole set of file descriptors stored in this daemon, including their identifiers and expiration dates.

It then executes into prog... with the additional open descriptors and the additional environment variables.

Getting the whole state of an s6-fdholderd(8) daemon requires specific privileges. Make sure you properly configure s6-fdholderd(8) access rights so your client can perform that operation.

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 (connecting to the wrong socket, for instance).

ENVIRONMENT
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[1]. If the file descriptor is not supposed to expire, this environment variable is not defined.

EXIT STATUS
On success, the program doesn't exit; instead, it execs into prog....

1   The server denied the operation. The meanings of the error messages are explained in s6-fdholder-error-codes(7).

100 Wrong usage.

111 System call failed - this includes attempting to connect to a nonexistent socket, or one where no s6-fdholderd(8) daemon is listening.

EXAMPLES
    s6-fdholder-getdump /service/fdholderd/s s6-fdholder-setdump /service/fdholderd-2/s

will get the state of the s6-fdholderd(8) daemon listening on the /service/fdholderd/s socket, and transmit it to the other s6-fdholderd(8) daemon listening on the /service/fdholderd-2/s socket. Note that in this precise case, the s6-fdholder-transferdump(8) program does the same thing more efficiently.

SEE ALSO
s6-fdholder-daemon(8), s6-fdholder-delete(8), s6-fdholder-list(8), s6-fdholder-retrieve(8), s6-fdholder-setdump(8), s6-fdholder-store(8), s6-fdholder-transferdump(8), s6-fdholderd(8),

[1] https://cr.yp.to/libtai/tai64.html#tai64n

This man page is ported from the authoritative documentation at: https://skarnet.org/software/s6/s6-fdholder-getdump.html

AUTHORS
Laurent Bercot Alexis <flexibeast@gmail.com> (man page port)