From 4f1b7a3cd96694a142d98a359f90ba264c9f6972 Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Tue, 5 Dec 2023 21:48:38 +1100 Subject: [PATCH] provide resolve doc --- doc/66-inresolve.md | 36 ------------------------------------ doc/resolve.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 36 deletions(-) delete mode 100644 doc/66-inresolve.md create mode 100644 doc/resolve.md diff --git a/doc/66-inresolve.md b/doc/66-inresolve.md deleted file mode 100644 index e953ef48..00000000 --- a/doc/66-inresolve.md +++ /dev/null @@ -1,36 +0,0 @@ -title: The 66 Suite: 66-inresolve -author: Eric Vidal <eric@obarun.org> - -[66](index.html) - -[Software](https://web.obarun.org/software) - -[obarun.org](https://web.obarun.org) - -# 66-inresolve - -This command displays the contents of the service's *resolve* file. - -## Interface - -``` - 66-inresolve [ -h ] [ -z ] [ -t tree ] [ -l ] service -``` - -66-inresolve displays the contents of the service's *resolve* file. This file are used internally by the *66* tools to know *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 *resolve* file if any. diff --git a/doc/resolve.md b/doc/resolve.md new file mode 100644 index 00000000..d6824275 --- /dev/null +++ b/doc/resolve.md @@ -0,0 +1,33 @@ +title: The 66 Suite: resolve +author: Eric Vidal <eric@obarun.org> + +[66](index.html) + +[Software](https://web.obarun.org/software) + +[obarun.org](https://web.obarun.org) + +# resolve + +This command displays the contents of the service's *resolve* file. + +## Interface + +``` +resolve [ -h ] service +``` + +This command displays the contents of the service's *resolve* file. This file are used internally by the `66` program to know *service* information. This command is purely a debug command used by system administrators or developers. + +[Resolve](deeper.html#Resolve-files) files are at the core of `66` for service information. They are used internally by `66` to build the dependency graph, ascertain file locations, the parse process result of a service, and other critical aspects of a service. + +## Options + +- **-h** : prints this help; + +## Usage example + +Displays the *resolve* file of service `foo` +``` +66 resolve foo +``` \ No newline at end of file -- GitLab