diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/markdown/podman-build.1.md | 8 | ||||
| -rw-r--r-- | docs/source/markdown/podman-create.1.md | 36 | ||||
| -rw-r--r-- | docs/source/markdown/podman-image-tree.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-images.1.md | 4 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network-exists.1.md | 44 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network.1.md | 1 | ||||
| -rw-r--r-- | docs/source/markdown/podman-run.1.md | 10 | ||||
| -rw-r--r-- | docs/source/markdown/podman-system-service.1.md | 4 | ||||
| -rw-r--r-- | docs/source/network.rst | 2 |
9 files changed, 79 insertions, 32 deletions
diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md index 29f763d54..61c05fdef 100644 --- a/docs/source/markdown/podman-build.1.md +++ b/docs/source/markdown/podman-build.1.md @@ -394,7 +394,7 @@ Name of the manifest list to which the image will be added. Creates the manifest if it does not exist. This option is useful for building multi architecture images. #### **--memory**, **-m**=*LIMIT* -Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), +Memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) Allows you to constrain the memory available to a container. If the host @@ -944,11 +944,11 @@ useradd to stop creating the lastlog file. podman(1), buildah(1), containers-registries.conf(5), crun(8), runc(8), useradd(8), podman-ps(1), podman-rm(1) ## HISTORY -Aug 2020, Additional options and .dockerignore added by Dan Walsh <dwalsh@redhat.com> +Aug 2020, Additional options and .dockerignore added by Dan Walsh `<dwalsh@redhat.com>` -May 2018, Minor revisions added by Joe Doss <joe@solidadmin.com> +May 2018, Minor revisions added by Joe Doss `<joe@solidadmin.com>` -December 2017, Originally compiled by Tom Sweeney <tsweeney@redhat.com> +December 2017, Originally compiled by Tom Sweeney `<tsweeney@redhat.com>` ## FOOTNOTES <a name="Footnote1">1</a>: The Podman project is committed to inclusivity, a diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md index 8deaa8540..35d8474a6 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -114,10 +114,10 @@ Drop Linux capabilities #### **--cgroupns**=*mode* Set the cgroup namespace mode for the container. - **host**: use the host's cgroup namespace inside the container. - **container:<NAME|ID>**: join the namespace of the specified container. - **ns:<PATH>**: join the namespace at the specified path. - **private**: create a new cgroup namespace. + **`host`**: use the host's cgroup namespace inside the container. + **`container:<NAME|ID>`**: join the namespace of the specified container. + **`ns:<PATH>`**: join the namespace at the specified path. + **`private`**: create a new cgroup namespace. If the host uses cgroups v1, the default is set to **host**. On cgroups v2 the default is **private**. @@ -295,7 +295,7 @@ solely for scripting compatibility. #### **--dns**=*dns* -Set custom DNS servers. Invalid if using **--dns** and **--network** that is set to 'none' or 'container:<name|id>'. +Set custom DNS servers. Invalid if using **--dns** and **--network** that is set to 'none' or `container:<name|id>`. This option can be used to override the DNS configuration passed to the container. Typically this is necessary when the @@ -307,11 +307,11 @@ The **/etc/resolv.conf** file in the image will be used without changes. #### **--dns-opt**=*option* -Set custom DNS options. Invalid if using **--dns-opt** and **--network** that is set to 'none' or 'container:<name|id>'. +Set custom DNS options. Invalid if using **--dns-opt** and **--network** that is set to 'none' or `container:<name|id>`. #### **--dns-search**=*domain* -Set custom DNS search domains. Invalid if using **--dns-search** and **--network** that is set to 'none' or 'container:<name|id>'. (Use --dns-search=. if you don't wish to set the search domain) +Set custom DNS search domains. Invalid if using **--dns-search** and **--network** that is set to 'none' or `container:<name|id>`. (Use --dns-search=. if you don't wish to set the search domain) #### **--entrypoint**=*"command"* | *'["command", "arg1", ...]'* @@ -453,9 +453,9 @@ The address must be within the CNI network's IP address pool (default **10.88.0. #### **--ipc**=*ipc* Default is to create a private IPC namespace (POSIX SysV IPC) for the container - 'container:<name|id>': reuses another container shared memory, semaphores and message queues - 'host': use the host shared memory,semaphores and message queues inside the container. Note: the host mode gives the container full access to local shared memory and is therefore considered insecure. - 'ns:<path>' path to an IPC namespace to join. + `container:<name|id>`: reuses another container shared memory, semaphores and message queues + `host`: use the host shared memory,semaphores and message queues inside the container. Note: the host mode gives the container full access to local shared memory and is therefore considered insecure. + `ns:<path>` path to an IPC namespace to join. #### **--kernel-memory**=*number[unit]* @@ -516,7 +516,7 @@ according to RFC4862. #### **--memory**, **-m**=*limit* -Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) +Memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) Allows you to constrain the memory available to a container. If the host supports swap memory, then the **-m** memory setting can be larger than physical @@ -526,7 +526,7 @@ system's page size (the value would be very large, that's millions of trillions) #### **--memory-reservation**=*limit* -Memory soft limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) +Memory soft limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) After setting memory reservation, when the system detects memory contention or low memory, containers are forced to restrict their consumption to their @@ -860,7 +860,7 @@ Note: Labeling can be disabled for all containers by setting label=false in the #### **--shm-size**=*size* -Size of `/dev/shm` (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) +Size of `/dev/shm` (format: `<number>[<unit>]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`. When size is `0`, there is no limit on the amount of memory used for IPC by the container. @@ -1133,7 +1133,7 @@ Mounting the volume with the nodev option means that no devices on the volume will be able to be used by processes within the container. By default volumes are mounted with `nodev`. -If the <source-dir> is a mount point, then "dev", "suid", and "exec" options are +If the `<source-dir>` is a mount point, then "dev", "suid", and "exec" options are ignored by the kernel. Use `df <source-dir>` to figure out the source mount and then use @@ -1280,13 +1280,13 @@ NOTE: Use the environment variable `TMPDIR` to change the temporary storage loca **podman-generate-systemd**(1) **podman-rm**(1), **subgid**(5), **subuid**(5), **containers.conf**(5), **systemd.unit**(5), **setsebool**(8), **slirp4netns**(1), **fuse-overlayfs**(1), **proc**(5)**. ## HISTORY -October 2017, converted from Docker documentation to Podman by Dan Walsh for Podman <dwalsh@redhat.com> +October 2017, converted from Docker documentation to Podman by Dan Walsh for Podman `<dwalsh@redhat.com>` -November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +November 2014, updated by Sven Dowideit `<SvenDowideit@home.org.au>` -September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +September 2014, updated by Sven Dowideit `<SvenDowideit@home.org.au>` -August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +August 2014, updated by Sven Dowideit `<SvenDowideit@home.org.au>` ## FOOTNOTES <a name="Footnote1">1</a>: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and should be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. diff --git a/docs/source/markdown/podman-image-tree.1.md b/docs/source/markdown/podman-image-tree.1.md index 9a52e8444..fe36929cc 100644 --- a/docs/source/markdown/podman-image-tree.1.md +++ b/docs/source/markdown/podman-image-tree.1.md @@ -85,4 +85,4 @@ Image Layers podman(1) ## HISTORY -Feb 2019, Originally compiled by Kunal Kushwaha <kushwaha_kunal_v7@lab.ntt.co.jp> +Feb 2019, Originally compiled by Kunal Kushwaha `<kushwaha_kunal_v7@lab.ntt.co.jp>` diff --git a/docs/source/markdown/podman-images.1.md b/docs/source/markdown/podman-images.1.md index 9ee62ef2b..23cce450a 100644 --- a/docs/source/markdown/podman-images.1.md +++ b/docs/source/markdown/podman-images.1.md @@ -36,7 +36,7 @@ Filter output based on conditions provided Filter on images created before the given IMAGE (name or tag). **dangling=true|false** - Show dangling images. Dangling images are a file system layer that was used in a previous build of an image and is no longer referenced by any active images. They are denoted with the <none> tag, consume disk space and serve no active purpose. + Show dangling images. Dangling images are a file system layer that was used in a previous build of an image and is no longer referenced by any active images. They are denoted with the `<none>` tag, consume disk space and serve no active purpose. **label** Filter by images labels key and/or value. @@ -191,4 +191,4 @@ docker.io/library/alpine latest 3fd9065eaf02 5 months ago 4.41 MB podman(1), containers-storage.conf(5) ## HISTORY -March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com> +March 2017, Originally compiled by Dan Walsh `<dwalsh@redhat.com>` diff --git a/docs/source/markdown/podman-network-exists.1.md b/docs/source/markdown/podman-network-exists.1.md new file mode 100644 index 000000000..c7edc2ac7 --- /dev/null +++ b/docs/source/markdown/podman-network-exists.1.md @@ -0,0 +1,44 @@ +% podman-network-exists(1) + +## NAME +podman\-network\-exists - Check if the given network exists + +## SYNOPSIS +**podman network exists** *network* + +## DESCRIPTION +**podman network exists** checks if a network exists. The **Name** or **ID** +of the network may be used as input. Podman will return an exit code +of `0` when the network is found. A `1` will be returned otherwise. An exit code of +`125` indicates there was an other issue. + + +## OPTIONS + +#### **--help**, **-h** + +Print usage statement + +## EXAMPLE + +Check if a network called `net1` exists (the network does actually exist). +``` +$ podman network exists net1 +$ echo $? +0 +$ +``` + +Check if an network called `webbackend` exists (the network does not actually exist). +``` +$ podman network exists webbackend +$ echo $? +1 +$ +``` + +## SEE ALSO +podman(1), podman-network-create(1), podman-network-rm(1) + +## HISTORY +January 2021, Originally compiled by Paul Holzinger <paul.holzinger@web.de> diff --git a/docs/source/markdown/podman-network.1.md b/docs/source/markdown/podman-network.1.md index 41e2ae885..3ad37b8bf 100644 --- a/docs/source/markdown/podman-network.1.md +++ b/docs/source/markdown/podman-network.1.md @@ -16,6 +16,7 @@ The network command manages CNI networks for Podman. | connect | [podman-network-connect(1)](podman-network-connect.1.md) | Connect a container to a network | | create | [podman-network-create(1)](podman-network-create.1.md) | Create a Podman CNI network | | disconnect | [podman-network-disconnect(1)](podman-network-disconnect.1.md) | Disconnect a container from a network | +| exists | [podman-network-exists(1)](podman-network-exists.1.md) | Check if the given network exists | | inspect | [podman-network-inspect(1)](podman-network-inspect.1.md) | Displays the raw CNI network configuration for one or more networks | | ls | [podman-network-ls(1)](podman-network-ls.1.md) | Display a summary of CNI networks | | reload | [podman-network-reload(1)](podman-network-reload.1.md) | Reload network configuration for containers | diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index 74c231184..89f05c308 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -1632,15 +1632,15 @@ NOTE: Use the environment variable `TMPDIR` to change the temporary storage loca **podman-generate-systemd**(1) **podman-rm**(1), **subgid**(5), **subuid**(5), **containers.conf**(5), **systemd.unit**(5), **setsebool**(8), **slirp4netns**(1), **fuse-overlayfs**(1), **proc**(5)**. ## HISTORY -September 2018, updated by Kunal Kushwaha <kushwaha_kunal_v7@lab.ntt.co.jp> +September 2018, updated by Kunal Kushwaha `<kushwaha_kunal_v7@lab.ntt.co.jp>` -October 2017, converted from Docker documentation to Podman by Dan Walsh for Podman <dwalsh@redhat.com> +October 2017, converted from Docker documentation to Podman by Dan Walsh for Podman `<dwalsh@redhat.com>` -November 2015, updated by Sally O'Malley <somalley@redhat.com> +November 2015, updated by Sally O'Malley `<somalley@redhat.com>` -June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +June 2014, updated by Sven Dowideit `<SvenDowideit@home.org.au>` -April 2014, Originally compiled by William Henry <whenry@redhat.com> based on docker.com source material and internal work. +April 2014, Originally compiled by William Henry `<whenry@redhat.com>` based on docker.com source material and internal work. ## FOOTNOTES <a name="Footnote1">1</a>: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and should be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md index 0905830c5..70764823c 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -41,5 +41,5 @@ podman system service --timeout 5000 podman(1), podman-system-service(1), podman-system-connection(1) ## HISTORY -January 2020, Originally compiled by Brent Baude<bbaude@redhat.com> -November 2020, Updated by Jhon Honce <jhonce at redhat.com> +January 2020, Originally compiled by Brent Baude `<bbaude@redhat.com>` +November 2020, Updated by Jhon Honce (jhonce at redhat dot com) diff --git a/docs/source/network.rst b/docs/source/network.rst index 2ecb97858..b5829876e 100644 --- a/docs/source/network.rst +++ b/docs/source/network.rst @@ -7,6 +7,8 @@ Network :doc:`disconnect <markdown/podman-network-disconnect.1>` network disconnect +:doc:`exists <markdown/podman-network-exists.1>` network exists + :doc:`inspect <markdown/podman-network-inspect.1>` network inspect :doc:`ls <markdown/podman-network-ls.1>` network list |