Skip to content

Commit 2bea980

Browse files
wkingwking
committed
cmd: Document the cas, refs, and init commands
Most of this is new boilerplate, but oci-image-tools.7.md is based on the old oci-image-tool.1.md removed by fe363aa (*: move to opencontainers/image-tools, 2016-09-15). There's a lot going on in this repo, and it's nice to have a page that outlines everything provided by the project even though we're no longer providing a single command. Signed-off-by: W. Trevor King <[email protected]>
1 parent ea85928 commit 2bea980

File tree

13 files changed

+340
-3
lines changed

13 files changed

+340
-3
lines changed

‎cmd/oci-cas/oci-cas-get.1.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% AUGUST 2016
4+
# NAME
5+
6+
oci-cas-get \- Retrieve a blob from the store
7+
8+
# SYNOPSIS
9+
10+
**oci-cas get** [OPTIONS] PATH DIGEST
11+
12+
# DESCRIPTION
13+
14+
`oci-cas get` retrieves a blob referenced by `DIGEST` from the store at `PATH` and writes it to standard output.
15+
16+
# OPTIONS
17+
18+
**--help**
19+
Print usage statement
20+
21+
# SEE ALSO
22+
23+
**oci-cas**(1), **oci-cas-put**(1)
24+
25+
# HISTORY
26+
27+
August 2016, Originally compiled by W. Trevor King (wking at tremily dot us)

‎cmd/oci-cas/oci-cas-put.1.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% AUGUST 2016
4+
# NAME
5+
6+
oci-cas-put \- Write a blob to the store
7+
8+
# SYNOPSIS
9+
10+
**oci-cas put** [OPTIONS] PATH
11+
12+
# DESCRIPTION
13+
14+
`oci-cas put` reads a blob from stdin, writes it to the store at `PATH`, and prints the digest to standard output.
15+
16+
# OPTIONS
17+
18+
**--help**
19+
Print usage statement
20+
21+
# SEE ALSO
22+
23+
**oci-cas**(1), **oci-cas-get**(1)
24+
25+
# HISTORY
26+
27+
August 2016, Originally compiled by W. Trevor King (wking at tremily dot us)

‎cmd/oci-cas/oci-cas.1.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
% OCI(1) OCI-User Manuals
2+
% OCI Community
3+
% AUGUST 2016
4+
# NAME
5+
6+
oci-cas \- Content-addressable storage manipulation
7+
8+
# SYNOPSIS
9+
10+
**oci-cas** [command]
11+
12+
# DESCRIPTION
13+
14+
`oci-cas` manipulates content-addressable storage.
15+
16+
# OPTIONS
17+
18+
**--help**
19+
Print usage statement
20+
21+
# COMMANDS
22+
23+
**get**
24+
Retrieve a blob from the store.
25+
See **oci-cas-get**(1) for full documentation on the **get** command.
26+
27+
**put**
28+
Write a blob to the store.
29+
See **oci-cas-put**(1) for full documentation on the **put** command.
30+
31+
# EXAMPLES
32+
33+
```
34+
$ oci-init image-layout image.tar
35+
$ echo hello | oci-cas put image.tar
36+
sha256:5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
37+
$ oci-cas get image.tar sha256:5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
38+
hello
39+
```
40+
41+
# SEE ALSO
42+
43+
**oci-image-tools**(7), **oci-cas-get**(1), **oci-cas-put**(1), **oci-init**(1)
44+
45+
# HISTORY
46+
47+
August 2016, Originally compiled by W. Trevor King (wking at tremily dot us)

