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>

.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*

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
+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
-	rm -rf bin/windows
+	$(eval DOCFILE := docs/build/remote/windows)
-	mkdir -p bin/windows
+	find $(DOCFILE) -print \
-	docs/podman-remote.sh windows bin/windows docs
+	|wixl-heat --var var.ManSourceDir --component-group ManFiles --directory-ref INSTALLDIR --prefix $(DOCFILE)/ >$(DOCFILE)/pages.wsx
-	find bin/windows -print \
+	wixl -D VERSION=$(RELEASE_NUMBER) -D ManSourceDir=$(DOCFILE) -o podman-v$(RELEASE_NUMBER).msi contrib/msi/podman.wxs $(DOCFILE)/pages.wsx
-	|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-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
+install-podman-remote-%-docs: podman-remote docs $(MANPAGES)
-	rm -rf docs/remote
+	rm -rf docs/build/remote
-	docs/podman-remote.sh darwin docs/remote docs
+	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/"
+	cp -r ./docs/build/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)"
 	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)

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 |

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
+PLATFORM=$1                         ## linux, windows or darwin
-TARGET=$2                           ## where to output files
+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 "PLATFORM: Is either linux, darwin or windows."
-    echo >&2 "TARGET: Is the directory where files will be staged."
+    echo >&2 "TARGET: Is the directory where files will be staged. eg, docs/build/remote/linux"
-    echo >&2 "SOURCES: Are the directories to source markdown files."
+    echo >&2 "SOURCES: Are the directories of source files. eg, docs/markdown"
 }
 
 function fail() {
@@ -21,19 +21,17 @@ function fail() {
 }
 
 case $PLATFORM in
-'darwin')
+darwin|linux)
-    EXT=1
+    PUBLISHER=man_fn
-    PUBLISHER=darwin_fn
     ;;
-'windows')
+windows)
-    EXT=1.md
+    PUBLISHER=html_fn
-    PUBLISHER=windows_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
+## man_fn copies the man page or link to flattened directory
-function darwin_fn() {
+function man_fn() {
-    local markdown=$1
+    local page=$1
-    local file=$(basename $markdown)
+    local file=$(basename $page)
-    local dir=$(dirname $markdown)
+    local dir=$(dirname $page)
-    if [[ -f $dir/../../links/$file ]]; then
+
-        markdown=$dir/../../links/$file
+    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
+## html_fn converts the markdown page or link to HTML
-function windows_fn() {
+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
 }

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
+:doc:`wait <markdown/podman-wait.1>` Block on one or more containers

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

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

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

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