From 0e2d6457b2a320295166a2dec9f2376dc7e298bf Mon Sep 17 00:00:00 2001 From: Tomas Tomecek Date: Thu, 4 May 2017 14:48:01 +0200 Subject: [PATCH] add manpage for help command Signed-off-by: Tomas Tomecek Closes: #941 Approved by: rhatdan --- docs/atomic-help.1.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/atomic-help.1.md diff --git a/docs/atomic-help.1.md b/docs/atomic-help.1.md new file mode 100644 index 0000000..662b7ae --- /dev/null +++ b/docs/atomic-help.1.md @@ -0,0 +1,27 @@ +% ATOMIC(1) Atomic Man Pages +% Tomas Tomecek +% May 2017 +# NAME +atomic-help - Get help for container images + +# SYNOPSIS +**atomic help** +[**-h**|**--help**] +IMAGE + +**atomic help** provides documentation for the specified container IMAGE. + +The documentation is extracted from the container image. **atomic** searches +for the documentation in following locations: + +1. File placed inside root of the container named either **help.1** or +**README.md**. +2. Label named **help** which should contain executable command +to display the documentation. + +# OPTIONS +**-h** **-help** + Print usage statement. + +# HISTORY +May 2017, Originally compiled by Tomas Tomecek (ttomecek at redhat dot com)