summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-container-checkpoint.1.md2
-rw-r--r--docs/podman-container-restore.1.md2
-rw-r--r--docs/podman-container-runlabel.1.md7
-rw-r--r--docs/podman-generate-kube.1.md5
-rw-r--r--docs/podman-inspect.1.md2
-rw-r--r--docs/podman-pod-kill.1.md2
-rw-r--r--docs/podman-pod-pause.1.md2
-rw-r--r--docs/podman-pod-rm.1.md4
-rw-r--r--docs/podman-pod-stop.1.md2
-rw-r--r--docs/podman-pod-unpause.1.md2
-rw-r--r--docs/podman-port.1.md2
-rw-r--r--docs/podman-rm.1.md6
-rw-r--r--docs/podman-volume-inspect.1.md2
-rw-r--r--docs/podman-volume-rm.1.md3
-rw-r--r--docs/podman-wait.1.md2
-rw-r--r--docs/tutorials/podman_tutorial.md12
16 files changed, 31 insertions, 26 deletions
diff --git a/docs/podman-container-checkpoint.1.md b/docs/podman-container-checkpoint.1.md
index 666dbbb80..79dc12261 100644
--- a/docs/podman-container-checkpoint.1.md
+++ b/docs/podman-container-checkpoint.1.md
@@ -10,7 +10,7 @@ podman\-container\-checkpoint - Checkpoints one or more running containers
Checkpoints all the processes in one or more containers. You may use container IDs or names as input.
## OPTIONS
-**-k**, **--keep**
+**--keep**, **-k**
Keep all temporary log and statistics files created by CRIU during checkpointing. These files
are not deleted if checkpointing fails for further debugging. If checkpointing succeeds these
diff --git a/docs/podman-container-restore.1.md b/docs/podman-container-restore.1.md
index e47d585cc..e41f7c1d8 100644
--- a/docs/podman-container-restore.1.md
+++ b/docs/podman-container-restore.1.md
@@ -10,7 +10,7 @@ podman\-container\-restore - Restores one or more running containers
Restores a container from a checkpoint. You may use container IDs or names as input.
## OPTIONS
-**-k**, **--keep**
+**--keep**, **-k**
Keep all temporary log and statistics files created by CRIU during
checkpointing as well as restoring. These files are not deleted if restoring
diff --git a/docs/podman-container-runlabel.1.md b/docs/podman-container-runlabel.1.md
index 7fa9805e6..39d798804 100644
--- a/docs/podman-container-runlabel.1.md
+++ b/docs/podman-container-runlabel.1.md
@@ -76,11 +76,12 @@ The [username[:password]] to use to authenticate with the registry if required.
If one or both values are not supplied, a command line prompt will appear and the
value can be entered. The password is entered without echo.
-**-h** **--help**
+**--help** **-h**
Print usage statement
-**-n** **--name**=""
- Use this name for creating content for the container. NAME will default to the IMAGENAME if it is not specified.
+**--name** **-n**=""
+
+Use this name for creating content for the container. NAME will default to the IMAGENAME if it is not specified.
**--quiet, -q**
diff --git a/docs/podman-generate-kube.1.md b/docs/podman-generate-kube.1.md
index b6fa78606..99029be90 100644
--- a/docs/podman-generate-kube.1.md
+++ b/docs/podman-generate-kube.1.md
@@ -5,7 +5,7 @@
podman-generate-kube - Generate Kubernetes YAML
# SYNOPSIS
-**podman generate kube** [*-s*][*--service*] *container* | *pod*
+**podman generate kube** [*-s*|*--service*] *container* | *pod*
# DESCRIPTION
**podman generate kube** will generate Kubernetes Pod YAML (v1 specification) from a podman container or pod. Whether
@@ -20,7 +20,8 @@ Note that the generated Kubernetes YAML file can be used to re-run the deploymen
# OPTIONS:
-**s** **--service**
+**--service** **-s**
+
Generate a Kubernetes service object in addition to the Pods.
## Examples ##
diff --git a/docs/podman-inspect.1.md b/docs/podman-inspect.1.md
index 712891ad6..8b67c7dac 100644
--- a/docs/podman-inspect.1.md
+++ b/docs/podman-inspect.1.md
@@ -17,7 +17,7 @@ unspecified type. If a format is specified, the given template will be executed
## OPTIONS
-**--type, t="TYPE"**
+**--type, -t="TYPE"**
Return JSON for the specified type. Type can be 'container', 'image' or 'all' (default: all)
(Only meaningful when invoked as *podman inspect*)
diff --git a/docs/podman-pod-kill.1.md b/docs/podman-pod-kill.1.md
index 2a863d3d9..d617acd66 100644
--- a/docs/podman-pod-kill.1.md
+++ b/docs/podman-pod-kill.1.md
@@ -21,7 +21,7 @@ to run pods such as CRI-O, the last started pod could be from either of those me
The latest option is not supported on the remote client.
-**--signal, s**
+**--signal, -s**
Signal to send to the containers in the pod. For more information on Linux signals, refer to *man signal(7)*.
diff --git a/docs/podman-pod-pause.1.md b/docs/podman-pod-pause.1.md
index 418a9ee2a..0ed63a7f8 100644
--- a/docs/podman-pod-pause.1.md
+++ b/docs/podman-pod-pause.1.md
@@ -11,7 +11,7 @@ Pauses all the running processes in the containers of one or more pods. You may
## OPTIONS
-**--all, a**
+**--all, -a**
Pause all pods.
diff --git a/docs/podman-pod-rm.1.md b/docs/podman-pod-rm.1.md
index aa26a1bbb..7cd7c26bc 100644
--- a/docs/podman-pod-rm.1.md
+++ b/docs/podman-pod-rm.1.md
@@ -11,7 +11,7 @@ podman\-pod\-rm - Remove one or more pods
## OPTIONS
-**--all, a**
+**--all, -a**
Remove all pods. Can be used in conjunction with \-f as well.
@@ -21,7 +21,7 @@ Instead of providing the pod name or ID, remove the last created pod.
The latest option is not supported on the remote client.
-**--force, f**
+**--force, -f**
Stop running containers and delete all stopped containers before removal of pod.
diff --git a/docs/podman-pod-stop.1.md b/docs/podman-pod-stop.1.md
index 338e04d67..787c672bd 100644
--- a/docs/podman-pod-stop.1.md
+++ b/docs/podman-pod-stop.1.md
@@ -21,7 +21,7 @@ Instead of providing the pod name or ID, stop the last created pod.
The latest option is not supported on the remote client.
-**--timeout, --time, t**
+**--timeout, --time, -t**
Timeout to wait before forcibly stopping the containers in the pod.
diff --git a/docs/podman-pod-unpause.1.md b/docs/podman-pod-unpause.1.md
index 1004e09f9..8930fde32 100644
--- a/docs/podman-pod-unpause.1.md
+++ b/docs/podman-pod-unpause.1.md
@@ -11,7 +11,7 @@ Unpauses all the paused processes in the containers of one or more pods. You ma
## OPTIONS
-**--all, a**
+**--all, -a**
Unpause all pods.
diff --git a/docs/podman-port.1.md b/docs/podman-port.1.md
index 020a25d32..5adfae5f3 100644
--- a/docs/podman-port.1.md
+++ b/docs/podman-port.1.md
@@ -11,7 +11,7 @@ List port mappings for the *container* or lookup the public-facing port that is
## OPTIONS
-**--all, a**
+**--all, -a**
List all known port mappings for running containers. When using this option, you cannot pass any container names
or private ports/protocols as filters.
diff --git a/docs/podman-rm.1.md b/docs/podman-rm.1.md
index dc1729188..16d4027c9 100644
--- a/docs/podman-rm.1.md
+++ b/docs/podman-rm.1.md
@@ -13,11 +13,11 @@ podman\-container\-rm (podman\-rm) - Remove one or more containers
## OPTIONS
-**--all, a**
+**--all, -a**
Remove all containers. Can be used in conjunction with -f as well.
-**--force, f**
+**--force, -f**
Force the removal of running and paused containers. Forcing a containers removal also
removes containers from container storage even if the container is not known to podman.
@@ -32,7 +32,7 @@ The latest option is not supported on the remote client.
**--volumes, -v**
-Remove the volumes associated with the container. (Not yet implemented)
+Remove the volumes associated with the container.
## EXAMPLE
Remove a container by its name *mywebserver*
diff --git a/docs/podman-volume-inspect.1.md b/docs/podman-volume-inspect.1.md
index c22c80bb7..88cc3cf3e 100644
--- a/docs/podman-volume-inspect.1.md
+++ b/docs/podman-volume-inspect.1.md
@@ -15,7 +15,7 @@ existing volumes, use the **--all** flag.
## OPTIONS
-**-a**, **--all**=""
+**-a**, **--all**
Inspect all volumes.
diff --git a/docs/podman-volume-rm.1.md b/docs/podman-volume-rm.1.md
index c23d7675c..8c3765235 100644
--- a/docs/podman-volume-rm.1.md
+++ b/docs/podman-volume-rm.1.md
@@ -21,7 +21,8 @@ Remove all volumes.
**-f**, **--force**=""
-Remove a volume by force, even if it is being used by a container
+Remove a volume by force.
+If it is being used by containers, the containers will be removed first.
**--help**
diff --git a/docs/podman-wait.1.md b/docs/podman-wait.1.md
index 2d145527b..ed5e11ac7 100644
--- a/docs/podman-wait.1.md
+++ b/docs/podman-wait.1.md
@@ -17,7 +17,7 @@ After the container stops, the container's return code is printed.
Print usage statement
-**--interval, i**"
+**--interval, -i**"
Microseconds to wait before polling for completion
**--latest, -l**
diff --git a/docs/tutorials/podman_tutorial.md b/docs/tutorials/podman_tutorial.md
index bfff90016..2abd9c50f 100644
--- a/docs/tutorials/podman_tutorial.md
+++ b/docs/tutorials/podman_tutorial.md
@@ -123,13 +123,14 @@ sudo make install PREFIX=/usr
This sample container will run a very basic httpd server that serves only its index
page.
```console
-podman run -dt -e HTTPD_VAR_RUN=/var/run/httpd -e HTTPD_MAIN_CONF_D_PATH=/etc/httpd/conf.d \
+podman run -dt -p 8080:8080/tcp -e HTTPD_VAR_RUN=/var/run/httpd -e HTTPD_MAIN_CONF_D_PATH=/etc/httpd/conf.d \
-e HTTPD_MAIN_CONF_PATH=/etc/httpd/conf \
-e HTTPD_CONTAINER_SCRIPTS_PATH=/usr/share/container-scripts/httpd/ \
registry.fedoraproject.org/f27/httpd /usr/bin/run-httpd
```
Because the container is being run in detached mode, represented by the *-d* in the podman run command, podman
-will print the container ID after it has run.
+will print the container ID after it has run. Note that we use port forwarding to be able to
+access the HTTP server. For successful running at least slirp4netns v0.3.0 is needed.
### Listing running containers
The Podman *ps* command is used to list creating and running containers.
@@ -140,10 +141,11 @@ podman ps
Note: If you add *-a* to the *ps* command, Podman will show all containers.
### Inspecting a running container
You can "inspect" a running container for metadata and details about itself. We can even use
-the inspect subcommand to see what IP address was assigned to the container.
+the inspect subcommand to see what IP address was assigned to the container. As the container is running in rootless mode, an IP address is not assigned and the value will be listed as "none" in the output from inspect.
```console
-$ sudo podman inspect -l | grep IPAddress\":
- "IPAddress": "10.88.6.140",
+$ podman inspect -l | grep IPAddress\":
+ "SecondaryIPAddresses": null,
+ "IPAddress": "",
```
Note: The -l is a convenience argument for **latest container**. You can also use the container's ID instead