From 505f47c73f8541e2f4a1d82432831f070d4a0d17 Mon Sep 17 00:00:00 2001 From: Michael Arndt Date: Fri, 14 Sep 2018 09:24:16 +0000 Subject: [PATCH] :gem: Release v0.0.4 --- README.adoc | 103 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 96 insertions(+), 7 deletions(-) diff --git a/README.adoc b/README.adoc index 9638420..83bb45d 100644 --- a/README.adoc +++ b/README.adoc @@ -1,5 +1,5 @@ -:branch: develop +:branch: master == dockmoor image:https://img.shields.io/circleci/project/github/MeneDev/dockmoor/{branch}.svg[Build Status (Circle CI), link=https://circleci.com/gh/MeneDev/dockmoor] @@ -13,7 +13,7 @@ Manage docker image references. Examples -------- -[[contains-command-examples]] +[[list-command-examples]] list command ~~~~~~~~~~~~ @@ -183,8 +183,8 @@ stdout: _____________________________________________ .... some-folder/Dockerfile-nginx-latest -some-folder/subfolder/Dockerfile-nginx-latest some-folder/Dockerfile-nginx-untagged +some-folder/subfolder/Dockerfile-nginx-latest some-folder/Dockerfile-nginx-1.15.3 .... _____________________________________________ @@ -206,8 +206,8 @@ stdout: _____________________________________________ .... some-folder/Dockerfile-nginx-latest -some-folder/subfolder/Dockerfile-nginx-latest some-folder/Dockerfile-nginx-untagged +some-folder/subfolder/Dockerfile-nginx-latest .... _____________________________________________ @@ -228,10 +228,10 @@ stdout: _____________________________________________ .... some-folder/Dockerfile-nginx-digest -some-folder/Dockerfile-nginx-tagged-digest some-folder/Dockerfile-nginx-latest -some-folder/subfolder/Dockerfile-nginx-latest +some-folder/Dockerfile-nginx-tagged-digest some-folder/Dockerfile-nginx-untagged +some-folder/subfolder/Dockerfile-nginx-latest some-folder/Dockerfile-nginx-1.15.3 .... _____________________________________________ @@ -269,5 +269,94 @@ Supported Formats * Dockerfile (as used by `docker build`) -Unresolved directive in _readme.adoc - include::dockmoor.adoc[] +[[_usage]] +Usage +----- + +__________________________________________________________________________________________________ +dockmoor [OPTIONS] [command-OPTIONS] +__________________________________________________________________________________________________ + +[[_application_options]] +Application Options +------------------- + +**-l**, *--log-level* Sets the log-level (one of `NONE`, `ERROR`, `WARN`, `INFO`, `DEBUG`) + +*--version* Show version and exit + +*--manpage* Show man page and exit + +*--markdown* Show usage as markdown and exit + +*--asciidoc-usage* Show usage as asciidoc and exit + +[[_help_options]] +Help Options +------------ + +**-h**, *--help* Show this help message + +[[_commands]] +Commands +~~~~~~~~ + +* link:#contains-command[contains] +* link:#list-command[list] + +[[_contains_command]] +contains command +^^^^^^^^^^^^^^^^ + +________________________________________________________ +dockmoor [OPTIONS] contains [contains-OPTIONS] InputFile +________________________________________________________ + +Returns exit code 0 when the given input contains at least one image reference that satisfy the given conditions, non-null otherwise + +[[_predicates]] +Predicates +~~~~~~~~~~ + +Specify which kind of image references should be selected. Exactly one must be specified + +*--any* Matches all images + +*--latest* Matches images with latest or no tag + +*--unpinned* Matches unpinned images + +[[_help_options_2]] +Help Options +~~~~~~~~~~~~ + +**-h**, *--help* Show this help message + +[[_list_command]] +list command +^^^^^^^^^^^^ + +________________________________________________ +dockmoor [OPTIONS] list [list-OPTIONS] InputFile +________________________________________________ + +Returns exit code 0 when the given input contains at least one image reference that satisfy the given conditions, non-null otherwise + +[[_predicates_2]] +Predicates +~~~~~~~~~~ + +Specify which kind of image references should be selected. Exactly one must be specified + +*--any* Matches all images + +*--latest* Matches images with latest or no tag + +*--unpinned* Matches unpinned images + +[[_help_options_3]] +Help Options +~~~~~~~~~~~~ + +**-h**, *--help* Show this help message