Bug 2187187

Summary: "Alias" manpages should be included in podman-docker sub-package
Product: Red Hat Enterprise Linux 9 Reporter: Warren Young <warren>
Component: podmanAssignee: Jindrich Novy <jnovy>
Status: CLOSED ERRATA QA Contact: Yuhui Jiang <yujiang>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 9.4CC: ajia, bbaude, dwalsh, jnovy, lsm5, mboddu, mheon, pthomas, tsweeney, umohnani, ypu
Target Milestone: rcKeywords: Triaged
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: podman-4.4.1-10.el9 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-11-07 08:34:00 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Warren Young 2023-04-17 07:04:47 UTC
According to @rhatdan, who asked me to file this report, the podman-docker package should be installing the "docker-*" manpages so you can say "man docker-create" and such and get the podman-create docs. Apparently these are shipping upstream, and you aren't packaging them.

I tested this with 4.4.1-3 on an up-to-date EL9 box.

Comment 1 Daniel Walsh 2023-04-17 10:56:15 UTC
Here is what the podman-docker package on f38 looks like.

$ rpm -qpl podman-docker-4.5.0~rc2-1.fc38.noarch.rpm 
/usr/bin/docker
/usr/lib/tmpfiles.d/podman-docker.conf
/usr/share/man/man1/docker-attach.1.gz
/usr/share/man/man1/docker-auto-update.1.gz
/usr/share/man/man1/docker-build.1.gz
/usr/share/man/man1/docker-commit.1.gz
/usr/share/man/man1/docker-completion.1.gz
/usr/share/man/man1/docker-container-checkpoint.1.gz
/usr/share/man/man1/docker-container-cleanup.1.gz
/usr/share/man/man1/docker-container-clone.1.gz
/usr/share/man/man1/docker-container-diff.1.gz
/usr/share/man/man1/docker-container-exists.1.gz
/usr/share/man/man1/docker-container-inspect.1.gz
/usr/share/man/man1/docker-container-prune.1.gz
/usr/share/man/man1/docker-container-restore.1.gz
/usr/share/man/man1/docker-container-runlabel.1.gz
/usr/share/man/man1/docker-container.1.gz
/usr/share/man/man1/docker-cp.1.gz
/usr/share/man/man1/docker-create.1.gz
/usr/share/man/man1/docker-diff.1.gz
/usr/share/man/man1/docker-events.1.gz
/usr/share/man/man1/docker-exec.1.gz
/usr/share/man/man1/docker-export.1.gz
/usr/share/man/man1/docker-generate-spec.1.gz
/usr/share/man/man1/docker-generate-systemd.1.gz
/usr/share/man/man1/docker-generate.1.gz
/usr/share/man/man1/docker-healthcheck-run.1.gz
/usr/share/man/man1/docker-healthcheck.1.gz
/usr/share/man/man1/docker-history.1.gz
/usr/share/man/man1/docker-image-diff.1.gz
/usr/share/man/man1/docker-image-exists.1.gz
/usr/share/man/man1/docker-image-inspect.1.gz
/usr/share/man/man1/docker-image-mount.1.gz
/usr/share/man/man1/docker-image-prune.1.gz
/usr/share/man/man1/docker-image-scp.1.gz
/usr/share/man/man1/docker-image-sign.1.gz
/usr/share/man/man1/docker-image-tree.1.gz
/usr/share/man/man1/docker-image-trust.1.gz
/usr/share/man/man1/docker-image-unmount.1.gz
/usr/share/man/man1/docker-image.1.gz
/usr/share/man/man1/docker-images.1.gz
/usr/share/man/man1/docker-import.1.gz
/usr/share/man/man1/docker-info.1.gz
/usr/share/man/man1/docker-init.1.gz
/usr/share/man/man1/docker-inspect.1.gz
/usr/share/man/man1/docker-kill.1.gz
/usr/share/man/man1/docker-kube-apply.1.gz
/usr/share/man/man1/docker-kube-down.1.gz
/usr/share/man/man1/docker-kube-generate.1.gz
/usr/share/man/man1/docker-kube-play.1.gz
/usr/share/man/man1/docker-kube.1.gz
/usr/share/man/man1/docker-load.1.gz
/usr/share/man/man1/docker-login.1.gz
/usr/share/man/man1/docker-logout.1.gz
/usr/share/man/man1/docker-logs.1.gz
/usr/share/man/man1/docker-machine-info.1.gz
/usr/share/man/man1/docker-machine-init.1.gz
/usr/share/man/man1/docker-machine-inspect.1.gz
/usr/share/man/man1/docker-machine-list.1.gz
/usr/share/man/man1/docker-machine-os-apply.1.gz
/usr/share/man/man1/docker-machine-os.1.gz
/usr/share/man/man1/docker-machine-rm.1.gz
/usr/share/man/man1/docker-machine-set.1.gz
/usr/share/man/man1/docker-machine-ssh.1.gz
/usr/share/man/man1/docker-machine-start.1.gz
/usr/share/man/man1/docker-machine-stop.1.gz
/usr/share/man/man1/docker-machine.1.gz
/usr/share/man/man1/docker-manifest-add.1.gz
/usr/share/man/man1/docker-manifest-annotate.1.gz
/usr/share/man/man1/docker-manifest-create.1.gz
/usr/share/man/man1/docker-manifest-exists.1.gz
/usr/share/man/man1/docker-manifest-inspect.1.gz
/usr/share/man/man1/docker-manifest-push.1.gz
/usr/share/man/man1/docker-manifest-remove.1.gz
/usr/share/man/man1/docker-manifest-rm.1.gz
/usr/share/man/man1/docker-manifest.1.gz
/usr/share/man/man1/docker-mount.1.gz
/usr/share/man/man1/docker-network-connect.1.gz
/usr/share/man/man1/docker-network-create.1.gz
/usr/share/man/man1/docker-network-disconnect.1.gz
/usr/share/man/man1/docker-network-exists.1.gz
/usr/share/man/man1/docker-network-inspect.1.gz
/usr/share/man/man1/docker-network-ls.1.gz
/usr/share/man/man1/docker-network-prune.1.gz
/usr/share/man/man1/docker-network-reload.1.gz
/usr/share/man/man1/docker-network-rm.1.gz
/usr/share/man/man1/docker-network-update.1.gz
/usr/share/man/man1/docker-network.1.gz
/usr/share/man/man1/docker-pause.1.gz
/usr/share/man/man1/docker-pod-clone.1.gz
/usr/share/man/man1/docker-pod-create.1.gz
/usr/share/man/man1/docker-pod-exists.1.gz
/usr/share/man/man1/docker-pod-inspect.1.gz
/usr/share/man/man1/docker-pod-kill.1.gz
/usr/share/man/man1/docker-pod-logs.1.gz
/usr/share/man/man1/docker-pod-pause.1.gz
/usr/share/man/man1/docker-pod-prune.1.gz
/usr/share/man/man1/docker-pod-ps.1.gz
/usr/share/man/man1/docker-pod-restart.1.gz
/usr/share/man/man1/docker-pod-rm.1.gz
/usr/share/man/man1/docker-pod-start.1.gz
/usr/share/man/man1/docker-pod-stats.1.gz
/usr/share/man/man1/docker-pod-stop.1.gz
/usr/share/man/man1/docker-pod-top.1.gz
/usr/share/man/man1/docker-pod-unpause.1.gz
/usr/share/man/man1/docker-pod.1.gz
/usr/share/man/man1/docker-port.1.gz
/usr/share/man/man1/docker-ps.1.gz
/usr/share/man/man1/docker-pull.1.gz
/usr/share/man/man1/docker-push.1.gz
/usr/share/man/man1/docker-remote.1.gz
/usr/share/man/man1/docker-rename.1.gz
/usr/share/man/man1/docker-restart.1.gz
/usr/share/man/man1/docker-rm.1.gz
/usr/share/man/man1/docker-rmi.1.gz
/usr/share/man/man1/docker-run.1.gz
/usr/share/man/man1/docker-save.1.gz
/usr/share/man/man1/docker-search.1.gz
/usr/share/man/man1/docker-secret-create.1.gz
/usr/share/man/man1/docker-secret-exists.1.gz
/usr/share/man/man1/docker-secret-inspect.1.gz
/usr/share/man/man1/docker-secret-ls.1.gz
/usr/share/man/man1/docker-secret-rm.1.gz
/usr/share/man/man1/docker-secret.1.gz
/usr/share/man/man1/docker-start.1.gz
/usr/share/man/man1/docker-stats.1.gz
/usr/share/man/man1/docker-stop.1.gz
/usr/share/man/man1/docker-system-connection-add.1.gz
/usr/share/man/man1/docker-system-connection-default.1.gz
/usr/share/man/man1/docker-system-connection-list.1.gz
/usr/share/man/man1/docker-system-connection-remove.1.gz
/usr/share/man/man1/docker-system-connection-rename.1.gz
/usr/share/man/man1/docker-system-connection.1.gz
/usr/share/man/man1/docker-system-df.1.gz
/usr/share/man/man1/docker-system-migrate.1.gz
/usr/share/man/man1/docker-system-prune.1.gz
/usr/share/man/man1/docker-system-renumber.1.gz
/usr/share/man/man1/docker-system-reset.1.gz
/usr/share/man/man1/docker-system-service.1.gz
/usr/share/man/man1/docker-system.1.gz
/usr/share/man/man1/docker-tag.1.gz
/usr/share/man/man1/docker-top.1.gz
/usr/share/man/man1/docker-unmount.1.gz
/usr/share/man/man1/docker-unpause.1.gz
/usr/share/man/man1/docker-unshare.1.gz
/usr/share/man/man1/docker-untag.1.gz
/usr/share/man/man1/docker-update.1.gz
/usr/share/man/man1/docker-version.1.gz
/usr/share/man/man1/docker-volume-create.1.gz
/usr/share/man/man1/docker-volume-exists.1.gz
/usr/share/man/man1/docker-volume-export.1.gz
/usr/share/man/man1/docker-volume-import.1.gz
/usr/share/man/man1/docker-volume-inspect.1.gz
/usr/share/man/man1/docker-volume-ls.1.gz
/usr/share/man/man1/docker-volume-mount.1.gz
/usr/share/man/man1/docker-volume-prune.1.gz
/usr/share/man/man1/docker-volume-reload.1.gz
/usr/share/man/man1/docker-volume-rm.1.gz
/usr/share/man/man1/docker-volume-unmount.1.gz
/usr/share/man/man1/docker-volume.1.gz
/usr/share/man/man1/docker-wait.1.gz
/usr/share/man/man1/docker.1.gz
/usr/share/user-tmpfiles.d/podman-docker.conf

