From 1b4d9aa84746abc79621009bc397e9af18127baf Mon Sep 17 00:00:00 2001
From: Nathaniel van Diepen <Eeems@users.noreply.github.com>
Date: Tue, 18 Jun 2024 23:21:16 -0600
Subject: [PATCH] Start flushing out toltec article (#36)

---
 src/devel/device/toltec.rst | 94 +++++++++++++++++++++++++++++++++++++
 src/spelling_wordlist.txt   | 11 +++++
 2 files changed, 105 insertions(+)

diff --git a/src/devel/device/toltec.rst b/src/devel/device/toltec.rst
index 8af3adc..9dac268 100644
--- a/src/devel/device/toltec.rst
+++ b/src/devel/device/toltec.rst
@@ -22,14 +22,108 @@ Filesystem Layout
 /opt/etc
 --------
 
+/opt/etc/init.d
+---------------
+
+Entware packages will add executable scripts here to manage services that you
+install. Toltec allows you to manage this with ``rcctl``, which is provided by
+the ``entware-rc`` package.
+
+/opt/bin
+--------
+
+/opt/libexec
+------------
+
+/opt/sbin
+---------
+
 /opt/share/remarkable/templates
 -------------------------------
 
+/opt/share/launcherctl
+----------------------
+
+Executable files in this folder will be treated as possible launchers for
+``launcherctl``.
+
+/opt/share/toltec/reenable.d
+----------------------------
+
+Contains empty files owned by packages to indicate that they make changes to
+the root partition, and will need to be reinstalled when re-enabling toltec
+after an update.
+
+/opt/usr/share/backupscrns
+--------------------------
+
+Used by ``changescrn`` to backup the stock splashscreens.
+
+/opt/share/remarkable/splashscreens
+-----------------------------------
+
+This directory contains the active splashscreen from an installed toltec package.
+
+/opt/usr/share/kernelctl
+------------------------
+
+Contains ``tar.bz2`` archives that kernelctl uses to manage the currently
+installed linux kernel.
+
+/opt/usr/share/licenses
+-----------------------
+
+Some toltec applications will include their licenses, which will be installed
+to this folder. Entware doesn't include licenses in it's packages, due to
+potential space constraints on the systems it targets.
+
+/opt/share/zoneinfo
+-------------------
+The ``zoneinfo-utils`` package will mount this to ``/usr/share/zoneinfo`` to
+allow ``timedatectl`` to access the full set of timezones. Instead of the subset
+that the device comes with.
+
 Systemd Services
 ================
 
+entware-rc@.service
+-------------------
+
+opt.mount
+---------
+
+rm2fb.service
+-------------
+
+launcher.service
+----------------
+
 Launcher Application Registration
 =================================
 
+Launcher Registration
+=====================
+
+- ``/opt/share/launcherctl/<name>``
+- Must be executable.
+- Must implement the following:
+
+  - ``is-active``
+  - ``is-enabled``
+  - ``start``
+  - ``stop``
+  - ``enable``
+  - ``disable``
+  - ``logs [-f|--follow]``
+  - ``apps``
+  - ``running``
+  - ``paused``
+  - ``launch <name>``
+  - ``resume <name>``
+  - ``close <name>``
+  - ``pause <name>``
+
 Kernels
 =======
+
+- /opt/usr/share/kernelctl
diff --git a/src/spelling_wordlist.txt b/src/spelling_wordlist.txt
index b8f74d7..4305cd7 100644
--- a/src/spelling_wordlist.txt
+++ b/src/spelling_wordlist.txt
@@ -1,6 +1,8 @@
 ackee
+analytics
 automagic
 backgrounded
+backupscrns
 behaviour
 bugfixes
 Carta
@@ -8,11 +10,13 @@ changescrn
 chroot
 codex
 codexctl
+commandline
 config
 cryptographic
 DBus
 ddvk
 debian
+decrypt
 dev
 discoverable
 distro
@@ -32,9 +36,12 @@ github
 homescreen
 hostname
 hotspot
+init
 interactable
 js
+kernelctl
 keypair
+launcherctl
 liboxide
 Libremarkable
 linux
@@ -48,6 +55,7 @@ programmatically
 proxying
 pypi
 pySAS
+rcctl
 reenable
 reenabled
 reimplements
@@ -58,6 +66,7 @@ rmfakecloud
 rmKit
 rMlib
 rsa
+runtime
 sftp
 sha
 splashscreens
@@ -74,8 +83,10 @@ toolchains
 Unregister
 usb
 userspace
+usr
 utils
 wget
 wifi
 wpa
 xochitl
+zoneinfo