Skip to content

Commit

Permalink
Man pages: refactor common options: --subXidname
Browse files Browse the repository at this point in the history
Whew! This one started off identical everywhere, but the version
in podman-run got fixed in #1380, then again in #5192, with no
corresponding fixes to any of the other man pages.

I went with the podman-run version, with a small change in wording.

Signed-off-by: Ed Santiago <[email protected]>
  • Loading branch information
edsantiago committed Aug 30, 2022
1 parent 7f141a7 commit 62d87aa
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 29 deletions.
5 changes: 5 additions & 0 deletions docs/source/markdown/options/subgidname.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#### **--subgidname**=*name*

Run the container in a new user namespace using the map with _name_ in the _/etc/subgid_ file.
If running rootless, the user needs to have the right to use the mapping. See **subgid**(5).
This flag conflicts with **--userns** and **--gidmap**.
5 changes: 5 additions & 0 deletions docs/source/markdown/options/subuidname.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#### **--subuidname**=*name*

Run the container in a new user namespace using the map with _name_ in the _/etc/subuid_ file.
If running rootless, the user needs to have the right to use the mapping. See **subuid**(5).
This flag conflicts with **--userns** and **--uidmap**.
8 changes: 2 additions & 6 deletions docs/source/markdown/podman-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -586,13 +586,9 @@ When size is `0`, there is no limit on the amount of memory used for IPC by the

@@option stop-timeout

#### **--subgidname**=*name*
@@option subgidname

Name for GID map from the `/etc/subgid` file. Using this flag will run the container with user namespace enabled. This flag conflicts with `--userns` and `--gidmap`.

#### **--subuidname**=*name*

Name for UID map from the `/etc/subuid` file. Using this flag will run the container with user namespace enabled. This flag conflicts with `--userns` and `--uidmap`.
@@option subuidname

#### **--sysctl**=*SYSCTL*

Expand Down
8 changes: 2 additions & 6 deletions docs/source/markdown/podman-pod-clone.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,9 @@ When size is `0`, there is no limit on the amount of memory used for IPC by the
When set to true, this flag starts the newly created pod after the
clone process has completed. All containers within the pod are started.

#### **--subgidname**=*name*
@@option subgidname

Name for GID map from the `/etc/subgid` file. Using this flag will run the container with user namespace enabled. This flag conflicts with `--userns` and `--gidmap`.

#### **--subuidname**=*name*

Name for UID map from the `/etc/subuid` file. Using this flag will run the container with user namespace enabled. This flag conflicts with `--userns` and `--uidmap`.
@@option subuidname

#### **--sysctl**=*name=value*

Expand Down
9 changes: 2 additions & 7 deletions docs/source/markdown/podman-pod-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -287,14 +287,9 @@ Size of `/dev/shm` (format: `<number>[<unit>]`, where unit = b (bytes), k (kibib
If the unit is omitted, the system uses bytes. If the size is omitted, the system uses `64m`.
When size is `0`, there is no limit on the amount of memory used for IPC by the pod. This option conflicts with **--ipc=host** when running containers.

#### **--subgidname**=*name*

Name for GID map from the `/etc/subgid` file. Using this flag will run the container with user namespace enabled. This flag conflicts with `--userns` and `--gidmap`.

#### **--subuidname**=*name*

Name for UID map from the `/etc/subuid` file. Using this flag will run the container with user namespace enabled. This flag conflicts with `--userns` and `--uidmap`.
@@option subgidname

@@option subuidname

#### **--sysctl**=*name=value*

Expand Down
12 changes: 2 additions & 10 deletions docs/source/markdown/podman-run.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -628,17 +628,9 @@ Sets whether the signals sent to the **podman run** command are proxied to the c

@@option stop-timeout

#### **--subgidname**=*name*
@@option subgidname

Run the container in a new user namespace using the map with _name_ in the _/etc/subgid_ file.
If calling **podman run** as an unprivileged user, the user needs to have the right to use the mapping. See **subgid**(5).
This flag conflicts with **--userns** and **--gidmap**.

#### **--subuidname**=*name*

Run the container in a new user namespace using the map with _name_ in the _/etc/subuid_ file.
If calling **podman run** as an unprivileged user, the user needs to have the right to use the mapping. See **subuid**(5).
This flag conflicts with **--userns** and **--uidmap**.
@@option subuidname

#### **--sysctl**=*name=value*

Expand Down

0 comments on commit 62d87aa

Please sign in to comment.