summaryrefslogtreecommitdiffstats
path: root/doc/index.html
diff options
context:
space:
mode:
authorPS <p@0x53.net>2026-02-07 10:34:21 +0100
committerPS <p@0x53.net>2026-02-07 10:34:21 +0100
commiteb36640078ee6469427e85ca0695f8c920909ea0 (patch)
tree4e490a9b3b4e2f2c07bf261acde1d8ac70bb87d0 /doc/index.html
parent891a3316a22acdc57a2e65429f4d59ada268410c (diff)
downloadgoetia-freebsd-init-eb36640078ee6469427e85ca0695f8c920909ea0.tar.gz
goetia-freebsd-init-eb36640078ee6469427e85ca0695f8c920909ea0.tar.bz2
goetia-freebsd-init-eb36640078ee6469427e85ca0695f8c920909ea0.zip
Add doc
Diffstat (limited to 'doc/index.html')
-rw-r--r--doc/index.html113
1 files changed, 113 insertions, 0 deletions
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 0000000..38cb5a0
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,113 @@
+<!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>goetia-freebsd-init</title>
+ <meta name="Description" content="goetia-freebsd-init contains minimal init and shutdown scripts for FreeBSD." />
+ <meta name="Keywords" content="goetia s6 s6-rc FreeBSD init shutdown" />
+ </head>
+ <header>
+ <p>
+ <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>goetia-freebsd-init</h1>
+ <h2>What is it?</h2>
+ <p>
+ goetia-freebsd-init contains
+ init and shutdown scripts for running goetia on a
+ FreeBSD operating system.
+ Additionally, it contains
+ <a href="https://skarnet.org/software/s6/servicedir.html">service directories</a>
+ specific to this init system.
+ </p>
+ <hr>
+ <h2>Installation</h2>
+ <h3>Requirements</h3>
+ <ul>
+ <li>
+ A POSIX-compliant implementation of make, or GNU make
+ </li>
+ <li>
+ A set of POSIX and kernel specific tools as described in the general
+ <a href="//0x53.net/software/requirements.html">requirements</a>.
+ This is a runtime requirement
+ </li>
+ <li>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</a>,
+ this is a runtime requirement
+ </li>
+ <li>
+ The package and its runtime requirements need to reside at
+ the root partition.
+ </li>
+ </ul>
+ <h3>Licensing</h3>
+ <p>
+ goetia-freebsd-init is free software. It is available under the
+ <a href="https://opensource.org/licenses/ISC">ISC license</a>.
+ </p>
+ <h3>Download</h3>
+ <ul>
+ <!--
+ <li>
+ The current released version of goetia-freebsd-init is
+ <a href="./goetia-freebsd-init-0.0.1.0.tar.gz">0.0.1.0</a>.
+ You can access its checksum
+ <a href="./goetia-freebsd-init-0.0.1.0.tar.gz.sha256">here</a>.
+ </li>
+ -->
+ <li>
+ Alternatively, you can checkout a copy of the
+ <a href="https://git.0x53.net/goetia-freebsd-init">goetia-freebsd-init git repository</a>:
+ <pre>git clone git://git.0x53.net/goetia-freebsd-init</pre>
+ </li>
+ </ul>
+ <h3>Compilation</h3>
+ <ul>
+ <li>
+ See the enclosed INSTALL file for installation details.
+ </li>
+ </ul>
+ <hr>
+ <h2>Reference</h2>
+ <section id="bin">
+ <h3>Commands</h3>
+ <p>
+ All of the following are
+ <a href="https://skarnet.org/software/execline/">execline</a>
+ scripts.
+ </p>
+ <ul>
+ <li>
+ <a href="./bin/system-init.html">system-init</a>
+ </li>
+ <li>
+ <a href="./bin/system-shutdown.html">system-shutdown</a>
+ </li>
+ </ul>
+ </section>
+ <section id="service">
+ <h3>Service directories</h3>
+ <p>
+ Service directories specific to the Linux Kernel
+ and to this init system.
+ </p>
+ <ul>
+ <li>
+ <a href="./service/system/.s6-svscan.html">.s6-svscan</a>
+ </li>
+ <li>
+ <a href="./service/system/goetia-shutdown.html">goetia-shutdown</a>
+ </li>
+ </ul>
+ </section>
+ </body>
+</html>