Skip to content

Commit

Permalink
cmd/oci-image-tool/man: clarify unpack and create-runtime-bundle desc…
Browse files Browse the repository at this point in the history
…ription

Signed-off-by: Antonio Murdaca <[email protected]>
  • Loading branch information
runcom committed Sep 2, 2016
1 parent d1014a4 commit 1ec6417
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@
% OCI Community
% JULY 2016
# NAME
oci-image-tool-create-runtime-bundle \- Create an OCI image runtime bundle
oci-image-tool-create-runtime-bundle \- Create an OCI runtime bundle

# SYNOPSIS
**oci-image-tool create-runtime-bundle** [src] [dest] [flags]

# DESCRIPTION
`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).
`oci-image-tool create-runtime-bundle` validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `dest/rootfs`, although the target directory is configurable with `--rootfs`. See **oci-image-tool-unpack**(1) for more details on this process.

Also translates the referenced config from application/vnd.oci.image.config.v1+json to a
runtime-spec-compatible `dest/config.json`.

# OPTIONS
**--help**
Expand All @@ -34,7 +36,7 @@ $ cd busybox-bundle && sudo runc run busybox
```

# SEE ALSO
**oci-image-tool(1)**, **runc**(1), **skopeo**(1)
**oci-image-tool**(1), **runc**(1), **skopeo**(1)

# HISTORY
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)
5 changes: 2 additions & 3 deletions cmd/oci-image-tool/man/oci-image-tool-unpack.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ oci-image-tool-unpack \- Unpack an image or image source layout
**oci-image-tool unpack** [src] [dest] [flags]

# DESCRIPTION
`oci-image-tool unpack` unpacks a given OCI image into a directory suitable to be used with `runc`.

`oci-image-tool unpack` validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `dest`.

# OPTIONS
**--help**
Expand Down Expand Up @@ -44,7 +43,7 @@ busybox-bundle
```

# SEE ALSO
**oci-image-tool(1)**, **skopeo**(1)
**oci-image-tool**(1), **skopeo**(1)

# HISTORY
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)
2 changes: 1 addition & 1 deletion cmd/oci-image-tool/man/oci-image-tool-validate.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ busybox-oci: OK
```

# SEE ALSO
**oci-image-tool(1)**, **skopeo**(1)
**oci-image-tool**(1), **skopeo**(1)

# HISTORY
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)
8 changes: 4 additions & 4 deletions cmd/oci-image-tool/man/oci-image-tool.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ oci-image-tool \- OCI (Open Container Initiative) image tool
# COMMANDS
**create-runtime-bundle**
Create an OCI image runtime bundle
See **oci-image-tool-create-runtime-bundle(1)** for full documentation on the **create-runtime-bundle** command.
See **oci-image-tool-create-runtime-bundle**(1) for full documentation on the **create-runtime-bundle** command.

**unpack**
Unpack an image or image source layout
See **oci-image-tool-unpack(1)** for full documentation on the **unpack** command.
See **oci-image-tool-unpack**(1) for full documentation on the **unpack** command.

**validate**
Validate one or more image files
See **oci-image-tool-validate(1)** for full documentation on the **validate** command.
See **oci-image-tool-validate**(1) for full documentation on the **validate** command.

# SEE ALSO
**oci-image-tool-create-runtime-bundle**, **ocitools-unpack**(1), **ocitools-validate**(1)
**oci-image-tool-create-runtime-bundle**(1), **ocitools-unpack**(1), **ocitools-validate**(1)

# HISTORY
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

0 comments on commit 1ec6417

Please sign in to comment.