Skip to content

Commit e60ff1d

Browse files
runcomruncom
committed
cmd/oci-image-tool: add manuals
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
1 parent 45e8036 commit e60ff1d

4 files changed

Lines changed: 162 additions & 0 deletions

File tree

‎cmd/oci-image-tool/man/oci-image-tool-create-runtime-bundle.1.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% JULY 2016
4+
# NAME
5+
oci-image-tool-create-runtime-bundle \- Create an OCI image runtime bundle
6+
7+
# SYNOPSIS
8+
**oci-image-tool create-runtime-bundle** [src] [dest] [flags]
9+
10+
# DESCRIPTION
11+
`oci-image-tool create-runtime-bundle` generates an [OCI bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md) from an [OCI image layout](https://github.com/opencontainers/image-spec/blob/master/image-layout.md).
12+
13+
14+
# OPTIONS
15+
**--help**
16+
Print usage statement
17+
18+
**--ref**
19+
The ref pointing to the manifest of the OCI image. This must be present in the "refs" subdirectory of the image. (default "v1.0")
20+
21+
**--rootfs**
22+
A directory representing the root filesystem of the container in the OCI runtime bundle. It is strongly recommended to keep the default value. (default "rootfs")
23+
24+
**--type**
25+
Type of the file to unpack. If unset, oci-image-tool will try to auto-detect the type. One of "imageLayout,image"
26+
27+
# EXAMPLES
28+
```
29+
$ skopeo copy docker://busybox oci:busybox-oci
30+
$ mkdir busybox-bundle
31+
$ ci-image-tool create-runtime-bundle --ref latest busybox-oci busybox-bundle
32+
$ cd busybox-bundle && sudo runc start busybox
33+
[...]
34+
```
35+
36+
# SEE ALSO
37+
**oci-image-tool(1)**, **runc**(1), **skopeo**(1)
38+
39+
# HISTORY
40+
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

‎cmd/oci-image-tool/man/oci-image-tool-unpack.1.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% JULY 2016
4+
# NAME
5+
oci-image-tool-unpack \- Unpack an image or image source layout
6+
7+
# SYNOPSIS
8+
**oci-image-tool unpack** [src] [dest] [flags]
9+
10+
# DESCRIPTION
11+
`oci-image-tool unpack` unpacks a given OCI image into a directory suitable to be used with `runc`.
12+
13+
14+
# OPTIONS
15+
**--help**
16+
Print usage statement
17+
18+
**--ref**
19+
The ref pointing to the manifest to be unpacked. This must be present in the "refs" subdirectory of the image. (default "v1.0")
20+
21+
**--type**
22+
Type of the file to unpack. If unset, oci-image-tool will try to auto-detect the type. One of "imageLayout,image"
23+
24+
# EXAMPLES
25+
```
26+
$ skopeo copy docker://busybox oci:busybox-oci
27+
$ mkdir busybox-bundle
28+
$ oci-image-tool unpack --ref latest busybox-oci busybox-bundle
29+
tree busybox-bundle
30+
busybox-bundle
31+
├── bin
32+
│   ├── [
33+
│   ├── [[
34+
│   ├── acpid
35+
│   ├── addgroup
36+
│   ├── add-shell
37+
│   ├── adduser
38+
│   ├── adjtimex
39+
│   ├── ar
40+
│   ├── arp
41+
│   ├── arping
42+
│   ├── ash
43+
[...]
44+
```
45+
46+
# SEE ALSO
47+
**oci-image-tool(1)**, **skopeo**(1)
48+
49+
# HISTORY
50+
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

‎cmd/oci-image-tool/man/oci-image-tool-validate.1.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% JULY 2016
4+
# NAME
5+
oci-image-tool-validate \- Validate one or more image files
6+
7+
# SYNOPSIS
8+
**oci-image-tool validate** FILE... [flags]
9+
10+
# DESCRIPTION
11+
`oci-image-tool validate` validates the given file(s) against the OCI image specification.
12+
13+
14+
# OPTIONS
15+
**--help**
16+
Print usage statement
17+
18+
**--ref**
19+
The ref pointing to the manifest to be validated. This must be present in the "refs" subdirectory of the image. Only applicable if type is image or imageLayout. (default "v1.0")
20+
21+
**--type**
22+
Type of the file to validate. If unset, oci-image-tool will try to auto-detect the type. One of "imageLayout,image,manifest,manifestList,config"
23+
24+
# EXAMPLES
25+
```
26+
$ skopeo copy docker://busybox oci:busybox-oci
27+
$ oci-image-tool validate --type imageLayout --ref latest busybox-oci
28+
busybox-oci: OK
29+
```
30+
31+
# SEE ALSO
32+
**oci-image-tool(1)**, **skopeo**(1)
33+
34+
# HISTORY
35+
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

‎cmd/oci-image-tool/man/oci-image-tool.1.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% JULY 2016
4+
# NAME
5+
oci-image-tool \- OCI (Open Container Initiative) image tool
6+
7+
# SYNOPSIS
8+
**oci-image-tool** [OPTIONS] COMMAND [arg...]
9+
10+
**oci-image-tool** [--help]
11+
12+
# DESCRIPTION
13+
`oci-image-tool` is a collection of tools for working with the [OCI image specification](https://github.com/opencontainers/image-spec).
14+
15+
16+
# OPTIONS
17+
**--help**
18+
Print usage statement
19+
20+
# COMMANDS
21+
**create-runtime-bundle**
22+
Create an OCI image runtime bundle
23+
See **oci-image-tools-create-runtime-bundle(1)** for full documentation on the **create-runtime-bundle** command.
24+
25+
**unpack**
26+
Unpack an image or image source layout
27+
See **oci-image-tools-unpack(1)** for full documentation on the **unpack** command.
28+
29+
**validate**
30+
Validate one or more image files
31+
See **oci-image-tool-validate(1)** for full documentation on the **validate** command.
32+
33+
# SEE ALSO
34+
**oci-image-tool-create-runtime-bundle**, **ocitools-unpack**(1), **ocitools-validate**(1)
35+
36+
# HISTORY
37+
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

0 commit comments

Comments
 (0)