Skip to content

Commit

Permalink
Start flushing out toltec article (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eeems committed Jun 19, 2024
1 parent b6b809d commit 1b4d9aa
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 0 deletions.
94 changes: 94 additions & 0 deletions src/devel/device/toltec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
11 changes: 11 additions & 0 deletions src/spelling_wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
ackee
analytics
automagic
backgrounded
backupscrns
behaviour
bugfixes
Carta
changescrn
chroot
codex
codexctl
commandline
config
cryptographic
DBus
ddvk
debian
decrypt
dev
discoverable
distro
Expand All @@ -32,9 +36,12 @@ github
homescreen
hostname
hotspot
init
interactable
js
kernelctl
keypair
launcherctl
liboxide
Libremarkable
linux
Expand All @@ -48,6 +55,7 @@ programmatically
proxying
pypi
pySAS
rcctl
reenable
reenabled
reimplements
Expand All @@ -58,6 +66,7 @@ rmfakecloud
rmKit
rMlib
rsa
runtime
sftp
sha
splashscreens
Expand All @@ -74,8 +83,10 @@ toolchains
Unregister
usb
userspace
usr
utils
wget
wifi
wpa
xochitl
zoneinfo

0 comments on commit 1b4d9aa

Please sign in to comment.