diff options
author | Ed Santiago <santiago@redhat.com> | 2022-08-31 09:01:53 -0600 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2022-09-05 17:59:13 -0600 |
commit | fb38838feafb0d2adae278922da948e52419c9f3 (patch) | |
tree | 40451e8a738297a4b889cba15000fc0b8a1706fb /docs/source/markdown/podman-pod-create.1.md.in | |
parent | 8882b7664d225bf7f8efac6ab10e8d583e48c712 (diff) | |
download | podman-fb38838feafb0d2adae278922da948e52419c9f3.tar.gz podman-fb38838feafb0d2adae278922da948e52419c9f3.tar.bz2 podman-fb38838feafb0d2adae278922da948e52419c9f3.zip |
Man pages: refactor common options: --memory*
(memory-star, i.e., several memory options) that didn't get
included in #15276. Most of them are shoo-ins; the two in
container-clone and pod-clone deserve special attention
because of the "If unspecified" wording.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-pod-create.1.md.in')
-rw-r--r-- | docs/source/markdown/podman-pod-create.1.md.in | 21 |
1 files changed, 2 insertions, 19 deletions
diff --git a/docs/source/markdown/podman-pod-create.1.md.in b/docs/source/markdown/podman-pod-create.1.md.in index f3d6884c5..bad39b66f 100644 --- a/docs/source/markdown/podman-pod-create.1.md.in +++ b/docs/source/markdown/podman-pod-create.1.md.in @@ -136,26 +136,9 @@ To specify multiple static IPv6 addresses per pod, set multiple networks using t @@option mac-address -#### **--memory**, **-m**=*limit* +@@option memory -Memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes)) - -Constrains the memory available to a container. If the host -supports swap memory, then the **-m** memory setting can be larger than physical -RAM. If a limit of 0 is specified (not using **-m**), the container's memory is -not limited. The actual limit may be rounded up to a multiple of the operating -system's page size (the value would be very large, that's millions of trillions). - -#### **--memory-swap**=*limit* - -A limit value equal to memory plus swap. Must be used with the **-m** -(**--memory**) flag. The swap `LIMIT` should always be larger than **-m** -(**--memory**) value. By default, the swap `LIMIT` will be set to double -the value of --memory. - -The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes), -`k` (kibibytes), `m` (mebibytes), or `g` (gibibytes). If you don't specify a -unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap. +@@option memory-swap #### **--name**, **-n**=*name* |