1ATOMIC(1)                          May 2017                          ATOMIC(1)
2
3
4

NAME

6       atomic-help - Get help for container images
7
8
9

SYNOPSIS

11       atomic help [-h|--help] IMAGE
12
13
14       atomic help provides documentation for the specified container IMAGE.
15
16
17       The documentation is extracted from the container image. atomic
18       searches for the documentation in following locations:
19
20         1. File placed inside root of the container named either help.1 or
21            README.md.
22
23         2. Label named help which should contain executable command to
24            display the documentation.
25
26
27

OPTIONS

29       -h -help
30         Print usage statement.
31
32
33

HISTORY

35       May 2017, Originally compiled by Tomas Tomecek (ttomecek at redhat dot
36       com)
37
38
39
40Tomas Tomecek                   Atomic Man Pages                     ATOMIC(1)