From ae0726ca490b93c9a173e6fe6ad4bd004048ec72 Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:36:23 +0100 Subject: Add doc --- doc/index.html | 171 +++++++++++++++++++++++++++++++ doc/service/system/getty-12.html | 42 ++++++++ doc/source/system/other/local.html | 69 +++++++++++++ doc/source/system/other/syslog-priv.html | 39 +++++++ doc/source/system/other/syslog.html | 39 +++++++ 5 files changed, 360 insertions(+) create mode 100644 doc/index.html create mode 100644 doc/service/system/getty-12.html create mode 100644 doc/source/system/other/local.html create mode 100644 doc/source/system/other/syslog-priv.html create mode 100644 doc/source/system/other/syslog.html 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 @@ + + + + + + + goetia-freebsd + + + +

+ goetia +
+ Software +
+ 0x53.net +

+ +

goetia-freebsd

What is it?

+ goetia-freebsd contains + service directories + and + source directories + for the system supervision tree that are specific for the FreeBSD operating system. +

Installation

Requirements

+ A set of POSIX tools and kernel specific tools + as described in the general + requirements +
+ A POSIX-compliant implementation of make, or GNU make +
+ goetia-base +
+ Additional per-service dependencies, + e.g. the daemon itself the service corresponds to, + are listed on the respective page. +

Licensing

+ goetia-freebsd is free software. It is available under the + ISC license. +

Download

+ Alternatively, you can checkout a copy of the + goetia-freebsd git repository: +
```
git clone git://git.0x53.net/goetia-freebsd
```
+

Compilation

+ See the enclosed INSTALL file for installation details. +

Reference

Service directories

+ Service directories for early and basic services, + used without + s6-rc. + Service directories in this package are used independent + of the kernel in use. +

System service directories

+ getty-12 +

Source directories

+ 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 + tutorial page. +

System source directories

mount

+ mount-fstab +
+ mount-tmp +
+ remount-root +

net

+ hostname +

Userspace device management

+ devd +

vfs

+ mount-dev +
+ mount-run +

other

+ dmesg +
+ local +
+ modules +
+ random-seed-load +
+ random-seed-save +
+ swap-fstab +
+ syslog +
+ syslog-priv +

+ + 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 @@ + + + + + + + getty-12 + + + +

+ goetia-freebsd +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The getty-12 service

+ This service tries to spawn a tty on slot 12 + (ctrl + alt + F12). + Using both the agetty + and in case it does not exist, + the getty command. +

Requirements

+ The device node /dev/tty12 must exist + even when no proper filesystem + (e.g. devfs, devtmpfs) is mounted at /dev. +

+ + 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 @@ + + + + + + + local service + + + +

+ goetia-freebsd +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The local service

+ local is a + oneshot service. +

+ It tries to execute all + files /etc/local.d/*.up + when it is started (typically during boot). +
+ It tries to execute all files /etc/local.d/*.down + when it is stopped (typically during shutdown). +

+ The files are executed in random order + and in parallel. +

Examples

+ An executable file /etc/local.d/echo.up + with the content +

+#!/bin/execlineb -P
+
+echo "example"
+

+ would be executed and write "example" to the system log + upon starting the service local. +

+ An executable file /etc/local.d/echo.down + with the content +

+#!/bin/execlineb -P
+
+echo "example"
+

+ would be executed and write "example" to the system log + upon stopping the service local. +

+ + 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 @@ + + + + + + + syslog-priv service + + + +

+ goetia-freebsd +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The syslog-priv service

+ syslog-priv is a + longrun service + to support legacy applications + that only support logging through a syslog socket. +

+ It runs an instance of + s6-socklog + with the socket set to /var/run/logpriv. + The logs are then processed by + s6-log + (see logging directory). +

+ + 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 @@ + + + + + + + syslog service + + + +

+ goetia-freebsd +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The syslog service

+ syslog is a + longrun service + to support legacy applications + that only support logging through a syslog socket. +

+ It runs an instance of + s6-socklog + with the socket set to /var/run/log. + The logs are then processed by + s6-log + (see logging directory). +

+ + -- cgit v1.2.3