summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/source/conf.py9
-rw-r--r--docs/source/markdown/podman-build.1.md9
-rw-r--r--docs/source/markdown/podman-create.1.md5
-rw-r--r--docs/source/markdown/podman-machine-rm.1.md14
-rw-r--r--docs/source/markdown/podman-network-create.1.md6
-rw-r--r--docs/source/markdown/podman-play-kube.1.md13
-rw-r--r--docs/source/markdown/podman-rmi.1.md14
-rw-r--r--docs/source/markdown/podman-run.1.md6
-rw-r--r--docs/source/markdown/podman-system-service.1.md2
9 files changed, 66 insertions, 12 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 7684dd3f7..505bcbec7 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -72,8 +72,13 @@ def convert_markdown_title(app, docname, source):
docpath = app.env.doc2path(docname)
if docpath.endswith(".md"):
# Convert pandoc title line into eval_rst block for myst_parser
- source[0] = re.sub(r"^% (.*)", r"```{title} \g<1>\n```", source[0])
-
+ #
+ # Remove the ending "(1)" to avoid it from being displayed
+ # in the web tab. Often such a text indicates that
+ # a web page got an update. For instance GitHub issues
+ # shows the number of new comments that have been written
+ # after the user's last visit.
+ source[0] = re.sub(r"^% (.*)(\(\d\))", r"```{title} \g<1>\n```", source[0])
def setup(app):
app.connect("source-read", convert_markdown_title)
diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md
index 2c8f4005c..b9542fec5 100644
--- a/docs/source/markdown/podman-build.1.md
+++ b/docs/source/markdown/podman-build.1.md
@@ -52,7 +52,7 @@ command to see these containers. External containers can be removed with the
Add a custom host-to-IP mapping (host:ip)
Add a line to /etc/hosts. The format is hostname:ip. The **--add-host** option
-can be set multiple times.
+can be set multiple times. Conflicts with the --no-hosts option.
#### **--all-platforms**
@@ -432,6 +432,13 @@ considered insecure.
Do not use existing cached images for the container build. Build from the start
with a new set of cached layers.
+#### **--no-hosts**
+
+Do not create _/etc/hosts_ for the container.
+
+By default, Buildah manages _/etc/hosts_, adding the container's own IP address.
+**--no-hosts** disables this, and the image's _/etc/hosts_ will be preserved unmodified. Conflicts with the --add-host option.
+
#### **--os**=*string*
Set the OS of the image to be built, and that of the base image to be pulled,
diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md
index 2a0f3b738..506f575fe 100644
--- a/docs/source/markdown/podman-create.1.md
+++ b/docs/source/markdown/podman-create.1.md
@@ -1453,6 +1453,11 @@ After the container is started, the location for the pidfile can be discovered w
$ podman inspect --format '{{ .PidFile }}' $CID
/run/containers/storage/${storage-driver}-containers/$CID/userdata/pidfile
+#### **--chrootdirs**=*path*
+
+Path to a directory inside the container that should be treated as a `chroot` directory.
+Any Podman managed file (e.g., /etc/resolv.conf, /etc/hosts, etc/hostname) that is mounted into the root directory will be mounted into that location as well.
+Multiple directories should be separated with a comma.
## EXAMPLES
diff --git a/docs/source/markdown/podman-machine-rm.1.md b/docs/source/markdown/podman-machine-rm.1.md
index 7c9eb65c5..c9c68d111 100644
--- a/docs/source/markdown/podman-machine-rm.1.md
+++ b/docs/source/markdown/podman-machine-rm.1.md
@@ -23,17 +23,17 @@ is used.
Print usage statement.
-#### **--force**
+#### **--force**, **-f**
-Delete without confirmation
+Stop and delete without confirmation.
#### **--save-ignition**
-Do not delete the generated ignition file
+Do not delete the generated ignition file.
#### **--save-image**
-Do not delete the VM image
+Do not delete the VM image.
#### **--save-keys**
@@ -42,7 +42,7 @@ deleted.
## EXAMPLES
-Remove a VM named "test1"
+Remove a VM named "test1":
```
$ podman machine rm test1
@@ -58,6 +58,10 @@ The following files will be deleted:
Are you sure you want to continue? [y/N] y
```
+```
+$ podman machine rm -f test1
+$
+```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-machine(1)](podman-machine.1.md)**
diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md
index 357a06cea..5a3224501 100644
--- a/docs/source/markdown/podman-network-create.1.md
+++ b/docs/source/markdown/podman-network-create.1.md
@@ -28,6 +28,10 @@ resolution.
Driver to manage the network. Currently `bridge`, `macvlan` and `ipvlan` are supported. Defaults to `bridge`.
As rootless the `macvlan` and `ipvlan` driver have no access to the host network interfaces because rootless networking requires a separate network namespace.
+Special considerations for the *netavark* backend:
+- The `macvlan` driver requires the `--subnet` option, DHCP is currently not supported.
+- The `ipvlan` driver is not currently supported.
+
#### **--opt**=*option*, **-o**
Set driver specific options.
@@ -114,7 +118,7 @@ podman4
Create a Macvlan based network using the host interface eth0. Macvlan networks can only be used as root.
```
-# podman network create -d macvlan -o parent=eth0 newnet
+# podman network create -d macvlan -o parent=eth0 --subnet 192.5.0.0/16 newnet
newnet
```
diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md
index 389affc3a..310bade34 100644
--- a/docs/source/markdown/podman-play-kube.1.md
+++ b/docs/source/markdown/podman-play-kube.1.md
@@ -105,6 +105,11 @@ and as a result environment variable `FOO` will be set to `bar` for container `c
## OPTIONS
+#### **--annotation**=*key=value*
+
+Add an annotation to the container or pod. The format is key=value.
+The **--annotation** option can be set multiple times.
+
#### **--authfile**=*path*
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
@@ -115,7 +120,7 @@ environment variable. `export REGISTRY_AUTH_FILE=path`
#### **--build**
-Build images even if they are found in the local storage. Use `--build=false` to completely disable builds.
+Build images even if they are found in the local storage. Use `--build=false` to completely disable builds. (This option is not available with the remote Podman client)
#### **--cert-dir**=*path*
@@ -124,10 +129,14 @@ Please refer to containers-certs.d(5) for details. (This option is not available
#### **--configmap**=*path*
-Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod.
+Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod. (This option is not available with the remote Podman client)
Note: The *--configmap* option can be used multiple times or a comma-separated list of paths can be used to pass multiple Kubernetes configmap YAMLs.
+#### **--context-dir**=*path*
+
+Use *path* as the build context directory for each image. Requires --build option be true. (This option is not available with the remote Podman client)
+
#### **--creds**
The [username[:password]] to use to authenticate with the registry if required.
diff --git a/docs/source/markdown/podman-rmi.1.md b/docs/source/markdown/podman-rmi.1.md
index 5fe0efa18..8d0e5e500 100644
--- a/docs/source/markdown/podman-rmi.1.md
+++ b/docs/source/markdown/podman-rmi.1.md
@@ -24,6 +24,10 @@ Remove all images in the local storage.
This option will cause podman to remove all containers that are using the image before removing the image from the system.
+#### **--ignore**, **-i**
+
+If a specified image does not exist in the local storage, ignore it and do not throw an error.
+
Remove an image by its short ID
```
@@ -43,6 +47,16 @@ Remove all images and containers.
```
$ podman rmi -a -f
```
+
+Remove an absent image with and without the `--ignore` flag.
+```
+$ podman rmi --ignore nothing
+$ podman rmi nothing
+Error: nothing: image not known
+
+```
+
+
## Exit Status
**0** All specified images removed
diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md
index 239cf3b83..7fa7bda30 100644
--- a/docs/source/markdown/podman-run.1.md
+++ b/docs/source/markdown/podman-run.1.md
@@ -1529,6 +1529,12 @@ After the container is started, the location for the pidfile can be discovered w
$ podman inspect --format '{{ .PidFile }}' $CID
/run/containers/storage/${storage-driver}-containers/$CID/userdata/pidfile
+#### **--chrootdirs**=*path*
+
+Path to a directory inside the container that should be treated as a `chroot` directory.
+Any Podman managed file (e.g., /etc/resolv.conf, /etc/hosts, etc/hostname) that is mounted into the root directory will be mounted into that location as well.
+Multiple directories should be separated with a comma.
+
## Exit Status
The exit code from **podman run** gives information about why the container
diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md
index 3bc4fc7f1..17d8ea06a 100644
--- a/docs/source/markdown/podman-system-service.1.md
+++ b/docs/source/markdown/podman-system-service.1.md
@@ -15,7 +15,7 @@ example *unix:///run/user/1000/podman/podman.sock*)
To access the API service inside a container:
- mount the socket as a volume
-- run the container with `--security-opt label:disable`
+- run the container with `--security-opt label=disable`
The REST API provided by **podman system service** is split into two parts: a compatibility layer offering support for the Docker v1.40 API, and a Podman-native Libpod layer.
Documentation for the latter is available at *https://docs.podman.io/en/latest/_static/api.html*.