summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2019-10-29 17:27:12 -0700
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit486fcd4e1e6f00424f1016d8e331582523bd2c68 (patch)
treea1aff46e1f585a9e7a99e7a61a7cca63a4a1b507
parent52b92023edeba3a5e2c466d92d742e54b14a85cb (diff)
downloadpodman-486fcd4e1e6f00424f1016d8e331582523bd2c68.tar.gz
podman-486fcd4e1e6f00424f1016d8e331582523bd2c68.tar.bz2
podman-486fcd4e1e6f00424f1016d8e331582523bd2c68.zip
Update document formatting and packaging code
* Refactored code and Makefile to support new docs layout * Removed some old code packaging code * Add Readme.md to document what we're doing Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: baude <bbaude@redhat.com>
-rw-r--r--.gitignore2
-rw-r--r--Makefile41
-rw-r--r--docs/Readme.md21
-rwxr-xr-xdocs/remote-docs.sh (renamed from docs/podman-remote.sh)56
-rw-r--r--docs/source/Commands.rst86
-rw-r--r--docs/source/generate.rst4
-rw-r--r--docs/source/healthcheck.rst2
-rw-r--r--docs/source/image.rst32
-rw-r--r--docs/source/managecontainers.rst62
-rw-r--r--docs/source/markdown/links/podman-container-attach.1 (renamed from docs/links/podman-container-attach.1)0
-rw-r--r--docs/source/markdown/links/podman-container-commit.1 (renamed from docs/links/podman-container-commit.1)0
-rw-r--r--docs/source/markdown/links/podman-container-cp.1 (renamed from docs/links/podman-container-cp.1)0
-rw-r--r--docs/source/markdown/links/podman-container-create.1 (renamed from docs/links/podman-container-create.1)0
-rw-r--r--docs/source/markdown/links/podman-container-diff.1 (renamed from docs/links/podman-container-diff.1)0
-rw-r--r--docs/source/markdown/links/podman-container-exec.1 (renamed from docs/links/podman-container-exec.1)0
-rw-r--r--docs/source/markdown/links/podman-container-export.1 (renamed from docs/links/podman-container-export.1)0
-rw-r--r--docs/source/markdown/links/podman-container-init.1 (renamed from docs/links/podman-container-init.1)0
-rw-r--r--docs/source/markdown/links/podman-container-inspect.1 (renamed from docs/links/podman-container-inspect.1)0
-rw-r--r--docs/source/markdown/links/podman-container-kill.1 (renamed from docs/links/podman-container-kill.1)0
-rw-r--r--docs/source/markdown/links/podman-container-list.1 (renamed from docs/links/podman-container-list.1)0
-rw-r--r--docs/source/markdown/links/podman-container-logs.1 (renamed from docs/links/podman-container-logs.1)0
-rw-r--r--docs/source/markdown/links/podman-container-ls.1 (renamed from docs/links/podman-container-ls.1)0
-rw-r--r--docs/source/markdown/links/podman-container-mount.1 (renamed from docs/links/podman-container-mount.1)0
-rw-r--r--docs/source/markdown/links/podman-container-pause.1 (renamed from docs/links/podman-container-pause.1)0
-rw-r--r--docs/source/markdown/links/podman-container-port.1 (renamed from docs/links/podman-container-port.1)0
-rw-r--r--docs/source/markdown/links/podman-container-ps.1 (renamed from docs/links/podman-container-ps.1)0
-rw-r--r--docs/source/markdown/links/podman-container-restart.1 (renamed from docs/links/podman-container-restart.1)0
-rw-r--r--docs/source/markdown/links/podman-container-rm.1 (renamed from docs/links/podman-container-rm.1)0
-rw-r--r--docs/source/markdown/links/podman-container-run.1 (renamed from docs/links/podman-container-run.1)0
-rw-r--r--docs/source/markdown/links/podman-container-start.1 (renamed from docs/links/podman-container-start.1)0
-rw-r--r--docs/source/markdown/links/podman-container-stats.1 (renamed from docs/links/podman-container-stats.1)0
-rw-r--r--docs/source/markdown/links/podman-container-stop.1 (renamed from docs/links/podman-container-stop.1)0
-rw-r--r--docs/source/markdown/links/podman-container-top.1 (renamed from docs/links/podman-container-top.1)0
-rw-r--r--docs/source/markdown/links/podman-container-umount.1 (renamed from docs/links/podman-container-umount.1)0
-rw-r--r--docs/source/markdown/links/podman-container-unmount.1 (renamed from docs/links/podman-container-unmount.1)0
-rw-r--r--docs/source/markdown/links/podman-container-unpause.1 (renamed from docs/links/podman-container-unpause.1)0
-rw-r--r--docs/source/markdown/links/podman-container-wait.1 (renamed from docs/links/podman-container-wait.1)0
-rw-r--r--docs/source/markdown/links/podman-help.1 (renamed from docs/links/podman-help.1)0
-rw-r--r--docs/source/markdown/links/podman-image-build.1 (renamed from docs/links/podman-image-build.1)0
-rw-r--r--docs/source/markdown/links/podman-image-history.1 (renamed from docs/links/podman-image-history.1)0
-rw-r--r--docs/source/markdown/links/podman-image-import.1 (renamed from docs/links/podman-image-import.1)0
-rw-r--r--docs/source/markdown/links/podman-image-inspect.1 (renamed from docs/links/podman-image-inspect.1)0
-rw-r--r--docs/source/markdown/links/podman-image-list.1 (renamed from docs/links/podman-image-list.1)0
-rw-r--r--docs/source/markdown/links/podman-image-load.1 (renamed from docs/links/podman-image-load.1)0
-rw-r--r--docs/source/markdown/links/podman-image-ls.1 (renamed from docs/links/podman-image-ls.1)0
-rw-r--r--docs/source/markdown/links/podman-image-pull.1 (renamed from docs/links/podman-image-pull.1)0
-rw-r--r--docs/source/markdown/links/podman-image-push.1 (renamed from docs/links/podman-image-push.1)0
-rw-r--r--docs/source/markdown/links/podman-image-rm.1 (renamed from docs/links/podman-image-rm.1)0
-rw-r--r--docs/source/markdown/links/podman-image-save.1 (renamed from docs/links/podman-image-save.1)0
-rw-r--r--docs/source/markdown/links/podman-image-tag.1 (renamed from docs/links/podman-image-tag.1)0
-rw-r--r--docs/source/markdown/links/podman-list.1 (renamed from docs/links/podman-list.1)0
-rw-r--r--docs/source/markdown/links/podman-ls.1 (renamed from docs/links/podman-ls.1)0
-rw-r--r--docs/source/markdown/links/podman-system-info.1 (renamed from docs/links/podman-system-info.1)0
-rw-r--r--docs/source/markdown/links/podman-unmount.1 (renamed from docs/links/podman-unmount.1)0
-rw-r--r--docs/source/markdown/podman-attach.1.md (renamed from docs/source/man/podman-attach.1.md)0
-rw-r--r--docs/source/markdown/podman-build.1.md (renamed from docs/source/man/podman-build.1.md)0
-rw-r--r--docs/source/markdown/podman-commit.1.md (renamed from docs/source/man/podman-commit.1.md)0
-rw-r--r--docs/source/markdown/podman-container-checkpoint.1.md (renamed from docs/source/man/podman-container-checkpoint.1.md)0
-rw-r--r--docs/source/markdown/podman-container-cleanup.1.md (renamed from docs/source/man/podman-container-cleanup.1.md)0
-rw-r--r--docs/source/markdown/podman-container-exists.1.md (renamed from docs/source/man/podman-container-exists.1.md)0
-rw-r--r--docs/source/markdown/podman-container-prune.1.md (renamed from docs/source/man/podman-container-prune.1.md)0
-rw-r--r--docs/source/markdown/podman-container-restore.1.md (renamed from docs/source/man/podman-container-restore.1.md)0
-rw-r--r--docs/source/markdown/podman-container-runlabel.1.md (renamed from docs/source/man/podman-container-runlabel.1.md)0
-rw-r--r--docs/source/markdown/podman-container.1.md (renamed from docs/source/man/podman-container.1.md)0
-rw-r--r--docs/source/markdown/podman-cp.1.md (renamed from docs/source/man/podman-cp.1.md)0
-rw-r--r--docs/source/markdown/podman-create.1.md (renamed from docs/source/man/podman-create.1.md)0
-rw-r--r--docs/source/markdown/podman-diff.1.md (renamed from docs/source/man/podman-diff.1.md)0
-rw-r--r--docs/source/markdown/podman-events.1.md (renamed from docs/source/man/podman-events.1.md)0
-rw-r--r--docs/source/markdown/podman-exec.1.md (renamed from docs/source/man/podman-exec.1.md)0
-rw-r--r--docs/source/markdown/podman-export.1.md (renamed from docs/source/man/podman-export.1.md)0
-rw-r--r--docs/source/markdown/podman-generate-kube.1.md (renamed from docs/source/man/podman-generate-kube.1.md)0
-rw-r--r--docs/source/markdown/podman-generate-systemd.1.md (renamed from docs/source/man/podman-generate-systemd.1.md)0
-rw-r--r--docs/source/markdown/podman-generate.1.md (renamed from docs/source/man/podman-generate.1.md)0
-rw-r--r--docs/source/markdown/podman-healthcheck-run.1.md (renamed from docs/source/man/podman-healthcheck-run.1.md)0
-rw-r--r--docs/source/markdown/podman-healthcheck.1.md (renamed from docs/source/man/podman-healthcheck.1.md)0
-rw-r--r--docs/source/markdown/podman-history.1.md (renamed from docs/source/man/podman-history.1.md)0
-rw-r--r--docs/source/markdown/podman-image-exists.1.md (renamed from docs/source/man/podman-image-exists.1.md)0
-rw-r--r--docs/source/markdown/podman-image-prune.1.md (renamed from docs/source/man/podman-image-prune.1.md)0
-rw-r--r--docs/source/markdown/podman-image-sign.1.md (renamed from docs/source/man/podman-image-sign.1.md)0
-rw-r--r--docs/source/markdown/podman-image-tree.1.md (renamed from docs/source/man/podman-image-tree.1.md)0
-rw-r--r--docs/source/markdown/podman-image-trust.1.md (renamed from docs/source/man/podman-image-trust.1.md)0
-rw-r--r--docs/source/markdown/podman-image.1.md (renamed from docs/source/man/podman-image.1.md)0
-rw-r--r--docs/source/markdown/podman-images.1.md (renamed from docs/source/man/podman-images.1.md)0
-rw-r--r--docs/source/markdown/podman-import.1.md (renamed from docs/source/man/podman-import.1.md)0
-rw-r--r--docs/source/markdown/podman-info.1.md (renamed from docs/source/man/podman-info.1.md)0
-rw-r--r--docs/source/markdown/podman-init.1.md (renamed from docs/source/man/podman-init.1.md)0
-rw-r--r--docs/source/markdown/podman-inspect.1.md (renamed from docs/source/man/podman-inspect.1.md)0
-rw-r--r--docs/source/markdown/podman-kill.1.md (renamed from docs/source/man/podman-kill.1.md)0
-rw-r--r--docs/source/markdown/podman-load.1.md (renamed from docs/source/man/podman-load.1.md)0
-rw-r--r--docs/source/markdown/podman-login.1.md (renamed from docs/source/man/podman-login.1.md)0
-rw-r--r--docs/source/markdown/podman-logout.1.md (renamed from docs/source/man/podman-logout.1.md)0
-rw-r--r--docs/source/markdown/podman-logs.1.md (renamed from docs/source/man/podman-logs.1.md)0
-rw-r--r--docs/source/markdown/podman-mount.1.md (renamed from docs/source/man/podman-mount.1.md)0
-rw-r--r--docs/source/markdown/podman-network-create.1.md (renamed from docs/source/man/podman-network-create.1.md)0
-rw-r--r--docs/source/markdown/podman-network-inspect.1.md (renamed from docs/source/man/podman-network-inspect.1.md)0
-rw-r--r--docs/source/markdown/podman-network-ls.1.md (renamed from docs/source/man/podman-network-ls.1.md)0
-rw-r--r--docs/source/markdown/podman-network-rm.1.md (renamed from docs/source/man/podman-network-rm.1.md)0
-rw-r--r--docs/source/markdown/podman-network.1.md (renamed from docs/source/man/podman-network.1.md)0
-rw-r--r--docs/source/markdown/podman-pause.1.md (renamed from docs/source/man/podman-pause.1.md)0
-rw-r--r--docs/source/markdown/podman-play-kube.1.md (renamed from docs/source/man/podman-play-kube.1.md)0
-rw-r--r--docs/source/markdown/podman-play.1.md (renamed from docs/source/man/podman-play.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-create.1.md (renamed from docs/source/man/podman-pod-create.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-exists.1.md (renamed from docs/source/man/podman-pod-exists.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-inspect.1.md (renamed from docs/source/man/podman-pod-inspect.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-kill.1.md (renamed from docs/source/man/podman-pod-kill.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-pause.1.md (renamed from docs/source/man/podman-pod-pause.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-prune.1.md (renamed from docs/source/man/podman-pod-prune.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-ps.1.md (renamed from docs/source/man/podman-pod-ps.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-restart.1.md (renamed from docs/source/man/podman-pod-restart.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-rm.1.md (renamed from docs/source/man/podman-pod-rm.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-start.1.md (renamed from docs/source/man/podman-pod-start.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-stats.1.md (renamed from docs/source/man/podman-pod-stats.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-stop.1.md (renamed from docs/source/man/podman-pod-stop.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-top.1.md (renamed from docs/source/man/podman-pod-top.1.md)0
-rw-r--r--docs/source/markdown/podman-pod-unpause.1.md (renamed from docs/source/man/podman-pod-unpause.1.md)0
-rw-r--r--docs/source/markdown/podman-pod.1.md (renamed from docs/source/man/podman-pod.1.md)0
-rw-r--r--docs/source/markdown/podman-port.1.md (renamed from docs/source/man/podman-port.1.md)0
-rw-r--r--docs/source/markdown/podman-ps.1.md (renamed from docs/source/man/podman-ps.1.md)0
-rw-r--r--docs/source/markdown/podman-pull.1.md (renamed from docs/source/man/podman-pull.1.md)0
-rw-r--r--docs/source/markdown/podman-push.1.md (renamed from docs/source/man/podman-push.1.md)0
-rw-r--r--docs/source/markdown/podman-remote.1.md (renamed from docs/source/man/podman-remote.1.md)0
-rw-r--r--docs/source/markdown/podman-restart.1.md (renamed from docs/source/man/podman-restart.1.md)0
-rw-r--r--docs/source/markdown/podman-rm.1.md (renamed from docs/source/man/podman-rm.1.md)0
-rw-r--r--docs/source/markdown/podman-rmi.1.md (renamed from docs/source/man/podman-rmi.1.md)0
-rw-r--r--docs/source/markdown/podman-run.1.md (renamed from docs/source/man/podman-run.1.md)0
-rw-r--r--docs/source/markdown/podman-save.1.md (renamed from docs/source/man/podman-save.1.md)0
-rw-r--r--docs/source/markdown/podman-search.1.md (renamed from docs/source/man/podman-search.1.md)0
-rw-r--r--docs/source/markdown/podman-start.1.md (renamed from docs/source/man/podman-start.1.md)0
-rw-r--r--docs/source/markdown/podman-stats.1.md (renamed from docs/source/man/podman-stats.1.md)0
-rw-r--r--docs/source/markdown/podman-stop.1.md (renamed from docs/source/man/podman-stop.1.md)0
-rw-r--r--docs/source/markdown/podman-system-df.1.md (renamed from docs/source/man/podman-system-df.1.md)0
-rw-r--r--docs/source/markdown/podman-system-migrate.1.md (renamed from docs/source/man/podman-system-migrate.1.md)0
-rw-r--r--docs/source/markdown/podman-system-prune.1.md (renamed from docs/source/man/podman-system-prune.1.md)0
-rw-r--r--docs/source/markdown/podman-system-renumber.1.md (renamed from docs/source/man/podman-system-renumber.1.md)0
-rw-r--r--docs/source/markdown/podman-system.1.md (renamed from docs/source/man/podman-system.1.md)0
-rw-r--r--docs/source/markdown/podman-tag.1.md (renamed from docs/source/man/podman-tag.1.md)0
-rw-r--r--docs/source/markdown/podman-top.1.md (renamed from docs/source/man/podman-top.1.md)0
-rw-r--r--docs/source/markdown/podman-umount.1.md (renamed from docs/source/man/podman-umount.1.md)0
-rw-r--r--docs/source/markdown/podman-unpause.1.md (renamed from docs/source/man/podman-unpause.1.md)0
-rw-r--r--docs/source/markdown/podman-unshare.1.md (renamed from docs/source/man/podman-unshare.1.md)0
-rw-r--r--docs/source/markdown/podman-varlink.1.md (renamed from docs/source/man/podman-varlink.1.md)0
-rw-r--r--docs/source/markdown/podman-version.1.md (renamed from docs/source/man/podman-version.1.md)0
-rw-r--r--docs/source/markdown/podman-volume-create.1.md (renamed from docs/source/man/podman-volume-create.1.md)0
-rw-r--r--docs/source/markdown/podman-volume-inspect.1.md (renamed from docs/source/man/podman-volume-inspect.1.md)0
-rw-r--r--docs/source/markdown/podman-volume-ls.1.md (renamed from docs/source/man/podman-volume-ls.1.md)0
-rw-r--r--docs/source/markdown/podman-volume-prune.1.md (renamed from docs/source/man/podman-volume-prune.1.md)0
-rw-r--r--docs/source/markdown/podman-volume-rm.1.md (renamed from docs/source/man/podman-volume-rm.1.md)0
-rw-r--r--docs/source/markdown/podman-volume.1.md (renamed from docs/source/man/podman-volume.1.md)0
-rw-r--r--docs/source/markdown/podman-wait.1.md (renamed from docs/source/man/podman-wait.1.md)0
-rw-r--r--docs/source/markdown/podman.1.md (renamed from docs/source/man/podman.1.md)0
-rw-r--r--docs/source/network.rst8
-rw-r--r--docs/source/play.rst2
-rw-r--r--docs/source/pod.rst28
-rw-r--r--docs/source/system.rst10
-rw-r--r--docs/source/volume.rst10
-rwxr-xr-xhack/man-page-checker2
-rwxr-xr-xhack/podman-commands.sh4
157 files changed, 195 insertions, 175 deletions
diff --git a/.gitignore b/.gitignore
index 598384582..54b63518f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,7 @@
/docs/*.[158]
/docs/*.[158].gz
/docs/remote
+/docs/build/
*.o
*.orig
/pause/pause.o
@@ -25,3 +26,4 @@ release.txt
podman-remote*.zip
podman*.tar.gz
.idea*
+.vscode*
diff --git a/Makefile b/Makefile
index 587ab2ec2..73442eb7c 100644
--- a/Makefile
+++ b/Makefile
@@ -167,13 +167,11 @@ podman-remote: .gopathok $(PODMAN_VARLINK_DEPENDENCIES) ## Build with podman on
$(GO_BUILD) $(BUILDFLAGS) -gcflags '$(GCFLAGS)' -asmflags '$(ASMFLAGS)' -ldflags '$(LDFLAGS_PODMAN)' -tags "$(BUILDTAGS) remoteclient" -o bin/$@ $(PROJECT)/cmd/podman
.PHONY: podman.msi
-podman.msi: podman-remote podman-remote-windows docs ## Will always rebuild exe as there is no podman-remote-windows.exe target to verify timestamp
- rm -rf bin/windows
- mkdir -p bin/windows
- docs/podman-remote.sh windows bin/windows docs
- find bin/windows -print \
- |wixl-heat --var var.ManSourceDir --component-group ManFiles --directory-ref INSTALLDIR --prefix bin/windows/ >bin/windows/pages.wsx
- wixl -D VERSION=$(RELEASE_NUMBER) -D ManSourceDir=bin/windows -o podman-v$(RELEASE_NUMBER).msi contrib/msi/podman.wxs bin/windows/pages.wsx
+podman.msi: podman-remote podman-remote-windows install-podman-remote-windows-docs ## Will always rebuild exe as there is no podman-remote-windows.exe target to verify timestamp
+ $(eval DOCFILE := docs/build/remote/windows)
+ find $(DOCFILE) -print \
+ |wixl-heat --var var.ManSourceDir --component-group ManFiles --directory-ref INSTALLDIR --prefix $(DOCFILE)/ >$(DOCFILE)/pages.wsx
+ wixl -D VERSION=$(RELEASE_NUMBER) -D ManSourceDir=$(DOCFILE) -o podman-v$(RELEASE_NUMBER).msi contrib/msi/podman.wxs $(DOCFILE)/pages.wsx
podman-remote-%: .gopathok $(PODMAN_VARLINK_DEPENDENCIES) ## Build podman for a specific GOOS
$(eval BINSFX := $(shell test "$*" != "windows" || echo ".exe"))
@@ -196,7 +194,6 @@ clean: ## Clean artifacts
$(wildcard podman*.tar.gz) \
bin \
build \
- docs/remote \
test/checkseccomp/checkseccomp \
test/goecho/goecho \
test/testdata/redis-image \
@@ -310,24 +307,26 @@ install.catatonit:
test-binaries: test/checkseccomp/checkseccomp test/goecho/goecho install.catatonit
-MANPAGES_MD ?= $(wildcard docs/source/man/*.md pkg/*/docs/*.md)
+MANPAGES_MD ?= $(wildcard docs/source/markdown/*.md pkg/*/docs/*.md)
MANPAGES ?= $(MANPAGES_MD:%.md=%)
-MANPAGES_DEST ?= $(subst source,build,$(MANPAGES))
+MANPAGES_DEST ?= $(subst markdown,man, $(subst source,build,$(MANPAGES)))
$(MANPAGES): %: %.md .gopathok
- @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $(subst source,build,$@)
+ @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $(subst source/markdown,build/man,$@)
docdir:
mkdir -p docs/build/man
docs: docdir $(MANPAGES) ## Generate documentation
-install-podman-remote-docs: podman-remote docs
- rm -rf docs/remote
- docs/podman-remote.sh darwin docs/remote docs
+install-podman-remote-%-docs: podman-remote docs $(MANPAGES)
+ rm -rf docs/build/remote
+ mkdir -p docs/build/remote
+ ln -sf $(shell pwd)/docs/source/markdown/links docs/build/man/
+ docs/remote-docs.sh $* docs/build/remote/$* $(if $(findstring windows,$*),docs/source/markdown,docs/build/man)
man-page-check:
- ./hack/man-page-checker
+ hack/man-page-checker
# When publishing releases include critical build-time details
.PHONY: release.txt
@@ -351,7 +350,7 @@ podman-v$(RELEASE_NUMBER).tar.gz: binaries docs release.txt
# Must call make in-line: Dependency-spec. w/ wild-card also consumes variable value.
podman-remote-v$(RELEASE_NUMBER)-%.zip:
- $(MAKE) podman-remote-$* install-podman-remote-docs release.txt \
+ $(MAKE) podman-remote-$* install-podman-remote-$*-docs release.txt \
RELEASE_BASENAME=$(shell hack/get_release_info.sh REMOTENAME) \
RELEASE_DIST=$* RELEASE_DIST_VER="-"
$(eval TMPDIR := $(shell mktemp -d -p '' $podman_remote_XXXX))
@@ -361,13 +360,7 @@ podman-remote-v$(RELEASE_NUMBER)-%.zip:
# release.txt location and content depended upon by automated tooling
cp release.txt "$(TMPDIR)/"
cp ./bin/podman-remote-$*$(BINSFX) "$(TMPDIR)/$(SUBDIR)/podman$(BINSFX)"
- cp -r ./docs/remote "$(TMPDIR)/$(SUBDIR)/docs/"
- $(eval DOCFILE := $(TMPDIR)/$(SUBDIR)/docs/podman.1)
- cp docs/podman-remote.1 "$(DOCFILE)"
- sed -i 's/podman\\*-remote/podman/g' "$(DOCFILE)"
- sed -i 's/Podman\\*-remote/Podman\ for\ $*/g' "$(DOCFILE)"
- sed -i 's/podman\.conf/podman\-remote\.conf/g' "$(DOCFILE)"
- sed -i 's/A\ remote\ CLI\ for\ Podman\:\ //g' "$(DOCFILE)"
+ cp -r ./docs/build/remote/$* "$(TMPDIR)/$(SUBDIR)/docs/"
cd "$(TMPDIR)" && \
zip --recurse-paths "$(CURDIR)/$@" "./release.txt" "./"
-rm -rf "$(TMPDIR)"
@@ -412,7 +405,7 @@ install.man: docs
install ${SELINUXOPT} -d -m 755 $(DESTDIR)$(MANDIR)/man5
install ${SELINUXOPT} -m 644 $(filter %.1,$(MANPAGES_DEST)) -t $(DESTDIR)$(MANDIR)/man1
install ${SELINUXOPT} -m 644 $(filter %.5,$(MANPAGES_DEST)) -t $(DESTDIR)$(MANDIR)/man5
- install ${SELINUXOPT} -m 644 docs/links/*1 -t $(DESTDIR)$(MANDIR)/man1
+ install ${SELINUXOPT} -m 644 docs/source/markdown/links/*1 -t $(DESTDIR)$(MANDIR)/man1
install.config:
install ${SELINUXOPT} -d -m 755 $(DESTDIR)$(SHAREDIR_CONTAINERS)
diff --git a/docs/Readme.md b/docs/Readme.md
new file mode 100644
index 000000000..4514afa77
--- /dev/null
+++ b/docs/Readme.md
@@ -0,0 +1,21 @@
+# Build the Docs
+
+## Directory Structure
+
+| | Directory |
+| ------------------------------------ | --------------------------- |
+| Markdown source for man pages | docs/source/markdown/ |
+| man pages aliases as .so files | docs/source/markdown/links/ |
+| restructured text for readthedocs.io | docs/rst/ |
+| target for output | docs/build |
+| man pages | docs/build/man |
+| remote linux man pages | docs/build/remote/linux |
+| remote darwin man pages | docs/build/remote/darwin |
+| remote windows html pages | docs/build/remote/windows |
+
+## Support files
+
+| | |
+| ------------------------------------ | --------------------------- |
+| docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform |
+| docs/links-to-html.lua | pandoc filter to do aliases for html files | \ No newline at end of file
diff --git a/docs/podman-remote.sh b/docs/remote-docs.sh
index d8ce4a359..1440b0926 100755
--- a/docs/podman-remote.sh
+++ b/docs/remote-docs.sh
@@ -1,17 +1,17 @@
#!/bin/bash -e
# Assemble remote man pages for darwin or windows from markdown files
-PLATFORM=$1 ## windows or darwin
-TARGET=$2 ## where to output files
+PLATFORM=$1 ## linux, windows or darwin
+TARGET=${2} ## where to output files
SOURCES=${@:3} ## directories to find markdown files
PODMAN=${PODMAN:-bin/podman-remote} ## location overridden for testing
function usage() {
echo >&2 "$0 PLATFORM TARGET SOURCES..."
- echo >&2 "PLATFORM: Is either darwin or windows."
- echo >&2 "TARGET: Is the directory where files will be staged."
- echo >&2 "SOURCES: Are the directories to source markdown files."
+ echo >&2 "PLATFORM: Is either linux, darwin or windows."
+ echo >&2 "TARGET: Is the directory where files will be staged. eg, docs/build/remote/linux"
+ echo >&2 "SOURCES: Are the directories of source files. eg, docs/markdown"
}
function fail() {
@@ -21,19 +21,17 @@ function fail() {
}
case $PLATFORM in
-'darwin')
- EXT=1
- PUBLISHER=darwin_fn
+darwin|linux)
+ PUBLISHER=man_fn
;;
-'windows')
- EXT=1.md
- PUBLISHER=windows_fn
+windows)
+ PUBLISHER=html_fn
;;
-'-help')
+-help)
usage
exit 0
;;
-*) fail '"darwin" and "windows" are currently the only supported platforms.' ;;
+*) fail '"linux", "darwin" and "windows" are the only supported platforms.' ;;
esac
if [[ -z $TARGET ]]; then
@@ -48,19 +46,20 @@ if [[ ! -x $PODMAN ]]; then
fail "$PODMAN does not exist"
fi
-## darwin_fn copies the markdown page or link to flattened directory
-function darwin_fn() {
- local markdown=$1
- local file=$(basename $markdown)
- local dir=$(dirname $markdown)
- if [[ -f $dir/../../links/$file ]]; then
- markdown=$dir/../../links/$file
+## man_fn copies the man page or link to flattened directory
+function man_fn() {
+ local page=$1
+ local file=$(basename $page)
+ local dir=$(dirname $page)
+
+ if [[ ! -f $page ]]; then
+ page=$dir/links/${file%.*}.1
fi
- install $markdown $TARGET
+ install $page $TARGET/${file%%.*}.1
}
-## windows_fn converts the markdown page or link to HTML
-function windows_fn() {
+## html_fn converts the markdown page or link to HTML
+function html_fn() {
local markdown=$1
local file=$(basename $markdown)
local dir=$(dirname $markdown)
@@ -69,21 +68,26 @@ function windows_fn() {
local link=$(sed -e 's?.so man1/\(.*\)?\1?' <$dir/links/${file%.md})
markdown=$dir/$link.md
fi
- pandoc --ascii --lua-filter=$dir/links-to-html.lua -o $TARGET/${file%.$EXT}.html $markdown
+ pandoc --ascii --lua-filter=docs/links-to-html.lua -o $TARGET/${file%%.*}.html $markdown
}
## pub_pages finds and publishes the remote manual pages
function pub_pages() {
local source=$1
local publisher=$2
- for f in $(ls $source/podman-remote*$EXT); do
+ for f in $(ls $source/podman-remote*); do
$publisher $f
done
+ # rename podman-remote.ext to podman.ext and copy
+ local remote=$(echo $TARGET/podman-remote.*)
+ local ext=${remote##*.}
+ cp -f $remote $TARGET/podman.$ext
+
for c in "container" "image" "pod" "volume" ""; do
local cmd=${c:+-$c}
for s in $($PODMAN $c --help | sed -n '/^Available Commands:/,/^Flags:/p' | sed -e '1d;$d' -e '/^$/d' | awk '{print $1}'); do
- $publisher $source/podman$cmd-$s.$EXT
+ $publisher $(echo $source/podman$cmd-$s.*)
done
done
}
diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst
index bc34da60b..276a9c4fb 100644
--- a/docs/source/Commands.rst
+++ b/docs/source/Commands.rst
@@ -2,106 +2,106 @@ Commands
========
-:doc:`attach <man/podman-attach.1>` Attach to a running container
+:doc:`attach <markdown/podman-attach.1>` Attach to a running container
-:doc:`build <man/podman-build.1>` Build an image using instructions from Containerfiles
+:doc:`build <markdown/podman-build.1>` Build an image using instructions from Containerfiles
-:doc:`commit <man/podman-commit.1>` Create new image based on the changed container
+:doc:`commit <markdown/podman-commit.1>` Create new image based on the changed container
:doc:`containers <managecontainers>` Manage Containers
-:doc:`cp <man/podman-cp.1>` Copy files/folders between a container and the local filesystem
+:doc:`cp <markdown/podman-cp.1>` Copy files/folders between a container and the local filesystem
-:doc:`create <man/podman-create.1>` Create but do not start a container
+:doc:`create <markdown/podman-create.1>` Create but do not start a container
-:doc:`diff <man/podman-diff.1>` Inspect changes on container's file systems
+:doc:`diff <markdown/podman-diff.1>` Inspect changes on container's file systems
-:doc:`events <man/podman-events.1>` Show podman events
+:doc:`events <markdown/podman-events.1>` Show podman events
-:doc:`exec <man/podman-exec.1>` Run a process in a running container
+:doc:`exec <markdown/podman-exec.1>` Run a process in a running container
-:doc:`export <man/podman-export.1>` Export container's filesystem contents as a tar archive
+:doc:`export <markdown/podman-export.1>` Export container's filesystem contents as a tar archive
:doc:`generate <generate>` Generated structured data
:doc:`healthcheck <healthcheck>` Manage Healthcheck
-:doc:`history <man/podman-history.1>` Show history of a specified image
+:doc:`history <markdown/podman-history.1>` Show history of a specified image
:doc:`image <image>` Manage images
-:doc:`images <man/podman-images.1>` List images in local storage
+:doc:`images <markdown/podman-images.1>` List images in local storage
-:doc:`import <man/podman-import.1>` Import a tarball to create a filesystem image
+:doc:`import <markdown/podman-import.1>` Import a tarball to create a filesystem image
-:doc:`info <man/podman-info.1>` Display podman system information
+:doc:`info <markdown/podman-info.1>` Display podman system information
-:doc:`init <man/podman-init.1>` Initialize one or more containers
+:doc:`init <markdown/podman-init.1>` Initialize one or more containers
-:doc:`inspect <man/podman-inspect.1>` Display the configuration of a container or image
+:doc:`inspect <markdown/podman-inspect.1>` Display the configuration of a container or image
-:doc:`kill <man/podman-kill.1>` Kill one or more running containers with a specific signal
+:doc:`kill <markdown/podman-kill.1>` Kill one or more running containers with a specific signal
-:doc:`load <man/podman-load.1>` Load an image from container archive
+:doc:`load <markdown/podman-load.1>` Load an image from container archive
-:doc:`login <man/podman-login.1>` Login to a container registry
+:doc:`login <markdown/podman-login.1>` Login to a container registry
-:doc:`logout <man/podman-logout.1>` Logout of a container registry
+:doc:`logout <markdown/podman-logout.1>` Logout of a container registry
-:doc:`logs <man/podman-logs.1>` Fetch the logs of a container
+:doc:`logs <markdown/podman-logs.1>` Fetch the logs of a container
-:doc:`mount <man/podman-mount.1>` Mount a working container's root filesystem
+:doc:`mount <markdown/podman-mount.1>` Mount a working container's root filesystem
:doc:`network <network>` Manage Networks
-:doc:`pause <man/podman-pause.1>` Pause all the processes in one or more containers
+:doc:`pause <markdown/podman-pause.1>` Pause all the processes in one or more containers
:doc:`play <play>` Play a pod
:doc:`pod <pod>` Manage pods
-:doc:`port <man/podman-port.1>` List port mappings or a specific mapping for the container
+:doc:`port <markdown/podman-port.1>` List port mappings or a specific mapping for the container
-:doc:`ps <man/podman-ps.1>` List containers
+:doc:`ps <markdown/podman-ps.1>` List containers
-:doc:`pull <man/podman-pull.1>` Pull an image from a registry
+:doc:`pull <markdown/podman-pull.1>` Pull an image from a registry
-:doc:`push <man/podman-push.1>` Push an image to a specified destination
+:doc:`push <markdown/podman-push.1>` Push an image to a specified destination
-:doc:`restart <man/podman-restart.1>` Restart one or more containers
+:doc:`restart <markdown/podman-restart.1>` Restart one or more containers
-:doc:`rm <man/podman-rm.1>` Remove one or more containers
+:doc:`rm <markdown/podman-rm.1>` Remove one or more containers
-:doc:`rmi <man/podman-rmi.1>` Removes one or more images from local storage
+:doc:`rmi <markdown/podman-rmi.1>` Removes one or more images from local storage
-:doc:`run <man/podman-run.1>` Run a command in a new container
+:doc:`run <markdown/podman-run.1>` Run a command in a new container
-:doc:`save <man/podman-save.1>` Save image to an archive
+:doc:`save <markdown/podman-save.1>` Save image to an archive
-:doc:`search <man/podman-search.1>` Search registry for image
+:doc:`search <markdown/podman-search.1>` Search registry for image
-:doc:`start <man/podman-start.1>` Start one or more containers
+:doc:`start <markdown/podman-start.1>` Start one or more containers
-:doc:`stats <man/podman-stats.1>` Display a live stream of container resource usage statistics
+:doc:`stats <markdown/podman-stats.1>` Display a live stream of container resource usage statistics
-:doc:`stop <man/podman-stop.1>` Stop one or more containers
+:doc:`stop <markdown/podman-stop.1>` Stop one or more containers
:doc:`system <system>` Manage podman
-:doc:`tag <man/podman-tag.1>` Add an additional name to a local image
+:doc:`tag <markdown/podman-tag.1>` Add an additional name to a local image
-:doc:`top <man/podman-top.1>` Display the running processes of a container
+:doc:`top <markdown/podman-top.1>` Display the running processes of a container
-:doc:`umount <man/podman-umount.1>` Unmounts working container's root filesystem
+:doc:`umount <markdown/podman-umount.1>` Unmounts working container's root filesystem
-:doc:`unpause <man/podman-unpause.1>` Unpause the processes in one or more containers
+:doc:`unpause <markdown/podman-unpause.1>` Unpause the processes in one or more containers
-:doc:`unshare <man/podman-unshare.1>` Run a command in a modified user namespace
+:doc:`unshare <markdown/podman-unshare.1>` Run a command in a modified user namespace
-:doc:`varlink <man/podman-varlink.1>` Run varlink interface
+:doc:`varlink <markdown/podman-varlink.1>` Run varlink interface
-:doc:`version <man/podman-version.1>` Display the Podman Version Information
+:doc:`version <markdown/podman-version.1>` Display the Podman Version Information
:doc:`volume <volume>` Manage volumes
-:doc:`wait <man/podman-wait.1>` Block on one or more containers \ No newline at end of file
+:doc:`wait <markdown/podman-wait.1>` Block on one or more containers \ No newline at end of file
diff --git a/docs/source/generate.rst b/docs/source/generate.rst
index 79af69146..fd267ce62 100644
--- a/docs/source/generate.rst
+++ b/docs/source/generate.rst
@@ -1,6 +1,6 @@
Generate
========
-:doc:`kube <man/podman-generate-kube.1>` Generate Kubernetes pod YAML from a container or pod
+:doc:`kube <markdown/podman-generate-kube.1>` Generate Kubernetes pod YAML from a container or pod
-:doc:`systemd <man/podman-generate-systemd.1>` Generate a systemd unit file for a Podman container
+:doc:`systemd <markdown/podman-generate-systemd.1>` Generate a systemd unit file for a Podman container
diff --git a/docs/source/healthcheck.rst b/docs/source/healthcheck.rst
index dc10ceb62..2e2f88fbc 100644
--- a/docs/source/healthcheck.rst
+++ b/docs/source/healthcheck.rst
@@ -1,4 +1,4 @@
HealthCheck
===========
-:doc:`run <man/podman-healthcheck-run.1>` run the health check of a container
+:doc:`run <markdown/podman-healthcheck-run.1>` run the health check of a container
diff --git a/docs/source/image.rst b/docs/source/image.rst
index b28ad7613..a8c6171e1 100644
--- a/docs/source/image.rst
+++ b/docs/source/image.rst
@@ -2,34 +2,34 @@ Image
=====
-:doc:`build <man/podman-build.1>` Build an image using instructions from Containerfiles
+:doc:`build <markdown/podman-build.1>` Build an image using instructions from Containerfiles
-:doc:`exists <man/podman-image-exists.1>` Check if an image exists in local storage
+:doc:`exists <markdown/podman-image-exists.1>` Check if an image exists in local storage
-:doc:`history <man/podman-history.1>` Show history of a specified image
+:doc:`history <markdown/podman-history.1>` Show history of a specified image
-:doc:`import <man/podman-import.1>` Import a tarball to create a filesystem image
+:doc:`import <markdown/podman-import.1>` Import a tarball to create a filesystem image
-:doc:`inspect <man/podman-inspect.1>` Display the configuration of an image
+:doc:`inspect <markdown/podman-inspect.1>` Display the configuration of an image
-:doc:`list <man/podman-images.1>` List images in local storage
+:doc:`list <markdown/podman-images.1>` List images in local storage
-:doc:`load <man/podman-load.1>` Load an image from container archive
+:doc:`load <markdown/podman-load.1>` Load an image from container archive
-:doc:`prune <man/podman-image-prune.1>` Remove unused images
+:doc:`prune <markdown/podman-image-prune.1>` Remove unused images
-:doc:`pull <man/podman-pull.1>` Pull an image from a registry
+:doc:`pull <markdown/podman-pull.1>` Pull an image from a registry
-:doc:`push <man/podman-push.1>` Push an image to a specified destination
+:doc:`push <markdown/podman-push.1>` Push an image to a specified destination
-:doc:`rm <man/podman-rmi.1>` Removes one or more images from local storage
+:doc:`rm <markdown/podman-rmi.1>` Removes one or more images from local storage
-:doc:`save <man/podman-save.1>` Save image to an archive
+:doc:`save <markdown/podman-save.1>` Save image to an archive
-:doc:`sign <man/podman-image-sign.1>` Sign an image
+:doc:`sign <markdown/podman-image-sign.1>` Sign an image
-:doc:`tag <man/podman-tag.1>` Add an additional name to a local image
+:doc:`tag <markdown/podman-tag.1>` Add an additional name to a local image
-:doc:`tree <man/podman-image-tree.1>` Prints layer hierarchy of an image in a tree format
+:doc:`tree <markdown/podman-image-tree.1>` Prints layer hierarchy of an image in a tree format
-:doc:`trust <man/podman-image-trust.1>` Manage container image trust policy
+:doc:`trust <markdown/podman-image-trust.1>` Manage container image trust policy
diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst
index 0607f129d..5c5a83a82 100644
--- a/docs/source/managecontainers.rst
+++ b/docs/source/managecontainers.rst
@@ -1,64 +1,64 @@
Manage Containers
=================
-:doc:`attach <man/podman-attach.1>` Attach to a running container
+:doc:`attach <markdown/podman-attach.1>` Attach to a running container
-:doc:`checkpoint <man/podman-container-checkpoint.1>` Checkpoints one or more containers
+:doc:`checkpoint <markdown/podman-container-checkpoint.1>` Checkpoints one or more containers
-:doc:`cleanup <man/podman-container-cleanup.1>` Cleanup network and mountpoints of one or more containers
+:doc:`cleanup <markdown/podman-container-cleanup.1>` Cleanup network and mountpoints of one or more containers
-:doc:`commit <man/podman-commit.1>` Create new image based on the changed container
+:doc:`commit <markdown/podman-commit.1>` Create new image based on the changed container
-:doc:`cp <man/podman-cp.1>` Copy files/folders between a container and the local filesystem
+:doc:`cp <markdown/podman-cp.1>` Copy files/folders between a container and the local filesystem
-:doc:`create <man/podman-create.1>` Create but do not start a container
+:doc:`create <markdown/podman-create.1>` Create but do not start a container
-:doc:`diff <man/podman-diff.1>` Inspect changes on container's file systems
+:doc:`diff <markdown/podman-diff.1>` Inspect changes on container's file systems
-:doc:`exec <man/podman-exec.1>` Run a process in a running container
+:doc:`exec <markdown/podman-exec.1>` Run a process in a running container
-:doc:`exists <man/podman-container-exists.1>` Check if a container exists in local storage
+:doc:`exists <markdown/podman-container-exists.1>` Check if a container exists in local storage
-:doc:`export <man/podman-export.1>` Export container's filesystem contents as a tar archive
+:doc:`export <markdown/podman-export.1>` Export container's filesystem contents as a tar archive
-:doc:`init <man/podman-init.1>` Initialize one or more containers
+:doc:`init <markdown/podman-init.1>` Initialize one or more containers
-:doc:`inspect <man/podman-inspect.1>` Display the configuration of a container or image
+:doc:`inspect <markdown/podman-inspect.1>` Display the configuration of a container or image
-:doc:`kill <man/podman-kill.1>` Kill one or more running containers with a specific signal
+:doc:`kill <markdown/podman-kill.1>` Kill one or more running containers with a specific signal
-:doc:`list <man/podman-ps.1>` List containers
+:doc:`list <markdown/podman-ps.1>` List containers
-:doc:`logs <man/podman-logs.1>` Fetch the logs of a container
+:doc:`logs <markdown/podman-logs.1>` Fetch the logs of a container
-:doc:`mount <man/podman-mount.1>` Mount a working container's root filesystem
+:doc:`mount <markdown/podman-mount.1>` Mount a working container's root filesystem
-:doc:`pause <man/podman-pause.1>` Pause all the processes in one or more containers
+:doc:`pause <markdown/podman-pause.1>` Pause all the processes in one or more containers
-:doc:`port <man/podman-port.1>` List port mappings or a specific mapping for the container
+:doc:`port <markdown/podman-port.1>` List port mappings or a specific mapping for the container
-:doc:`restart <man/podman-restart.1>` Restart one or more containers
+:doc:`restart <markdown/podman-restart.1>` Restart one or more containers
-:doc:`prune <man/podman-container-prune.1>` Remove all stopped containers
+:doc:`prune <markdown/podman-container-prune.1>` Remove all stopped containers
-:doc:`restore <man/podman-container-restore.1>` Restores one or more containers from a checkpoint
+:doc:`restore <markdown/podman-container-restore.1>` Restores one or more containers from a checkpoint
-:doc:`rm <man/podman-rm.1>` Remove one or more containers
+:doc:`rm <markdown/podman-rm.1>` Remove one or more containers
-:doc:`run <man/podman-run.1>` Run a command in a new container
+:doc:`run <markdown/podman-run.1>` Run a command in a new container
-:doc:`runlabel <man/podman-container-runlabel.1>` Execute the command described by an image label
+:doc:`runlabel <markdown/podman-container-runlabel.1>` Execute the command described by an image label
-:doc:`start <man/podman-start.1>` Start one or more containers
+:doc:`start <markdown/podman-start.1>` Start one or more containers
-:doc:`stats <man/podman-stats.1>` Display a live stream of container resource usage statistics
+:doc:`stats <markdown/podman-stats.1>` Display a live stream of container resource usage statistics
-:doc:`stop <man/podman-stop.1>` Stop one or more containers
+:doc:`stop <markdown/podman-stop.1>` Stop one or more containers
-:doc:`top <man/podman-top.1>` Display the running processes of a container
+:doc:`top <markdown/podman-top.1>` Display the running processes of a container
-:doc:`umount <man/podman-umount.1>` Unmounts working container's root filesystem
+:doc:`umount <markdown/podman-umount.1>` Unmounts working container's root filesystem
-:doc:`unpause <man/podman-unpause.1>` Unpause the processes in one or more containers
+:doc:`unpause <markdown/podman-unpause.1>` Unpause the processes in one or more containers
-:doc:`wait <man/podman-wait.1>` Block on one or more containers
+:doc:`wait <markdown/podman-wait.1>` Block on one or more containers
diff --git a/docs/links/podman-container-attach.1 b/docs/source/markdown/links/podman-container-attach.1
index be3b5efd3..be3b5efd3 100644
--- a/docs/links/podman-container-attach.1
+++ b/docs/source/markdown/links/podman-container-attach.1
diff --git a/docs/links/podman-container-commit.1 b/docs/source/markdown/links/podman-container-commit.1
index cdff06766..cdff06766 100644
--- a/docs/links/podman-container-commit.1
+++ b/docs/source/markdown/links/podman-container-commit.1
diff --git a/docs/links/podman-container-cp.1 b/docs/source/markdown/links/podman-container-cp.1
index 6ad859c84..6ad859c84 100644
--- a/docs/links/podman-container-cp.1
+++ b/docs/source/markdown/links/podman-container-cp.1
diff --git a/docs/links/podman-container-create.1 b/docs/source/markdown/links/podman-container-create.1
index f6b07d946..f6b07d946 100644
--- a/docs/links/podman-container-create.1
+++ b/docs/source/markdown/links/podman-container-create.1
diff --git a/docs/links/podman-container-diff.1 b/docs/source/markdown/links/podman-container-diff.1
index ac4881f98..ac4881f98 100644
--- a/docs/links/podman-container-diff.1
+++ b/docs/source/markdown/links/podman-container-diff.1
diff --git a/docs/links/podman-container-exec.1 b/docs/source/markdown/links/podman-container-exec.1
index 6bb98ec75..6bb98ec75 100644
--- a/docs/links/podman-container-exec.1
+++ b/docs/source/markdown/links/podman-container-exec.1
diff --git a/docs/links/podman-container-export.1 b/docs/source/markdown/links/podman-container-export.1
index 85b1d5438..85b1d5438 100644
--- a/docs/links/podman-container-export.1
+++ b/docs/source/markdown/links/podman-container-export.1
diff --git a/docs/links/podman-container-init.1 b/docs/source/markdown/links/podman-container-init.1
index 3a8bee249..3a8bee249 100644
--- a/docs/links/podman-container-init.1
+++ b/docs/source/markdown/links/podman-container-init.1
diff --git a/docs/links/podman-container-inspect.1 b/docs/source/markdown/links/podman-container-inspect.1
index 261043845..261043845 100644
--- a/docs/links/podman-container-inspect.1
+++ b/docs/source/markdown/links/podman-container-inspect.1
diff --git a/docs/links/podman-container-kill.1 b/docs/source/markdown/links/podman-container-kill.1
index 71960113d..71960113d 100644
--- a/docs/links/podman-container-kill.1
+++ b/docs/source/markdown/links/podman-container-kill.1
diff --git a/docs/links/podman-container-list.1 b/docs/source/markdown/links/podman-container-list.1
index f7f44c704..f7f44c704 100644
--- a/docs/links/podman-container-list.1
+++ b/docs/source/markdown/links/podman-container-list.1
diff --git a/docs/links/podman-container-logs.1 b/docs/source/markdown/links/podman-container-logs.1
index 7e0ce6307..7e0ce6307 100644
--- a/docs/links/podman-container-logs.1
+++ b/docs/source/markdown/links/podman-container-logs.1
diff --git a/docs/links/podman-container-ls.1 b/docs/source/markdown/links/podman-container-ls.1
index f7f44c704..f7f44c704 100644
--- a/docs/links/podman-container-ls.1
+++ b/docs/source/markdown/links/podman-container-ls.1
diff --git a/docs/links/podman-container-mount.1 b/docs/source/markdown/links/podman-container-mount.1
index b14e594a4..b14e594a4 100644
--- a/docs/links/podman-container-mount.1
+++ b/docs/source/markdown/links/podman-container-mount.1
diff --git a/docs/links/podman-container-pause.1 b/docs/source/markdown/links/podman-container-pause.1
index 3ed8d7cef..3ed8d7cef 100644
--- a/docs/links/podman-container-pause.1
+++ b/docs/source/markdown/links/podman-container-pause.1
diff --git a/docs/links/podman-container-port.1 b/docs/source/markdown/links/podman-container-port.1
index adfeda201..adfeda201 100644
--- a/docs/links/podman-container-port.1
+++ b/docs/source/markdown/links/podman-container-port.1
diff --git a/docs/links/podman-container-ps.1 b/docs/source/markdown/links/podman-container-ps.1
index f7f44c704..f7f44c704 100644
--- a/docs/links/podman-container-ps.1
+++ b/docs/source/markdown/links/podman-container-ps.1
diff --git a/docs/links/podman-container-restart.1 b/docs/source/markdown/links/podman-container-restart.1
index 9fb09ae50..9fb09ae50 100644
--- a/docs/links/podman-container-restart.1
+++ b/docs/source/markdown/links/podman-container-restart.1
diff --git a/docs/links/podman-container-rm.1 b/docs/source/markdown/links/podman-container-rm.1
index 6dfc6e98c..6dfc6e98c 100644
--- a/docs/links/podman-container-rm.1
+++ b/docs/source/markdown/links/podman-container-rm.1
diff --git a/docs/links/podman-container-run.1 b/docs/source/markdown/links/podman-container-run.1
index 6c70caa37..6c70caa37 100644
--- a/docs/links/podman-container-run.1
+++ b/docs/source/markdown/links/podman-container-run.1
diff --git a/docs/links/podman-container-start.1 b/docs/source/markdown/links/podman-container-start.1
index aa042cbfe..aa042cbfe 100644
--- a/docs/links/podman-container-start.1
+++ b/docs/source/markdown/links/podman-container-start.1
diff --git a/docs/links/podman-container-stats.1 b/docs/source/markdown/links/podman-container-stats.1
index 5f2e2e7d6..5f2e2e7d6 100644
--- a/docs/links/podman-container-stats.1
+++ b/docs/source/markdown/links/podman-container-stats.1
diff --git a/docs/links/podman-container-stop.1 b/docs/source/markdown/links/podman-container-stop.1
index 6b7e87c69..6b7e87c69 100644
--- a/docs/links/podman-container-stop.1
+++ b/docs/source/markdown/links/podman-container-stop.1
diff --git a/docs/links/podman-container-top.1 b/docs/source/markdown/links/podman-container-top.1
index ddcf7b5ec..ddcf7b5ec 100644
--- a/docs/links/podman-container-top.1
+++ b/docs/source/markdown/links/podman-container-top.1
diff --git a/docs/links/podman-container-umount.1 b/docs/source/markdown/links/podman-container-umount.1
index 789dabbb0..789dabbb0 100644
--- a/docs/links/podman-container-umount.1
+++ b/docs/source/markdown/links/podman-container-umount.1
diff --git a/docs/links/podman-container-unmount.1 b/docs/source/markdown/links/podman-container-unmount.1
index 789dabbb0..789dabbb0 100644
--- a/docs/links/podman-container-unmount.1
+++ b/docs/source/markdown/links/podman-container-unmount.1
diff --git a/docs/links/podman-container-unpause.1 b/docs/source/markdown/links/podman-container-unpause.1
index b8d970744..b8d970744 100644
--- a/docs/links/podman-container-unpause.1
+++ b/docs/source/markdown/links/podman-container-unpause.1
diff --git a/docs/links/podman-container-wait.1 b/docs/source/markdown/links/podman-container-wait.1
index bd2505dde..bd2505dde 100644
--- a/docs/links/podman-container-wait.1
+++ b/docs/source/markdown/links/podman-container-wait.1
diff --git a/docs/links/podman-help.1 b/docs/source/markdown/links/podman-help.1
index 6b7954b0d..6b7954b0d 100644
--- a/docs/links/podman-help.1
+++ b/docs/source/markdown/links/podman-help.1
diff --git a/docs/links/podman-image-build.1 b/docs/source/markdown/links/podman-image-build.1
index 27c751cf6..27c751cf6 100644
--- a/docs/links/podman-image-build.1
+++ b/docs/source/markdown/links/podman-image-build.1
diff --git a/docs/links/podman-image-history.1 b/docs/source/markdown/links/podman-image-history.1
index 6b6dc17e1..6b6dc17e1 100644
--- a/docs/links/podman-image-history.1
+++ b/docs/source/markdown/links/podman-image-history.1
diff --git a/docs/links/podman-image-import.1 b/docs/source/markdown/links/podman-image-import.1
index 4564fc6c9..4564fc6c9 100644
--- a/docs/links/podman-image-import.1
+++ b/docs/source/markdown/links/podman-image-import.1
diff --git a/docs/links/podman-image-inspect.1 b/docs/source/markdown/links/podman-image-inspect.1
index 261043845..261043845 100644
--- a/docs/links/podman-image-inspect.1
+++ b/docs/source/markdown/links/podman-image-inspect.1
diff --git a/docs/links/podman-image-list.1 b/docs/source/markdown/links/podman-image-list.1
index 17d6ca880..17d6ca880 100644
--- a/docs/links/podman-image-list.1
+++ b/docs/source/markdown/links/podman-image-list.1
diff --git a/docs/links/podman-image-load.1 b/docs/source/markdown/links/podman-image-load.1
index 21b6d8e9c..21b6d8e9c 100644
--- a/docs/links/podman-image-load.1
+++ b/docs/source/markdown/links/podman-image-load.1
diff --git a/docs/links/podman-image-ls.1 b/docs/source/markdown/links/podman-image-ls.1
index 17d6ca880..17d6ca880 100644
--- a/docs/links/podman-image-ls.1
+++ b/docs/source/markdown/links/podman-image-ls.1
diff --git a/docs/links/podman-image-pull.1 b/docs/source/markdown/links/podman-image-pull.1
index d14519be3..d14519be3 100644
--- a/docs/links/podman-image-pull.1
+++ b/docs/source/markdown/links/podman-image-pull.1
diff --git a/docs/links/podman-image-push.1 b/docs/source/markdown/links/podman-image-push.1
index 51d52ad11..51d52ad11 100644
--- a/docs/links/podman-image-push.1
+++ b/docs/source/markdown/links/podman-image-push.1
diff --git a/docs/links/podman-image-rm.1 b/docs/source/markdown/links/podman-image-rm.1
index 1007ad150..1007ad150 100644
--- a/docs/links/podman-image-rm.1
+++ b/docs/source/markdown/links/podman-image-rm.1
diff --git a/docs/links/podman-image-save.1 b/docs/source/markdown/links/podman-image-save.1
index 715d7d6ee..715d7d6ee 100644
--- a/docs/links/podman-image-save.1
+++ b/docs/source/markdown/links/podman-image-save.1
diff --git a/docs/links/podman-image-tag.1 b/docs/source/markdown/links/podman-image-tag.1
index e41c50de9..e41c50de9 100644
--- a/docs/links/podman-image-tag.1
+++ b/docs/source/markdown/links/podman-image-tag.1
diff --git a/docs/links/podman-list.1 b/docs/source/markdown/links/podman-list.1
index f7f44c704..f7f44c704 100644
--- a/docs/links/podman-list.1
+++ b/docs/source/markdown/links/podman-list.1
diff --git a/docs/links/podman-ls.1 b/docs/source/markdown/links/podman-ls.1
index f7f44c704..f7f44c704 100644
--- a/docs/links/podman-ls.1
+++ b/docs/source/markdown/links/podman-ls.1
diff --git a/docs/links/podman-system-info.1 b/docs/source/markdown/links/podman-system-info.1
index 809a71b8b..809a71b8b 100644
--- a/docs/links/podman-system-info.1
+++ b/docs/source/markdown/links/podman-system-info.1
diff --git a/docs/links/podman-unmount.1 b/docs/source/markdown/links/podman-unmount.1
index 789dabbb0..789dabbb0 100644
--- a/docs/links/podman-unmount.1
+++ b/docs/source/markdown/links/podman-unmount.1
diff --git a/docs/source/man/podman-attach.1.md b/docs/source/markdown/podman-attach.1.md
index cef01f0f6..cef01f0f6 100644
--- a/docs/source/man/podman-attach.1.md
+++ b/docs/source/markdown/podman-attach.1.md
diff --git a/docs/source/man/podman-build.1.md b/docs/source/markdown/podman-build.1.md
index 567d0ead3..567d0ead3 100644
--- a/docs/source/man/podman-build.1.md
+++ b/docs/source/markdown/podman-build.1.md
diff --git a/docs/source/man/podman-commit.1.md b/docs/source/markdown/podman-commit.1.md
index 07a885ae2..07a885ae2 100644
--- a/docs/source/man/podman-commit.1.md
+++ b/docs/source/markdown/podman-commit.1.md
diff --git a/docs/source/man/podman-container-checkpoint.1.md b/docs/source/markdown/podman-container-checkpoint.1.md
index 034d338bb..034d338bb 100644
--- a/docs/source/man/podman-container-checkpoint.1.md
+++ b/docs/source/markdown/podman-container-checkpoint.1.md
diff --git a/docs/source/man/podman-container-cleanup.1.md b/docs/source/markdown/podman-container-cleanup.1.md
index 69e21ce9f..69e21ce9f 100644
--- a/docs/source/man/podman-container-cleanup.1.md
+++ b/docs/source/markdown/podman-container-cleanup.1.md
diff --git a/docs/source/man/podman-container-exists.1.md b/docs/source/markdown/podman-container-exists.1.md
index 4d988132b..4d988132b 100644
--- a/docs/source/man/podman-container-exists.1.md
+++ b/docs/source/markdown/podman-container-exists.1.md
diff --git a/docs/source/man/podman-container-prune.1.md b/docs/source/markdown/podman-container-prune.1.md
index d8a4b7f4e..d8a4b7f4e 100644
--- a/docs/source/man/podman-container-prune.1.md
+++ b/docs/source/markdown/podman-container-prune.1.md
diff --git a/docs/source/man/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md
index 1d2cf0b3e..1d2cf0b3e 100644
--- a/docs/source/man/podman-container-restore.1.md
+++ b/docs/source/markdown/podman-container-restore.1.md
diff --git a/docs/source/man/podman-container-runlabel.1.md b/docs/source/markdown/podman-container-runlabel.1.md
index 8511dd5cd..8511dd5cd 100644
--- a/docs/source/man/podman-container-runlabel.1.md
+++ b/docs/source/markdown/podman-container-runlabel.1.md
diff --git a/docs/source/man/podman-container.1.md b/docs/source/markdown/podman-container.1.md
index 4ea7c7acc..4ea7c7acc 100644
--- a/docs/source/man/podman-container.1.md
+++ b/docs/source/markdown/podman-container.1.md
diff --git a/docs/source/man/podman-cp.1.md b/docs/source/markdown/podman-cp.1.md
index 0f54b2e8b..0f54b2e8b 100644
--- a/docs/source/man/podman-cp.1.md
+++ b/docs/source/markdown/podman-cp.1.md
diff --git a/docs/source/man/podman-create.1.md b/docs/source/markdown/podman-create.1.md
index 6617850fd..6617850fd 100644
--- a/docs/source/man/podman-create.1.md
+++ b/docs/source/markdown/podman-create.1.md
diff --git a/docs/source/man/podman-diff.1.md b/docs/source/markdown/podman-diff.1.md
index 5b0434a07..5b0434a07 100644
--- a/docs/source/man/podman-diff.1.md
+++ b/docs/source/markdown/podman-diff.1.md
diff --git a/docs/source/man/podman-events.1.md b/docs/source/markdown/podman-events.1.md
index bb1923574..bb1923574 100644
--- a/docs/source/man/podman-events.1.md
+++ b/docs/source/markdown/podman-events.1.md
diff --git a/docs/source/man/podman-exec.1.md b/docs/source/markdown/podman-exec.1.md
index 4c17c056a..4c17c056a 100644
--- a/docs/source/man/podman-exec.1.md
+++ b/docs/source/markdown/podman-exec.1.md
diff --git a/docs/source/man/podman-export.1.md b/docs/source/markdown/podman-export.1.md
index 4286d0e2f..4286d0e2f 100644
--- a/docs/source/man/podman-export.1.md
+++ b/docs/source/markdown/podman-export.1.md
diff --git a/docs/source/man/podman-generate-kube.1.md b/docs/source/markdown/podman-generate-kube.1.md
index f4b4cd482..f4b4cd482 100644
--- a/docs/source/man/podman-generate-kube.1.md
+++ b/docs/source/markdown/podman-generate-kube.1.md
diff --git a/docs/source/man/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md
index b81e68a46..b81e68a46 100644
--- a/docs/source/man/podman-generate-systemd.1.md
+++ b/docs/source/markdown/podman-generate-systemd.1.md
diff --git a/docs/source/man/podman-generate.1.md b/docs/source/markdown/podman-generate.1.md
index 50050f2c1..50050f2c1 100644
--- a/docs/source/man/podman-generate.1.md
+++ b/docs/source/markdown/podman-generate.1.md
diff --git a/docs/source/man/podman-healthcheck-run.1.md b/docs/source/markdown/podman-healthcheck-run.1.md
index 21f2d9b20..21f2d9b20 100644
--- a/docs/source/man/podman-healthcheck-run.1.md
+++ b/docs/source/markdown/podman-healthcheck-run.1.md
diff --git a/docs/source/man/podman-healthcheck.1.md b/docs/source/markdown/podman-healthcheck.1.md
index 91c3e4345..91c3e4345 100644
--- a/docs/source/man/podman-healthcheck.1.md
+++ b/docs/source/markdown/podman-healthcheck.1.md
diff --git a/docs/source/man/podman-history.1.md b/docs/source/markdown/podman-history.1.md
index a67cb0286..a67cb0286 100644
--- a/docs/source/man/podman-history.1.md
+++ b/docs/source/markdown/podman-history.1.md
diff --git a/docs/source/man/podman-image-exists.1.md b/docs/source/markdown/podman-image-exists.1.md
index f6a89e2aa..f6a89e2aa 100644
--- a/docs/source/man/podman-image-exists.1.md
+++ b/docs/source/markdown/podman-image-exists.1.md
diff --git a/docs/source/man/podman-image-prune.1.md b/docs/source/markdown/podman-image-prune.1.md
index b844a9f63..b844a9f63 100644
--- a/docs/source/man/podman-image-prune.1.md
+++ b/docs/source/markdown/podman-image-prune.1.md
diff --git a/docs/source/man/podman-image-sign.1.md b/docs/source/markdown/podman-image-sign.1.md
index 62845e715..62845e715 100644
--- a/docs/source/man/podman-image-sign.1.md
+++ b/docs/source/markdown/podman-image-sign.1.md
diff --git a/docs/source/man/podman-image-tree.1.md b/docs/source/markdown/podman-image-tree.1.md
index c4624e05c..c4624e05c 100644
--- a/docs/source/man/podman-image-tree.1.md
+++ b/docs/source/markdown/podman-image-tree.1.md
diff --git a/docs/source/man/podman-image-trust.1.md b/docs/source/markdown/podman-image-trust.1.md
index 3fe4f7f52..3fe4f7f52 100644
--- a/docs/source/man/podman-image-trust.1.md
+++ b/docs/source/markdown/podman-image-trust.1.md
diff --git a/docs/source/man/podman-image.1.md b/docs/source/markdown/podman-image.1.md
index 339a531dd..339a531dd 100644
--- a/docs/source/man/podman-image.1.md
+++ b/docs/source/markdown/podman-image.1.md
diff --git a/docs/source/man/podman-images.1.md b/docs/source/markdown/podman-images.1.md
index 3ac07fc43..3ac07fc43 100644
--- a/docs/source/man/podman-images.1.md
+++ b/docs/source/markdown/podman-images.1.md
diff --git a/docs/source/man/podman-import.1.md b/docs/source/markdown/podman-import.1.md
index 946b680dd..946b680dd 100644
--- a/docs/source/man/podman-import.1.md
+++ b/docs/source/markdown/podman-import.1.md
diff --git a/docs/source/man/podman-info.1.md b/docs/source/markdown/podman-info.1.md
index 9721755ef..9721755ef 100644
--- a/docs/source/man/podman-info.1.md
+++ b/docs/source/markdown/podman-info.1.md
diff --git a/docs/source/man/podman-init.1.md b/docs/source/markdown/podman-init.1.md
index 3b49cfb99..3b49cfb99 100644
--- a/docs/source/man/podman-init.1.md
+++ b/docs/source/markdown/podman-init.1.md
diff --git a/docs/source/man/podman-inspect.1.md b/docs/source/markdown/podman-inspect.1.md
index f1630c713..f1630c713 100644
--- a/docs/source/man/podman-inspect.1.md
+++ b/docs/source/markdown/podman-inspect.1.md
diff --git a/docs/source/man/podman-kill.1.md b/docs/source/markdown/podman-kill.1.md
index 617d25b85..617d25b85 100644
--- a/docs/source/man/podman-kill.1.md
+++ b/docs/source/markdown/podman-kill.1.md
diff --git a/docs/source/man/podman-load.1.md b/docs/source/markdown/podman-load.1.md
index deb4fb5ec..deb4fb5ec 100644
--- a/docs/source/man/podman-load.1.md
+++ b/docs/source/markdown/podman-load.1.md
diff --git a/docs/source/man/podman-login.1.md b/docs/source/markdown/podman-login.1.md
index 9d368e9f2..9d368e9f2 100644
--- a/docs/source/man/podman-login.1.md
+++ b/docs/source/markdown/podman-login.1.md
diff --git a/docs/source/man/podman-logout.1.md b/docs/source/markdown/podman-logout.1.md
index 01dc52ecd..01dc52ecd 100644
--- a/docs/source/man/podman-logout.1.md
+++ b/docs/source/markdown/podman-logout.1.md
diff --git a/docs/source/man/podman-logs.1.md b/docs/source/markdown/podman-logs.1.md
index 405f180d9..405f180d9 100644
--- a/docs/source/man/podman-logs.1.md
+++ b/docs/source/markdown/podman-logs.1.md
diff --git a/docs/source/man/podman-mount.1.md b/docs/source/markdown/podman-mount.1.md
index 8f4deeca6..8f4deeca6 100644
--- a/docs/source/man/podman-mount.1.md
+++ b/docs/source/markdown/podman-mount.1.md
diff --git a/docs/source/man/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md
index c281d50d9..c281d50d9 100644
--- a/docs/source/man/podman-network-create.1.md
+++ b/docs/source/markdown/podman-network-create.1.md
diff --git a/docs/source/man/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md
index dfa7e4b0c..dfa7e4b0c 100644
--- a/docs/source/man/podman-network-inspect.1.md
+++ b/docs/source/markdown/podman-network-inspect.1.md
diff --git a/docs/source/man/podman-network-ls.1.md b/docs/source/markdown/podman-network-ls.1.md
index 46e424593..46e424593 100644
--- a/docs/source/man/podman-network-ls.1.md
+++ b/docs/source/markdown/podman-network-ls.1.md
diff --git a/docs/source/man/podman-network-rm.1.md b/docs/source/markdown/podman-network-rm.1.md
index c71f0d8fd..c71f0d8fd 100644
--- a/docs/source/man/podman-network-rm.1.md
+++ b/docs/source/markdown/podman-network-rm.1.md
diff --git a/docs/source/man/podman-network.1.md b/docs/source/markdown/podman-network.1.md
index f05b2b78f..f05b2b78f 100644
--- a/docs/source/man/podman-network.1.md
+++ b/docs/source/markdown/podman-network.1.md
diff --git a/docs/source/man/podman-pause.1.md b/docs/source/markdown/podman-pause.1.md
index dfd4da416..dfd4da416 100644
--- a/docs/source/man/podman-pause.1.md
+++ b/docs/source/markdown/podman-pause.1.md
diff --git a/docs/source/man/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md
index 2ac860a32..2ac860a32 100644
--- a/docs/source/man/podman-play-kube.1.md
+++ b/docs/source/markdown/podman-play-kube.1.md
diff --git a/docs/source/man/podman-play.1.md b/docs/source/markdown/podman-play.1.md
index 364baad60..364baad60 100644
--- a/docs/source/man/podman-play.1.md
+++ b/docs/source/markdown/podman-play.1.md
diff --git a/docs/source/man/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md
index cd1de6401..cd1de6401 100644
--- a/docs/source/man/podman-pod-create.1.md
+++ b/docs/source/markdown/podman-pod-create.1.md
diff --git a/docs/source/man/podman-pod-exists.1.md b/docs/source/markdown/podman-pod-exists.1.md
index cf2852934..cf2852934 100644
--- a/docs/source/man/podman-pod-exists.1.md
+++ b/docs/source/markdown/podman-pod-exists.1.md
diff --git a/docs/source/man/podman-pod-inspect.1.md b/docs/source/markdown/podman-pod-inspect.1.md
index 831d28259..831d28259 100644
--- a/docs/source/man/podman-pod-inspect.1.md
+++ b/docs/source/markdown/podman-pod-inspect.1.md
diff --git a/docs/source/man/podman-pod-kill.1.md b/docs/source/markdown/podman-pod-kill.1.md
index 596e15cea..596e15cea 100644
--- a/docs/source/man/podman-pod-kill.1.md
+++ b/docs/source/markdown/podman-pod-kill.1.md
diff --git a/docs/source/man/podman-pod-pause.1.md b/docs/source/markdown/podman-pod-pause.1.md
index 9533ed4a1..9533ed4a1 100644
--- a/docs/source/man/podman-pod-pause.1.md
+++ b/docs/source/markdown/podman-pod-pause.1.md
diff --git a/docs/source/man/podman-pod-prune.1.md b/docs/source/markdown/podman-pod-prune.1.md
index f79961b2f..f79961b2f 100644
--- a/docs/source/man/podman-pod-prune.1.md
+++ b/docs/source/markdown/podman-pod-prune.1.md
diff --git a/docs/source/man/podman-pod-ps.1.md b/docs/source/markdown/podman-pod-ps.1.md
index 65a7072ab..65a7072ab 100644
--- a/docs/source/man/podman-pod-ps.1.md
+++ b/docs/source/markdown/podman-pod-ps.1.md
diff --git a/docs/source/man/podman-pod-restart.1.md b/docs/source/markdown/podman-pod-restart.1.md
index 57f479102..57f479102 100644
--- a/docs/source/man/podman-pod-restart.1.md
+++ b/docs/source/markdown/podman-pod-restart.1.md
diff --git a/docs/source/man/podman-pod-rm.1.md b/docs/source/markdown/podman-pod-rm.1.md
index 6659534b4..6659534b4 100644
--- a/docs/source/man/podman-pod-rm.1.md
+++ b/docs/source/markdown/podman-pod-rm.1.md
diff --git a/docs/source/man/podman-pod-start.1.md b/docs/source/markdown/podman-pod-start.1.md
index 29960d6aa..29960d6aa 100644
--- a/docs/source/man/podman-pod-start.1.md
+++ b/docs/source/markdown/podman-pod-start.1.md
diff --git a/docs/source/man/podman-pod-stats.1.md b/docs/source/markdown/podman-pod-stats.1.md
index 962edbda0..962edbda0 100644
--- a/docs/source/man/podman-pod-stats.1.md
+++ b/docs/source/markdown/podman-pod-stats.1.md
diff --git a/docs/source/man/podman-pod-stop.1.md b/docs/source/markdown/podman-pod-stop.1.md
index b3ce47d72..b3ce47d72 100644
--- a/docs/source/man/podman-pod-stop.1.md
+++ b/docs/source/markdown/podman-pod-stop.1.md
diff --git a/docs/source/man/podman-pod-top.1.md b/docs/source/markdown/podman-pod-top.1.md
index 48f10055a..48f10055a 100644
--- a/docs/source/man/podman-pod-top.1.md
+++ b/docs/source/markdown/podman-pod-top.1.md
diff --git a/docs/source/man/podman-pod-unpause.1.md b/docs/source/markdown/podman-pod-unpause.1.md
index e0a88c2e3..e0a88c2e3 100644
--- a/docs/source/man/podman-pod-unpause.1.md
+++ b/docs/source/markdown/podman-pod-unpause.1.md
diff --git a/docs/source/man/podman-pod.1.md b/docs/source/markdown/podman-pod.1.md
index b3d002a06..b3d002a06 100644
--- a/docs/source/man/podman-pod.1.md
+++ b/docs/source/markdown/podman-pod.1.md
diff --git a/docs/source/man/podman-port.1.md b/docs/source/markdown/podman-port.1.md
index c9833f447..c9833f447 100644
--- a/docs/source/man/podman-port.1.md
+++ b/docs/source/markdown/podman-port.1.md
diff --git a/docs/source/man/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md
index 298de0b2b..298de0b2b 100644
--- a/docs/source/man/podman-ps.1.md
+++ b/docs/source/markdown/podman-ps.1.md
diff --git a/docs/source/man/podman-pull.1.md b/docs/source/markdown/podman-pull.1.md
index de9688f5e..de9688f5e 100644
--- a/docs/source/man/podman-pull.1.md
+++ b/docs/source/markdown/podman-pull.1.md
diff --git a/docs/source/man/podman-push.1.md b/docs/source/markdown/podman-push.1.md
index 3f0350bcd..3f0350bcd 100644
--- a/docs/source/man/podman-push.1.md
+++ b/docs/source/markdown/podman-push.1.md
diff --git a/docs/source/man/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md
index 04010abaf..04010abaf 100644
--- a/docs/source/man/podman-remote.1.md
+++ b/docs/source/markdown/podman-remote.1.md
diff --git a/docs/source/man/podman-restart.1.md b/docs/source/markdown/podman-restart.1.md
index 08fa29244..08fa29244 100644
--- a/docs/source/man/podman-restart.1.md
+++ b/docs/source/markdown/podman-restart.1.md
diff --git a/docs/source/man/podman-rm.1.md b/docs/source/markdown/podman-rm.1.md
index 207d9d61d..207d9d61d 100644
--- a/docs/source/man/podman-rm.1.md
+++ b/docs/source/markdown/podman-rm.1.md
diff --git a/docs/source/man/podman-rmi.1.md b/docs/source/markdown/podman-rmi.1.md
index d911ee6cb..d911ee6cb 100644
--- a/docs/source/man/podman-rmi.1.md
+++ b/docs/source/markdown/podman-rmi.1.md
diff --git a/docs/source/man/podman-run.1.md b/docs/source/markdown/podman-run.1.md
index d6d8f4c1e..d6d8f4c1e 100644
--- a/docs/source/man/podman-run.1.md
+++ b/docs/source/markdown/podman-run.1.md
diff --git a/docs/source/man/podman-save.1.md b/docs/source/markdown/podman-save.1.md
index b2b0995d3..b2b0995d3 100644
--- a/docs/source/man/podman-save.1.md
+++ b/docs/source/markdown/podman-save.1.md
diff --git a/docs/source/man/podman-search.1.md b/docs/source/markdown/podman-search.1.md
index 31de6f839..31de6f839 100644
--- a/docs/source/man/podman-search.1.md
+++ b/docs/source/markdown/podman-search.1.md
diff --git a/docs/source/man/podman-start.1.md b/docs/source/markdown/podman-start.1.md
index 4c81d17bd..4c81d17bd 100644
--- a/docs/source/man/podman-start.1.md
+++ b/docs/source/markdown/podman-start.1.md
diff --git a/docs/source/man/podman-stats.1.md b/docs/source/markdown/podman-stats.1.md
index 741873c3f..741873c3f 100644
--- a/docs/source/man/podman-stats.1.md
+++ b/docs/source/markdown/podman-stats.1.md
diff --git a/docs/source/man/podman-stop.1.md b/docs/source/markdown/podman-stop.1.md
index b5ea670b0..b5ea670b0 100644
--- a/docs/source/man/podman-stop.1.md
+++ b/docs/source/markdown/podman-stop.1.md
diff --git a/docs/source/man/podman-system-df.1.md b/docs/source/markdown/podman-system-df.1.md
index d0b1755ee..d0b1755ee 100644
--- a/docs/source/man/podman-system-df.1.md
+++ b/docs/source/markdown/podman-system-df.1.md
diff --git a/docs/source/man/podman-system-migrate.1.md b/docs/source/markdown/podman-system-migrate.1.md
index d5e3bcb95..d5e3bcb95 100644
--- a/docs/source/man/podman-system-migrate.1.md
+++ b/docs/source/markdown/podman-system-migrate.1.md
diff --git a/docs/source/man/podman-system-prune.1.md b/docs/source/markdown/podman-system-prune.1.md
index e6297dc0b..e6297dc0b 100644
--- a/docs/source/man/podman-system-prune.1.md
+++ b/docs/source/markdown/podman-system-prune.1.md
diff --git a/docs/source/man/podman-system-renumber.1.md b/docs/source/markdown/podman-system-renumber.1.md
index 071eefe29..071eefe29 100644
--- a/docs/source/man/podman-system-renumber.1.md
+++ b/docs/source/markdown/podman-system-renumber.1.md
diff --git a/docs/source/man/podman-system.1.md b/docs/source/markdown/podman-system.1.md
index bbd541066..bbd541066 100644
--- a/docs/source/man/podman-system.1.md
+++ b/docs/source/markdown/podman-system.1.md
diff --git a/docs/source/man/podman-tag.1.md b/docs/source/markdown/podman-tag.1.md
index 291d95228..291d95228 100644
--- a/docs/source/man/podman-tag.1.md
+++ b/docs/source/markdown/podman-tag.1.md
diff --git a/docs/source/man/podman-top.1.md b/docs/source/markdown/podman-top.1.md
index 1410aa651..1410aa651 100644
--- a/docs/source/man/podman-top.1.md
+++ b/docs/source/markdown/podman-top.1.md
diff --git a/docs/source/man/podman-umount.1.md b/docs/source/markdown/podman-umount.1.md
index 100c47b32..100c47b32 100644
--- a/docs/source/man/podman-umount.1.md
+++ b/docs/source/markdown/podman-umount.1.md
diff --git a/docs/source/man/podman-unpause.1.md b/docs/source/markdown/podman-unpause.1.md
index f5538d6d5..f5538d6d5 100644
--- a/docs/source/man/podman-unpause.1.md
+++ b/docs/source/markdown/podman-unpause.1.md
diff --git a/docs/source/man/podman-unshare.1.md b/docs/source/markdown/podman-unshare.1.md
index 9052b97ab..9052b97ab 100644
--- a/docs/source/man/podman-unshare.1.md
+++ b/docs/source/markdown/podman-unshare.1.md
diff --git a/docs/source/man/podman-varlink.1.md b/docs/source/markdown/podman-varlink.1.md
index 0d2ab1668..0d2ab1668 100644
--- a/docs/source/man/podman-varlink.1.md
+++ b/docs/source/markdown/podman-varlink.1.md
diff --git a/docs/source/man/podman-version.1.md b/docs/source/markdown/podman-version.1.md
index 4499f6338..4499f6338 100644
--- a/docs/source/man/podman-version.1.md
+++ b/docs/source/markdown/podman-version.1.md
diff --git a/docs/source/man/podman-volume-create.1.md b/docs/source/markdown/podman-volume-create.1.md
index b354f396f..b354f396f 100644
--- a/docs/source/man/podman-volume-create.1.md
+++ b/docs/source/markdown/podman-volume-create.1.md
diff --git a/docs/source/man/podman-volume-inspect.1.md b/docs/source/markdown/podman-volume-inspect.1.md
index ac5b6c977..ac5b6c977 100644
--- a/docs/source/man/podman-volume-inspect.1.md
+++ b/docs/source/markdown/podman-volume-inspect.1.md
diff --git a/docs/source/man/podman-volume-ls.1.md b/docs/source/markdown/podman-volume-ls.1.md
index d431c7c6e..d431c7c6e 100644
--- a/docs/source/man/podman-volume-ls.1.md
+++ b/docs/source/markdown/podman-volume-ls.1.md
diff --git a/docs/source/man/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md
index 25ea701a3..25ea701a3 100644
--- a/docs/source/man/podman-volume-prune.1.md
+++ b/docs/source/markdown/podman-volume-prune.1.md
diff --git a/docs/source/man/podman-volume-rm.1.md b/docs/source/markdown/podman-volume-rm.1.md
index 9a2fe8c99..9a2fe8c99 100644
--- a/docs/source/man/podman-volume-rm.1.md
+++ b/docs/source/markdown/podman-volume-rm.1.md
diff --git a/docs/source/man/podman-volume.1.md b/docs/source/markdown/podman-volume.1.md
index 288e57b82..288e57b82 100644
--- a/docs/source/man/podman-volume.1.md
+++ b/docs/source/markdown/podman-volume.1.md
diff --git a/docs/source/man/podman-wait.1.md b/docs/source/markdown/podman-wait.1.md
index ce1c70a5f..ce1c70a5f 100644
--- a/docs/source/man/podman-wait.1.md
+++ b/docs/source/markdown/podman-wait.1.md
diff --git a/docs/source/man/podman.1.md b/docs/source/markdown/podman.1.md
index f6fa1a457..f6fa1a457 100644
--- a/docs/source/man/podman.1.md
+++ b/docs/source/markdown/podman.1.md
diff --git a/docs/source/network.rst b/docs/source/network.rst
index aa379bf46..c1c53bc34 100644
--- a/docs/source/network.rst
+++ b/docs/source/network.rst
@@ -1,10 +1,10 @@
Network
=====
-:doc:`create <man/podman-network-create.1>` network create
+:doc:`create <markdown/podman-network-create.1>` network create
-:doc:`inspect <man/podman-network-inspect.1>` network inspect
+:doc:`inspect <markdown/podman-network-inspect.1>` network inspect
-:doc:`ls <man/podman-network-ls.1>` network list
+:doc:`ls <markdown/podman-network-ls.1>` network list
-:doc:`rm <man/podman-network-rm.1>` network rm \ No newline at end of file
+:doc:`rm <markdown/podman-network-rm.1>` network rm \ No newline at end of file
diff --git a/docs/source/play.rst b/docs/source/play.rst
index 5e5c02ee1..8f00d2f45 100644
--- a/docs/source/play.rst
+++ b/docs/source/play.rst
@@ -1,4 +1,4 @@
Play
====
-:doc:`kube <man/podman-play-kube.1>` Play a pod based on Kubernetes YAML
+:doc:`kube <markdown/podman-play-kube.1>` Play a pod based on Kubernetes YAML
diff --git a/docs/source/pod.rst b/docs/source/pod.rst
index 94ed9604a..391686ce5 100644
--- a/docs/source/pod.rst
+++ b/docs/source/pod.rst
@@ -1,30 +1,30 @@
Pod
===
-:doc:`create <man/podman-pod-create.1>` Create a new empty pod
+:doc:`create <markdown/podman-pod-create.1>` Create a new empty pod
-:doc:`exists <man/podman-pod-exists.1>` Check if a pod exists in local storage
+:doc:`exists <markdown/podman-pod-exists.1>` Check if a pod exists in local storage
-:doc:`inspect <man/podman-pod-inspect.1>` Displays a pod configuration
+:doc:`inspect <markdown/podman-pod-inspect.1>` Displays a pod configuration
-:doc:`kill <man/podman-pod-kill.1>` Send the specified signal or SIGKILL to containers in pod
+:doc:`kill <markdown/podman-pod-kill.1>` Send the specified signal or SIGKILL to containers in pod
-:doc:`pause <man/podman-pause.1>` Pause one or more pods
+:doc:`pause <markdown/podman-pause.1>` Pause one or more pods
-:doc:`prune <man/podman-pod-prune.1>` Remove all stopped pods
+:doc:`prune <markdown/podman-pod-prune.1>` Remove all stopped pods
-:doc:`ps <man/podman-pod-ps.1>` List pods
+:doc:`ps <markdown/podman-pod-ps.1>` List pods
-:doc:`restart <man/podman-pod-restart.1>` Restart one or more pods
+:doc:`restart <markdown/podman-pod-restart.1>` Restart one or more pods
-:doc:`rm <man/podman-pod-rm.1>` Remove one or more pods
+:doc:`rm <markdown/podman-pod-rm.1>` Remove one or more pods
-:doc:`start <man/podman-pod-start.1>` Start one or more pods
+:doc:`start <markdown/podman-pod-start.1>` Start one or more pods
-:doc:`stats <man/podman-pod-stats.1>` Display a live stream of resource usage statistics for the containers in one or more pods
+:doc:`stats <markdown/podman-pod-stats.1>` Display a live stream of resource usage statistics for the containers in one or more pods
-:doc:`stop <man/podman-pod-stop.1>` Stop one or more pods
+:doc:`stop <markdown/podman-pod-stop.1>` Stop one or more pods
-:doc:`top <man/podman-pod-top.1>` Display the running processes of containers in a pod
+:doc:`top <markdown/podman-pod-top.1>` Display the running processes of containers in a pod
-:doc:`unpause <man/podman-pod-unpause.1>` Unpause one or more pods
+:doc:`unpause <markdown/podman-pod-unpause.1>` Unpause one or more pods
diff --git a/docs/source/system.rst b/docs/source/system.rst
index a35409454..2f2b7ea8f 100644
--- a/docs/source/system.rst
+++ b/docs/source/system.rst
@@ -1,12 +1,12 @@
System
======
-:doc:`df <man/podman-system-df.1>` Show podman disk usage
+:doc:`df <markdown/podman-system-df.1>` Show podman disk usage
-:doc:`info <man/podman-info.1>` Display podman system information
+:doc:`info <markdown/podman-info.1>` Display podman system information
-:doc:`migrate <man/podman-system-migrate.1>` Migrate containers
+:doc:`migrate <markdown/podman-system-migrate.1>` Migrate containers
-:doc:`prune <man/podman-system-prune.1>` Remove unused data
+:doc:`prune <markdown/podman-system-prune.1>` Remove unused data
-:doc:`renumber <man/podman-system-renumber.1>` Migrate lock numbers
+:doc:`renumber <markdown/podman-system-renumber.1>` Migrate lock numbers
diff --git a/docs/source/volume.rst b/docs/source/volume.rst
index a0f31ac34..43fe87054 100644
--- a/docs/source/volume.rst
+++ b/docs/source/volume.rst
@@ -1,11 +1,11 @@
Volume
======
-:doc:`create <man/podman-volume-create.1>` Create a new volume
+:doc:`create <markdown/podman-volume-create.1>` Create a new volume
-:doc:`inspect <man/podman-volume-inspect.1>` Display detailed information on one or more volumes
+:doc:`inspect <markdown/podman-volume-inspect.1>` Display detailed information on one or more volumes
-:doc:`ls <man/podman-volume-ls.1>` List volumes
+:doc:`ls <markdown/podman-volume-ls.1>` List volumes
-:doc:`prune <man/podman-volume-prune.1>` Remove all unused volumes
+:doc:`prune <markdown/podman-volume-prune.1>` Remove all unused volumes
-:doc:`rm <man/podman-volume-rm.1>` Remove one or more volumes \ No newline at end of file
+:doc:`rm <markdown/podman-volume-rm.1>` Remove one or more volumes \ No newline at end of file
diff --git a/hack/man-page-checker b/hack/man-page-checker
index 6e5cad6b2..99d280539 100755
--- a/hack/man-page-checker
+++ b/hack/man-page-checker
@@ -18,7 +18,7 @@ die() {
exit 1
}
-cd $(dirname $0)/../docs/source/man || die "Please run me from top-level libpod dir"
+cd $(dirname $0)/../docs/source/markdown || die "Please run me from top-level libpod dir"
rc=0
diff --git a/hack/podman-commands.sh b/hack/podman-commands.sh
index bd35b03bc..32f94fc7b 100755
--- a/hack/podman-commands.sh
+++ b/hack/podman-commands.sh
@@ -34,7 +34,7 @@ function podman_man() {
# This md file has a table of the form:
# | [podman-cmd(1)\[(podman-cmd.1.md) | Description ... |
# For all such, print the 'cmd' portion (the one in brackets).
- sed -ne 's/^|\s\+\[podman-\([a-z]\+\)(1.*/\1/p' <docs/source/man/$1.1.md
+ sed -ne 's/^|\s\+\[podman-\([a-z]\+\)(1.*/\1/p' <docs/source/markdown/$1.1.md
# Special case: there is no podman-help man page, nor need for such.
echo "help"
@@ -48,7 +48,7 @@ function podman_man() {
# | cmd | [podman-cmd(1)](podman-cmd.1.md) | Description ... |
# For all such we find, with 'podman- in the second column, print the
# first column (with whitespace trimmed)
- awk -F\| '$3 ~ /podman-/ { gsub(" ","",$2); print $2 }' < docs/source/man/$1.1.md
+ awk -F\| '$3 ~ /podman-/ { gsub(" ","",$2); print $2 }' < docs/source/markdown/$1.1.md
fi
}