summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-build.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2020-03-10 14:03:50 -0600
committerEd Santiago <santiago@redhat.com>2020-03-10 15:03:59 -0600
commit281def2647142acd1a901332391bd25f96169286 (patch)
tree0a52c1d1fe2c1235d351d0606ff1cead5219f1d7 /docs/source/markdown/podman-build.1.md
parentfe49daa3c2e83bd0ec8ee36ec156b73967f4f0da (diff)
downloadpodman-281def2647142acd1a901332391bd25f96169286.tar.gz
podman-281def2647142acd1a901332391bd25f96169286.tar.bz2
podman-281def2647142acd1a901332391bd25f96169286.zip
man pages: fix inconsistencies
I wrote a script to cross-reference podman --help against man pages. It found a bunch of inconsistencies fix them: * options missing from man pages * options misspelled or misformatted in man pages (usually misplaced asterisks or missing dashes, but see --dns-opt) * one spurious comma in the actual source file --help This is a fix in which I iterate over 'podman CMD --help' and check for presence in man pages. The other way around (look for flags in man pages, check podman CMD --help) is probably impossible: there are too many special cases Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-build.1.md')
-rw-r--r--docs/source/markdown/podman-build.1.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md
index e08eebc24..dc38caac0 100644
--- a/docs/source/markdown/podman-build.1.md
+++ b/docs/source/markdown/podman-build.1.md
@@ -37,6 +37,10 @@ Add an image *annotation* (e.g. annotation=*value*) to the image metadata. Can b
Note: this information is not present in Docker image formats, so it is discarded when writing images in Docker formats.
+**--arch**=*arch*
+
+Set the ARCH of the image to the provided value instead of the architecture of the host.
+
**--authfile**=*path*
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
@@ -187,7 +191,7 @@ Note: if the user only has access rights via a group, accessing the device
from inside a rootless container will fail. The **crun**(1) runtime offers a
workaround for this by adding the option **--annotation run.oci.keep_original_groups=1**.
-**--disable-compression, -D**
+**--disable-compression**, **-D**
Don't compress filesystem layers when building the image unless it is required
by the location where the image is being written. This is the default setting,
@@ -248,6 +252,10 @@ environment variable. `export BUILDAH_FORMAT=docker`
Print usage statement
+**--http-proxy**
+
+Pass through HTTP Proxy environment variables.
+
**--iidfile**=*ImageIDfile*
Write the image ID to the file.
@@ -340,6 +348,10 @@ another process.
Do not use existing cached images for the container build. Build from the start with a new set of cached layers.
+**--os**=*string*
+
+Set the OS to the provided value instead of the current operating system of the host.
+
**--pid**=*pid*
Sets the configuration for PID namespaces when handling `RUN` instructions.
@@ -429,6 +441,10 @@ Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater tha
Unit is optional and can be `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`.
+**--sign-by**=*fingerprint*
+
+Sign the image using a GPG key with the specified FINGERPRINT.
+
**--squash**
Squash all of the image's new layers into a single new layer; any preexisting layers