diff options
Diffstat (limited to 'doc/bin/user-run.html')
| -rw-r--r-- | doc/bin/user-run.html | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/bin/user-run.html b/doc/bin/user-run.html new file mode 100644 index 0000000..924849c --- /dev/null +++ b/doc/bin/user-run.html @@ -0,0 +1,78 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>user-run</title> + <meta name="Description" content="Run little scripts from the user supervision tree, providing reliability." /> + <meta name="Keywords" content="goetia s6 user supervision tree" /> + </head> + <header> + <p> + <a href="//0x53.net/software/goetia/goetia-base">goetia-base</a> + <br /> + <a href="//0x53.net/software/goetia">goetia</a> + <br /> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>The user-run program</h1> + <p> + The user-run program allows + to hand over the execution of commands to the + <a href="//0x53.net/software/goetia/supervisiontree.html#user">user supervision tree</a>. + </p> + <h2>Interface</h2> + <pre> user-run <em>prog...</em></pre> + <ul> + <li> + user-rc reads the <code>USER</code> environment variable, + if it is empty it exits 100. + </li> + <li> + It reads the <code>USERTREE</code> environment variable, + if it is empty it exits 100. + </li> + <li> + Internally, user-run invokes + <a href="https://skarnet.org/software/s6/s6-sudo.html">s6-sudo</a> + to connect to an + <a href="https://skarnet.org/software/s6/s6-sudod.html">s6-sudod</a> + instance provided by the user + <a href="//0x53.net/software/goetia/service/user/goetia-runner.html">goetia-runner</a>. + </li> + <li> + <code><em>prog...</em></code> is then transferred + to and executed by goetia-runner. + </li> + <li> + See + <a href="https://skarnet.org/software/s6/s6-sudo.html">s6-sudo</a> + and + <a href="https://skarnet.org/software/s6/s6-sudod.html">s6-sudod</a> + for configuration options and detailed information. + </li> + </ul> + <h2>Exit codes</h2> + <ul> + <li> + 100 if a critical environment variable is missing. + </li> + <li> + user-run behaves exactly as + <a href="https://skarnet.org/software/s6/s6-sudo.html">s6-sudo</a>. + </li> + </ul> + <h2>Options</h2> + <ul> + <li> + user-run takes the exact same options as + <a href="https://skarnet.org/software/s6/s6-sudoc.html">s6-sudoc</a>. + </li> + </ul> + </body> +</html> |