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-db.html | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 doc/bin/user-db.html (limited to 'doc/bin/user-db.html') diff --git a/doc/bin/user-db.html b/doc/bin/user-db.html new file mode 100644 index 0000000..26ef310 --- /dev/null +++ b/doc/bin/user-db.html @@ -0,0 +1,82 @@ + + + + + + + user-db + + + +

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

+ +

The user-db program

+ user-db compiles the + source directories + of the + user configuration directory + into the compiled format. + This format can then be used by init and + user-rc + to set up and control a + user supervision tree. +

+ user-db is a wrapper around the more general + compile-db + making it target the user supervision tree. +

Interface

     user-db

+ user-db takes no arguments. +
+ It reads the USER environment variable, + if it is empty it exits 100. +
+ It reads the USERTREE environment variable, + if it is empty it exits 100. +
+ It reads the HOME environment variable, + if it is empty it exits 100. +
+ It runs compile-db supplementing it the correct + user configuration directory + and + user runtime directory. +

Exit codes

+ 100 if a critical environment variable is missing. +
+ Since user-db is a wrapper around compile-db, it + behaves exactly like it. +

Options

+ There are no options to user-db. +

+ + -- cgit v1.2.3