From a784a2257c9068a24e717d668fd7f1454953e38d Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Mon, 4 Dec 2023 21:35:46 +1100 Subject: [PATCH] fix state file documentation --- doc/state.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/doc/state.md b/doc/state.md index 4a154519..f1f6e234 100644 --- a/doc/state.md +++ b/doc/state.md @@ -1,4 +1,4 @@ -title: The 66 Suite: 66-instate +title: The 66 Suite: state author: Eric Vidal <eric@obarun.org> [66](index.html) @@ -7,7 +7,7 @@ author: Eric Vidal <eric@obarun.org> [obarun.org](https://web.obarun.org) -# 66-instate +# state This command displays the contents of the service's *state* file. @@ -17,20 +17,15 @@ This command displays the contents of the service's *state* file. 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 +This command displays the contents of the service's *state* file. This file are used internally by the `66` program to know runtime *service* information. This command is purely a debug command used by system administrator or developers. ## 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. +## Usage example -- **-l**: displays the contents of the associated logger's *state* file if any. +Display state of service `foo` +``` +66 state foo +``` -- GitLab