Updated docs.

This commit is contained in:
Storm Dragon committed 2026-10-16 15:33:08 -04:00
1 parent 980fd8029d
commit bc305993b8
2 files changed
+14 -6

No files matched your search

+10 -3
View File
@@ -62,7 +62,12 @@ without a published compatible release show a clear message and remain unchecked
No source builds or install scripts run during this workflow. Resource limits No source builds or install scripts run during this workflow. Resource limits
do not make untrusted same-user programs safe. do not make untrusted same-user programs safe.
After installation, refresh status until Active and use Cthulhu+Alt+Shift+H. Install and enable reports success after the Tentacle becomes Active. A failed
start returns an error and leaves the installed package disabled. Enable it again
to retry. Activation needs no administrator setup or particular init system;
configured cgroup resource limits are optional.
For Hello World, use Cthulhu+Alt+Shift+H after activation.
Disable retains the package; re-enabling and reader startup use installed files Disable retains the package; re-enabling and reader startup use installed files
without network access. Removing the source retains installed Tentacles. Removing without network access. Removing the source retains installed Tentacles. Removing
a managed Tentacle stops it and deletes its package files after shutdown. a managed Tentacle stops it and deletes its package files after shutdown.
@@ -309,8 +314,10 @@ substituting your absolute executable path and launch ID `greeting`, with
`Presentation: true` in the launch JSON. `--replace --tentacles` replaces the `Presentation: true` in the launch JSON. `--replace --tentacles` replaces the
current Go reader and selects the development list instead of the saved registry; current Go reader and selects the development list instead of the saved registry;
run it explicitly when ready. Rebuild the reader first if its implementation run it explicitly when ready. Rebuild the reader first if its implementation
changed. Production activation requires delegated cgroup resources and does not changed. Production activation uses init-independent process supervision and
silently fall back when delegation fails. needs no administrator setup. Kernel resource limits are optional: configure a
delegated cgroup v2 parent with `--tentacle-cgroup-parent` or
`CTHULHU_TENTACLE_CGROUP_PARENT`. An invalid explicit parent fails startup.
Test the shortcut, learn mode, remapping, ordinary reading and web navigation on Test the shortcut, learn mode, remapping, ordinary reading and web navigation on
Xorg. Verify speech modes, interruption, screen lock, terminal handoff, disable Xorg. Verify speech modes, interruption, screen lock, terminal handoff, disable
+4 -3
View File
@@ -60,9 +60,10 @@ When ready to test, launch the rebuilt reader explicitly:
``` ```
That command replaces the running Go reader and selects the development launch That command replaces the running Go reader and selects the development launch
list instead of saved Tentacles. The reader automatically requests systemd user list instead of saved Tentacles. The reader supervises each Tentacle directly;
cgroup delegation. A delegation failure leaves the Tentacle unavailable. no administrator setup or particular init system is required. Kernel CPU, memory
Resource limits do not make untrusted same-user programs safe. and task limits are optional and require an explicitly configured delegated
cgroup v2 parent. Tentacles run with your account's access; install trusted code.
## Live verification ## Live verification