diff options
| -rw-r--r-- | doc/einhyrningsins.1.ronn | 17 | ||||
| -rw-r--r-- | doc/einhyrningsinsctl.1.ronn | 7 | ||||
| -rw-r--r-- | doc/index.txt | 3 |
3 files changed, 20 insertions, 7 deletions
diff --git a/doc/einhyrningsins.1.ronn b/doc/einhyrningsins.1.ronn index 3a1d1c0..d148c9e 100644 --- a/doc/einhyrningsins.1.ronn +++ b/doc/einhyrningsins.1.ronn @@ -7,7 +7,7 @@ einhyrningsins(1) -- graceful restarts for socket-based daemons ## DESCRIPTION -`Einhyrningsins` is a socket multiplexer featuring graceful restarts. It runs +`einhyrningsins` is a socket multiplexer featuring graceful restarts. It runs multiple copies of a child program, each of which are passed a shared socket (or multiple shared sockets) to bind(2) to and accept(2) connections from. Graceful, rolling restarts enable updates of the child program with zero @@ -19,6 +19,8 @@ to bind to inherited file descriptors (as indicated by environment variables). Child programs must also be able to run in parallel: for example, each copy must not try to write to the same output file without some form of locking. +## OPTIONS + * `-n`, `--number` <COUNT>: How many child processes to spawn. @@ -58,13 +60,13 @@ must not try to write to the same output file without some form of locking. * `-d`, `--socket-path` <PATH>: Where to create the control socket (default: `/tmp/einhorn.sock`). - * `-r`, `--retries` <COUNT> + * `-r`, `--retries` <COUNT>: How many times to attempt re-spawning before giving up. ## CHILD API -`Einhyrningsins` creates children by fork(1)-ing a new process and +`einhyrningsins` creates children by fork(1)-ing a new process and execve(1)-ing to run the proces itself. For every socket specified by a `-b` flag, a socket is bound in the main `einhyrningsins` process and then explicitly flagged to be passed on to the child processes. This means the child @@ -86,21 +88,24 @@ containing the child's PID number: ## HISTORY -`Einhyrningsins` is a partially-comparible re-implementation of einhorn(1) (a +`einhyrningsins` is a partially-comparible re-implementation of einhorn(1) (a Ruby program) in Rust. Einhorn itself derived from Unicorn. -The word "Einhyrningsins" is Icelandic for unicorn. +The word "einhyrningsins" is Icelandic for unicorn. ## STATUS -`Einhyrningsins` is a for-fun hobby project. It is not feature complete, fully +`einhyrningsins` is a for-fun hobby project. It is not feature complete, fully documented, or tested. ## 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), einhyrningsinsctl(1), socket(7) diff --git a/doc/einhyrningsinsctl.1.ronn b/doc/einhyrningsinsctl.1.ronn index 37e8d70..f8de6b5 100644 --- a/doc/einhyrningsinsctl.1.ronn +++ b/doc/einhyrningsinsctl.1.ronn @@ -7,12 +7,14 @@ einhyrningsinsctl(1) -- control of einhyrningsins ## DESCRIPTION -`Einhyrningsinsctl` is a shell client for einhyrningsins(1), which connects to +`einhyrningsinsctl` is a shell client for einhyrningsins(1), which connects to a control socket (UNIX domain socket) and either sends a single command (via `-e`) or acts as an interactive shell. For a list of valid commands, start in shell mode and run `help`. +## OPTIONS + * `-e`, `--execute` <CMD>: Instead of starting a shell, just execute the CMD. @@ -27,10 +29,13 @@ For a list of valid commands, start in shell mode and run `help`. Prints version number ## 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), einhyrningsins(1) diff --git a/doc/index.txt b/doc/index.txt index d2a3714..781ba1a 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -3,5 +3,8 @@ einhyrningsins(1) einhyrningsins.1 einhyrningsinsctl(1) einhyrningsinsctl.1 +# man pages +socket(7) http://man7.org/linux/man-pages/man7/socket.7.html + # External links einhorn(1) https://github.com/stripe/einhorn |