From 49098cf9c6055b85a4cd0dcb4a0d57fc003310f4 Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:36:49 +0100 Subject: Add doc --- doc/index.html | 279 +++++++++++++++++++++++++++ doc/service/system/getty-12.html | 42 ++++ doc/source/system/net/nftables.html | 41 ++++ doc/source/system/other/local.html | 69 +++++++ doc/source/system/other/syslog.html | 39 ++++ doc/source/system/vfs/mount-binfmt_misc.html | 81 ++++++++ 6 files changed, 551 insertions(+) create mode 100644 doc/index.html create mode 100644 doc/service/system/getty-12.html create mode 100644 doc/source/system/net/nftables.html create mode 100644 doc/source/system/other/local.html create mode 100644 doc/source/system/other/syslog.html create mode 100644 doc/source/system/vfs/mount-binfmt_misc.html diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..a0bc8db --- /dev/null +++ b/doc/index.html @@ -0,0 +1,279 @@ + + + + + + + goetia-linux + + + +

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

+ +

goetia-linux

What is it?

+ goetia-linux contains + service directories + and + source directories + for the system supervision tree that are specific for the Linux Kernel. +

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-linux is free software. It is available under the + ISC license. +

Download

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

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

+ dnsfunneld +
+ hostname +
+ iwd +
+ net-lo +
+ net-nm-online +
+ net-nm-ready +
+ networkmanager +
+ nftables +

udev

+ mdev-coldplug +
+ mdev +
+ mdevd-coldplug +
+ mdevd +
+ udevadm-settle +
+ udevadm-trigger +
+ udevd +

vfs

+ mount-binfmt_misc +
+ mount-cgroups-v1 +
+ mount-cgroups-v2 +
+ mount-config +
+ mount-debug +
+ mount-dev +
+ mount-efivars +
+ mount-fuse-connections +
+ mount-hugepages +
+ mount-mqueue +
+ mount-proc +
+ mount-pstore +
+ mount-pts +
+ mount-run +
+ mount-security +
+ mount-selinux +
+ mount-shm +
+ mount-sys +
+ mount-tracing +

web

+ jellyfin +

other

+ acpid +
+ dmesg +
+ kmod-static-nodes +
+ local +
+ modules +
+ random-seed-load +
+ random-seed-save +
+ swap-fstab +
+ sysctl +
+ syslog +
+ tmpfiles-dev +
+ tmpfiles-setup +

+ + diff --git a/doc/service/system/getty-12.html b/doc/service/system/getty-12.html new file mode 100644 index 0000000..1d67a8b --- /dev/null +++ b/doc/service/system/getty-12.html @@ -0,0 +1,42 @@ + + + + + + + getty-12 + + + +

+ goetia-linux +
+ 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/net/nftables.html b/doc/source/system/net/nftables.html new file mode 100644 index 0000000..4bcd42b --- /dev/null +++ b/doc/source/system/net/nftables.html @@ -0,0 +1,41 @@ + + + + + + + nftables service + + + +

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

+ +

The nftables service

+ nftables is a + oneshot service + to use + nftables +

+ It runs nft -f /etc/nftables.rules + when it is started. +
+ It runs nft flush ruleset + when it is stopped. +

+ + diff --git a/doc/source/system/other/local.html b/doc/source/system/other/local.html new file mode 100644 index 0000000..aa943e2 --- /dev/null +++ b/doc/source/system/other/local.html @@ -0,0 +1,69 @@ + + + + + + + local service + + + +

+ goetia-linux +
+ 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.html b/doc/source/system/other/syslog.html new file mode 100644 index 0000000..c09af1a --- /dev/null +++ b/doc/source/system/other/syslog.html @@ -0,0 +1,39 @@ + + + + + + + syslog service + + + +

+ goetia-linux +
+ 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 /dev/log. + The logs are then processed by + s6-log + (see logging directory). +

+ + diff --git a/doc/source/system/vfs/mount-binfmt_misc.html b/doc/source/system/vfs/mount-binfmt_misc.html new file mode 100644 index 0000000..09cadc8 --- /dev/null +++ b/doc/source/system/vfs/mount-binfmt_misc.html @@ -0,0 +1,81 @@ + + + + + + + mount-binfmt_misc service + + + +

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

+ +

The mount-binfmt_misc service

+ mount-binfmt_misc is a + oneshot service + set up the + binfmt_misc + virtual filesystem. +

+ When it is started: +

+ It mounts the binfmt_misc virtual filesystem at + /proc/sys/fs/binfmt_misc. +
+ It reads all files at + /etc/binfmt.d/* +
+ For each line in each file it finds there, + ignoring empty lines and lines starting with a + #, + it tries to apply the line + as a registration string as defined + here + under the following conditions: +

+ Files are ordered by + elglob. +
+ If name fields are duplicated, + the last one processed will be applied. +

+ When it is stopped: +

+ It umounts /proc/sys/fs/binfmt_misc. +

Examples

+ A file /etc/binfmt.d/wine.conf + with the content :DOSWin:M::MZ::/bin/wine: + would make windows binaries be executed + using wine automatically. +

+ + -- cgit v1.2.3