From 5e95d487982b9362b544139b98d1da55fa6ef78c Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:20:30 +0100 Subject: Add doc --- doc/bin/user-tmpfs.html | 104 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 doc/bin/user-tmpfs.html (limited to 'doc/bin/user-tmpfs.html') diff --git a/doc/bin/user-tmpfs.html b/doc/bin/user-tmpfs.html new file mode 100644 index 0000000..3c22c57 --- /dev/null +++ b/doc/bin/user-tmpfs.html @@ -0,0 +1,104 @@ + + + + + + + user-tmpfs + + + +

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

+ +

The user-tmpfs program

+ The user-tmpfs program prepares + a user owned tmpfs for + the user defined in the USER + environment variable. + The user owned tmpfs is created at + @tmpfsdir@/@usrrundir@/${USER}. +

Interface

     user-tmpfs

+ user-tmpfs takes no arguments. +
+ It reads the USER environment variable, + if it is empty it exits 100. +
+ It reads the USER_TMPFSDIR_SIZE environment variable, + defaulting to 64m if undefined. +
+ It creates the directory + @tmpfsdir@/@usrrundir@/${USER}. +
+ It mounts a tmpfs + of size USER_TMPFSDIR_SIZE + with its root owned bi USER + and mode 0755 + at @tmpfsdir@/@usrrundir@/${USER}. +

Exit codes

+ 100 if a critical environment variable is missing. +
+ Since user-tmpfs is an + execline + script, it exits with an approximation + of employed program that failed. +
+ user-tmpfs mostly uses + execline + and + s6 + software, the exit behaviour of which can be looked up on + their respective documentation. +
+ See also: + execline exit code handling. +

Options

+ There are no otions to user-tmpfs. +

Notes

+ user-tmpfs is intended to be used in a boot time + system supervision tree + oneshot service to prepare the + user runtime directory + of a user. + For each user who should have a user runtime directory, + there should be a distinct oneshot running user-tmpfs. +

+ Alternatively, user-tmpfs could be run by a login manager + after login, but befor initiating the first + user supervision tree. +

+ + -- cgit v1.2.3