summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-build.1.md14
-rw-r--r--docs/podman-logs.1.md14
-rw-r--r--docs/podman-pod-create.1.md2
-rw-r--r--docs/podman-ps.1.md1
-rw-r--r--docs/podman-system-df.1.md57
-rw-r--r--docs/podman-system.1.md3
6 files changed, 83 insertions, 8 deletions
diff --git a/docs/podman-build.1.md b/docs/podman-build.1.md
index 42fa9a359..ccc8bd900 100644
--- a/docs/podman-build.1.md
+++ b/docs/podman-build.1.md
@@ -288,13 +288,21 @@ process.
**--pull**
-Pull the image if it is not present. If this flag is disabled (with
-*--pull=false*) and the image is not present, the image will not be pulled.
+When the flag is enabled, attempt to pull the latest image from the registries
+listed in registries.conf if a local image does not exist or the image is newer
+than the one in storage. Raise an error if the image is not in any listed
+registry and is not present locally.
+
+If the flag is disabled (with *--pull=false*), do not pull the image from the
+registry, use only the local version. Raise an error if the image is not
+present locally.
+
Defaults to *true*.
**--pull-always**
-Pull the image even if a version of the image is already present.
+Pull the image from the first registry it is found in as listed in registries.conf.
+Raise an error if not found in the registries, even if the image is present locally.
**--quiet, -q**
diff --git a/docs/podman-logs.1.md b/docs/podman-logs.1.md
index 8cd6ad5e7..ce5d890ce 100644
--- a/docs/podman-logs.1.md
+++ b/docs/podman-logs.1.md
@@ -1,9 +1,11 @@
-% podman-logs(1)
+% podman-container-logs(1)
## NAME
-podman\-logs - Fetch the logs of one or more containers
+podman\-container\-logs (podman\-logs) - Fetch the logs of one or more containers
## SYNOPSIS
+**podman** **container** **logs** [*options*] *container* [*container...*]
+
**podman** **logs** [*options*] *container* [*container...*]
## DESCRIPTION
@@ -15,7 +17,11 @@ any logs at the time you execute podman logs
**--follow, -f**
-Follow log output. Default is false
+Follow log output. Default is false.
+
+Note: If you are following a container which is removed `podman container rm`
+or removed on exit `podman run --rm ...`, then there is a chance the the log
+file will be removed before `podman logs` reads the final content.
**--latest, -l**
@@ -86,7 +92,7 @@ podman logs --since 10m myserver
```
## SEE ALSO
-podman(1)
+podman(1), podman-run(1), podman-container-rm(1)
## HISTORY
February 2018, Updated by Brent Baude <bbaude@redhat.com>
diff --git a/docs/podman-pod-create.1.md b/docs/podman-pod-create.1.md
index 06f962849..d913083d1 100644
--- a/docs/podman-pod-create.1.md
+++ b/docs/podman-pod-create.1.md
@@ -81,6 +81,8 @@ $ podman pod create --name test
$ podman pod create --infra=false
$ podman pod create --infra-command /top
+
+$ podman pod create --publish 8443:443
```
## SEE ALSO
diff --git a/docs/podman-ps.1.md b/docs/podman-ps.1.md
index 811fbbc2f..685a52bda 100644
--- a/docs/podman-ps.1.md
+++ b/docs/podman-ps.1.md
@@ -100,6 +100,7 @@ Valid filters are listed below:
| before | [ID] or [Name] Containers created before this container |
| since | [ID] or [Name] Containers created since this container |
| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
+| health | [Status] healthy or unhealthy |
**--help**, **-h**
diff --git a/docs/podman-system-df.1.md b/docs/podman-system-df.1.md
new file mode 100644
index 000000000..f33523dd6
--- /dev/null
+++ b/docs/podman-system-df.1.md
@@ -0,0 +1,57 @@
+% podman-system-df(1) podman
+
+## NAME
+podman\-system\-df - Show podman disk usage
+
+## SYNOPSIS
+**podman system df** [*options*]
+
+## DESCRIPTION
+Show podman disk usage
+
+## OPTIONS
+**--format**=""
+
+Pretty-print images using a Go template
+
+**-v, --verbose**[=false]
+Show detailed information on space usage
+
+## EXAMPLE
+
+$ podman system df
+TYPE TOTAL ACTIVE SIZE RECLAIMABLE
+Images 6 2 281MB 168MB (59%)
+Containers 3 1 0B 0B (0%)
+Local Volumes 1 1 22B 0B (0%)
+
+$ podman system df -v
+Images space usage:
+
+REPOSITORY TAG IMAGE ID CREATED SIZE SHARED SIZE UNQUE SIZE CONTAINERS
+docker.io/library/alpine latest 5cb3aa00f899 2 weeks ago 5.79MB 0B 5.79MB 5
+
+Containers space usage:
+
+CONTAINER ID IMAGE COMMAND LOCAL VOLUMES SIZE CREATED STATUS NAMES
+073f7e62812d 5cb3 sleep 100 1 0B About an hourago exited zen_joliot
+3f19f5bba242 5cb3 sleep 100 0 5.52kB 4 hoursago exited pedantic_archimedes
+8cd89bf645cc 5cb3 ls foodir 0 58B 2 hoursago configured agitated_hamilton
+a1d948a4b61d 5cb3 ls foodir 0 12B 2 hoursago exited laughing_wing
+eafe3e3c5bb3 5cb3 sleep 10000 0 72B 2 hoursago running priceless_liskov
+
+Local Volumes space usage:
+
+VOLUME NAME LINKS SIZE
+data 1 0B
+
+$ podman system df --format "{{.Type}}\t{{.Total}}"
+Images 1
+Containers 5
+Local Volumes 1
+
+## SEE ALSO
+podman-system(1)
+
+# HISTORY
+March 2019, Originally compiled by Qi Wang (qiwan at redhat dot com)
diff --git a/docs/podman-system.1.md b/docs/podman-system.1.md
index 6d87648e8..32b3efdd9 100644
--- a/docs/podman-system.1.md
+++ b/docs/podman-system.1.md
@@ -13,7 +13,8 @@ The system command allows you to manage the podman systems
| Command | Man Page | Description |
| ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- |
-| info | [podman-info(1)](podman-info.1.md) | Displays Podman related system information. |
+| df | [podman-system-df(1)](podman-system-df.1.md) | Show podman disk usage. |
+| info | [podman-system-info(1)](podman-info.1.md) | Displays Podman related system information. |
| prune | [podman-system-prune(1)](podman-system-prune.1.md) | Remove all unused data |
| renumber | [podman-system-renumber(1)](podman-system-renumber.1.md)| Migrate lock numbers to handle a change in maximum number of locks. |