From aa3f93beafc17945adefc6148ff2eeb30b388d2c Mon Sep 17 00:00:00 2001 From: bnewbold Date: Mon, 17 Oct 2016 01:19:17 -0700 Subject: updating rendered manpage for github docs --- einhyrningsins.1.html | 66 +++++++++++++++++++++--------------------------- einhyrningsinsctl.1.html | 14 +++++++--- 2 files changed, 39 insertions(+), 41 deletions(-) diff --git a/einhyrningsins.1.html b/einhyrningsins.1.html index 10f54ff..ed1f39f 100644 --- a/einhyrningsins.1.html +++ b/einhyrningsins.1.html @@ -62,6 +62,7 @@ NAME SYNOPSIS DESCRIPTION + OPTIONS CHILD API HISTORY STATUS @@ -86,7 +87,7 @@

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 @@ -98,43 +99,33 @@ 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.

- +will be considered unhealthy and get restarted.

+
--drop-env-var VAR

Clears the given variable from the child's environment. All other variables +are passed through by default. This argument can be repeated.

+
-d, --socket-path PATH

Where to create the control socket (default: /tmp/einhorn.sock).

+
-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 @@ -157,26 +148,27 @@ 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 2016 Bryan Newbold -License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html. +

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)

+

einhorn(1), einhyrningsinsctl(1), socket(7)

    diff --git a/einhyrningsinsctl.1.html b/einhyrningsinsctl.1.html index 1c4096b..1b4910a 100644 --- a/einhyrningsinsctl.1.html +++ b/einhyrningsinsctl.1.html @@ -62,6 +62,7 @@ NAME SYNOPSIS DESCRIPTION + OPTIONS COPYRIGHT SEE ALSO @@ -83,12 +84,14 @@

    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.

    -d, --socket-path PATH

    Where to look for the control socket (a UNIX domain socket). @@ -100,14 +103,17 @@ Defaults to /tmp/einhorn.sock.

    -

    Copyright 2016 Bryan Newbold -License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html. +

    # +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)

    +

    # +einhorn(1), einhyrningsins(1)

      -- cgit v1.2.3