vbatts/cri-o
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #958 from umohnani8/man_pages

Browse source 
Made some changes to man pages
This commit is contained in:
Daniel J Walsh 2017-09-28 14:59:54 -04:00 committed by GitHub
commit 3394b3b2d6
7 changed files with 66 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/kpod-export.1.md
View file

@ -8,6 +8,7 @@ kpod-export - Export container's filesystem contents as a tar archive
## SYNOPSIS
**kpod export**
**CONTAINER**
[**--output**|**-o**]
[**--help**|**-h**]
## DESCRIPTION
@ -19,18 +20,13 @@ redirected to a file using the **output flag**.
**kpod export [GLOBAL OPTIONS]**
**kpod export [OPTIONS] CONTAINER [GLOBAL OPTIONS]**
**kpod export [OPTIONS] CONTAINER**
## OPTIONS
**--output, -o**
Write to a file, default is STDOUT
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
## EXAMPLES
```

57
docs/kpod-history.1.md
View file

@ -6,7 +6,13 @@
kpod-history - Shows the history of an image
## SYNOPSIS
**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]**
**kpod history**
**IMAGE[:TAG|DIGEST]**
[**--human**|**-H**]
[**--no-trunc**]
[**--quiet**|**-q**]
[**--format**]
[**--help**|**-h**]
## DESCRIPTION
**kpod history** displays the history of an image by printing out information
@ -29,12 +35,9 @@ Valid placeholders for the Go template are listed below:
**kpod [GLOBAL OPTIONS]**
**kpod [GLOBAL OPTIONS] history [OPTIONS]**
**kpod history [GLOBAL OPTIONS]**
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]**
## OPTIONS
@ -51,15 +54,47 @@ Valid placeholders for the Go template are listed below:
Alter the output for a format like 'json' or a Go template.
## COMMANDS
## EXAMPLES
**kpod history debian**
```
# kpod history debian
ID CREATED CREATED BY SIZE COMMENT
b676ca55e4f2c 9 weeks ago /bin/sh -c #(nop) CMD ["bash"] 0 B
<missing> 9 weeks ago /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45.14 MB
```
**kpod history --no-trunc=true --human=false debian**
```
# kpod history --no-trunc=true --human=false debian
ID CREATED CREATED BY SIZE COMMENT
b676ca55e4f2c 2017-07-24T16:52:55Z /bin/sh -c #(nop) CMD ["bash"] 0
<missing> 2017-07-24T16:52:54Z /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45142935
```
**kpod history --format "{{.ID}} {{.Created}}" debian**
```
# kpod history --format "{{.ID}} {{.Created}}" debian
b676ca55e4f2c 9 weeks ago
<missing> 9 weeks ago
```
**kpod history --format json debian**
```
# kpod history --format json debian
[
{
"id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060",
"created": "2017-07-24T16:52:55.195062314Z",
"createdBy": "/bin/sh -c #(nop) CMD [\"bash\"]",
"size": 0,
"comment": ""
},
{
"id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060",
"created": "2017-07-24T16:52:54.898893387Z",
"createdBy": "/bin/sh -c #(nop) ADD file:ebba725fb97cea45d0b1b35ccc8144e766fcfc9a78530465c23b0c4674b14042 in / ",
"size": 45142935,
"comment": ""
}
]
```
## history
Show the history of an image

9
docs/kpod-load.1.md
View file

@ -8,6 +8,8 @@ kpod-load - Load an image from docker archive
## SYNOPSIS
**kpod load**
**NAME[:TAG|@DIGEST]**
[**--input**|**-i**]
[**--quiet**|**-q**]
[**--help**|**-h**]
## DESCRIPTION
@ -19,7 +21,7 @@ The **quiet** flag suppresses the output when set.
**kpod load [GLOBAL OPTIONS]**
**kpod load [OPTIONS] NAME[:TAG|@DIGEST] [GLOBAL OPTIONS]**
**kpod load [OPTIONS] NAME[:TAG|@DIGEST]**
## OPTIONS
@ -29,11 +31,6 @@ Read from archive file, default is STDIN
**--quiet, -q**
Suppress the output
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
## EXAMPLES
```

16
docs/kpod-ps.1.md
View file

@ -6,7 +6,12 @@
kpod-ps - Prints out information about containers
## SYNOPSIS
**kpod ps [OPTIONS] CONTAINER**
**kpod ps**
[**--all**|**-a**]
[**--no-trunc**]
[**--quiet**|**-q**]
[**--fromat**]
[**--help**|**-h**]
## DESCRIPTION
**kpod ps** lists the running containers on the system. Use the **--all** flag to view
@ -22,12 +27,9 @@ all the containers information. By default it lists:
**kpod [GLOBAL OPTIONS]**
**kpod [GLOBAL OPTIONS] ps [OPTIONS]**
**kpod ps [GLOBAL OPTIONS]**
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
**kpod ps [OPTIONS]**
## OPTIONS
@ -89,7 +91,7 @@ Valid filters are listed below:
| since | [ID] or [Name] Containers created since this container |
| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
## COMMANDS
## EXAMPLES
```
sudo kpod ps -a

7
docs/kpod-pull.1.md
View file

@ -50,12 +50,7 @@ Image stored in local container/storage
**kpod pull [GLOBAL OPTIONS]**
**kpod pull NAME[:TAG|@DIGEST] [GLOBAL OPTIONS]**
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
**kpod pull NAME[:TAG|@DIGEST]**
## SEE ALSO
kpod(1), crio(8), crio.conf(5)

10
docs/kpod-save.1.md
View file

@ -8,6 +8,9 @@ kpod-save - Save an image to docker-archive or oci-archive
## SYNOPSIS
**kpod save**
**NAME[:TAG]**
[**--quiet**|**-q**]
[**--format**]
[**--output**|**-o**]
[**--help**|**-h**]
## DESCRIPTION
@ -20,7 +23,7 @@ The **quiet** flag suppresses the output when set.
**kpod save [GLOBAL OPTIONS]**
**kpod save [OPTIONS] NAME[:TAG] [GLOBAL OPTIONS]**
**kpod save [OPTIONS] NAME[:TAG]**
## OPTIONS
@ -36,11 +39,6 @@ Save image to **oci-archive**
**--quiet, -q**
Suppress the output
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
## EXAMPLES
```

7
docs/kpod-version.1.md
View file

@ -15,12 +15,7 @@ OS, and Architecture.
**kpod [GLOBAL OPTIONS]**
**kpod [GLOBAL OPTIONS] version [OPTIONS]**
## GLOBAL OPTIONS
**--help, -h**
Print usage statement
**kpod version**
## SEE ALSO
kpod(1), crio(8), crio.conf(5)