‎cmd/oci-create-runtime-bundle/oci-create-runtime-bundle.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $ cd busybox-bundle && sudo runc run busybox
3636
```
3737

3838
# SEE ALSO
39-
**runc**(1), **skopeo**(1)
39+
**oci-image-tools**(7), **runc**(1), **skopeo**(1)
4040

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

‎cmd/oci-image-init/oci-image-init-image-layout.1.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% AUGUST 2016
4+
# NAME
5+
6+
oci-image-init-image-layout \- Initialize an OCI image-layout repository
7+
8+
# SYNOPSIS
9+
10+
**oci-image-init image-layout** [OPTIONS] PATH
11+
12+
# DESCRIPTION
13+
14+
`oci-image-init image-layout` initializes an image-layout repository at `PATH`.
15+
16+
# OPTIONS
17+
18+
**--help**
19+
Print usage statement
20+
21+
# SEE ALSO
22+
23+
**oci-image-init**(1), **oci-cas**(1), ***oci-refs**(1)
24+
25+
# HISTORY
26+
27+
August 2016, Originally compiled by W. Trevor King (wking at tremily dot us)

‎cmd/oci-image-init/oci-image-init.1.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% AUGUST 2016
4+
# NAME
5+
6+
oci-image-init \- Initialize an OCI image
7+
8+
# SYNOPSIS
9+
10+
**oci-image-init** [command]
11+
12+
# DESCRIPTION
13+
14+
`oci-image-init` Initializes an OCI image.
15+
16+
# OPTIONS
17+
18+
**--help**
19+
Print usage statement
20+
21+
# COMMANDS
22+
23+
**image-layout**
24+
Initialize an OCI image-layout repository.
25+
See **oci-image-init-image-layout**(1) for full documentation on the **image-layout** command.
26+
27+
# SEE ALSO
28+
29+
**oci-image-tool**(1), **oci-image-init-image-layout**(1)
30+
31+
# HISTORY
32+
33+
August 2016, Originally compiled by W. Trevor King (wking at tremily dot us)

‎cmd/oci-image-tools.7.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+
6+
oci-image-tools \- OCI (Open Container Initiative) image tools
7+
8+
# DESCRIPTION
9+
10+
The OCI image tools are a collection of tools for working with the OCI image specification.
11+
12+
# COMMANDS
13+
14+
**oci-cas**(1)
15+
Content-addressable storage manipulation.
16+
17+
**oci-create-runtime-bundle**(1)
18+
Create an OCI image runtime bundle
19+
20+
**oci-image-init**(1)
21+
Initialize an OCI image.
22+
23+
**oci-refs**(1)
24+
Name-based reference manipulation.
25+
26+
**oci-unpack**(1)
27+
Unpack an image or image source layout
28+
29+
**oci-validate**(1)
30+
Validate one or more image files
31+
32+
# SEE ALSO
33+
34+
**skopeo**(1),
35+
https://github.com/opencontainers/image-spec,
36+
https://github.com/opencontainers/image-tools
37+
38+
# HISTORY
39+
40+
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ busybox-oci: OK
3333
```
3434

3535
# SEE ALSO
36-
**skopeo**(1)
36+
**oci-image-tools**(7), **skopeo**(1)
3737

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

‎cmd/oci-refs/oci-refs-get.1.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% AUGUST 2016
4+
# NAME
5+
6+
oci-refs-get \- Retrieve a reference from the store
7+
8+
# SYNOPSIS
9+
10+
**oci-refs get** [OPTIONS] PATH NAME
11+
12+
# DESCRIPTION
13+
14+
`oci-refs get` retrieves reference `NAME` from the store at `PATH` and writes the JSON descriptor to standard output.
15+
16+
# OPTIONS
17+
18+
**--help**
19+
Print usage statement
20+
21+
# SEE ALSO
22+
23+
**oci-refs**(1), **oci-refs-list**(1), **oci-refs-put**(1)
24+
25+
# HISTORY
26+
27+
August 2016, Originally compiled by W. Trevor King (wking at tremily dot us)

‎cmd/oci-refs/oci-refs-list.1.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% AUGUST 2016
4+
# NAME
5+
6+
oci-refs-list \- Return available names from the store
7+
8+
# SYNOPSIS
9+
10+
**oci-refs list** [OPTIONS] PATH
11+
12+
# DESCRIPTION
13+
14+
`oci-refs list` retrieves all names from the store at `PATH` and writes them to standard output.
15+
16+
# OPTIONS
17+
18+
**--help**
19+
Print usage statement
20+
21+
# SEE ALSO
22+
23+
**oci-refs**(1), **oci-refs-get**(1), **oci-refs-put**(1)
24+
25+
# HISTORY
26+
27+
August 2016, Originally compiled by W. Trevor King (wking at tremily dot us)

0 commit comments

Comments
 (0)