summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2015-03-12 22:09:38 +0000
committerEric Wong <e@80x24.org>2015-04-22 18:57:39 +0000
commit548e1e67d314f6ebd17df37ece0ee20632462f6f (patch)
tree74b3248124a6a32e0439b33e0e6cf782b6c42414
parent1c4843708b0fddbb9d196d9419b220f82707ed61 (diff)
Due to the prevalence of socket activation in modern init systems,
we shall document UNICORN_FD (previously an implementation detail)
in the manpage.
-rw-r--r--Documentation/unicorn.1.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/unicorn.1.txt b/Documentation/unicorn.1.txt
index 376a6c6..b03962e 100644
--- a/Documentation/unicorn.1.txt
+++ b/Documentation/unicorn.1.txt
@@ -163,6 +163,13 @@ set in the old master process are inherited by the new master process.
 Unicorn only uses (and will overwrite) the UNICORN_FD environment
 variable internally when doing transparent upgrades.
 
+UNICORN_FD is a comma-delimited list of one or more file descriptors
+used to implement USR2 upgrades.  Init systems may bind listen sockets
+itself and spawn unicorn with UNICORN_FD set to the file descriptor
+numbers of the listen socket(s).  The unicorn CONFIG_FILE must still
+have the inherited listen socket parameters defined as in a normal
+startup, otherwise the socket will be closed.
+
 # SEE ALSO
 
 * unicorn_rails(1)