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
21                1. File placed inside root of the container named either
22                   help.1 or README.md.
23
24                2. Label named help which should contain executable command to
25                   display the documentation.
26
27
28
29

OPTIONS

31       -h -help
32         Print usage statement.
33
34
35

HISTORY

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