From 36eeb20b4c68dd630adb7c8c473343f5491a55ea Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Mon, 16 Feb 2015 13:11:20 +0000 Subject: More doc typo fixes --- doc/s6-fdholderd.html | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/s6-fdholderd.html b/doc/s6-fdholderd.html index ab05665..ec04d74 100644 --- a/doc/s6-fdholderd.html +++ b/doc/s6-fdholderd.html @@ -22,9 +22,9 @@ s6-fdholder-daemon fd-holding server. It assumes that its stdin is a bound and listening Unix -domain socket, and -it accepts connections from clients connecting to it, and stores and -retrieves file descriptors on their behalf. +domain socket; +it accepts connections from clients connecting to that socket, +and stores and retrieves file descriptors on their behalf.

Interface

@@ -38,8 +38,10 @@ retrieves file descriptors on their behalf. bound and listening SOCK_STREAM Unix domain socket which is its standard input.
  • Depending on the verbosity level, it logs what it does to stderr.
    • -
  • It runs until killed by a signal. Depending on the received -signal, it may kill its children before exiting.
    • +
  • It runs until killed by a signal (normally SIGTERM). +When s6-fdholderd is killed, all the fds it is currently holding are +lost; if they need to be preserved, the admin should make sure to +transfer them beforehand.
  • Client connections are short-lived. Clients generally perform one operation, then disconnect.
  • Possible operations include: @@ -149,7 +151,7 @@ stored in either a rulesfile in the CDB format, or in a rulesdir, i.e. a directory in the filesystem following a certain format. s6-fdholderd will refuse to run if neither the -i -nor the -x option have been provided. +nor the -x option has been provided.

    @@ -173,7 +175,7 @@ the client is authorized to do.

    By default, no client is allowed to do anything - not even connect to the server. Even root, the super-user, will be denied -access. That's why +access. That is why it is essential to create a sensible ruleset prior to running the server in order to do anything useful.

    @@ -316,7 +318,7 @@ you can always run a separate s6-fdholderd instance in a private directory with a configuration tailored to your needs - and you can even make the name of the listening socket private. s6-fdholderd is lightweight, you can start as many instances as you need, -and you can run them as long as you need then kill them with SIGTERM. +and you can run them as long as you need then kill them with SIGTERM.
  • s6-fdholderd pre-allocates its storage at start, in the stack. It uses a small amount of heap memory for communication with a client, but frees it as soon as the client disconnects. It should never run out of memory in -- cgit v1.2.3