summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/kpod-export.1.md44
-rw-r--r--docs/kpod-info.1.md36
-rw-r--r--docs/kpod-pause.1.md24
-rw-r--r--docs/kpod-rm.1.md38
-rw-r--r--docs/kpod-umount.1.md19
-rw-r--r--docs/kpod-unpause.1.md24
-rw-r--r--docs/kpod-wait.1.md36
-rw-r--r--docs/podman-attach.1.md (renamed from docs/kpod-attach.1.md)16
-rw-r--r--docs/podman-cp.1.md (renamed from docs/kpod-cp.1.md)28
-rw-r--r--docs/podman-create.1.md (renamed from docs/kpod-create.1.md)70
-rw-r--r--docs/podman-diff.1.md (renamed from docs/kpod-diff.1.md)14
-rw-r--r--docs/podman-exec.1.md (renamed from docs/kpod-exec.1.md)12
-rw-r--r--docs/podman-export.1.md44
-rw-r--r--docs/podman-history.1.md (renamed from docs/kpod-history.1.md)26
-rw-r--r--docs/podman-images.1.md (renamed from docs/kpod-images.1.md)24
-rw-r--r--docs/podman-import.1.md (renamed from docs/kpod-import.1.md)26
-rw-r--r--docs/podman-info.1.md36
-rw-r--r--docs/podman-inspect.1.md (renamed from docs/kpod-inspect.1.md)12
-rw-r--r--docs/podman-kill.1.md (renamed from docs/kpod-kill.1.md)16
-rw-r--r--docs/podman-load.1.md (renamed from docs/kpod-load.1.md)28
-rw-r--r--docs/podman-login.1.md (renamed from docs/kpod-login.1.md)26
-rw-r--r--docs/podman-logout.1.md (renamed from docs/kpod-logout.1.md)24
-rw-r--r--docs/podman-logs.1.md (renamed from docs/kpod-logs.1.md)18
-rw-r--r--docs/podman-mount.1.md (renamed from docs/kpod-mount.1.md)16
-rw-r--r--docs/podman-pause.1.md24
-rw-r--r--docs/podman-ps.1.md (renamed from docs/kpod-ps.1.md)26
-rw-r--r--docs/podman-pull.1.md (renamed from docs/kpod-pull.1.md)36
-rw-r--r--docs/podman-push.1.md (renamed from docs/kpod-push.1.md)30
-rw-r--r--docs/podman-rm.1.md38
-rw-r--r--docs/podman-rmi.1.md (renamed from docs/kpod-rmi.1.md)18
-rw-r--r--docs/podman-run.1.md (renamed from docs/kpod-run.1.md)134
-rw-r--r--docs/podman-save.1.md (renamed from docs/kpod-save.1.md)30
-rw-r--r--docs/podman-start.1.md (renamed from docs/kpod-start.1.md)16
-rw-r--r--docs/podman-stats.1.md (renamed from docs/kpod-stats.1.md)16
-rw-r--r--docs/podman-stop.1.md (renamed from docs/kpod-stop.1.md)20
-rw-r--r--docs/podman-tag.1.md (renamed from docs/kpod-tag.1.md)18
-rw-r--r--docs/podman-top.1.md (renamed from docs/kpod-top.1.md)16
-rw-r--r--docs/podman-umount.1.md19
-rw-r--r--docs/podman-unpause.1.md24
-rw-r--r--docs/podman-version.1.md (renamed from docs/kpod-version.1.md)14
-rw-r--r--docs/podman-wait.1.md36
-rw-r--r--docs/podman.1.md (renamed from docs/kpod.1.md)18
42 files changed, 595 insertions, 595 deletions
diff --git a/docs/kpod-export.1.md b/docs/kpod-export.1.md
deleted file mode 100644
index c344f1367..000000000
--- a/docs/kpod-export.1.md
+++ /dev/null
@@ -1,44 +0,0 @@
-% kpod(1) kpod-export - Simple tool to export a container's filesystem as a tarball
-% Urvashi Mohnani
-# kpod-export "1" "July 2017" "kpod"
-
-## NAME
-kpod-export - Export container's filesystem contents as a tar archive
-
-## SYNOPSIS
-**kpod export**
-**CONTAINER**
-[**--output**|**-o**]
-[**--help**|**-h**]
-
-## DESCRIPTION
-**kpod export** exports the filesystem of a container and saves it as a tarball
-on the local machine. **kpod export** writes to STDOUT by default and can be
-redirected to a file using the **output flag**.
-
-**kpod [GLOBAL OPTIONS]**
-
-**kpod export [GLOBAL OPTIONS]**
-
-**kpod export [OPTIONS] CONTAINER**
-
-## OPTIONS
-
-**--output, -o**
-Write to a file, default is STDOUT
-
-## EXAMPLES
-
-```
-# kpod export -o redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
-```
-
-```
-# kpod export > redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
-```
-
-## SEE ALSO
-kpod(1), kpod-import(1), crio(8), crio.conf(5)
-
-## HISTORY
-August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-info.1.md b/docs/kpod-info.1.md
deleted file mode 100644
index 99deae9b1..000000000
--- a/docs/kpod-info.1.md
+++ /dev/null
@@ -1,36 +0,0 @@
-% kpod(1) kpod-version - Simple tool to view version information
-% Vincent Batts
-% kpod-version "1" "JULY 2017" "kpod"
-
-## NAME
-kpod-info - Display system information
-
-
-## SYNOPSIS
-**kpod** **info** [*options* [...]]
-
-
-## DESCRIPTION
-
-Information display here pertain to the host, current storage stats, and build of kpod. Useful for the user and when reporting issues.
-
-
-## OPTIONS
-
-**--debug, -D**
-
-Show additional information
-
-**--format**
-
-Change output format to "json" or a Go template.
-
-
-## EXAMPLE
-
-`kpod info`
-
-`kpod info --debug --format json| jq .host.kernel`
-
-## SEE ALSO
-crio(8), crio.conf(5)
diff --git a/docs/kpod-pause.1.md b/docs/kpod-pause.1.md
deleted file mode 100644
index 4a1eee92e..000000000
--- a/docs/kpod-pause.1.md
+++ /dev/null
@@ -1,24 +0,0 @@
-% kpod(1) kpod-pause - Pause one or more containers
-% Dan Walsh
-# kpod-pause "1" "September 2017" "kpod"
-
-## NAME
-kpod pause - Pause one or more containers
-
-## SYNOPSIS
-**kpod pause [OPTIONS] CONTAINER [...]**
-
-## DESCRIPTION
-Pauses all the processes in one or more containers. You may use container IDs or names as input.
-
-## EXAMPLE
-
-kpod pause mywebserver
-
-kpod pause 860a4b23
-
-## SEE ALSO
-kpod(1), kpod-unpause(1)
-
-## HISTORY
-September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
diff --git a/docs/kpod-rm.1.md b/docs/kpod-rm.1.md
deleted file mode 100644
index 77753f1fe..000000000
--- a/docs/kpod-rm.1.md
+++ /dev/null
@@ -1,38 +0,0 @@
-% kpod(1) kpod-rm - Remove one or more containers
-% Ryan Cole
-# kpod-rm "1" "August 2017" "kpod"
-
-## NAME
-kpod rm - Remove one or more containers
-
-## SYNOPSIS
-**kpod** **rm** [*options* [...]] container
-
-## DESCRIPTION
-kpod rm will remove one or more containers from the host. The container name or ID can be used. This does not remove images. Running containers will not be removed without the -f option
-
-## OPTIONS
-
-**--force, f**
-
-Force the removal of a running container
-
-**--all, a**
-
-Remove all containers. Can be used in conjunction with -f as well.
-
-## EXAMPLE
-
-kpod rm mywebserver
-
-kpod rm mywebserver myflaskserver 860a4b23
-
-kpod rm -f 860a4b23
-
-kpod rm -f -a
-
-## SEE ALSO
-kpod(1), kpod-rmi(1)
-
-## HISTORY
-August 2017, Originally compiled by Ryan Cole <rycole@redhat.com>
diff --git a/docs/kpod-umount.1.md b/docs/kpod-umount.1.md
deleted file mode 100644
index 2ee03356d..000000000
--- a/docs/kpod-umount.1.md
+++ /dev/null
@@ -1,19 +0,0 @@
-% kpod(1) kpod-umount - Unmount a working container's root filesystem.
-% Dan Walsh
-# kpod-umount "1" "July 2017" "kpod"
-
-## NAME
-kpod umount - Unmount a working container's root file system
-
-## SYNOPSIS
-**kpod** **umount** **containerID**
-
-## DESCRIPTION
-Unmounts the specified container's root file system.
-
-## EXAMPLE
-
-kpod umount containerID
-
-## SEE ALSO
-kpod(1), kpod-mount(1)
diff --git a/docs/kpod-unpause.1.md b/docs/kpod-unpause.1.md
deleted file mode 100644
index 52a810025..000000000
--- a/docs/kpod-unpause.1.md
+++ /dev/null
@@ -1,24 +0,0 @@
-% kpod(1) kpod-unpause - Unpause one or more containers
-% Dan Walsh
-# kpod-unpause "1" "September 2017" "kpod"
-
-## NAME
-kpod unpause - Unpause one or more containers
-
-## SYNOPSIS
-**kpod unpause [OPTIONS] CONTAINER [...]**
-
-## DESCRIPTION
-Unpauses the processes in one or more containers. You may use container IDs or names as input.
-
-## EXAMPLE
-
-kpod unpause mywebserver
-
-kpod unpause 860a4b23
-
-## SEE ALSO
-kpod(1), kpod-pause(1)
-
-## HISTORY
-September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
diff --git a/docs/kpod-wait.1.md b/docs/kpod-wait.1.md
deleted file mode 100644
index 290cdedfc..000000000
--- a/docs/kpod-wait.1.md
+++ /dev/null
@@ -1,36 +0,0 @@
-% kpod(1) kpod-wait - Waits on a container
-% Brent Baude
-# kpod-wait "1" "September 2017" "kpod"
-
-## NAME
-kpod wait - Waits on one or more containers to stop and prints exit code
-
-## SYNOPSIS
-**kpod wait**
-[**--help**|**-h**]
-
-## DESCRIPTION
-Waits on one or more containers to stop. The container can be referred to by its
-name or ID. In the case of multiple containers, kpod will wait on each consecutively.
-After the container stops, the container's return code is printed.
-
-**kpod [GLOBAL OPTIONS] wait **
-
-## GLOBAL OPTIONS
-
-**--help, -h**
- Print usage statement
-
-## EXAMPLES
-
- kpod wait mywebserver
-
- kpod wait 860a4b23
-
- kpod wait mywebserver myftpserver
-
-## SEE ALSO
-kpod(1), crio(8), crio.conf(5)
-
-## HISTORY
-September 2017, Originally compiled by Brent Baude<bbaude@redhat.com>
diff --git a/docs/kpod-attach.1.md b/docs/podman-attach.1.md
index 0710cd06f..ddb59e553 100644
--- a/docs/kpod-attach.1.md
+++ b/docs/podman-attach.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-attach - See the output of pid 1 of a container or enter the container
+% podman(1) podman-attach - See the output of pid 1 of a container or enter the container
% Dan Walsh
-# kpod-attach "1" "December 2017" "kpod"
+# podman-attach "1" "December 2017" "podman"
## NAME
-kpod-attach - Attach to a running container
+podman-attach - Attach to a running container
## SYNOPSIS
-**kpod attach [OPTIONS] CONTAINER**
+**podman attach [OPTIONS] CONTAINER**
## DESCRIPTION
The attach command allows you to attach to a running container using the container's ID
@@ -26,15 +26,15 @@ Do not attach STDIN. The default is false.
## EXAMPLES ##
```
-kpod attach foobar
+podman attach foobar
[root@localhost /]#
```
```
-kpod attach 1234
+podman attach 1234
[root@localhost /]#
```
```
-kpod attach --no-stdin foobar
+podman attach --no-stdin foobar
```
## SEE ALSO
-kpod(1), kpod-exec(1), kpod-run(1)
+podman(1), podman-exec(1), podman-run(1)
diff --git a/docs/kpod-cp.1.md b/docs/podman-cp.1.md
index 1d33372b6..0c23d6f10 100644
--- a/docs/kpod-cp.1.md
+++ b/docs/podman-cp.1.md
@@ -1,14 +1,14 @@
-% kpod(1) kpod-cp - Copy content between container's file system and the host
+% podman(1) podman-cp - Copy content between container's file system and the host
% Dan Walsh
-# kpod-cp "1" "August 2017" "kpod"
+# podman-cp "1" "August 2017" "podman"
## NAME
-kpod-cp - Copy files/folders between a container and the local filesystem.
+podman-cp - Copy files/folders between a container and the local filesystem.
## Description
-We chose not to implement the `cp` feature in `kpod` even though the upstream Docker
-project has it. We have a much stronger capability. Using standard kpod-mount
-and kpod-umount, we can take advantage of the entire linux tool chain, rather
+We chose not to implement the `cp` feature in `podman` even though the upstream Docker
+project has it. We have a much stronger capability. Using standard podman-mount
+and podman-umount, we can take advantage of the entire linux tool chain, rather
then just cp.
If a user wants to copy contents out of a container or into a container, they
@@ -20,27 +20,27 @@ reverse, from the local filesystem to the container.
If you want to copy the /etc/foobar directory out of a container and onto /tmp
on the host, you could execute the following commands:
- mnt=$(kpod mount CONTAINERID)
+ mnt=$(podman mount CONTAINERID)
cp -R ${mnt}/etc/foobar /tmp
- kpod umount CONTAINERID
+ podman umount CONTAINERID
If you want to untar a tar ball into a container, you can execute these commands:
- mnt=$(kpod mount CONTAINERID)
+ mnt=$(podman mount CONTAINERID)
tar xf content.tgz -C ${mnt}
- kpod umount CONTAINERID
+ podman umount CONTAINERID
One last example, if you want to install a package into a container that
does not have dnf installed, you could execute something like:
- mnt=$(kpod mount CONTAINERID)
+ mnt=$(podman mount CONTAINERID)
dnf install --installroot=${mnt} httpd
chroot ${mnt} rm -rf /var/log/dnf /var/cache/dnf
- kpod umount CONTAINERID
+ podman umount CONTAINERID
-This shows that using `kpod mount` and `kpod umount` you can use all of the
+This shows that using `podman mount` and `podman umount` you can use all of the
standard linux tools for moving files into and out of containers, not just
the cp command.
## SEE ALSO
-kpod(1), kpod-mount(1), kpod-umount(1)
+podman(1), podman-mount(1), podman-umount(1)
diff --git a/docs/kpod-create.1.md b/docs/podman-create.1.md
index f6a0e6722..9deeb8149 100644
--- a/docs/kpod-create.1.md
+++ b/docs/podman-create.1.md
@@ -1,19 +1,19 @@
-% kpod(1) kpod-create - Create a new container
+% podman(1) podman-create - Create a new container
% Dan Walsh
-kpod-create - Create a new container
+podman-create - Create a new container
# SYNOPSIS
-**kpod create** [*options* [...]] IMAGE [COMMAND] [ARG...]
+**podman create** [*options* [...]] IMAGE [COMMAND] [ARG...]
# DESCRIPTION
Creates a writeable container layer over the specified image and prepares it for
running the specified command. The container ID is then printed to STDOUT. This
-is similar to **kpod run -d** except the container is never started. You can
-then use the **kpod start <container_id>** command to start the container at
+is similar to **podman run -d** except the container is never started. You can
+then use the **podman start <container_id>** command to start the container at
any point.
-The initial status of the container created with **kpod create** is 'created'.
+The initial status of the container created with **podman create** is 'created'.
# OPTIONS
**--add-host**=[]
@@ -26,7 +26,7 @@ option can be set multiple times.
Attach to STDIN, STDOUT or STDERR.
In foreground mode (the default when **-d**
-is not specified), **kpod run** can start the process in the container
+is not specified), **podman run** can start the process in the container
and attach the console to the process's standard input, output, and standard
error. It can even pretend to be a TTY (this is what most commandline
executables expect) and pass along signals. The **-a** option can be set for
@@ -134,9 +134,9 @@ two memory nodes.
**-d**, **--detach**=*true*|*false*
Detached mode: run the container in the background and print the new container ID. The default is *false*.
- At any time you can run **kpod ps** in
+ At any time you can run **podman ps** in
the other shell to view a list of the running containers. You can reattach to a
-detached container with **kpod attach**. If you choose to run a container in
+detached container with **podman attach**. If you choose to run a container in
the detached mode, then you cannot use the **-rm** option.
When attached in the tty mode, you can detach from the container (and leave it
@@ -253,7 +253,7 @@ millions of trillions.
**--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*"
Logging driver for the container. Default is defined by daemon `--log-driver` flag.
- **Warning**: the `kpod logs` command works only for the `json-file` and
+ **Warning**: the `podman logs` command works only for the `json-file` and
`journald` logging drivers.
**--log-opt**=[]
@@ -305,7 +305,7 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
UUID short identifier (“f78375b1c487”)
Name (“jonah”)
- kpod generates a UUID for each container, and if a name is not assigned
+ podman generates a UUID for each container, and if a name is not assigned
to the container with **--name** then the daemon will also generate a random
string name. The name is useful any place you need to identify a container.
This works for both background and foreground containers.
@@ -315,7 +315,7 @@ This works for both background and foreground containers.
'bridge': create a network stack on the default bridge
'none': no networking
'container:<name|id>': reuse another container's network stack
- 'host': use the kpod host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
+ 'host': use the podman host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
'<network-name>|<network-id>': connect to a user-defined network
**--network-alias**=[]
@@ -342,12 +342,12 @@ This works for both background and foreground containers.
**--privileged**=*true*|*false*
Give extended privileges to this container. The default is *false*.
- By default, kpod containers are
+ By default, podman containers are
“unprivileged” (=false) and cannot, for example, modify parts of the kernel.
This is because by default a container is not allowed to access any devices.
A “privileged” container is given access to all devices.
- When the operator executes **kpod run --privileged**, kpod enables access
+ When the operator executes **podman run --privileged**, podman enables access
to all devices on the host as well as set turn off most of the security messurs
protecting the host from the container.
@@ -357,21 +357,21 @@ protecting the host from the container.
Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort`
Both hostPort and containerPort can be specified as a range of ports.
When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range.
-(e.g., `kpod run -p 1234-1236:1222-1224 --name thisWorks -t busybox`
-but not `kpod run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`)
-With ip: `kpod run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
-Use `kpod port` to see the actual mapping: `kpod port CONTAINER $CONTAINERPORT`
+(e.g., `podman run -p 1234-1236:1222-1224 --name thisWorks -t busybox`
+but not `podman run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`)
+With ip: `podman run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
+Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPORT`
**-P**, **--publish-all**=*true*|*false*
Publish all exposed ports to random ports on the host interfaces. The default is *false*.
When set to true publish all exposed ports to the host interfaces. The
-default is false. If the operator uses -P (or -p) then kpod will make the
+default is false. If the operator uses -P (or -p) then podman will make the
exposed port accessible on the host and the ports will be available to any
-client that can reach the host. When using -P, kpod will bind any exposed
+client that can reach the host. When using -P, podman will bind any exposed
port to a random port on the host within an *ephemeral port range* defined by
`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
-ports and the exposed ports, use `kpod port`.
+ports and the exposed ports, use `podman port`.
**--read-only**=*true*|*false*
Mount the container's root filesystem as read only.
@@ -419,7 +419,7 @@ incompatible with any restart policy other than `none`.
**--storage-opt**=[]
Storage driver options per container
- $ kpod create -it --storage-opt size=120G fedora /bin/bash
+ $ podman create -it --storage-opt size=120G fedora /bin/bash
This (size) will allow to set the container rootfs size to 120G at creation time.
This option is only available for the `devicemapper`, `btrfs`, `overlay2` and `zfs` graph drivers.
@@ -446,7 +446,7 @@ incompatible with any restart policy other than `none`.
Mount a temporary filesystem (`tmpfs`) mount into a container, for example:
- $ kpod run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image
+ $ podman run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image
This command mounts a `tmpfs` at `/tmp` within the container. The supported mount
options are the same as the Linux default `mount` flags. If you do not specify
@@ -456,11 +456,11 @@ any options, the systems uses the following options:
**-t**, **--tty**=*true*|*false*
Allocate a pseudo-TTY. The default is *false*.
- When set to true kpod will allocate a pseudo-tty and attach to the standard
+ When set to true podman will allocate a pseudo-tty and attach to the standard
input of the container. This can be used, for example, to run a throwaway
interactive shell. The default is false.
-Note: The **-t** option is incompatible with a redirection of the kpod client
+Note: The **-t** option is incompatible with a redirection of the podman client
standard input.
**--ulimit**=[]
@@ -484,8 +484,8 @@ standard input.
Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
**-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
- Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, kpod
- bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the kpod
+ Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, podman
+ bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the podman
container. The `OPTIONS` are a comma delimited list and can be:
* [rw|ro]
@@ -493,8 +493,8 @@ standard input.
* [`[r]shared`|`[r]slave`|`[r]private`]
The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The `HOST-DIR`
-must be an absolute path as well. kpod bind-mounts the `HOST-DIR` to the
-path you specify. For example, if you supply the `/foo` value, kpod creates a bind-mount.
+must be an absolute path as well. podman bind-mounts the `HOST-DIR` to the
+path you specify. For example, if you supply the `/foo` value, podman creates a bind-mount.
You can specify multiple **-v** options to mount one or more mounts to a
container.
@@ -506,14 +506,14 @@ See examples.
Labeling systems like SELinux require that proper labels are placed on volume
content mounted into a container. Without a label, the security system might
prevent the processes running inside the container from using the content. By
-default, kpod does not change the labels set by the OS.
+default, podman does not change the labels set by the OS.
To change a label in the container context, you can add either of two suffixes
-`:z` or `:Z` to the volume mount. These suffixes tell kpod to relabel file
-objects on the shared volumes. The `z` option tells kpod that two containers
-share the volume content. As a result, kpod labels the content with a shared
+`:z` or `:Z` to the volume mount. These suffixes tell podman to relabel file
+objects on the shared volumes. The `z` option tells podman that two containers
+share the volume content. As a result, podman labels the content with a shared
content label. Shared volume labels allow all containers to read/write content.
-The `Z` option tells kpod to label the content with a private unshared label.
+The `Z` option tells podman to label the content with a private unshared label.
Only the current container can use a private volume.
By default bind mounted volumes are `private`. That means any mounts done
@@ -563,4 +563,4 @@ can override the working directory by using the **-w** option.
August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
-October 2017, converted from Docker documentation to kpod by Dan Walsh for kpod <dwalsh@redhat.com>
+October 2017, converted from Docker documentation to podman by Dan Walsh for podman <dwalsh@redhat.com>
diff --git a/docs/kpod-diff.1.md b/docs/podman-diff.1.md
index 1916780c8..1ba5951db 100644
--- a/docs/kpod-diff.1.md
+++ b/docs/podman-diff.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-diff - Inspect changes on a container or image's filesystem
+% podman(1) podman-diff - Inspect changes on a container or image's filesystem
% Dan Walsh
-# kpod-diff "1" "August 2017" "kpod"
+# podman-diff "1" "August 2017" "podman"
## NAME
-kpod diff - Inspect changes on a container or image's filesystem
+podman diff - Inspect changes on a container or image's filesystem
## SYNOPSIS
-**kpod** **diff** [*options* [...]] NAME
+**podman** **diff** [*options* [...]] NAME
## DESCRIPTION
Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer
@@ -20,13 +20,13 @@ Alter the output into a different format. The only valid format for diff is `js
## EXAMPLE
-kpod diff redis:alpine
+podman diff redis:alpine
C /usr
C /usr/local
C /usr/local/bin
A /usr/local/bin/docker-entrypoint.sh
-kpod diff --format json redis:alpine
+podman diff --format json redis:alpine
{
"changed": [
"/usr",
@@ -39,7 +39,7 @@ kpod diff --format json redis:alpine
}
## SEE ALSO
-kpod(1)
+podman(1)
## HISTORY
August 2017, Originally compiled by Ryan Cole <rycole@redhat.com>
diff --git a/docs/kpod-exec.1.md b/docs/podman-exec.1.md
index 1de5da39b..aa8d36a96 100644
--- a/docs/kpod-exec.1.md
+++ b/docs/podman-exec.1.md
@@ -1,18 +1,18 @@
-% kpod(1) kpod-exec - Execute a command in a running container
+% podman(1) podman-exec - Execute a command in a running container
% Brent Baude
-# kpod-exec "1" "December 2017" "kpod"
+# podman-exec "1" "December 2017" "podman"
## NAME
-kpod-exec - Execute a command in a running container
+podman-exec - Execute a command in a running container
## SYNOPSIS
-**kpod exec**
+**podman exec**
**CONTAINER**
[COMMAND] [ARG...]
[**--help**|**-h**]
## DESCRIPTION
-**kpod exec** executes a command in a running container.
+**podman exec** executes a command in a running container.
## OPTIONS
**--env, e**
@@ -37,7 +37,7 @@ The following examples are all valid:
## SEE ALSO
-kpod(1), kpod-run(1)
+podman(1), podman-run(1)
## HISTORY
December 2017, Originally compiled by Brent Baude<bbaude@redhat.com>
diff --git a/docs/podman-export.1.md b/docs/podman-export.1.md
new file mode 100644
index 000000000..5652c245b
--- /dev/null
+++ b/docs/podman-export.1.md
@@ -0,0 +1,44 @@
+% podman(1) podman-export - Simple tool to export a container's filesystem as a tarball
+% Urvashi Mohnani
+# podman-export "1" "July 2017" "podman"
+
+## NAME
+podman-export - Export container's filesystem contents as a tar archive
+
+## SYNOPSIS
+**podman export**
+**CONTAINER**
+[**--output**|**-o**]
+[**--help**|**-h**]
+
+## DESCRIPTION
+**podman export** exports the filesystem of a container and saves it as a tarball
+on the local machine. **podman export** writes to STDOUT by default and can be
+redirected to a file using the **output flag**.
+
+**podman [GLOBAL OPTIONS]**
+
+**podman export [GLOBAL OPTIONS]**
+
+**podman export [OPTIONS] CONTAINER**
+
+## OPTIONS
+
+**--output, -o**
+Write to a file, default is STDOUT
+
+## EXAMPLES
+
+```
+# podman export -o redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
+```
+
+```
+# podman export > redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57
+```
+
+## SEE ALSO
+podman(1), podman-import(1), crio(8), crio.conf(5)
+
+## HISTORY
+August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-history.1.md b/docs/podman-history.1.md
index bc8f1699d..f4a089b3c 100644
--- a/docs/kpod-history.1.md
+++ b/docs/podman-history.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-history - Simple tool to view the history of an image
+% podman(1) podman-history - Simple tool to view the history of an image
% Urvashi Mohnani
-% kpod-history "1" "JULY 2017" "kpod"
+% podman-history "1" "JULY 2017" "podman"
## NAME
-kpod-history - Shows the history of an image
+podman-history - Shows the history of an image
## SYNOPSIS
-**kpod history**
+**podman history**
**IMAGE[:TAG|DIGEST]**
[**--human**|**-H**]
[**--no-trunc**]
@@ -15,7 +15,7 @@ kpod-history - Shows the history of an image
[**--help**|**-h**]
## DESCRIPTION
-**kpod history** displays the history of an image by printing out information
+**podman history** displays the history of an image by printing out information
about each layer used in the image. The information printed out for each layer
include Created (time and date), Created By, Size, and Comment. The output can
be truncated or not using the **--no-trunc** flag. If the **--human** flag is
@@ -33,11 +33,11 @@ Valid placeholders for the Go template are listed below:
| .Size | Size of layer on disk |
| .Comment | Comment for the layer |
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod history [GLOBAL OPTIONS]**
+**podman history [GLOBAL OPTIONS]**
-**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]**
+**podman history [OPTIONS] IMAGE[:TAG|DIGEST]**
## OPTIONS
@@ -57,27 +57,27 @@ Valid placeholders for the Go template are listed below:
## EXAMPLES
```
-# kpod history debian
+# podman 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
+# podman 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
+# podman history --format "{{.ID}} {{.Created}}" debian
b676ca55e4f2c 9 weeks ago
<missing> 9 weeks ago
```
```
-# kpod history --format json debian
+# podman history --format json debian
[
{
"id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060",
@@ -100,7 +100,7 @@ b676ca55e4f2c 9 weeks ago
Show the history of an image
## SEE ALSO
-kpod(1), crio(8), crio.conf(5)
+podman(1), crio(8), crio.conf(5)
## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-images.1.md b/docs/podman-images.1.md
index b852e047b..cb0c52bef 100644
--- a/docs/kpod-images.1.md
+++ b/docs/podman-images.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-images - List images in local storage
+% podman(1) podman-images - List images in local storage
% Dan Walsh
-# kpod-images "1" "March 2017" "kpod"
+# podman-images "1" "March 2017" "podman"
## NAME
-kpod images - List images in local storage
+podman images - List images in local storage
## SYNOPSIS
-**kpod** **images** [*options* [...]]
+**podman** **images** [*options* [...]]
## DESCRIPTION
Displays locally stored images, their names, and their IDs.
@@ -42,7 +42,7 @@ Lists only the image IDs.
## EXAMPLE
```
-# kpod images
+# podman images
REPOSITORY TAG IMAGE ID CREATED SIZE
docker.io/kubernetes/pause latest e3d42bcaf643 3 years ago 251kB
<none> <none> ebb91b73692b 4 weeks ago 27.2MB
@@ -50,21 +50,21 @@ docker.io/library/ubuntu latest 4526339ae51c 6 weeks ago
```
```
-# kpod images --quiet
+# podman images --quiet
e3d42bcaf643
ebb91b73692b
4526339ae51c
```
```
-# kpod images --noheading
+# podman images --noheading
docker.io/kubernetes/pause latest e3d42bcaf643 3 years ago 251kB
<none> <none> ebb91b73692b 4 weeks ago 27.2MB
docker.io/library/ubuntu latest 4526339ae51c 6 weeks ago 126MB
```
```
-# kpod images --no-trunc
+# podman images --no-trunc
REPOSITORY TAG IMAGE ID CREATED SIZE
docker.io/kubernetes/pause latest sha256:e3d42bcaf643097dd1bb0385658ae8cbe100a80f773555c44690d22c25d16b27 3 years ago 251kB
<none> <none> sha256:ebb91b73692bd27890685846412ae338d13552165eacf7fcd5f139bfa9c2d6d9 4 weeks ago 27.2MB
@@ -72,7 +72,7 @@ docker.io/library/ubuntu latest sha256:4526339ae51c3cdc979
```
```
-# kpod images --format "table {{.ID}} {{.Repository}} {{.Tag}}"
+# podman images --format "table {{.ID}} {{.Repository}} {{.Tag}}"
IMAGE ID REPOSITORY TAG
e3d42bcaf643 docker.io/kubernetes/pause latest
ebb91b73692b <none> <none>
@@ -80,13 +80,13 @@ ebb91b73692b <none> <none>
```
```
-# kpod images --filter dangling=true
+# podman images --filter dangling=true
REPOSITORY TAG IMAGE ID CREATED SIZE
<none> <none> ebb91b73692b 4 weeks ago 27.2MB
```
```
-# kpod images --format json
+# podman images --format json
[
{
"id": "e3d42bcaf643097dd1bb0385658ae8cbe100a80f773555c44690d22c25d16b27",
@@ -119,7 +119,7 @@ REPOSITORY TAG IMAGE ID CREATED SIZE
```
## SEE ALSO
-kpod(1)
+podman(1)
## HISTORY
March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
diff --git a/docs/kpod-import.1.md b/docs/podman-import.1.md
index cfcfb6fb2..f90b82a89 100644
--- a/docs/kpod-import.1.md
+++ b/docs/podman-import.1.md
@@ -1,28 +1,28 @@
-% kpod(1) kpod-import - Simple tool to import a tarball as an image
+% podman(1) podman-import - Simple tool to import a tarball as an image
% Urvashi Mohnani
-# kpod-import "1" "November 2017" "kpod"
+# podman-import "1" "November 2017" "podman"
## NAME
-kpod-import - import a tarball and save it as a filesystem image
+podman-import - import a tarball and save it as a filesystem image
## SYNOPSIS
-**kpod import**
+**podman import**
**TARBALL**
[**--change**|**-c**]
[**--message**|**-m**]
[**--help**|**-h**]
## DESCRIPTION
-**kpod import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz)
+**podman import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz)
and saves it as a filesystem image. Remote tarballs can be specified using a URL.
Various image instructions can be configured with the **--change** flag and
a commit message can be set using the **--message** flag.
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod import [GLOBAL OPTIONS]**
+**podman import [GLOBAL OPTIONS]**
-**kpod import [OPTIONS] CONTAINER**
+**podman import [OPTIONS] CONTAINER**
## OPTIONS
@@ -37,7 +37,7 @@ Set commit message for imported image
## EXAMPLES
```
-# kpod import --change CMD=/bin/bash --change ENTRYPOINT=/bin/sh --change LABEL=blue=image ctr.tar image-imported
+# podman import --change CMD=/bin/bash --change ENTRYPOINT=/bin/sh --change LABEL=blue=image ctr.tar image-imported
Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
25.80 MB / 25.80 MB [======================================================] 0s
@@ -48,7 +48,7 @@ Storing signatures
```
```
-# cat ctr.tar | kpod import --message "importing the ctr.tar tarball" - image-imported
+# cat ctr.tar | podman import --message "importing the ctr.tar tarball" - image-imported
Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
25.80 MB / 25.80 MB [======================================================] 0s
@@ -59,7 +59,7 @@ Storing signatures
```
```
-# cat ctr.tar | kpod import -
+# cat ctr.tar | podman import -
Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
25.80 MB / 25.80 MB [======================================================] 0s
@@ -70,7 +70,7 @@ Storing signatures
```
```
-kpod import http://example.com/ctr.tar url-image
+podman import http://example.com/ctr.tar url-image
Downloading from "http://example.com/ctr.tar"
Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
@@ -82,7 +82,7 @@ Storing signatures
```
## SEE ALSO
-kpod(1), kpod-export(1), crio(8), crio.conf(5)
+podman(1), podman-export(1), crio(8), crio.conf(5)
## HISTORY
November 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/podman-info.1.md b/docs/podman-info.1.md
new file mode 100644
index 000000000..09c46d7f9
--- /dev/null
+++ b/docs/podman-info.1.md
@@ -0,0 +1,36 @@
+% podman(1) podman-version - Simple tool to view version information
+% Vincent Batts
+% podman-version "1" "JULY 2017" "podman"
+
+## NAME
+podman-info - Display system information
+
+
+## SYNOPSIS
+**podman** **info** [*options* [...]]
+
+
+## DESCRIPTION
+
+Information display here pertain to the host, current storage stats, and build of podman. Useful for the user and when reporting issues.
+
+
+## OPTIONS
+
+**--debug, -D**
+
+Show additional information
+
+**--format**
+
+Change output format to "json" or a Go template.
+
+
+## EXAMPLE
+
+`podman info`
+
+`podman info --debug --format json| jq .host.kernel`
+
+## SEE ALSO
+crio(8), crio.conf(5)
diff --git a/docs/kpod-inspect.1.md b/docs/podman-inspect.1.md
index d3927cd37..c2edf896d 100644
--- a/docs/kpod-inspect.1.md
+++ b/docs/podman-inspect.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-inspect - Display a container or image's configuration
+% podman(1) podman-inspect - Display a container or image's configuration
% Dan Walsh
-# kpod-inspect "1" "July 2017" "kpod"
+# podman-inspect "1" "July 2017" "podman"
## NAME
-kpod inspect - Display a container or image's configuration
+podman inspect - Display a container or image's configuration
## SYNOPSIS
-**kpod** **inspect** [*options* [...]] name
+**podman** **inspect** [*options* [...]] name
## DESCRIPTION
This displays the low-level information on containers and images identified by name or ID. By default, this will render all results in a JSON array. If the container and image have the same name, this will return container JSON for unspecified type. If a format is specified, the given template will be executed for each result.
@@ -29,7 +29,7 @@ Display the total file size if the type is a container
## EXAMPLE
```
-# kpod inspect fedora
+# podman inspect fedora
{
"Id": "422dc563ca3260ad9ef5c47a1c246f5065d7f177ce51f4dd208efd82967ff182",
"Digest": "sha256:1b9bfb4e634dc1e5c19d0fa1eb2e5a28a5c2b498e3d3e4ac742bd7f5dae08611",
@@ -76,7 +76,7 @@ Display the total file size if the type is a container
```
## SEE ALSO
-kpod(1)
+podman(1)
## HISTORY
July 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
diff --git a/docs/kpod-kill.1.md b/docs/podman-kill.1.md
index 91247d282..e254f2af3 100644
--- a/docs/kpod-kill.1.md
+++ b/docs/podman-kill.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-kill- Kill one or more containers with a signal
+% podman(1) podman-kill- Kill one or more containers with a signal
% Brent Baude
-# kpod-kill"1" "September 2017" "kpod"
+# podman-kill"1" "September 2017" "podman"
## NAME
-kpod kill - Kills one or more containers with a signal
+podman kill - Kills one or more containers with a signal
## SYNOPSIS
-**kpod kill [OPTIONS] CONTAINER [...]**
+**podman kill [OPTIONS] CONTAINER [...]**
## DESCRIPTION
The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal.
@@ -20,14 +20,14 @@ Signal to send to the container. For more information on Linux signals, refer to
## EXAMPLE
-kpod kill mywebserver
+podman kill mywebserver
-kpod kill 860a4b23
+podman kill 860a4b23
-kpod kill --signal TERM 860a4b23
+podman kill --signal TERM 860a4b23
## SEE ALSO
-kpod(1), kpod-stop(1)
+podman(1), podman-stop(1)
## HISTORY
September 2017, Originally compiled by Brent Baude <bbaude@redhat.com>
diff --git a/docs/kpod-load.1.md b/docs/podman-load.1.md
index bb13b5f02..80210d547 100644
--- a/docs/kpod-load.1.md
+++ b/docs/podman-load.1.md
@@ -1,27 +1,27 @@
-% kpod(1) kpod-load - Simple tool to load an image from an archive to containers-storage
+% podman(1) podman-load - Simple tool to load an image from an archive to containers-storage
% Urvashi Mohnani
-# kpod-load "1" "July 2017" "kpod"
+# podman-load "1" "July 2017" "podman"
## NAME
-kpod-load - Load an image from docker archive
+podman-load - Load an image from docker archive
## SYNOPSIS
-**kpod load**
+**podman load**
**NAME[:TAG|@DIGEST]**
[**--input**|**-i**]
[**--quiet**|**-q**]
[**--help**|**-h**]
## DESCRIPTION
-**kpod load** copies an image from either **docker-archive** or **oci-archive** stored
-on the local machine. **kpod load** reads from stdin by default or a file if the **input** flag is set.
+**podman load** copies an image from either **docker-archive** or **oci-archive** stored
+on the local machine. **podman load** reads from stdin by default or a file if the **input** flag is set.
The **quiet** flag suppresses the output when set.
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod load [GLOBAL OPTIONS]**
+**podman load [GLOBAL OPTIONS]**
-**kpod load [OPTIONS] NAME[:TAG|@DIGEST]**
+**podman load [OPTIONS] NAME[:TAG|@DIGEST]**
## OPTIONS
@@ -40,15 +40,15 @@ option be used, as the default behavior of using the system-wide default policy
## EXAMPLES
```
-# kpod load --quiet -i fedora.tar
+# podman load --quiet -i fedora.tar
```
```
-# kpod load -q --signature-policy /etc/containers/policy.json -i fedora.tar
+# podman load -q --signature-policy /etc/containers/policy.json -i fedora.tar
```
```
-# kpod load < fedora.tar
+# podman load < fedora.tar
Getting image source signatures
Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0
0 B / 4.03 MB [---------------------------------------------------------------]
@@ -60,7 +60,7 @@ Loaded image: registry.fedoraproject.org/fedora:latest
```
```
-# cat fedora.tar | kpod load
+# cat fedora.tar | podman load
Getting image source signatures
Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0
0 B / 4.03 MB [---------------------------------------------------------------]
@@ -72,7 +72,7 @@ Loaded image: registry.fedoraproject.org/fedora:latest
```
## SEE ALSO
-kpod(1), kpod-save(1), crio(8), crio.conf(5)
+podman(1), podman-save(1), crio(8), crio.conf(5)
## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-login.1.md b/docs/podman-login.1.md
index 05b3097c8..8d8e688c1 100644
--- a/docs/kpod-login.1.md
+++ b/docs/podman-login.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-login - Simple tool to login to a registry server
+% podman(1) podman-login - Simple tool to login to a registry server
% Urvashi Mohnani
-# kpod-login "1" "August 2017" "kpod"
+# podman-login "1" "August 2017" "podman"
## NAME
-kpod-login - Login to a container registry
+podman-login - Login to a container registry
## SYNOPSIS
-**kpod login**
+**podman login**
[**--help**|**-h**]
[**--authfile**]
[**--user**|**-u**]
@@ -14,17 +14,17 @@ kpod-login - Login to a container registry
**REGISTRY**
## DESCRIPTION
-**kpod login** logs into a specified registry server with the correct username
-and password. **kpod login** reads in the username and password from STDIN.
+**podman login** logs into a specified registry server with the correct username
+and password. **podman login** reads in the username and password from STDIN.
The username and password can also be set using the **username** and **password** flags.
The path of the authentication file can be specified by the user by setting the **authfile**
flag. The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**.
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod login [GLOBAL OPTIONS]**
+**podman login [GLOBAL OPTIONS]**
-**kpod login [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
+**podman login [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
## OPTIONS
@@ -40,26 +40,26 @@ Path of the authentication file. Default is ${XDG_\RUNTIME\_DIR}/containers/auth
## EXAMPLES
```
-# kpod login docker.io
+# podman login docker.io
Username: umohnani
Password:
Login Succeeded!
```
```
-# kpod login -u testuser -p testpassword localhost:5000
+# podman login -u testuser -p testpassword localhost:5000
Login Succeeded!
```
```
-# kpod login --authfile authdir/myauths.json docker.io
+# podman login --authfile authdir/myauths.json docker.io
Username: umohnani
Password:
Login Succeeded!
```
## SEE ALSO
-kpod(1), kpod-logout(1), crio(8), crio.conf(5)
+podman(1), podman-logout(1), crio(8), crio.conf(5)
## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-logout.1.md b/docs/podman-logout.1.md
index 5f119a18a..7fa6c728d 100644
--- a/docs/kpod-logout.1.md
+++ b/docs/podman-logout.1.md
@@ -1,28 +1,28 @@
-% kpod(1) kpod-logout - Simple tool to logout of a registry server
+% podman(1) podman-logout - Simple tool to logout of a registry server
% Urvashi Mohnani
-# kpod-logout "1" "August 2017" "kpod"
+# podman-logout "1" "August 2017" "podman"
## NAME
-kpod-logout - Logout of a container registry
+podman-logout - Logout of a container registry
## SYNOPSIS
-**kpod logout**
+**podman logout**
[**--help**|**-h**]
[**--authfile**]
[**--all**|**-a**]
**REGISTRY**
## DESCRIPTION
-**kpod logout** logs out of a specified registry server by deleting the cached credentials
+**podman logout** logs out of a specified registry server by deleting the cached credentials
stored in the **auth.json** file. The path of the authentication file can be overrriden by the user by setting the **authfile** flag.
The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**.
All the cached credentials can be removed by setting the **all** flag.
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod logout [GLOBAL OPTIONS]**
+**podman logout [GLOBAL OPTIONS]**
-**kpod logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
+**podman logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
## OPTIONS
@@ -35,22 +35,22 @@ Remove the cached credentials for all registries in the auth file
## EXAMPLES
```
-# kpod logout docker.io
+# podman logout docker.io
Remove login credentials for https://registry-1.docker.io/v2/
```
```
-# kpod logout --authfile authdir/myauths.json docker.io
+# podman logout --authfile authdir/myauths.json docker.io
Remove login credentials for https://registry-1.docker.io/v2/
```
```
-# kpod logout --all
+# podman logout --all
Remove login credentials for all registries
```
## SEE ALSO
-kpod(1), kpod-login(1), crio(8), crio.conf(5)
+podman(1), podman-login(1), crio(8), crio.conf(5)
## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-logs.1.md b/docs/podman-logs.1.md
index 25d108edd..8b8c755b9 100644
--- a/docs/kpod-logs.1.md
+++ b/docs/podman-logs.1.md
@@ -1,15 +1,15 @@
-% kpod(1) kpod-logs - Fetch the logs of a container
+% podman(1) podman-logs - Fetch the logs of a container
% Ryan Cole
-# kpod-logs "1" "March 2017" "kpod"
+# podman-logs "1" "March 2017" "podman"
## NAME
-kpod logs - Fetch the logs of a container
+podman logs - Fetch the logs of a container
## SYNOPSIS
-**kpod** **logs** [*options* [...]] container
+**podman** **logs** [*options* [...]] container
## DESCRIPTION
-The kpod logs command batch-retrieves whatever logs are present for a container at the time of execution. This does not guarantee execution order when combined with kpod run (i.e. your run may not have generated any logs at the time you execute kpod logs
+The podman logs command batch-retrieves whatever logs are present for a container at the time of execution. This does not guarantee execution order when combined with podman run (i.e. your run may not have generated any logs at the time you execute podman logs
## OPTIONS
@@ -27,7 +27,7 @@ Ouput the specified number of LINES at the end of the logs. LINES must be a pos
## EXAMPLE
-kpod logs b3f2436bdb978c1d33b1387afb5d7ba7e3243ed2ce908db431ac0069da86cb45
+podman logs b3f2436bdb978c1d33b1387afb5d7ba7e3243ed2ce908db431ac0069da86cb45
2017/08/07 10:16:21 Seeked /var/log/crio/pods/eb296bd56fab164d4d3cc46e5776b54414af3bf543d138746b25832c816b933b/c49f49788da14f776b7aa93fb97a2a71f9912f4e5a3e30397fca7dfe0ee0367b.log - &{Offset:0 Whence:0}
1:C 07 Aug 14:10:09.055 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
@@ -41,12 +41,12 @@ kpod logs b3f2436bdb978c1d33b1387afb5d7ba7e3243ed2ce908db431ac0069da86cb45
1:M 07 Aug 14:10:09.056 # Server initialized
-kpod logs --tail 2 b3f2436bdb97
+podman logs --tail 2 b3f2436bdb97
1:M 07 Aug 14:10:09.056 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128.
1:M 07 Aug 14:10:09.056 # Server initialized
-kpod logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver
+podman logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver
1:M 07 Aug 14:10:09.055 # Server can't set maximum open files to 10032 because of OS error: Operation not permitted.
1:M 07 Aug 14:10:09.055 # Current maximum open files is 4096. maxclients has been reduced to 4064 to compensate for low ulimit. If you need higher maxclients increase 'ulimit -n'.
@@ -55,7 +55,7 @@ kpod logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver
1:M 07 Aug 14:10:09.056 # Server initialized
## SEE ALSO
-kpod(1)
+podman(1)
## HISTORY
August 2017, Originally compiled by Ryan Cole <rycole@redhat.com>
diff --git a/docs/kpod-mount.1.md b/docs/podman-mount.1.md
index 25ccd937a..b0ebd05fb 100644
--- a/docs/kpod-mount.1.md
+++ b/docs/podman-mount.1.md
@@ -1,14 +1,14 @@
-% kpod(1) kpod-mount - Mount a working container's root filesystem.
+% podman(1) podman-mount - Mount a working container's root filesystem.
% Dan Walsh
-# kpod-mount "1" "July 2017" "kpod"
+# podman-mount "1" "July 2017" "podman"
## NAME
-kpod mount - Mount a working container's root filesystem
+podman mount - Mount a working container's root filesystem
## SYNOPSIS
-**kpod** **mount**
+**podman** **mount**
-**kpod** **mount** **containerID**
+**podman** **mount** **containerID**
## DESCRIPTION
Mounts the specified container's root file system in a location which can be
@@ -36,15 +36,15 @@ SELinux label for the mount point
## EXAMPLE
-kpod mount c831414b10a3
+podman mount c831414b10a3
/var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged
-kpod mount
+podman mount
c831414b10a3 /var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged
a7060253093b /var/lib/containers/storage/overlay/0ff7d7ca68bed1ace424f9df154d2dd7b5a125c19d887f17653cbcd5b6e30ba1/merged
## SEE ALSO
-kpod(1), kpod-umount(1), mount(8)
+podman(1), podman-umount(1), mount(8)
diff --git a/docs/podman-pause.1.md b/docs/podman-pause.1.md
new file mode 100644
index 000000000..274c95320
--- /dev/null
+++ b/docs/podman-pause.1.md
@@ -0,0 +1,24 @@
+% podman(1) podman-pause - Pause one or more containers
+% Dan Walsh
+# podman-pause "1" "September 2017" "podman"
+
+## NAME
+podman pause - Pause one or more containers
+
+## SYNOPSIS
+**podman pause [OPTIONS] CONTAINER [...]**
+
+## DESCRIPTION
+Pauses all the processes in one or more containers. You may use container IDs or names as input.
+
+## EXAMPLE
+
+podman pause mywebserver
+
+podman pause 860a4b23
+
+## SEE ALSO
+podman(1), podman-unpause(1)
+
+## HISTORY
+September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
diff --git a/docs/kpod-ps.1.md b/docs/podman-ps.1.md
index e42855311..493a11465 100644
--- a/docs/kpod-ps.1.md
+++ b/docs/podman-ps.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-ps - Simple tool to list containers
+% podman(1) podman-ps - Simple tool to list containers
% Urvashi Mohnani
-% kpod-ps "1" "AUGUST 2017" "kpod"
+% podman-ps "1" "AUGUST 2017" "podman"
## NAME
-kpod-ps - Prints out information about containers
+podman-ps - Prints out information about containers
## SYNOPSIS
-**kpod ps**
+**podman ps**
[**--all**|**-a**]
[**--no-trunc**]
[**--quiet**|**-q**]
@@ -14,7 +14,7 @@ kpod-ps - Prints out information about containers
[**--help**|**-h**]
## DESCRIPTION
-**kpod ps** lists the running containers on the system. Use the **--all** flag to view
+**podman ps** lists the running containers on the system. Use the **--all** flag to view
all the containers information. By default it lists:
* container id
@@ -25,11 +25,11 @@ all the containers information. By default it lists:
* port mappings the container is using
* alternative names for the container
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod ps [GLOBAL OPTIONS]**
+**podman ps [GLOBAL OPTIONS]**
-**kpod ps [OPTIONS]**
+**podman ps [OPTIONS]**
## OPTIONS
@@ -94,27 +94,27 @@ Valid filters are listed below:
## EXAMPLES
```
-sudo kpod ps -a
+sudo podman ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
02f65160e14ca redis:alpine "redis-server" 19 hours ago Exited (-1) 19 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0
69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1
```
```
-sudo kpod ps -a -s
+sudo podman ps -a -s
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES SIZE
02f65160e14ca redis:alpine "redis-server" 20 hours ago Exited (-1) 20 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 27.49 MB
69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 27.49 MB
```
```
-sudo kpod ps -a --format "{{.ID}} {{.Image}} {{.Labels}} {{.Mounts}}"
+sudo podman ps -a --format "{{.ID}} {{.Image}} {{.Labels}} {{.Mounts}}"
02f65160e14ca redis:alpine tier=backend proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/
69ed779d8ef9f redis:alpine batch=no,type=small proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/
```
```
-sudo kpod ps --ns -a
+sudo podman ps --ns -a
CONTAINER ID NAMES PID CGROUP IPC MNT NET PIDNS USER UTS
3557d882a82e3 k8s_container2_podsandbox1_redhat.test.crio_redhat-test-crio_1 29910 4026531835 4026532585 4026532593 4026532508 4026532595 4026531837 4026532594
09564cdae0bec k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 29851 4026531835 4026532585 4026532590 4026532508 4026532592 4026531837 4026532591
@@ -125,7 +125,7 @@ a31ebbee9cee7 k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-c
Print a list of containers
## SEE ALSO
-kpod(1), crio(8), crio.conf(5)
+podman(1), crio(8), crio.conf(5)
## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-pull.1.md b/docs/podman-pull.1.md
index f9933b6c6..ccb2248fb 100644
--- a/docs/kpod-pull.1.md
+++ b/docs/podman-pull.1.md
@@ -1,21 +1,21 @@
-% kpod(1) kpod-pull - Simple tool to pull an image from a registry
+% podman(1) podman-pull - Simple tool to pull an image from a registry
% Urvashi Mohnani
-# kpod-pull "1" "July 2017" "kpod"
+# podman-pull "1" "July 2017" "podman"
## NAME
-kpod-pull - Pull an image from a registry
+podman-pull - Pull an image from a registry
## SYNOPSIS
-**kpod pull**
+**podman pull**
**NAME[:TAG|@DIGEST]**
[**--help**|**-h**]
## DESCRIPTION
-Copies an image from a registry onto the local machine. **kpod pull** pulls an
+Copies an image from a registry onto the local machine. **podman pull** pulls an
image from Docker Hub if a registry is not specified in the command line argument.
-If an image tag is not specified, **kpod pull** defaults to the image with the
-**latest** tag (if it exists) and pulls it. **kpod pull** can also pull an image
-using its digest **kpod pull [image]@[digest]**. **kpod pull** can be used to pull
+If an image tag is not specified, **podman pull** defaults to the image with the
+**latest** tag (if it exists) and pulls it. **podman pull** can also pull an image
+using its digest **podman pull [image]@[digest]**. **podman pull** can be used to pull
images from archives and local storage using different transports.
## imageID
@@ -32,7 +32,7 @@ Image stored in local container/storage
An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection.
**docker://**_docker-reference_
- An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(kpod login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
+ An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(podman login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
**docker-archive:**_path_[**:**_docker-reference_]
An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest.
@@ -46,17 +46,17 @@ Image stored in local container/storage
**ostree:**_image_[**@**_/absolute/repo/path_]
An image in local OSTree repository. _/absolute/repo/path_ defaults to _/ostree/repo_.
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod pull [GLOBAL OPTIONS]**
+**podman pull [GLOBAL OPTIONS]**
-**kpod pull NAME[:TAG|@DIGEST]**
+**podman pull NAME[:TAG|@DIGEST]**
## OPTIONS
**--authfile**
-Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `kpod login`.
+Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.
**--cert-dir**
@@ -84,7 +84,7 @@ Require HTTPS and verify certificates when contacting registries (default: true)
## EXAMPLES
```
-# kpod pull --signature-policy /etc/containers/policy.json alpine:latest
+# podman pull --signature-policy /etc/containers/policy.json alpine:latest
Trying to pull registry.access.redhat.com/alpine:latest... Failed
Trying to pull registry.fedoraproject.org/alpine:latest... Failed
Trying to pull docker.io/library/alpine:latest...Getting image source signatures
@@ -97,7 +97,7 @@ Storing signatures
```
```
-# kpod pull --authfile temp-auths/myauths.json docker://docker.io/umohnani/finaltest
+# podman pull --authfile temp-auths/myauths.json docker://docker.io/umohnani/finaltest
Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures
Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913
1.90 MB / 1.90 MB [========================================================] 0s
@@ -108,7 +108,7 @@ Storing signatures
```
```
-# kpod pull --creds testuser:testpassword docker.io/umohnani/finaltest
+# podman pull --creds testuser:testpassword docker.io/umohnani/finaltest
Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures
Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913
1.90 MB / 1.90 MB [========================================================] 0s
@@ -119,7 +119,7 @@ Storing signatures
```
```
-# kpod pull --tls-verify=false --cert-dir image/certs docker.io/umohnani/finaltest
+# podman pull --tls-verify=false --cert-dir image/certs docker.io/umohnani/finaltest
Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures
Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913
1.90 MB / 1.90 MB [========================================================] 0s
@@ -130,7 +130,7 @@ Storing signatures
```
## SEE ALSO
-kpod(1), kpod-push(1), crio(8), crio.conf(5), docker-login(1)
+podman(1), podman-push(1), crio(8), crio.conf(5), docker-login(1)
## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-push.1.md b/docs/podman-push.1.md
index 211a5f517..63c75ea36 100644
--- a/docs/kpod-push.1.md
+++ b/docs/podman-push.1.md
@@ -1,16 +1,16 @@
-% kpod(1) kpod-push - Push an image from local storage to elsewhere
+% podman(1) podman-push - Push an image from local storage to elsewhere
% Dan Walsh
-# kpod-push "1" "June 2017" "kpod"
+# podman-push "1" "June 2017" "podman"
## NAME
-kpod push - Push an image from local storage to elsewhere
+podman push - Push an image from local storage to elsewhere
## SYNOPSIS
-**kpod** **push** [*options* [...]] **imageID** [**destination**]
+**podman** **push** [*options* [...]] **imageID** [**destination**]
## DESCRIPTION
Pushes an image from local storage to a specified destination.
-Push is mainly used to push images to registries, however **kpod push**
+Push is mainly used to push images to registries, however **podman push**
can be used to save images to tarballs and directories using the following
transports: **dir:**, **docker-archive:**, **docker-daemon:**, **oci-archive:**, and **ostree:**.
@@ -21,7 +21,7 @@ Image stored in local container/storage
The DESTINATION is a location to store container images
The Image "DESTINATION" uses a "transport":"details" format.
- If a transport is not given, kpod push will attempt to push
+ If a transport is not given, podman push will attempt to push
to a registry.
Multiple transports are supported:
@@ -30,7 +30,7 @@ Image stored in local container/storage
An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection.
**docker://**_docker-reference_
- An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(kpod login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
+ An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(podman login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
**docker-archive:**_path_[**:**_docker-reference_]
An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest.
@@ -48,7 +48,7 @@ Image stored in local container/storage
**--authfile**
-Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `kpod login`.
+Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.
**--creds="CREDENTIALS"**
@@ -95,25 +95,25 @@ Require HTTPS and verify certificates when contacting registries (default: true)
This example extracts the imageID image to a local directory in docker format.
- `# kpod push imageID dir:/path/to/image`
+ `# podman push imageID dir:/path/to/image`
This example extracts the imageID image to a local directory in oci format.
- `# kpod push imageID oci-archive:/path/to/layout:image:tag`
+ `# podman push imageID oci-archive:/path/to/layout:image:tag`
This example extracts the imageID image to a container registry named registry.example.com
- `# kpod push imageID docker://registry.example.com/repository:tag`
+ `# podman push imageID docker://registry.example.com/repository:tag`
This example extracts the imageID image and puts into the local docker container store
- `# kpod push imageID docker-daemon:image:tag`
+ `# podman push imageID docker-daemon:image:tag`
This example pushes the alpine image to umohnani/alpine on dockerhub and reads the creds from
the path given to --authfile
```
-# kpod push --authfile temp-auths/myauths.json alpine docker://docker.io/umohnani/alpine
+# podman push --authfile temp-auths/myauths.json alpine docker://docker.io/umohnani/alpine
Getting image source signatures
Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0
4.03 MB / 4.03 MB [========================================================] 1s
@@ -125,7 +125,7 @@ Storing signatures
This example pushes the rhel7 image to rhel7-dir with the "oci" manifest type
```
-# kpod push --format oci registry.access.redhat.com/rhel7 dir:rhel7-dir
+# podman push --format oci registry.access.redhat.com/rhel7 dir:rhel7-dir
Getting image source signatures
Copying blob sha256:9cadd93b16ff2a0c51ac967ea2abfadfac50cfa3af8b5bf983d89b8f8647f3e4
71.41 MB / 71.41 MB [======================================================] 9s
@@ -138,4 +138,4 @@ Storing signatures
```
## SEE ALSO
-kpod(1), kpod-pull(1), crio(8), crio.conf(5), docker-login(1)
+podman(1), podman-pull(1), crio(8), crio.conf(5), docker-login(1)
diff --git a/docs/podman-rm.1.md b/docs/podman-rm.1.md
new file mode 100644
index 000000000..0d86dae1c
--- /dev/null
+++ b/docs/podman-rm.1.md
@@ -0,0 +1,38 @@
+% podman(1) podman-rm - Remove one or more containers
+% Ryan Cole
+# podman-rm "1" "August 2017" "podman"
+
+## NAME
+podman rm - Remove one or more containers
+
+## SYNOPSIS
+**podman** **rm** [*options* [...]] container
+
+## DESCRIPTION
+podman rm will remove one or more containers from the host. The container name or ID can be used. This does not remove images. Running containers will not be removed without the -f option
+
+## OPTIONS
+
+**--force, f**
+
+Force the removal of a running container
+
+**--all, a**
+
+Remove all containers. Can be used in conjunction with -f as well.
+
+## EXAMPLE
+
+podman rm mywebserver
+
+podman rm mywebserver myflaskserver 860a4b23
+
+podman rm -f 860a4b23
+
+podman rm -f -a
+
+## SEE ALSO
+podman(1), podman-rmi(1)
+
+## HISTORY
+August 2017, Originally compiled by Ryan Cole <rycole@redhat.com>
diff --git a/docs/kpod-rmi.1.md b/docs/podman-rmi.1.md
index 2674c7ac2..9ef3cb963 100644
--- a/docs/kpod-rmi.1.md
+++ b/docs/podman-rmi.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-rmi - Removes one or more images
+% podman(1) podman-rmi - Removes one or more images
% Dan Walsh
-# kpod-rmi "1" "March 2017" "kpod"
+# podman-rmi "1" "March 2017" "podman"
## NAME
-kpod rmi - Removes one or more images
+podman rmi - Removes one or more images
## SYNOPSIS
-**kpod** **rmi** **imageID [...]**
+**podman** **rmi** **imageID [...]**
## DESCRIPTION
Removes one or more locally stored images.
@@ -22,16 +22,16 @@ Executing this command will stop all containers that are using the image and rem
## EXAMPLE
-kpod rmi imageID
+podman rmi imageID
-kpod rmi --force imageID
+podman rmi --force imageID
-kpod rmi imageID1 imageID2 imageID3
+podman rmi imageID1 imageID2 imageID3
-kpod rmi -a -f
+podman rmi -a -f
## SEE ALSO
-kpod(1)
+podman(1)
## HISTORY
March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
diff --git a/docs/kpod-run.1.md b/docs/podman-run.1.md
index 478afe408..36efc2a2e 100644
--- a/docs/kpod-run.1.md
+++ b/docs/podman-run.1.md
@@ -1,22 +1,22 @@
-% kpod(1) kpod-run - Run a command in a container
+% podman(1) podman-run - Run a command in a container
% Dan Walsh
-kpod-run - Run a command in a new container
+podman-run - Run a command in a new container
# SYNOPSIS
-**kpod run** [*options* [...]] IMAGE [COMMAND] [ARG...]
+**podman run** [*options* [...]] IMAGE [COMMAND] [ARG...]
# DESCRIPTION
-Run a process in a new container. **kpod run** starts a process with its own
+Run a process in a new container. **podman run** starts a process with its own
file system, its own networking, and its own isolated process tree. The IMAGE
which starts the process may define defaults related to the process that will be
-run in the container, the networking to expose, and more, but **kpod run**
+run in the container, the networking to expose, and more, but **podman run**
gives final control to the operator or administrator who starts the container
-from the image. For that reason **kpod run** has more options than any other
-kpod command.
+from the image. For that reason **podman run** has more options than any other
+podman command.
-If the IMAGE is not already loaded then **kpod run** will pull the IMAGE, and
-all image dependencies, from the repository in the same way running **kpod
+If the IMAGE is not already loaded then **podman run** will pull the IMAGE, and
+all image dependencies, from the repository in the same way running **podman
pull** IMAGE, before it starts the container from that image.
# OPTIONS
@@ -30,7 +30,7 @@ option can be set multiple times.
Attach to STDIN, STDOUT or STDERR.
In foreground mode (the default when **-d**
-is not specified), **kpod run** can start the process in the container
+is not specified), **podman run** can start the process in the container
and attach the console to the process's standard input, output, and standard
error. It can even pretend to be a TTY (this is what most commandline
executables expect) and pass along signals. The **-a** option can be set for
@@ -138,9 +138,9 @@ two memory nodes.
**-d**, **--detach**=*true*|*false*
Detached mode: run the container in the background and print the new container ID. The default is *false*.
- At any time you can run **kpod ps** in
+ At any time you can run **podman ps** in
the other shell to view a list of the running containers. You can reattach to a
-detached container with **kpod attach**. If you choose to run a container in
+detached container with **podman attach**. If you choose to run a container in
the detached mode, then you cannot use the **-rm** option.
When attached in the tty mode, you can detach from the container (and leave it
@@ -259,7 +259,7 @@ millions of trillions.
**--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*"
Logging driver for the container. Default is defined by daemon `--log-driver` flag.
- **Warning**: the `kpod logs` command works only for the `json-file` and
+ **Warning**: the `podman logs` command works only for the `json-file` and
`journald` logging drivers.
**--log-opt**=[]
@@ -311,7 +311,7 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
UUID short identifier (“f78375b1c487”)
Name (“jonah”)
- kpod generates a UUID for each container, and if a name is not assigned
+ podman generates a UUID for each container, and if a name is not assigned
to the container with **--name** then the daemon will also generate a random
string name. The name is useful any place you need to identify a container.
This works for both background and foreground containers.
@@ -321,7 +321,7 @@ This works for both background and foreground containers.
'bridge': create a network stack on the default bridge
'none': no networking
'container:<name|id>': reuse another container's network stack
- 'host': use the kpod host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
+ 'host': use the podman host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
'<network-name>|<network-id>': connect to a user-defined network
**--network-alias**=[]
@@ -348,12 +348,12 @@ This works for both background and foreground containers.
**--privileged**=*true*|*false*
Give extended privileges to this container. The default is *false*.
- By default, kpod containers are
+ By default, podman containers are
“unprivileged” (=false) and cannot, for example, modify parts of the kernel.
This is because by default a container is not allowed to access any devices.
A “privileged” container is given access to all devices.
- When the operator executes **kpod run --privileged**, kpod enables access
+ When the operator executes **podman run --privileged**, podman enables access
to all devices on the host as well as set turn off most of the security messurs
protecting the host from the container.
@@ -363,21 +363,21 @@ protecting the host from the container.
Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort`
Both hostPort and containerPort can be specified as a range of ports.
When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range.
-(e.g., `kpod run -p 1234-1236:1222-1224 --name thisWorks -t busybox`
-but not `kpod run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`)
-With ip: `kpod run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
-Use `kpod port` to see the actual mapping: `kpod port CONTAINER $CONTAINERPORT`
+(e.g., `podman run -p 1234-1236:1222-1224 --name thisWorks -t busybox`
+but not `podman run -p 1230-1236:1230-1240 --name RangeContainerPortsBiggerThanRangeHostPorts -t busybox`)
+With ip: `podman run -p 127.0.0.1:$HOSTPORT:$CONTAINERPORT --name CONTAINER -t someimage`
+Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPORT`
**-P**, **--publish-all**=*true*|*false*
Publish all exposed ports to random ports on the host interfaces. The default is *false*.
When set to true publish all exposed ports to the host interfaces. The
-default is false. If the operator uses -P (or -p) then kpod will make the
+default is false. If the operator uses -P (or -p) then podman will make the
exposed port accessible on the host and the ports will be available to any
-client that can reach the host. When using -P, kpod will bind any exposed
+client that can reach the host. When using -P, podman will bind any exposed
port to a random port on the host within an *ephemeral port range* defined by
`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
-ports and the exposed ports, use `kpod port`.
+ports and the exposed ports, use `podman port`.
**--read-only**=*true*|*false*
Mount the container's root filesystem as read only.
@@ -424,7 +424,7 @@ incompatible with any restart policy other than `none`.
**--storage-opt**=[]
Storage driver options per container
- $ kpod run -it --storage-opt size=120G fedora /bin/bash
+ $ podman run -it --storage-opt size=120G fedora /bin/bash
This (size) will allow to set the container rootfs size to 120G at creation time.
This option is only available for the `devicemapper`, `btrfs`, `overlay2` and `zfs` graph drivers.
@@ -451,7 +451,7 @@ incompatible with any restart policy other than `none`.
Mount a temporary filesystem (`tmpfs`) mount into a container, for example:
- $ kpod run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image
+ $ podman run -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image
This command mounts a `tmpfs` at `/tmp` within the container. The supported mount
options are the same as the Linux default `mount` flags. If you do not specify
@@ -461,11 +461,11 @@ any options, the systems uses the following options:
**-t**, **--tty**=*true*|*false*
Allocate a pseudo-TTY. The default is *false*.
- When set to true kpod will allocate a pseudo-tty and attach to the standard
+ When set to true podman will allocate a pseudo-tty and attach to the standard
input of the container. This can be used, for example, to run a throwaway
interactive shell. The default is false.
-Note: The **-t** option is incompatible with a redirection of the kpod client
+Note: The **-t** option is incompatible with a redirection of the podman client
standard input.
**--ulimit**=[]
@@ -489,8 +489,8 @@ standard input.
Note: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
**-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
- Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, kpod
- bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the kpod
+ Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, podman
+ bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the podman
container. The `OPTIONS` are a comma delimited list and can be:
* [rw|ro]
@@ -498,8 +498,8 @@ standard input.
* [`[r]shared`|`[r]slave`|`[r]private`]
The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The `HOST-DIR`
-must be an absolute path as well. kpod bind-mounts the `HOST-DIR` to the
-path you specify. For example, if you supply the `/foo` value, kpod creates a bind-mount.
+must be an absolute path as well. podman bind-mounts the `HOST-DIR` to the
+path you specify. For example, if you supply the `/foo` value, podman creates a bind-mount.
You can specify multiple **-v** options to mount one or more mounts to a
container.
@@ -511,14 +511,14 @@ See examples.
Labeling systems like SELinux require that proper labels are placed on volume
content mounted into a container. Without a label, the security system might
prevent the processes running inside the container from using the content. By
-default, kpod does not change the labels set by the OS.
+default, podman does not change the labels set by the OS.
To change a label in the container context, you can add either of two suffixes
-`:z` or `:Z` to the volume mount. These suffixes tell kpod to relabel file
-objects on the shared volumes. The `z` option tells kpod that two containers
-share the volume content. As a result, kpod labels the content with a shared
+`:z` or `:Z` to the volume mount. These suffixes tell podman to relabel file
+objects on the shared volumes. The `z` option tells podman that two containers
+share the volume content. As a result, podman labels the content with a shared
content label. Shared volume labels allow all containers to read/write content.
-The `Z` option tells kpod to label the content with a private unshared label.
+The `Z` option tells podman to label the content with a private unshared label.
Only the current container can use a private volume.
By default bind mounted volumes are `private`. That means any mounts done
@@ -564,34 +564,34 @@ can override the working directory by using the **-w** option.
# Exit Status
-The exit code from `kpod run` gives information about why the container
-failed to run or why it exited. When `kpod run` exits with a non-zero code,
+The exit code from `podman run` gives information about why the container
+failed to run or why it exited. When `podman run` exits with a non-zero code,
the exit codes follow the `chroot` standard, see below:
-**_125_** if the error is with kpod **_itself_**
+**_125_** if the error is with podman **_itself_**
- $ kpod run --foo busybox; echo $?
+ $ podman run --foo busybox; echo $?
# flag provided but not defined: --foo
- See 'kpod run --help'.
+ See 'podman run --help'.
125
**_126_** if the **_contained command_** cannot be invoked
- $ kpod run busybox /etc; echo $?
+ $ podman run busybox /etc; echo $?
# exec: "/etc": permission denied
- kpod: Error response from daemon: Contained command could not be invoked
+ podman: Error response from daemon: Contained command could not be invoked
126
**_127_** if the **_contained command_** cannot be found
- $ kpod run busybox foo; echo $?
+ $ podman run busybox foo; echo $?
# exec: "foo": executable file not found in $PATH
- kpod: Error response from daemon: Contained command not found or does not exist
+ podman: Error response from daemon: Contained command not found or does not exist
127
**_Exit code_** of **_contained command_** otherwise
- $ kpod run busybox /bin/sh -c 'exit 3'
+ $ podman run busybox /bin/sh -c 'exit 3'
# 3
# EXAMPLES
@@ -607,14 +607,14 @@ This protects the containers image from modification. Read only containers may
still need to write temporary data. The best way to handle this is to mount
tmpfs directories on /run and /tmp.
- # kpod run --read-only --tmpfs /run --tmpfs /tmp -i -t fedora /bin/bash
+ # podman run --read-only --tmpfs /run --tmpfs /tmp -i -t fedora /bin/bash
## Exposing log messages from the container to the host's log
If you want messages that are logged in your container to show up in the host's
syslog/journal then you should bind mount the /dev/log directory as follows.
- # kpod run -v /dev/log:/dev/log -i -t fedora /bin/bash
+ # podman run -v /dev/log:/dev/log -i -t fedora /bin/bash
From inside the container you can test this by sending a message to the log.
@@ -630,11 +630,11 @@ This should list the message sent to logger.
## Attaching to one or more from STDIN, STDOUT, STDERR
-If you do not specify -a then kpod will attach everything (stdin,stdout,stderr)
+If you do not specify -a then podman will attach everything (stdin,stdout,stderr)
. You can specify to which of the three standard streams (stdin, stdout, stderr)
you'd like to connect instead, as in:
- # kpod run -a stdin -a stdout -i -t fedora /bin/bash
+ # podman run -a stdin -a stdout -i -t fedora /bin/bash
## Sharing IPC between containers
@@ -655,7 +655,7 @@ Host shows a shared memory segment with 7 pids attached, happens to be from http
Now run a regular container, and it correctly does NOT see the shared memory segment from the host:
```
- $ kpod run -it shm ipcs -m
+ $ podman run -it shm ipcs -m
------ Shared Memory Segments --------
key shmid owner perms bytes nattch status
@@ -664,7 +664,7 @@ Now run a regular container, and it correctly does NOT see the shared memory seg
Run a container with the new `--ipc=host` option, and it now sees the shared memory segment from the host httpd:
```
- $ kpod run -it --ipc=host shm ipcs -m
+ $ podman run -it --ipc=host shm ipcs -m
------ Shared Memory Segments --------
key shmid owner perms bytes nattch status
@@ -674,7 +674,7 @@ Testing `--ipc=container:CONTAINERID` mode:
Start a container with a program to create a shared memory segment:
```
- $ kpod run -it shm bash
+ $ podman run -it shm bash
$ sudo shm/shm_server &
$ sudo ipcs -m
@@ -684,7 +684,7 @@ Start a container with a program to create a shared memory segment:
```
Create a 2nd container correctly shows no shared memory segment from 1st container:
```
- $ kpod run shm ipcs -m
+ $ podman run shm ipcs -m
------ Shared Memory Segments --------
key shmid owner perms bytes nattch status
@@ -693,7 +693,7 @@ Create a 2nd container correctly shows no shared memory segment from 1st contain
Create a 3rd container using the new --ipc=container:CONTAINERID option, now it shows the shared memory segment from the first:
```
- $ kpod run -it --ipc=container:ed735b2264ac shm ipcs -m
+ $ podman run -it --ipc=container:ed735b2264ac shm ipcs -m
$ sudo ipcs -m
------ Shared Memory Segments --------
@@ -707,7 +707,7 @@ The exposed port of an application can be mapped to a host port using the **-p**
flag. For example, an httpd port 80 can be mapped to the host port 8080 using the
following:
- # kpod run -p 8080:80 -d -i -t fedora/httpd
+ # podman run -p 8080:80 -d -i -t fedora/httpd
## Mounting External Volumes
@@ -715,7 +715,7 @@ To mount a host directory as a container volume, specify the absolute path to
the directory and the absolute path for the container directory separated by a
colon:
- # kpod run -v /var/db:/data1 -i -t fedora bash
+ # podman run -v /var/db:/data1 -i -t fedora bash
When using SELinux, be aware that the host has no knowledge of container SELinux
policy. Therefore, in the above example, if SELinux policy is enforced, the
@@ -740,23 +740,23 @@ the `--security-opt` flag. For example, you can specify the MCS/MLS level, a
requirement for MLS systems. Specifying the level in the following command
allows you to share the same content between containers.
- # kpod run --security-opt label=level:s0:c100,c200 -i -t fedora bash
+ # podman run --security-opt label=level:s0:c100,c200 -i -t fedora bash
An MLS example might be:
- # kpod run --security-opt label=level:TopSecret -i -t rhel7 bash
+ # podman run --security-opt label=level:TopSecret -i -t rhel7 bash
To disable the security labeling for this container versus running with the
`--permissive` flag, use the following command:
- # kpod run --security-opt label=disable -i -t fedora bash
+ # podman run --security-opt label=disable -i -t fedora bash
If you want a tighter security policy on the processes within a container,
you can specify an alternate type for the container. You could run a container
that is only allowed to listen on Apache ports by executing the following
command:
- # kpod run --security-opt label=type:svirt_apache_t -i -t centos bash
+ # podman run --security-opt label=type:svirt_apache_t -i -t centos bash
Note:
@@ -767,10 +767,10 @@ You would have to write policy defining a `svirt_apache_t` type.
If you want to set `/dev/sda` device weight to `200`, you can specify the device
weight by `--blkio-weight-device` flag. Use the following command:
- # kpod run -it --blkio-weight-device "/dev/sda:200" ubuntu
+ # podman run -it --blkio-weight-device "/dev/sda:200" ubuntu
```
-$ kpod run -d busybox top
+$ podman run -d busybox top
```
## Setting Namespaced Kernel Parameters (Sysctls)
@@ -779,11 +779,11 @@ The `--sysctl` sets namespaced kernel parameters (sysctls) in the
container. For example, to turn on IP forwarding in the containers
network namespace, run this command:
- $ kpod run --sysctl net.ipv4.ip_forward=1 someimage
+ $ podman run --sysctl net.ipv4.ip_forward=1 someimage
Note:
-Not all sysctls are namespaced. kpod does not support changing sysctls
+Not all sysctls are namespaced. podman does not support changing sysctls
inside of a container that also modify the host system. As the kernel
evolves we expect to see more sysctls become namespaced.
@@ -796,4 +796,4 @@ based on docker.com source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
November 2015, updated by Sally O'Malley <somalley@redhat.com>
-October 2017, converted from Docker documentation to kpod by Dan Walsh for kpod <dwalsh@redhat.com>
+October 2017, converted from Docker documentation to podman by Dan Walsh for podman <dwalsh@redhat.com>
diff --git a/docs/kpod-save.1.md b/docs/podman-save.1.md
index ece4bea5e..e55ea1c9b 100644
--- a/docs/kpod-save.1.md
+++ b/docs/podman-save.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-save - Simple tool to save an image to an archive
+% podman(1) podman-save - Simple tool to save an image to an archive
% Urvashi Mohnani
-# kpod-save "1" "July 2017" "kpod"
+# podman-save "1" "July 2017" "podman"
## NAME
-kpod-save - Save an image to docker-archive or oci-archive
+podman-save - Save an image to docker-archive or oci-archive
## SYNOPSIS
-**kpod save**
+**podman save**
**NAME[:TAG]**
[**--quiet**|**-q**]
[**--format**]
@@ -14,16 +14,16 @@ kpod-save - Save an image to docker-archive or oci-archive
[**--help**|**-h**]
## DESCRIPTION
-**kpod save** saves an image to either **docker-archive**, **oci-archive**, **oci-dir** (directory
+**podman save** saves an image to either **docker-archive**, **oci-archive**, **oci-dir** (directory
with oci manifest type), or **docker-dir** (directory with v2s2 manifest type) on the local machine,
-default is **docker-archive**. **kpod save** writes to STDOUT by default and can be redirected to a
+default is **docker-archive**. **podman save** writes to STDOUT by default and can be redirected to a
file using the **output** flag. The **quiet** flag suppresses the output when set.
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod save [GLOBAL OPTIONS]**
+**podman save [GLOBAL OPTIONS]**
-**kpod save [OPTIONS] NAME[:TAG]**
+**podman save [OPTIONS] NAME[:TAG]**
## OPTIONS
@@ -49,19 +49,19 @@ Suppress the output
## EXAMPLES
```
-# kpod save --quiet -o alpine.tar alpine:2.6
+# podman save --quiet -o alpine.tar alpine:2.6
```
```
-# kpod save > alpine-all.tar alpine
+# podman save > alpine-all.tar alpine
```
```
-# kpod save -o oci-alpine.tar --format oci-archive alpine
+# podman save -o oci-alpine.tar --format oci-archive alpine
```
```
-# kpod save --compress --format oci-dir -o alp-dir alpine
+# podman save --compress --format oci-dir -o alp-dir alpine
Getting image source signatures
Copying blob sha256:2fdfe1cd78c20d05774f0919be19bc1a3e4729bce219968e4188e7e0f1af679d
1.97 MB / 1.97 MB [========================================================] 0s
@@ -72,7 +72,7 @@ Storing signatures
```
```
-# kpod save --format docker-dir -o ubuntu-dir ubuntu
+# podman save --format docker-dir -o ubuntu-dir ubuntu
Getting image source signatures
Copying blob sha256:660c48dd555dcbfdfe19c80a30f557ac57a15f595250e67bfad1e5663c1725bb
45.55 MB / 45.55 MB [======================================================] 8s
@@ -91,7 +91,7 @@ Storing signatures
```
## SEE ALSO
-kpod(1), kpod-load(1), crio(8), crio.conf(5)
+podman(1), podman-load(1), crio(8), crio.conf(5)
## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/kpod-start.1.md b/docs/podman-start.1.md
index d1c52a118..a6791127a 100644
--- a/docs/kpod-start.1.md
+++ b/docs/podman-start.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-start - Stop one or more containers
+% podman(1) podman-start - Stop one or more containers
% Brent Baude
-# kpod-start "1" "November 2017" "kpod"
+# podman-start "1" "November 2017" "podman"
## NAME
-kpod start - Start one or more containers
+podman start - Start one or more containers
## SYNOPSIS
-**kpod start [OPTIONS] CONTAINER [...]**
+**podman start [OPTIONS] CONTAINER [...]**
## DESCRIPTION
Start one or more containers. You may use container IDs or names as input. The *attach* and *interactive*
@@ -32,14 +32,14 @@ Attach container's STDIN. The default is false.
## EXAMPLE
-kpod start mywebserver
+podman start mywebserver
-kpod start 860a4b23 5421ab4
+podman start 860a4b23 5421ab4
-kpod start -i -a 860a4b23
+podman start -i -a 860a4b23
## SEE ALSO
-kpod(1), kpod-create(1)
+podman(1), podman-create(1)
## HISTORY
November 2018, Originally compiled by Brent Baude <bbaude@redhat.com>
diff --git a/docs/kpod-stats.1.md b/docs/podman-stats.1.md
index 2b73616a0..80d061cb2 100644
--- a/docs/kpod-stats.1.md
+++ b/docs/podman-stats.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-stats - Display a live stream of 1 or more containers' resource usage statistics
+% podman(1) podman-stats - Display a live stream of 1 or more containers' resource usage statistics
% Ryan Cole
-# kpod-stats "1" "July 2017" "kpod"
+# podman-stats "1" "July 2017" "podman"
## NAME
-kpod-stats - Display a live stream of 1 or more containers' resource usage statistics
+podman-stats - Display a live stream of 1 or more containers' resource usage statistics
## SYNOPSIS
-**kpod** **stats** [*options* [...]] [container]
+**podman** **stats** [*options* [...]] [container]
## DESCRIPTION
Display a live stream of one or more containers' resource usage statistics
@@ -33,7 +33,7 @@ Pretty-print images using a Go template
## EXAMPLE
```
-# kpod stats -a --no-stream
+# podman stats -a --no-stream
CONTAINER CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS
132ade621b5d 0.00% 1.618MB / 33.08GB 0.00% 0B / 0B 0B / 0B 0
@@ -46,14 +46,14 @@ f5a62a71b07b 0.00% 5.669MB / 33.08GB 0.02% 0B / 0B 0B / 0B 3
```
```
-# kpod stats --no-stream 31eab2cf93f4
+# podman stats --no-stream 31eab2cf93f4
CONTAINER CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS
31eab2cf93f4 0.00% 16.42MB / 33.08GB 0.05% 0B / 0B 22.43MB / 0B 0
#
```
```
-# kpod stats --no-stream --format=json 31eab2cf93f4
+# podman stats --no-stream --format=json 31eab2cf93f4
[
{
"name": "31eab2cf93f4",
@@ -71,7 +71,7 @@ CONTAINER CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS
## SEE ALSO
-kpod(1)
+podman(1)
## HISTORY
July 2017, Originally compiled by Ryan Cole <rycole@redhat.com>
diff --git a/docs/kpod-stop.1.md b/docs/podman-stop.1.md
index f45e6c078..ad15b9117 100644
--- a/docs/kpod-stop.1.md
+++ b/docs/podman-stop.1.md
@@ -1,12 +1,12 @@
-% kpod(1) kpod-stop - Stop one or more containers
+% podman(1) podman-stop - Stop one or more containers
% Brent Baude
-# kpod-stop "1" "September 2017" "kpod"
+# podman-stop "1" "September 2017" "podman"
## NAME
-kpod stop - Stop one or more containers
+podman stop - Stop one or more containers
## SYNOPSIS
-**kpod stop [OPTIONS] CONTAINER [...]**
+**podman stop [OPTIONS] CONTAINER [...]**
## DESCRIPTION
Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch
@@ -26,18 +26,18 @@ Stop all running containers. This does not include paused containers.
## EXAMPLE
-kpod stop mywebserver
+podman stop mywebserver
-kpod stop 860a4b23
+podman stop 860a4b23
-kpod stop mywebserver 860a4b23
+podman stop mywebserver 860a4b23
-kpod stop --timeout 2 860a4b23
+podman stop --timeout 2 860a4b23
-kpod stop -a
+podman stop -a
## SEE ALSO
-kpod(1), kpod-rm(1)
+podman(1), podman-rm(1)
## HISTORY
September 2018, Originally compiled by Brent Baude <bbaude@redhat.com>
diff --git a/docs/kpod-tag.1.md b/docs/podman-tag.1.md
index b92b2eb16..0728f1997 100644
--- a/docs/kpod-tag.1.md
+++ b/docs/podman-tag.1.md
@@ -1,20 +1,20 @@
-% kpod(1) kpod-tag - Add tags to an image
+% podman(1) podman-tag - Add tags to an image
% Ryan Cole
-# kpod-tag "1" "July 2017" "kpod"
+# podman-tag "1" "July 2017" "podman"
## NAME
-kpod tag - Add an additional name to a local image
+podman tag - Add an additional name to a local image
## SYNOPSIS
-**kpod tag**
+**podman tag**
[**--help**|**-h**]
## DESCRIPTION
Assigns a new alias to an image in a registry. An alias refers to the entire image name, including the optional **TAG** after the ':'
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod [GLOBAL OPTIONS] tag [OPTIONS]**
+**podman [GLOBAL OPTIONS] tag [OPTIONS]**
## GLOBAL OPTIONS
@@ -23,12 +23,12 @@ Assigns a new alias to an image in a registry. An alias refers to the entire im
## EXAMPLES
- kpod tag 0e3bbc2 fedora:latest
+ podman tag 0e3bbc2 fedora:latest
- kpod tag httpd myregistryhost:5000/fedora/httpd:v2
+ podman tag httpd myregistryhost:5000/fedora/httpd:v2
## SEE ALSO
-kpod(1), crio(8), crio.conf(5)
+podman(1), crio(8), crio.conf(5)
## HISTORY
July 2017, Originally compiled by Ryan Cole <rycole@redhat.com>
diff --git a/docs/kpod-top.1.md b/docs/podman-top.1.md
index e19b7342c..1067cdc52 100644
--- a/docs/kpod-top.1.md
+++ b/docs/podman-top.1.md
@@ -1,17 +1,17 @@
-% kpod(1) kpod-top - display the running processes of a container
+% podman(1) podman-top - display the running processes of a container
% Brent Baude
## NAME
-kpod top - Display the running processes of a container
+podman top - Display the running processes of a container
## SYNOPSIS
-**kpod top**
+**podman top**
[**--help**|**-h**]
## DESCRIPTION
Display the running process of the container. ps-OPTION can be any of the options you would pass to a Linux ps command
-**kpod [GLOBAL OPTIONS] top [OPTIONS]**
+**podman [GLOBAL OPTIONS] top [OPTIONS]**
## OPTIONS
@@ -24,7 +24,7 @@ Display the running process of the container. ps-OPTION can be any of the option
## EXAMPLES
```
-# kpod top f5a62a71b07
+# podman top f5a62a71b07
UID PID PPID %CPU STIME TT TIME CMD
0 18715 18705 0.0 10:35 pts/0 00:00:00 /bin/bash
0 18741 18715 0.0 10:35 pts/0 00:00:00 vi
@@ -32,14 +32,14 @@ Display the running process of the container. ps-OPTION can be any of the option
```
```
-#kpod --log-level=debug top f5a62a71b07 -o fuser,f,comm,label
+#podman --log-level=debug top f5a62a71b07 -o fuser,f,comm,label
FUSER F COMMAND LABEL
root 4 bash system_u:system_r:container_t:s0:c429,c1016
root 0 vi system_u:system_r:container_t:s0:c429,c1016
#
```
```
-# kpod top --format=json f5a62a71b07b -o %cpu,%mem,command,blocked
+# podman top --format=json f5a62a71b07b -o %cpu,%mem,command,blocked
[
{
"CPU": "0.0",
@@ -53,7 +53,7 @@ root 0 vi system_u:system_r:container_t:s0:c429,c1016
...
```
## SEE ALSO
-kpod(1), ps(1)
+podman(1), ps(1)
## HISTORY
December 2017, Originally compiled by Brent Baude<bbaude@redhat.com>
diff --git a/docs/podman-umount.1.md b/docs/podman-umount.1.md
new file mode 100644
index 000000000..5d3d04dab
--- /dev/null
+++ b/docs/podman-umount.1.md
@@ -0,0 +1,19 @@
+% podman(1) podman-umount - Unmount a working container's root filesystem.
+% Dan Walsh
+# podman-umount "1" "July 2017" "podman"
+
+## NAME
+podman umount - Unmount a working container's root file system
+
+## SYNOPSIS
+**podman** **umount** **containerID**
+
+## DESCRIPTION
+Unmounts the specified container's root file system.
+
+## EXAMPLE
+
+podman umount containerID
+
+## SEE ALSO
+podman(1), podman-mount(1)
diff --git a/docs/podman-unpause.1.md b/docs/podman-unpause.1.md
new file mode 100644
index 000000000..26ece3a1f
--- /dev/null
+++ b/docs/podman-unpause.1.md
@@ -0,0 +1,24 @@
+% podman(1) podman-unpause - Unpause one or more containers
+% Dan Walsh
+# podman-unpause "1" "September 2017" "podman"
+
+## NAME
+podman unpause - Unpause one or more containers
+
+## SYNOPSIS
+**podman unpause [OPTIONS] CONTAINER [...]**
+
+## DESCRIPTION
+Unpauses the processes in one or more containers. You may use container IDs or names as input.
+
+## EXAMPLE
+
+podman unpause mywebserver
+
+podman unpause 860a4b23
+
+## SEE ALSO
+podman(1), podman-pause(1)
+
+## HISTORY
+September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
diff --git a/docs/kpod-version.1.md b/docs/podman-version.1.md
index cdc2c9251..e6dba33fc 100644
--- a/docs/kpod-version.1.md
+++ b/docs/podman-version.1.md
@@ -1,24 +1,24 @@
-% kpod(1) kpod-version - Simple tool to view version information
+% podman(1) podman-version - Simple tool to view version information
% Urvashi Mohnani
-# kpod-version "1" "July 2017" "kpod"
+# podman-version "1" "July 2017" "podman"
## NAME
-kpod-version - Display the KPOD Version Information
+podman-version - Display the PODMAN Version Information
## SYNOPSIS
-**kpod version**
+**podman version**
[**--help**|**-h**]
## DESCRIPTION
Shows the the following information: Version, Go Version, Git Commit, Build Time,
OS, and Architecture.
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
-**kpod version**
+**podman version**
## SEE ALSO
-kpod(1), crio(8), crio.conf(5)
+podman(1), crio(8), crio.conf(5)
## HISTORY
July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
diff --git a/docs/podman-wait.1.md b/docs/podman-wait.1.md
new file mode 100644
index 000000000..5bdefbd5f
--- /dev/null
+++ b/docs/podman-wait.1.md
@@ -0,0 +1,36 @@
+% podman(1) podman-wait - Waits on a container
+% Brent Baude
+# podman-wait "1" "September 2017" "podman"
+
+## NAME
+podman wait - Waits on one or more containers to stop and prints exit code
+
+## SYNOPSIS
+**podman wait**
+[**--help**|**-h**]
+
+## DESCRIPTION
+Waits on one or more containers to stop. The container can be referred to by its
+name or ID. In the case of multiple containers, podman will wait on each consecutively.
+After the container stops, the container's return code is printed.
+
+**podman [GLOBAL OPTIONS] wait **
+
+## GLOBAL OPTIONS
+
+**--help, -h**
+ Print usage statement
+
+## EXAMPLES
+
+ podman wait mywebserver
+
+ podman wait 860a4b23
+
+ podman wait mywebserver myftpserver
+
+## SEE ALSO
+podman(1), crio(8), crio.conf(5)
+
+## HISTORY
+September 2017, Originally compiled by Brent Baude<bbaude@redhat.com>
diff --git a/docs/kpod.1.md b/docs/podman.1.md
index 02f97739e..be35c506d 100644
--- a/docs/kpod.1.md
+++ b/docs/podman.1.md
@@ -1,22 +1,22 @@
-% kpod(1) kpod - Simple management tool for pods and images
+% podman(1) podman - Simple management tool for pods and images
% Dan Walsh
-# kpod "1" "September 2016" "kpod"
+# podman "1" "September 2016" "podman"
## NAME
-kpod - Simple management tool for containers and images
+podman - Simple management tool for containers and images
## SYNOPSIS
-**kpod** [*options*] COMMAND
+**podman** [*options*] COMMAND
# DESCRIPTION
-kpod is a simple client only tool to help with debugging issues when daemons
+podman is a simple client only tool to help with debugging issues when daemons
such as CRI runtime and the kubelet are not responding or failing. A shared API
-layer could be created to share code between the daemon and kpod. kpod does not
-require any daemon running. kpod utilizes the same underlying components that
+layer could be created to share code between the daemon and podman. podman does not
+require any daemon running. podman utilizes the same underlying components that
crio uses i.e. containers/image, container/storage, oci-runtime-tool/generate,
-runc or any other OCI compatible runtime. kpod shares state with crio and so
+runc or any other OCI compatible runtime. podman shares state with crio and so
has the capability to debug pods/images created by crio.
-**kpod [GLOBAL OPTIONS]**
+**podman [GLOBAL OPTIONS]**
## GLOBAL OPTIONS
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-09-27 13:25:32 +0000