Skip to content

Commit 7e96d03

Browse files
wkingwking
committed
cmd/oci-image-tool/man: Document the cas, refs, and init commands
Signed-off-by: W. Trevor King <[email protected]>
1 parent b9becbd commit 7e96d03

10 files changed

+250
-0
lines changed

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
% OCI(1) OCI-IMAGE-TOOL User Manuals
2+
% OCI Community
3+
% AUGUST 2016
4+
# NAME
5+
oci-image-tool-refs \- Name-based reference manipulation
6+
7+
# SYNOPSIS
8+
**oci-image-tool refs** [command]
9+
10+
# DESCRIPTION
11+
`oci-image-tool refs` manipulates name-based references.
12+
13+
# OPTIONS
14+
**--help**
15+
Print usage statement
16+
17+
# COMMANDS
18+
**get**
19+
Retrieve a reference from the store.
20+
See **oci-image-tool-refs-get**(1) for full documentation on the **get** command.
21+
22+
**list**
23+
Return available names from the store.
24+
See **oci-image-tool-refs-list**(1) for full documentation on the **list** command.
25+
26+
**put**
27+
Write a reference to the store.
28+
See **oci-image-tool-refs-put**(1) for full documentation on the **put** command.
29+
30+
# EXAMPLES
31+
```
32+
$ oci-image-tool init image-layout image.tar
33+
$ DIGEST=$(echo hello | oci-image-tool cas put image.tar)
34+
$ SIZE=$(echo hello | wc -c)
35+
$ printf '{"mediaType": "text/plain", "digest": "%s", "size": %d}' "${DIGEST}" "${SIZE}" |
36+
> oci-image-tool refs put image.tar greeting
37+
$ oci-image-tool refs list image.tar
38+
greeting
39+
$ oci-image-tool refs get image.tar greeting
40+
{"mediaType":"text/plain","digest":"sha256:5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03","size":6}
41+
```
42+
43+
# SEE ALSO
44+
**oci-image-tool**(1), **oci-image-tool-cas-put**(1), **oci-image-tool-refs-get**(1), **oci-image-tool-refs-list**(1), **oci-image-tool-refs-put**(1)
45+
46+
# HISTORY
47+
August 2016, Originally compiled by W. Trevor King (wking at tremily dot us)

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,22 @@ oci-image-tool \- OCI (Open Container Initiative) image tool
1818
Print usage statement
1919

2020
# COMMANDS
21+
**cas**
22+
Content-addressable storage manipulation.
23+
See **oci-image-tool-cas**(1) for full documentation on the **cas** command.
24+
2125
**create-runtime-bundle**
2226
Create an OCI image runtime bundle
2327
See **oci-image-tool-create-runtime-bundle(1)** for full documentation on the **create-runtime-bundle** command.
2428

29+
**init**
30+
Initialize an OCI image.
31+
See **oci-image-tool-init**(1) for full documentation on the **init** command.
32+
33+
**refs**
34+
Name-based reference manipulation.
35+
See **oci-image-tool-refs**(1) for full documentation on the **refs** command.
36+
2537
**unpack**
2638
Unpack an image or image source layout
2739
See **oci-image-tool-unpack(1)** for full documentation on the **unpack** command.

0 commit comments

Comments
 (0)