diff options
| author | PS <p@0x53.net> | 2026-02-07 10:20:30 +0100 |
|---|---|---|
| committer | PS <p@0x53.net> | 2026-02-07 10:20:30 +0100 |
| commit | 5e95d487982b9362b544139b98d1da55fa6ef78c (patch) | |
| tree | 1abf6d91f9e6d0b6d0ac7b7d759663f2531eb51b /doc/bin/oneshot-make.html | |
| parent | f7df2f7bb6abbea365cccb1345dcf1a1b7a80797 (diff) | |
| download | goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.gz goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.bz2 goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.zip | |
Add doc
Diffstat (limited to 'doc/bin/oneshot-make.html')
| -rw-r--r-- | doc/bin/oneshot-make.html | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/doc/bin/oneshot-make.html b/doc/bin/oneshot-make.html new file mode 100644 index 0000000..1b285c6 --- /dev/null +++ b/doc/bin/oneshot-make.html @@ -0,0 +1,101 @@ +<!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>oneshot-make</title> + <meta name="Description" content="Helper script to generate s6-rc oneshot source directories from a commandline." /> + <meta name="Keywords" content="goetia s6-rc oneshot source directory" /> + </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 oneshot-make program</h1> + <p> + oneshot-make contains boilerplate code + required to create the + <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">source directory</a> + of a oneshot service + based on strings. + </p> + <h2>Interface</h2> + <pre> oneshot-make <em>workingdir</em> <em>name</em> <em>upscript</em> <em>downscript</em> <em>dependencies</em></pre> + <ul> + <li> + <code><em>dependencies</em></code> can only be one of <code>"dependency1 dependency2 ..." | none</code>. + </li> + <li> + oneshot-make creates the directory <code><em>workingdir</em>/<em>name</em></code> + </li> + <li> + it creates the file <code><em>workingdir</em>/<em>name</em>/type</code> + and writes the line <code>oneshot</code> to it. + </li> + <li> + it creates the file <code><em>workingdir</em>/<em>name</em>/up</code> + and writes <code><em>upscript</em></code> to it. + </li> + <li> + it creates the file <code><em>workingdir</em>/<em>name</em>/down</code> + and writes <code><em>downscript</em></code> to it. + </li> + <li> + If <code><em>dependencies</em></code> is not <code>none</code>: + <ul> + <li> + The directory + <code><em>workingdir</em>/<em>name</em>/dependencies.d</code> + is created. + </li> + <li> + For each word <code>"dependency1 dependency2 ..."</code> in + <code><em>dependencies</em></code> separated by spaces, + a file + <code><em>workingdir</em>/<em>name</em>/dependencies.d/<em>dependency</em></code> + is created. + </li> + </ul> + </li> + </ul> + <h2>Exit codes</h2> + <ul> + <li> + 0: success + </li> + <li> + Since oneshot-make is an + <a href="https://skarnet.org/software/execline/">execline</a> + script, it exits with an approximation + of employed program that failed. + </li> + <li> + oneshot-make mostly uses + <a href="https://skarnet.org/software/execline/">execline</a> + and + <a href="https://skarnet.org/software/s6/">s6</a> + software, the exit behaviour of which can be looked up on + their respective pages. + </li> + <li> + See also: + <a href="https://skarnet.org/software/execline/exitcodes.html">execline exit code handling</a>. + </li> + </ul> + <h2>Options</h2> + <ul> + <li> + There are no otions to oneshot-make. + </li> + </ul> + </body> +</html> |