Comment 2 Warren Young 2023-04-17 11:45:01 UTC
What I get on both CentOS Stream 8 and 9 is:

$ rpm -ql podman-docker
/usr/bin/docker
/usr/lib/tmpfiles.d/podman-docker.conf
/usr/share/user-tmpfiles.d/podman-docker.conf

More details on Stream 9:

$ rpm -qi podman-docker
Name        : podman-docker
Epoch       : 2
Version     : 4.4.1
Release     : 3.el9
Architecture: noarch
Install Date: Sun 26 Mar 2023 10:45:17 PM MDT
Group       : Unspecified
Size        : 293
License     : ASL 2.0 and GPLv3+
Signature   : RSA/SHA256, Wed 15 Mar 2023 04:56:15 AM MDT, Key ID 05b555b38483c65d
Source RPM  : podman-4.4.1-3.el9.src.rpm
Build Date  : Tue 21 Feb 2023 04:10:49 AM MST
Build Host  : aarch64-01.stream.rdu2.redhat.com
Packager    : builder
Vendor      : CentOS
URL         : https://podman.io/

I assume this is similar to what one gets on RHEL9, or at least what *will* happen to it later, if this is one of those areas where Stream is ahead of RHEL.

Comment 3 Jindrich Novy 2023-04-17 19:33:27 UTC
Is this a new thing introduced with the upcoming podman-4.5.0? I don't see any of these aliases in 4.4.1 sources?

Comment 4 Daniel Walsh 2023-04-17 21:17:26 UTC
No this has been there from the beginning.  These are the links to the the matching man pages.

make docker-docs

Executes:
```
.PHONY: docker-docs
docker-docs: docs
	(cd docs; ./dckrman.sh ./build/man/*.1)
```

make install.docker

Comment 5 Tom Sweeney 2023-04-17 22:28:54 UTC
Assigning to Jindrich as I think this is all on the packaging side.  Jindrich, holler if not.

Comment 6 Jindrich Novy 2023-04-18 08:22:45 UTC
Thanks Dan, just to double-check - I noticed this in the Fedora spec file:

rm -f %{buildroot}%{_mandir}/man5/docker*.5

Assuming this need to be present in RHEL too?

Comment 7 Daniel Walsh 2023-04-25 14:19:59 UTC
Yes I guess this removes a link to podman-systemd-unit.5?

Comment 8 Jindrich Novy 2023-04-25 15:29:58 UTC
Nope, podman-systemd.unit.5.gz and quadlet.5.gz remains in place.

Comment 15 errata-xmlrpc 2023-11-07 08:34:00 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: podman security, bug fix, and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2023:6474