aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPS <p@0x53.net>2026-02-07 10:36:23 +0100
committerPS <p@0x53.net>2026-02-07 10:36:23 +0100
commitae0726ca490b93c9a173e6fe6ad4bd004048ec72 (patch)
treed908b5ab162265b32992a1d21fe2fb30816529cb
parent49371f8654a82e3300caa898f4a211716681735f (diff)
downloadgoetia-freebsd-ae0726ca490b93c9a173e6fe6ad4bd004048ec72.tar.gz
goetia-freebsd-ae0726ca490b93c9a173e6fe6ad4bd004048ec72.tar.bz2
goetia-freebsd-ae0726ca490b93c9a173e6fe6ad4bd004048ec72.zip
Add doc
Diffstat
-rw-r--r--doc/index.html171
-rw-r--r--doc/service/system/getty-12.html42
-rw-r--r--doc/source/system/other/local.html69
-rw-r--r--doc/source/system/other/syslog-priv.html39
-rw-r--r--doc/source/system/other/syslog.html39
5 files changed, 360 insertions, 0 deletions
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 0000000..5e36566
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,171 @@
+<!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</title>
+ <meta name="Description" content="goetia-freebsd contains scripts, service- and source directories specific to FreeBSD." />
+ <meta name="Keywords" content="goetia FreeBSD" />
+ </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</h1>
+ <h2>What is it?</h2>
+ <p>
+ goetia-freebsd contains
+ <a href="https://skarnet.org/software/s6/servicedir.html">service directories</a>
+ and
+ <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">source directories</a>
+ for the system supervision tree that are specific for the FreeBSD operating system.
+ </p>
+ <hr>
+ <h2>Installation</h2>
+ <h3>Requirements</h3>
+ <ul>
+ <li>
+ A set of POSIX tools and kernel specific tools
+ as described in the general
+ <a href="//0x53.net/software/requirements.html">requirements</a>
+ </li>
+ <li>
+ A POSIX-compliant implementation of make, or GNU make
+ </li>
+ <li>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</a>
+ </li>
+ <li>
+ Additional per-service dependencies,
+ e.g. the daemon itself the service corresponds to,
+ are listed on the respective page.
+ </li>
+ </ul>
+ <h3>Licensing</h3>
+ <p>
+ goetia-freebsd 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 is
+ <a href="./goetia-freebsd-0.0.1.0.tar.gz">0.0.1.0</a>.
+ You can access its checksum
+ <a href="./goetia-freebsd-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">goetia-freebsd git repository</a>:
+ <pre>git clone git://git.0x53.net/goetia-freebsd</pre>
+ </li>
+ </ul>
+ <h3>Compilation</h3>
+ <ul>
+ <li>
+ See the enclosed INSTALL file for installation details.
+ </li>
+ </ul>
+ <hr>
+ <h2>Reference</h2>
+ <section id="service">
+ <h3>Service directories</h3>
+ <p>
+ Service directories for early and basic services,
+ used without
+ <a href="https://skarnet.org/software/s6-rc/">s6-rc</a>.
+ Service directories in this package are used independent
+ of the kernel in use.
+ </p>
+ <h4>System service directories</h4>
+ <ul>
+ <li>
+ <a href="./service/system/getty-12.html">getty-12</a>
+ </li>
+ </ul>
+ </section>
+ <section id="source">
+ <h3>Source directories</h3>
+ <p>
+ Following is a list of included
+ source directories.
+ Note that some daemons are so modular
+ and configurable, it would be nonsense
+ to provide a "stock" source directory.
+ How to set those up is explained in
+ an according
+ <a href="//0x53.net/software/goetia/tutorials/">tutorial page</a>.
+ </p>
+ <h4>System source directories</h4>
+ <h5>mount</h5>
+ <ul>
+ <li>
+ mount-fstab
+ </li>
+ <li>
+ mount-tmp
+ </li>
+ <li>
+ remount-root
+ </li>
+ </ul>
+ <h5>net</h5>
+ <ul>
+ <li>
+ hostname
+ </li>
+ </ul>
+ <h5>Userspace device management</h5>
+ <ul>
+ <li>
+ devd
+ </li>
+ </ul>
+ <h5>vfs</h5>
+ <ul>
+ <li>
+ mount-dev
+ </li>
+ <li>
+ mount-run
+ </li>
+ </ul>
+ <h5>other</h5>
+ <ul>
+ <li>
+ dmesg
+ </li>
+ <li>
+ <a href="./source/system/other/local.html">local</a>
+ </li>
+ <li>
+ modules
+ </li>
+ <li>
+ random-seed-load
+ </li>
+ <li>
+ random-seed-save
+ </li>
+ <li>
+ swap-fstab
+ </li>
+ <li>
+ <a href="./source/system/other/syslog.html">syslog</a>
+ </li>
+ <li>
+ <a href="./source/system/other/syslog-priv.html">syslog-priv</a>
+ </li>
+ </ul>
+ </section>
+ </body>
+</html>
diff --git a/doc/service/system/getty-12.html b/doc/service/system/getty-12.html
new file mode 100644
index 0000000..0e68083
--- /dev/null
+++ b/doc/service/system/getty-12.html
@@ -0,0 +1,42 @@
+<!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>getty-12</title>
+ <meta name="Description" content="System service providing a tty acccessible at slot 12." />
+ <meta name="Keywords" content="goetia s6 FreeBSD tty getty agetty system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-freebsd">goetia-freebsd</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 getty-12 service</h1>
+ <p>
+ This service tries to spawn a tty on slot 12
+ (<code>ctrl + alt + F12</code>).
+ Using both the <code>agetty</code>
+ and in case it does not exist,
+ the <code>getty</code> command.
+ </p>
+ <section id="requirements">
+ <h2>Requirements</h2>
+ <ul>
+ <li>
+ The device node <code>/dev/tty12</code> must exist
+ even when no proper filesystem
+ (e.g. devfs, devtmpfs) is mounted at <code>/dev</code>.
+ </li>
+ </ul>
+ </section>
+ </body>
+</html>
diff --git a/doc/source/system/other/local.html b/doc/source/system/other/local.html
new file mode 100644
index 0000000..29c25e5
--- /dev/null
+++ b/doc/source/system/other/local.html
@@ -0,0 +1,69 @@
+<!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>local service</title>
+ <meta name="Description" content="System oneshot that executes scripts." />
+ <meta name="Keywords" content="goetia s6-rc FreeBSD script system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-freebsd">goetia-freebsd</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 local service</h1>
+ <p>
+ local is a
+ <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">oneshot service</a>.
+ </p>
+ <ul>
+ <li>
+ It tries to execute all
+ files <code>/etc/local.d/*.up</code>
+ when it is started (typically during boot).
+ </li>
+ <li>
+ It tries to execute all files <code>/etc/local.d/*.down</code>
+ when it is stopped (typically during shutdown).
+ </li>
+ </ul>
+ <p>
+ The files are executed in random order
+ and in parallel.
+ </p>
+ <section id="examples">
+ <h2>Examples</h2>
+ <p>
+ An executable file <code>/etc/local.d/echo.up</code>
+ with the content
+ <pre>
+#!/bin/execlineb -P
+
+echo "example"
+ </pre>
+ would be executed and write "example" to the system log
+ upon starting the service local.
+ </p>
+ <p>
+ An executable file <code>/etc/local.d/echo.down</code>
+ with the content
+ <pre>
+#!/bin/execlineb -P
+
+echo "example"
+ </pre>
+ would be executed and write "example" to the system log
+ upon stopping the service local.
+ </p>
+ </section>
+ </body>
+</html>
diff --git a/doc/source/system/other/syslog-priv.html b/doc/source/system/other/syslog-priv.html
new file mode 100644
index 0000000..f73df27
--- /dev/null
+++ b/doc/source/system/other/syslog-priv.html
@@ -0,0 +1,39 @@
+<!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>syslog-priv service</title>
+ <meta name="Description" content="System longrun to emulate syslog on the priv socket." />
+ <meta name="Keywords" content="goetia s6-rc FreeBSD syslog priv system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-freebsd">goetia-freebsd</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 syslog-priv service</h1>
+ <p>
+ syslog-priv is a
+ <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">longrun service</a>
+ to support legacy applications
+ that only support logging through a syslog socket.
+ </p>
+ <p>
+ It runs an instance of
+ <a href="https://skarnet.org/software/s6/s6-socklog.html">s6-socklog</a>
+ with the socket set to <code>/var/run/logpriv</code>.
+ The logs are then processed by
+ <a href="https://skarnet.org/software/s6/s6-log.html">s6-log</a>
+ (see <a href="//0x53.net/software/goetia/logdir.html">logging directory</a>).
+ </p>
+ </body>
+</html>
diff --git a/doc/source/system/other/syslog.html b/doc/source/system/other/syslog.html
new file mode 100644
index 0000000..14be6c3
--- /dev/null
+++ b/doc/source/system/other/syslog.html
@@ -0,0 +1,39 @@
+<!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>syslog service</title>
+ <meta name="Description" content="System longrun to emulate syslog." />
+ <meta name="Keywords" content="goetia s6-rc FreeBSD syslog system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-freebsd">goetia-freebsd</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 syslog service</h1>
+ <p>
+ syslog is a
+ <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">longrun service</a>
+ to support legacy applications
+ that only support logging through a syslog socket.
+ </p>
+ <p>
+ It runs an instance of
+ <a href="https://skarnet.org/software/s6/s6-socklog.html">s6-socklog</a>
+ with the socket set to <code>/var/run/log</code>.
+ The logs are then processed by
+ <a href="https://skarnet.org/software/s6/s6-log.html">s6-log</a>
+ (see <a href="//0x53.net/software/goetia/logdir.html">logging directory</a>).
+ </p>
+ </body>
+</html>
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-14 09:02:21 +0000