Skip to content

Commit 84203fa

Browse files
committed
Update links and markup in man pages
- Fix links to other man-pages in podman-build.1.md.in - Fix markup and add link to oci-hooks manpage in podman.1.md Signed-off-by: Paul Lettich <[email protected]>
1 parent 53be17d commit 84203fa

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/source/markdown/podman-build.1.md.in

+4-4
Original file line numberDiff line numberDiff line change
@@ -699,15 +699,15 @@ mechanism:
699699
Exclude all doc files except Help.doc from the image.
700700

701701
This functionality is compatible with the handling of .containerignore files
702-
described here:
702+
described here: **[containerignore(5)](https://github.com/containers/common/blob/main/docs/containerignore.5.md)**
703703

704-
https://github.com/containers/common/blob/main/docs/containerignore.5.md
705-
706-
**registries.conf** (`/etc/containers/registries.conf`)
704+
### registries.conf (`/etc/containers/registries.conf`)
707705

708706
registries.conf is the configuration file which specifies which container
709707
registries is consulted when completing image names which do not include
710708
a registry or domain portion.
709+
See **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)**
710+
711711

712712
## Troubleshooting
713713

docs/source/markdown/podman.1.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -213,12 +213,12 @@ URL value resolution precedence:
213213
Remote connections use local containers.conf for default.
214214

215215
Some example URL values in valid formats:
216-
- unix:///run/podman/podman.sock
217-
- unix:///run/user/$UID/podman/podman.sock
218-
- ssh://notroot@localhost:22/run/user/$UID/podman/podman.sock
219-
- ssh://root@localhost:22/run/podman/podman.sock
220-
- tcp://localhost:34451
221-
- tcp://127.0.0.1:34451
216+
- `unix:///run/podman/podman.sock`
217+
- `unix:///run/user/$UID/podman/podman.sock`
218+
- `ssh://notroot@localhost:22/run/user/$UID/podman/podman.sock`
219+
- `ssh://root@localhost:22/run/podman/podman.sock`
220+
- `tcp://localhost:34451`
221+
- `tcp://127.0.0.1:34451`
222222

223223
#### **--version**, **-v**
224224

@@ -435,7 +435,7 @@ When Podman runs in rootless mode, the file `$HOME/.config/containers/storage.co
435435
If the **CONTAINERS_STORAGE_CONF** environment variable is set, then its value is used for the storage.conf file rather than the default.
436436

437437
## Rootless mode
438-
Podman can also be used as non-root user. When podman runs in rootless mode, a user namespace is automatically created for the user, defined in /etc/subuid and /etc/subgid.
438+
Podman can also be used as non-root user. When podman runs in rootless mode, a user namespace is automatically created for the user, defined in `/etc/subuid` and `/etc/subgid`.
439439

440440
Containers created by a non-root user are not visible to other users and are not seen or managed by Podman running as root.
441441

@@ -455,24 +455,24 @@ See the `subuid(5)` and `subgid(5)` man pages for more information.
455455

456456

457457

458-
Note: whitespace in any row of /etc/subuid or /etc/subgid, including trailing blanks, may result in no entry failures.
458+
Note: whitespace in any row of `/etc/subuid` or `/etc/subgid`, including trailing blanks, may result in no entry failures.
459459

460460
Images are pulled under `XDG_DATA_HOME` when specified, otherwise in the home directory of the user under `.local/share/containers/storage`.
461461

462462
Currently slirp4netns or pasta is required to be installed to create a network
463463
device, otherwise rootless containers need to run in the network namespace of
464464
the host.
465465

466-
In certain environments like HPC (High Performance Computing), users cannot take advantage of the additional UIDs and GIDs from the /etc/subuid and /etc/subgid systems. However, in this environment, rootless Podman can operate with a single UID. To make this work, set the `ignore_chown_errors` option in the `containers-storage.conf(5)` file. This option tells Podman when pulling an image to ignore chown errors when attempting to change a file in a container image to match the non-root UID in the image. This means all files get saved as the user's UID. Note this can cause issues when running the container.
466+
In certain environments like HPC (High Performance Computing), users cannot take advantage of the additional UIDs and GIDs from the `/etc/subuid` and `/etc/subgid` systems. However, in this environment, rootless Podman can operate with a single UID. To make this work, set the `ignore_chown_errors` option in the `containers-storage.conf(5)` file. This option tells Podman when pulling an image to ignore chown errors when attempting to change a file in a container image to match the non-root UID in the image. This means all files get saved as the user's UID. Note this can cause issues when running the container.
467467

468468
### **NOTE:** Unsupported file systems in rootless mode
469469

470-
The Overlay file system (OverlayFS) is not supported with kernels prior to 5.12.9 in rootless mode. The fuse-overlayfs package is a tool that provides the functionality of OverlayFS in user namespace that allows mounting file systems in rootless environments. It is recommended to install the fuse-overlayfs package. In rootless mode, Podman automatically uses the fuse-overlayfs program as the mount_program if installed, as long as the $HOME/.config/containers/storage.conf file was not previously created. If storage.conf exists in the homedir, add `mount_program = "/usr/bin/fuse-overlayfs"` under `[storage.options.overlay]` to enable this feature.
470+
The Overlay file system (OverlayFS) is not supported with kernels prior to 5.12.9 in rootless mode. The fuse-overlayfs package is a tool that provides the functionality of OverlayFS in user namespace that allows mounting file systems in rootless environments. It is recommended to install the fuse-overlayfs package. In rootless mode, Podman automatically uses the fuse-overlayfs program as the mount_program if installed, as long as the `$HOME/.config/containers/storage.conf` file was not previously created. If storage.conf exists in the homedir, add `mount_program = "/usr/bin/fuse-overlayfs"` under `[storage.options.overlay]` to enable this feature.
471471

472472
The Network File System (NFS) and other distributed file systems (for example: Lustre, Spectrum Scale, the General Parallel File System (GPFS)) are not supported when running in rootless mode as these file systems do not understand user namespace. However, rootless Podman can make use of an NFS Homedir by modifying the `$HOME/.config/containers/storage.conf` to have the `graphroot` option point to a directory stored on local (Non NFS) storage.
473473

474474
## SEE ALSO
475-
**[containers-mounts.conf(5)](https://github.com/containers/common/blob/main/docs/containers-mounts.conf.5.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)**, **[containers-storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md)**, **[buildah(1)](https://github.com/containers/buildah/blob/main/docs/buildah.1.md)**, **oci-hooks(5)**, **[containers-policy.json(5)](https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md)**, **[crun(1)](https://github.com/containers/crun/blob/main/crun.1.md)**, **[runc(8)](https://github.com/opencontainers/runc/blob/main/man/runc.8.md)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[slirp4netns(1)](https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**
475+
**[containers-mounts.conf(5)](https://github.com/containers/common/blob/main/docs/containers-mounts.conf.5.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)**, **[containers-storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md)**, **[buildah(1)](https://github.com/containers/buildah/blob/main/docs/buildah.1.md)**, **[oci-hooks(5)](https://github.com/containers/common/blob/main/pkg/hooks/docs/oci-hooks.5.md)**, **[containers-policy.json(5)](https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md)**, **[crun(1)](https://github.com/containers/crun/blob/main/crun.1.md)**, **[runc(8)](https://github.com/opencontainers/runc/blob/main/man/runc.8.md)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[slirp4netns(1)](https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**
476476

477477
### Troubleshooting
478478

0 commit comments

Comments
 (0)