summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-09-26 07:30:30 -0600
committerEd Santiago <santiago@redhat.com>2022-09-26 08:27:54 -0600
commitfa18d35e8900bf04d735ce708be5caf377faa93d (patch)
tree1cd7a35e089946b77331ef284b5ff5e1b59a0714 /docs/source
parenta399e58cfb85a46d7931d61167c6101a3ca1a3f3 (diff)
downloadpodman-fa18d35e8900bf04d735ce708be5caf377faa93d.tar.gz
podman-fa18d35e8900bf04d735ce708be5caf377faa93d.tar.bz2
podman-fa18d35e8900bf04d735ce708be5caf377faa93d.zip
Man pages: refactor common options: --env
Only among podman create, exec, run. The same option in podman build, generate-systemd, and secret-create is too different. Should be a trivial one to review, the only difference is a period at the end of one sentence. And, of course, the "See Environment note" applies only to podman-create and run, not exec, so it can't be deduplicated. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/options/env.md5
-rw-r--r--docs/source/markdown/podman-create.1.md.in6
-rw-r--r--docs/source/markdown/podman-exec.1.md.in6
-rw-r--r--docs/source/markdown/podman-run.1.md.in6
4 files changed, 8 insertions, 15 deletions
diff --git a/docs/source/markdown/options/env.md b/docs/source/markdown/options/env.md
new file mode 100644
index 000000000..ace25138e
--- /dev/null
+++ b/docs/source/markdown/options/env.md
@@ -0,0 +1,5 @@
+#### **--env**, **-e**=*env*
+
+Set environment variables.
+
+This option allows arbitrary environment variables that are available for the process to be launched inside of the container. If an environment variable is specified without a value, Podman will check the host environment for a value and set the variable only if it is set on the host. As a special case, if an environment variable ending in __*__ is specified without a value, Podman will search the host environment for variables starting with the prefix and will add those variables to the container.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index 742a32b5a..e182e289c 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -151,11 +151,7 @@ This option cannot be combined with **--network** that is set to **none** or **c
@@option entrypoint
-#### **--env**, **-e**=*env*
-
-Set environment variables
-
-This option allows arbitrary environment variables that are available for the process to be launched inside of the container. If an environment variable is specified without a value, Podman will check the host environment for a value and set the variable only if it is set on the host. As a special case, if an environment variable ending in __*__ is specified without a value, Podman will search the host environment for variables starting with the prefix and will add those variables to the container.
+@@option env
See [**Environment**](#environment) note below for precedence and examples.
diff --git a/docs/source/markdown/podman-exec.1.md.in b/docs/source/markdown/podman-exec.1.md.in
index 8198c319e..6ddf6d3ff 100644
--- a/docs/source/markdown/podman-exec.1.md.in
+++ b/docs/source/markdown/podman-exec.1.md.in
@@ -21,11 +21,7 @@ Start the exec session, but do not attach to it. The command will run in the bac
Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*.
-#### **--env**, **-e**=*env*
-
-Set environment variables.
-
-This option allows arbitrary environment variables that are available for the process to be launched inside of the container. If an environment variable is specified without a value, Podman will check the host environment for a value and set the variable only if it is set on the host. As a special case, if an environment variable ending in __*__ is specified without a value, Podman will search the host environment for variables starting with the prefix and will add those variables to the container.
+@@option env
#### **--env-file**=*file*
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 1259f0e37..a50b82d2a 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -187,11 +187,7 @@ This option cannot be combined with **--network** that is set to **none** or **c
@@option entrypoint
-#### **--env**, **-e**=*env*
-
-Set environment variables.
-
-This option allows arbitrary environment variables that are available for the process to be launched inside of the container. If an environment variable is specified without a value, Podman will check the host environment for a value and set the variable only if it is set on the host. As a special case, if an environment variable ending in __*__ is specified without a value, Podman will search the host environment for variables starting with the prefix and will add those variables to the container.
+@@option env
See [**Environment**](#environment) note below for precedence and examples.