diff --git a/docs/source/markdown/options/systemd.md b/docs/source/markdown/options/systemd.md index ffddb9c11f..8d69f9ab79 100644 --- a/docs/source/markdown/options/systemd.md +++ b/docs/source/markdown/options/systemd.md @@ -23,7 +23,7 @@ Running the container in systemd mode causes the following changes: * _/var/lib/journal_ * Podman sets the default stop signal to **SIGRTMIN+3**. * Podman sets **container_uuid** environment variable in the container to the -first 32 characters of the container id. +first 32 characters of the container ID. * Podman will not mount virtual consoles (_/dev/tty\d+_) when running with **--privileged**. This allows systemd to run in a confined container without any modifications. diff --git a/docs/source/markdown/options/userns.container.md b/docs/source/markdown/options/userns.container.md index bc5c85ca85..1c42a194d4 100644 --- a/docs/source/markdown/options/userns.container.md +++ b/docs/source/markdown/options/userns.container.md @@ -14,7 +14,7 @@ Key | Host User | Container User ----------|---------------|--------------------- "" |$UID |0 (Default User account mapped to root user in container.) keep-id |$UID |$UID (Map user account to same UID within container.) -keep-id:uid=200,gid=210 |$UID| 200:210 (Map user account to specified uid, gid value within container.) +keep-id:uid=200,gid=210 |$UID| 200:210 (Map user account to specified UID, GID value within container.) auto |$UID | nil (Host User UID is not mapped into container.) nomap |$UID | nil (Host User UID is not mapped into container.) @@ -26,7 +26,7 @@ The `--userns=auto` flag requires that the user name __containers__ be specified Example: `containers:2147483647:2147483648`. -Podman allocates unique ranges of UIDs and GIDs from the `containers` subordinate user ids. The size of the ranges is based on the number of UIDs required in the image. The number of UIDs and GIDs can be overridden with the `size` option. +Podman allocates unique ranges of UIDs and GIDs from the `containers` subordinate user IDs. The size of the ranges is based on the number of UIDs required in the image. The number of UIDs and GIDs can be overridden with the `size` option. The option `--userns=keep-id` uses all the subuids and subgids of the user. The option `--userns=nomap` uses all the subuids and subgids of the user except the user's own ID. diff --git a/docs/source/markdown/podman-container-clone.1.md.in b/docs/source/markdown/podman-container-clone.1.md.in index d4add19fdd..9902caa0f4 100644 --- a/docs/source/markdown/podman-container-clone.1.md.in +++ b/docs/source/markdown/podman-container-clone.1.md.in @@ -7,7 +7,7 @@ podman\-container\-clone - Creates a copy of an existing container **podman container clone** [*options*] *container* *name* *image* ## DESCRIPTION -**podman container clone** creates a copy of a container, recreating the original with an identical configuration. This command takes three arguments: the first being the container id or name to clone, the second argument in this command can change the name of the clone from the default of $ORIGINAL_NAME-clone, and the third is a new image to use in the cloned container. +**podman container clone** creates a copy of a container, recreating the original with an identical configuration. This command takes three arguments: the first being the container ID or name to clone, the second argument in this command can change the name of the clone from the default of $ORIGINAL_NAME-clone, and the third is a new image to use in the cloned container. ## OPTIONS diff --git a/docs/source/markdown/podman-cp.1.md b/docs/source/markdown/podman-cp.1.md index d6c8576538..c87e8b42b4 100644 --- a/docs/source/markdown/podman-cp.1.md +++ b/docs/source/markdown/podman-cp.1.md @@ -58,9 +58,9 @@ Further note that `podman cp` does not support globbing (e.g., `cp dir/*.txt`). #### **--archive**, **-a** -Archive mode (copy all uid/gid information). +Archive mode (copy all UID/GID information). When set to true, files copied to a container will have changed ownership to the primary UID/GID of the container. -When set to false, maintain uid/gid from archive sources instead of changing them to the primary uid/gid of the destination container. +When set to false, maintain UID/GID from archive sources instead of changing them to the primary UID/GID of the destination container. The default is **true**. #### **--overwrite** diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 974aa32ce2..5b91b3edb0 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -403,7 +403,7 @@ $ podman create --annotation HELLO=WORLD alpine ls ### Set UID/GID mapping in a new user namespace Running a container in a new user namespace requires a mapping of -the uids and gids from the host. +the UIDs and GIDs from the host. ``` $ podman create --uidmap 0:30000:7000 --gidmap 0:30000:7000 fedora echo hello diff --git a/docs/source/markdown/podman-images.1.md.in b/docs/source/markdown/podman-images.1.md.in index f41c6b6611..3926bdaa15 100644 --- a/docs/source/markdown/podman-images.1.md.in +++ b/docs/source/markdown/podman-images.1.md.in @@ -33,7 +33,7 @@ Supported filters: | Filter | Description | | :----------------: | --------------------------------------------------------------------------------------------- | -| *id* | Filter by image id. | +| *id* | Filter by image ID. | | *before* | Filter by images created before the given IMAGE (name or tag). | | *containers* | Filter by images with a running container. | | *dangling* | Filter by dangling (unused) images. | @@ -46,7 +46,7 @@ Supported filters: | *after*/*since* | Filter by images created after the given IMAGE (name or tag). | | *until* | Filter by images created until the given duration or time. | -The `id` *filter* accepts the image id string. +The `id` *filter* accepts the image ID string. The `before` *filter* accepts formats: `[:]`, `` or ``. diff --git a/docs/source/markdown/podman-pod-create.1.md.in b/docs/source/markdown/podman-pod-create.1.md.in index f2a6205176..322c637813 100644 --- a/docs/source/markdown/podman-pod-create.1.md.in +++ b/docs/source/markdown/podman-pod-create.1.md.in @@ -10,7 +10,7 @@ podman\-pod\-create - Create a new pod Creates an empty pod, or unit of multiple containers, and prepares it to have containers added to it. The pod can be created with a specific name. If a name -is not given a random name is generated. The pod id is printed to STDOUT. You +is not given a random name is generated. The pod ID is printed to STDOUT. You can then use **podman create --pod `` ...** to add containers to the pod, and **podman pod start ``** to start the pod. diff --git a/docs/source/markdown/podman-pod-logs.1.md.in b/docs/source/markdown/podman-pod-logs.1.md.in index 326eab1847..5d0764ca0f 100644 --- a/docs/source/markdown/podman-pod-logs.1.md.in +++ b/docs/source/markdown/podman-pod-logs.1.md.in @@ -7,7 +7,7 @@ podman\-pod\-logs - Displays logs for pod with one or more containers **podman pod logs** [*options*] *pod* ## DESCRIPTION -The podman pod logs command batch-retrieves whatever logs are present with all the containers of a pod. Pod logs can be filtered by container name or id using flag **-c** or **--container** if needed. +The podman pod logs command batch-retrieves whatever logs are present with all the containers of a pod. Pod logs can be filtered by container name or ID using flag **-c** or **--container** if needed. Note: Long running command of `podman pod log` with a `-f` or `--follow` needs to be reinvoked if new container is added to the pod dynamically otherwise logs of newly added containers would not be visible in log stream. diff --git a/docs/source/markdown/podman-pod-ps.1.md.in b/docs/source/markdown/podman-pod-ps.1.md.in index 27ad5788c9..a0d99a722a 100644 --- a/docs/source/markdown/podman-pod-ps.1.md.in +++ b/docs/source/markdown/podman-pod-ps.1.md.in @@ -10,11 +10,11 @@ podman\-pod\-ps - Prints out information about pods **podman pod ps** lists the pods on the system. By default it lists: - * pod id + * pod ID * pod name * the time the pod was created * number of containers attached to pod - * container id of the pod infra container + * container ID of the pod infra container * status of pod as defined by the following table | **Status** | **Description** | diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index f45e0bd4ed..129cb2e4b1 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -31,7 +31,7 @@ file is created in each container to indicate to programs they are running in a container. This file is located at _/run/.containerenv_. When using the --privileged flag the .containerenv contains name/value pairs indicating the container engine version, whether the engine is running in rootless mode, the -container name and id, as well as the image name and id that the container is based on. +container name and ID, as well as the image name and ID that the container is based on. When running from a user defined network namespace, the _/etc/netns/NSNAME/resolv.conf_ will be used if it exists, otherwise _/etc/resolv.conf_ will be used. @@ -736,7 +736,7 @@ supported sysctls. ### Set UID/GID mapping in a new user namespace Running a container in a new user namespace requires a mapping of -the uids and gids from the host. +the UIDs and GIDs from the host. ``` $ podman run --uidmap 0:30000:7000 --gidmap 0:30000:7000 fedora echo hello diff --git a/docs/source/markdown/podman-systemd.unit.5.md b/docs/source/markdown/podman-systemd.unit.5.md index 145e5f4d41..dd55aeb221 100644 --- a/docs/source/markdown/podman-systemd.unit.5.md +++ b/docs/source/markdown/podman-systemd.unit.5.md @@ -202,9 +202,8 @@ This key can be listed multiple times. ### `Group=` -The (numeric) gid to run as inside the container. This does not need to match the gid on the host, -which can be modified with `UsersNS`, but if that is not specified, this gid is also used on the host. - +The (numeric) GID to run as inside the container. This does not need to match the GID on the host, +which can be modified with `UsersNS`, but if that is not specified, this GID is also used on the host. ### `HealthCmd=` @@ -425,8 +424,8 @@ The timezone to run the container in. ### `User=` -The (numeric) uid to run as inside the container. This does not need to match the uid on the host, -which can be modified with `UserNS`, but if that is not specified, this uid is also used on the host. +The (numeric) UID to run as inside the container. This does not need to match the UID on the host, +which can be modified with `UserNS`, but if that is not specified, this UID is also used on the host. ### `UserNS=` @@ -663,7 +662,7 @@ The path of a device which should be mounted for the volume. ### `Group=` -The host (numeric) gid, or group name to use as the group for the volume +The host (numeric) GID, or group name to use as the group for the volume ### `Label=` @@ -682,7 +681,7 @@ The filesystem type of `Device` as used by the **mount(8)** commands `-t` option ### `User=` -The host (numeric) uid, or user name to use as the owner for the volume +The host (numeric) UID, or user name to use as the owner for the volume ## EXAMPLES diff --git a/docs/source/markdown/podman-volume-create.1.md b/docs/source/markdown/podman-volume-create.1.md index d637a12759..2253551f0e 100644 --- a/docs/source/markdown/podman-volume-create.1.md +++ b/docs/source/markdown/podman-volume-create.1.md @@ -91,10 +91,10 @@ Example /etc/fstab entry: /dev/podman/podman-var /var xfs defaults,x-systemd.device-timeout=0,pquota 1 2 ``` -Podman generates project ids for each builtin volume, but these project ids need to be unique for the XFS file system. These project ids by default are generated randomly, with a potential for overlap with other quotas on the same file +Podman generates project IDs for each builtin volume, but these project IDs need to be unique for the XFS file system. These project IDs by default are generated randomly, with a potential for overlap with other quotas on the same file system. -The xfs_quota tool can be used to assign a project id to the storage driver directory, e.g.: +The xfs_quota tool can be used to assign a project ID to the storage driver directory, e.g.: ``` echo 100000:/var/lib/containers/storage/overlay >> /etc/projects @@ -105,9 +105,9 @@ xfs_quota -x -c 'project -s storage volumes' / ``` In the example above we are configuring the overlay storage driver for newly -created containers as well as volumes to use project ids with a **start offset**. -All containers will be assigned larger project ids (e.g. >= 100000). -All volume assigned project ids larger project ids starting with 200000. +created containers as well as volumes to use project IDs with a **start offset**. +All containers will be assigned larger project IDs (e.g. >= 100000). +All volume assigned project IDs larger project IDs starting with 200000. This prevents xfs_quota management conflicts with containers/storage. ## SEE ALSO diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 49b8a1d8ee..924ef13d8d 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -408,7 +408,7 @@ Podman can also be used as non-root user. When podman runs in rootless mode, a u Containers created by a non-root user are not visible to other users and are not seen or managed by Podman running as root. -It is required to have multiple uids/gids set for a user. Be sure the user is present in the files `/etc/subuid` and `/etc/subgid`. +It is required to have multiple UIDS/GIDS set for a user. Be sure the user is present in the files `/etc/subuid` and `/etc/subgid`. Execute the following commands to add the ranges to the files