From 5711aabb4d9d705a09085eb6e324ee5dae8ed487 Mon Sep 17 00:00:00 2001 From: Marco Vedovati Date: Fri, 30 Aug 2019 15:55:59 +0200 Subject: cli-flags: use a consistent format for Use a consistent format for description of the flags. Also, avoid backticks for /dev/shm, as that's interpreted as the format by the flag parsing lib. Signed-off-by: Marco Vedovati --- docs/podman-run.1.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/podman-run.1.md') diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md index 8fb7453fe..c642b50b6 100644 --- a/docs/podman-run.1.md +++ b/docs/podman-run.1.md @@ -390,7 +390,7 @@ Default is to create a private IPC namespace (POSIX SysV IPC) for the container **--kernel-memory**=*number[unit]* -Kernel memory limit (format: `[]`, where unit = b, k, m or g) +Kernel memory limit (format: `[]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) Constrains the kernel memory available to a container. If a limit of 0 is specified (not using `--kernel-memory`), the container's kernel memory @@ -432,7 +432,7 @@ Not currently supported **--memory**, **-m**=*limit* -Memory limit (format: [], where unit = b, k, m or g) +Memory limit (format: [], 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 @@ -442,7 +442,7 @@ system's page size (the value would be very large, that's millions of trillions) **--memory-reservation**=*limit* -Memory soft limit (format: [], where unit = b, k, m or g) +Memory soft limit (format: [], 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 @@ -683,9 +683,9 @@ Note: Labeling can be disabled for all containers by setting label=false in the **--shm-size**=*size* -Size of `/dev/shm`. The format is ``. `number` must be greater than `0`. -Unit is optional and can be `b` (bytes), `k` (kilobytes), `m`(megabytes), or `g` (gigabytes). +Size of `/dev/shm` (format: [], 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. **--sig-proxy**=*true|false* -- cgit v1.2.3-54-g00ecf