From 7f06c5bf7aea8c1df8b444d078a0796355bef382 Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Mon, 4 Dec 2023 20:24:16 +1100 Subject: [PATCH] add state doc --- doc/state.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 doc/state.md diff --git a/doc/state.md b/doc/state.md new file mode 100644 index 00000000..4a154519 --- /dev/null +++ b/doc/state.md @@ -0,0 +1,36 @@ +title: The 66 Suite: 66-instate +author: Eric Vidal <eric@obarun.org> + +[66](index.html) + +[Software](https://web.obarun.org/software) + +[obarun.org](https://web.obarun.org) + +# 66-instate + +This command displays the contents of the service's *state* file. + +## Interface + +``` +state [ -h ] service +``` + +66-instate displays the contents of the service's *state* file. This file are used internally by the *66* tools to know runtime *service* information. This tool is purely a debug tool used by developers. + +## Exit codes + +- *0* success +- *100* wrong usage +- *111* system call failed + +## Options + +- **-h**: prints this help; + +- **-z**: use color. + +- **-t** *tree*: only searches the service at the specified *tree*, when the same service may be enabled in more trees. + +- **-l**: displays the contents of the associated logger's *state* file if any. -- GitLab