mirror of https://github.com/projectatomic/atomic.git synced 2026-02-05 18:45:01 +01:00

Files

Tomas Tomecek 0e2d6457b2 add manpage for help command

Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

Closes: #941
Approved by: rhatdan

2017-05-09 15:00:50 +00:00

% 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:

File placed inside root of the container named either help.1 or README.md.
Label named help which should contain executable command to display the documentation.

-h -help Print usage statement.

May 2017, Originally compiled by Tomas Tomecek (ttomecek at redhat dot com)