diff options
| author | bnewbold <bnewbold@robocracy.org> | 2016-10-12 03:57:01 -0700 |
|---|---|---|
| committer | bnewbold <bnewbold@robocracy.org> | 2016-10-12 03:57:01 -0700 |
| commit | d5df25162a58f2a7bcb41c1d46bccf084c3231d0 (patch) | |
| tree | 1db012947d35b09f9689b62b21d6cc788ecf1564 | |
| parent | 8d2bf9d3ccc6688281370812ed7d718f32f43ccd (diff) | |
| download | einhyrningsins-d5df25162a58f2a7bcb41c1d46bccf084c3231d0.tar.gz einhyrningsins-d5df25162a58f2a7bcb41c1d46bccf084c3231d0.zip | |
docs in progress
| -rw-r--r-- | doc/einhyrningsins.1.ronn | 38 | ||||
| -rw-r--r-- | doc/refs.txt | 3 |
2 files changed, 38 insertions, 3 deletions
diff --git a/doc/einhyrningsins.1.ronn b/doc/einhyrningsins.1.ronn index c912f92..e256246 100644 --- a/doc/einhyrningsins.1.ronn +++ b/doc/einhyrningsins.1.ronn @@ -3,11 +3,43 @@ einhyrningsins(1) -- graceful restarts for socket-based daemons ## SYNOPSIS -lorem +`einhyrningsins` [OPTIONS] -- PROGRAM [PROGRAM_ARGS] ## DESCRIPTION -ipsum +This is a socket multiplexer featuring graceful restarts. It runs multiple +copies of the child program that are passed a shared socket (or more than one) +to bind to and accept connections from. Graceful rolling restarts enable +updates of the child program with zero downtime and no dropped connections. + +This program requires special support in the child program to achive the +graceful restarts and bind to inherited file descriptors indicated by +environment variables. + +einhyrningsins(1) is a partially-comparible re-implementation of einhorn(1) (a +Ruby program) in Rust. Einhorn itself derived from Unicorn. + + + -4, --ipv4-only only accept IPv4 connections + -6, --ipv6-only only accept IPv6 connections + -m, --manual manual (explicit) acknowledge mode + -n, --number COUNT how many program copies to spawn + -b, --bind ADDR socket(s) to bind to + +* `-h`, `--help` + Print a help menu + --version print the version + -v, --verbose more debugging messages + +## STATUS + +This is a fun fun hobby project. Still in progress, and notably untested. + +## COPYRIGHT +Copyright 2016 Bryan Newbold +License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. +This is free software: you are free to change and redistribute it. There is NO +WARRANTY, to the extent permitted by law. ## SEE ALSO -`einhorn (1)` +`einhorn (1)`, `einhyrningsinsctl(1)` diff --git a/doc/refs.txt b/doc/refs.txt index 42e9512..98e86f1 100644 --- a/doc/refs.txt +++ b/doc/refs.txt @@ -11,3 +11,6 @@ http://jvns.ca/blog/2016/06/13/should-you-be-scared-of-signals/ "Reap zombie processes using a SIGCHLD handler" http://www.microhowto.info/howto/reap_zombie_processes_using_a_sigchld_handler.html + +manpages: +- https://linux.die.net/man/2/waitpid |