Skip to content

Commit

Permalink
Man pages: refactor common options: --env
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
edsantiago committed Sep 26, 2022
1 parent a399e58 commit fa18d35
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 15 deletions.
5 changes: 5 additions & 0 deletions docs/source/markdown/options/env.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 1 addition & 5 deletions docs/source/markdown/podman-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 1 addition & 5 deletions docs/source/markdown/podman-exec.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -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*

Expand Down
6 changes: 1 addition & 5 deletions docs/source/markdown/podman-run.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit fa18d35

Please sign in to comment.