summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTomSweeneyRedHat <tsweeney@redhat.com>2019-01-29 16:59:22 -0500
committerTomSweeneyRedHat <tsweeney@redhat.com>2019-02-01 13:44:41 -0500
commitb58b95b40889214c08f21583e212087da86d92ea (patch)
tree99d497086338438a18f608521fb88ee2a8f32c94
parente6426af30bdd649c54537728c8a9bb1cd5a1ff14 (diff)
downloadpodman-b58b95b40889214c08f21583e212087da86d92ea.tar.gz
podman-b58b95b40889214c08f21583e212087da86d92ea.tar.bz2
podman-b58b95b40889214c08f21583e212087da86d92ea.zip
Rework Podman description
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com> Rework the Podman Description. I'm starting off with the Podman man page to build consensus and we can then add to other places as appropriate. This partially addresses: #1636 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
-rw-r--r--docs/podman.1.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/podman.1.md b/docs/podman.1.md
index 74e700fac..6200a07f0 100644
--- a/docs/podman.1.md
+++ b/docs/podman.1.md
@@ -1,19 +1,21 @@
% podman(1)
## NAME
-podman - Simple management tool for containers and images
+podman - Simple management tool for pods, containers and images
## SYNOPSIS
**podman** [*options*] *command*
## DESCRIPTION
-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 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. podman shares state with crio and so
-has the capability to debug pods/images created by crio.
+Podman (Pod Manager) is a fully featured container engine that is a simple daemonless tool.
+Podman provides a Docker-CLI comparable command line that eases the transition from other
+container engines and allows the management of pods, containers and images. Simply put: `alias docker=podman`.
+Most Podman commands can be run as a regular user, without requiring additional
+privileges.
+
+Podman uses Buildah(1) internally to create container images. Both tools share image
+(not container) storage, hence each can use or manipulate images (but not containers)
+created by the other.
**podman [GLOBAL OPTIONS]**
@@ -220,7 +222,7 @@ Images are pulled under `XDG_DATA_HOME` when specified, otherwise in the home di
Currently the slirp4netns package is required to be installed to create a network device, otherwise rootless containers need to run in the network namespace of the host.
## SEE ALSO
-`containers-mounts.conf(5)`, `containers-registries.conf(5)`, `containers-storage.conf(5)`, `crio(8)`, `libpod.conf(5)`, `oci-hooks(5)`, `policy.json(5)`, `subuid(5)`, `subgid(5)`, `slirp4netns(1)`
+`containers-mounts.conf(5)`, `containers-registries.conf(5)`, `containers-storage.conf(5)`, `buildah(1)`, `crio(8)`, `libpod.conf(5)`, `oci-hooks(5)`, `policy.json(5)`, `subuid(5)`, `subgid(5)`, `slirp4netns(1)`
## HISTORY
Dec 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com>