From 52b92023edeba3a5e2c466d92d742e54b14a85cb Mon Sep 17 00:00:00 2001 From: baude Date: Thu, 24 Oct 2019 14:54:57 -0500 Subject: [PATCH 1/2] Restructure documentation dir Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude --- Makefile | 26 ++-- docs/Makefile | 23 ++++ docs/{rtd => }/make.bat | 0 docs/podman-remote.sh | 5 +- docs/{rtd => }/requirements.txt | 0 docs/rtd/Makefile | 123 ------------------ docs/rtd/source/man/generate.rst | 6 - docs/rtd/source/man/healthcheck.rst | 4 - docs/rtd/source/man/image.rst | 35 ----- docs/rtd/source/man/managecontainers.rst | 64 --------- docs/rtd/source/man/network.rst | 10 -- docs/rtd/source/man/play.rst | 4 - docs/rtd/source/man/pod.rst | 30 ----- docs/rtd/source/man/system.rst | 12 -- docs/rtd/source/man/volume.rst | 11 -- docs/{rtd => }/source/Commands.rst | 18 +-- docs/{rtd => }/source/Introduction.rst | 0 docs/{rtd => }/source/Reference.rst | 0 docs/{rtd => }/source/Tutorials.rst | 0 docs/{rtd => }/source/conf.py | 0 docs/source/generate.rst | 6 + docs/source/healthcheck.rst | 4 + docs/source/image.rst | 35 +++++ docs/{rtd => }/source/index.rst | 0 docs/{ => source/man}/podman-attach.1.md | 0 docs/{ => source/man}/podman-build.1.md | 0 docs/{ => source/man}/podman-commit.1.md | 0 .../man}/podman-container-checkpoint.1.md | 0 .../man}/podman-container-cleanup.1.md | 0 .../man}/podman-container-exists.1.md | 0 .../man}/podman-container-prune.1.md | 0 .../man}/podman-container-restore.1.md | 0 .../man}/podman-container-runlabel.1.md | 0 docs/{ => source/man}/podman-container.1.md | 0 docs/{ => source/man}/podman-cp.1.md | 0 docs/{ => source/man}/podman-create.1.md | 0 docs/{ => source/man}/podman-diff.1.md | 0 docs/{ => source/man}/podman-events.1.md | 0 docs/{ => source/man}/podman-exec.1.md | 0 docs/{ => source/man}/podman-export.1.md | 0 .../man}/podman-generate-kube.1.md | 0 .../man}/podman-generate-systemd.1.md | 0 docs/{ => source/man}/podman-generate.1.md | 0 .../man}/podman-healthcheck-run.1.md | 0 docs/{ => source/man}/podman-healthcheck.1.md | 0 docs/{ => source/man}/podman-history.1.md | 0 .../{ => source/man}/podman-image-exists.1.md | 0 docs/{ => source/man}/podman-image-prune.1.md | 0 docs/{ => source/man}/podman-image-sign.1.md | 0 docs/{ => source/man}/podman-image-tree.1.md | 0 docs/{ => source/man}/podman-image-trust.1.md | 0 docs/{ => source/man}/podman-image.1.md | 0 docs/{ => source/man}/podman-images.1.md | 0 docs/{ => source/man}/podman-import.1.md | 0 docs/{ => source/man}/podman-info.1.md | 0 docs/{ => source/man}/podman-init.1.md | 0 docs/{ => source/man}/podman-inspect.1.md | 0 docs/{ => source/man}/podman-kill.1.md | 0 docs/{ => source/man}/podman-load.1.md | 0 docs/{ => source/man}/podman-login.1.md | 0 docs/{ => source/man}/podman-logout.1.md | 0 docs/{ => source/man}/podman-logs.1.md | 0 docs/{ => source/man}/podman-mount.1.md | 0 .../man}/podman-network-create.1.md | 0 .../man}/podman-network-inspect.1.md | 0 docs/{ => source/man}/podman-network-ls.1.md | 0 docs/{ => source/man}/podman-network-rm.1.md | 0 docs/{ => source/man}/podman-network.1.md | 0 docs/{ => source/man}/podman-pause.1.md | 0 docs/{ => source/man}/podman-play-kube.1.md | 0 docs/{ => source/man}/podman-play.1.md | 0 docs/{ => source/man}/podman-pod-create.1.md | 0 docs/{ => source/man}/podman-pod-exists.1.md | 0 docs/{ => source/man}/podman-pod-inspect.1.md | 0 docs/{ => source/man}/podman-pod-kill.1.md | 0 docs/{ => source/man}/podman-pod-pause.1.md | 0 docs/{ => source/man}/podman-pod-prune.1.md | 0 docs/{ => source/man}/podman-pod-ps.1.md | 0 docs/{ => source/man}/podman-pod-restart.1.md | 0 docs/{ => source/man}/podman-pod-rm.1.md | 0 docs/{ => source/man}/podman-pod-start.1.md | 0 docs/{ => source/man}/podman-pod-stats.1.md | 0 docs/{ => source/man}/podman-pod-stop.1.md | 0 docs/{ => source/man}/podman-pod-top.1.md | 0 docs/{ => source/man}/podman-pod-unpause.1.md | 0 docs/{ => source/man}/podman-pod.1.md | 0 docs/{ => source/man}/podman-port.1.md | 0 docs/{ => source/man}/podman-ps.1.md | 0 docs/{ => source/man}/podman-pull.1.md | 0 docs/{ => source/man}/podman-push.1.md | 0 docs/{ => source/man}/podman-remote.1.md | 0 docs/{ => source/man}/podman-restart.1.md | 0 docs/{ => source/man}/podman-rm.1.md | 0 docs/{ => source/man}/podman-rmi.1.md | 0 docs/{ => source/man}/podman-run.1.md | 0 docs/{ => source/man}/podman-save.1.md | 0 docs/{ => source/man}/podman-search.1.md | 0 docs/{ => source/man}/podman-start.1.md | 0 docs/{ => source/man}/podman-stats.1.md | 0 docs/{ => source/man}/podman-stop.1.md | 0 docs/{ => source/man}/podman-system-df.1.md | 0 .../man}/podman-system-migrate.1.md | 0 .../{ => source/man}/podman-system-prune.1.md | 0 .../man}/podman-system-renumber.1.md | 0 docs/{ => source/man}/podman-system.1.md | 0 docs/{ => source/man}/podman-tag.1.md | 0 docs/{ => source/man}/podman-top.1.md | 0 docs/{ => source/man}/podman-umount.1.md | 0 docs/{ => source/man}/podman-unpause.1.md | 0 docs/{ => source/man}/podman-unshare.1.md | 0 docs/{ => source/man}/podman-varlink.1.md | 0 docs/{ => source/man}/podman-version.1.md | 0 .../man}/podman-volume-create.1.md | 0 .../man}/podman-volume-inspect.1.md | 0 docs/{ => source/man}/podman-volume-ls.1.md | 0 .../{ => source/man}/podman-volume-prune.1.md | 0 docs/{ => source/man}/podman-volume-rm.1.md | 0 docs/{ => source/man}/podman-volume.1.md | 0 docs/{ => source/man}/podman-wait.1.md | 0 docs/{ => source/man}/podman.1.md | 0 docs/source/managecontainers.rst | 64 +++++++++ docs/source/network.rst | 10 ++ docs/source/play.rst | 4 + docs/source/pod.rst | 30 +++++ docs/source/system.rst | 12 ++ docs/source/volume.rst | 11 ++ hack/man-page-checker | 2 +- hack/podman-commands.sh | 6 +- 128 files changed, 228 insertions(+), 327 deletions(-) create mode 100644 docs/Makefile rename docs/{rtd => }/make.bat (100%) rename docs/{rtd => }/requirements.txt (100%) delete mode 100644 docs/rtd/Makefile delete mode 100644 docs/rtd/source/man/generate.rst delete mode 100644 docs/rtd/source/man/healthcheck.rst delete mode 100644 docs/rtd/source/man/image.rst delete mode 100644 docs/rtd/source/man/managecontainers.rst delete mode 100644 docs/rtd/source/man/network.rst delete mode 100644 docs/rtd/source/man/play.rst delete mode 100644 docs/rtd/source/man/pod.rst delete mode 100644 docs/rtd/source/man/system.rst delete mode 100644 docs/rtd/source/man/volume.rst rename docs/{rtd => }/source/Commands.rst (86%) rename docs/{rtd => }/source/Introduction.rst (100%) rename docs/{rtd => }/source/Reference.rst (100%) rename docs/{rtd => }/source/Tutorials.rst (100%) rename docs/{rtd => }/source/conf.py (100%) create mode 100644 docs/source/generate.rst create mode 100644 docs/source/healthcheck.rst create mode 100644 docs/source/image.rst rename docs/{rtd => }/source/index.rst (100%) rename docs/{ => source/man}/podman-attach.1.md (100%) rename docs/{ => source/man}/podman-build.1.md (100%) rename docs/{ => source/man}/podman-commit.1.md (100%) rename docs/{ => source/man}/podman-container-checkpoint.1.md (100%) rename docs/{ => source/man}/podman-container-cleanup.1.md (100%) rename docs/{ => source/man}/podman-container-exists.1.md (100%) rename docs/{ => source/man}/podman-container-prune.1.md (100%) rename docs/{ => source/man}/podman-container-restore.1.md (100%) rename docs/{ => source/man}/podman-container-runlabel.1.md (100%) rename docs/{ => source/man}/podman-container.1.md (100%) rename docs/{ => source/man}/podman-cp.1.md (100%) rename docs/{ => source/man}/podman-create.1.md (100%) rename docs/{ => source/man}/podman-diff.1.md (100%) rename docs/{ => source/man}/podman-events.1.md (100%) rename docs/{ => source/man}/podman-exec.1.md (100%) rename docs/{ => source/man}/podman-export.1.md (100%) rename docs/{ => source/man}/podman-generate-kube.1.md (100%) rename docs/{ => source/man}/podman-generate-systemd.1.md (100%) rename docs/{ => source/man}/podman-generate.1.md (100%) rename docs/{ => source/man}/podman-healthcheck-run.1.md (100%) rename docs/{ => source/man}/podman-healthcheck.1.md (100%) rename docs/{ => source/man}/podman-history.1.md (100%) rename docs/{ => source/man}/podman-image-exists.1.md (100%) rename docs/{ => source/man}/podman-image-prune.1.md (100%) rename docs/{ => source/man}/podman-image-sign.1.md (100%) rename docs/{ => source/man}/podman-image-tree.1.md (100%) rename docs/{ => source/man}/podman-image-trust.1.md (100%) rename docs/{ => source/man}/podman-image.1.md (100%) rename docs/{ => source/man}/podman-images.1.md (100%) rename docs/{ => source/man}/podman-import.1.md (100%) rename docs/{ => source/man}/podman-info.1.md (100%) rename docs/{ => source/man}/podman-init.1.md (100%) rename docs/{ => source/man}/podman-inspect.1.md (100%) rename docs/{ => source/man}/podman-kill.1.md (100%) rename docs/{ => source/man}/podman-load.1.md (100%) rename docs/{ => source/man}/podman-login.1.md (100%) rename docs/{ => source/man}/podman-logout.1.md (100%) rename docs/{ => source/man}/podman-logs.1.md (100%) rename docs/{ => source/man}/podman-mount.1.md (100%) rename docs/{ => source/man}/podman-network-create.1.md (100%) rename docs/{ => source/man}/podman-network-inspect.1.md (100%) rename docs/{ => source/man}/podman-network-ls.1.md (100%) rename docs/{ => source/man}/podman-network-rm.1.md (100%) rename docs/{ => source/man}/podman-network.1.md (100%) rename docs/{ => source/man}/podman-pause.1.md (100%) rename docs/{ => source/man}/podman-play-kube.1.md (100%) rename docs/{ => source/man}/podman-play.1.md (100%) rename docs/{ => source/man}/podman-pod-create.1.md (100%) rename docs/{ => source/man}/podman-pod-exists.1.md (100%) rename docs/{ => source/man}/podman-pod-inspect.1.md (100%) rename docs/{ => source/man}/podman-pod-kill.1.md (100%) rename docs/{ => source/man}/podman-pod-pause.1.md (100%) rename docs/{ => source/man}/podman-pod-prune.1.md (100%) rename docs/{ => source/man}/podman-pod-ps.1.md (100%) rename docs/{ => source/man}/podman-pod-restart.1.md (100%) rename docs/{ => source/man}/podman-pod-rm.1.md (100%) rename docs/{ => source/man}/podman-pod-start.1.md (100%) rename docs/{ => source/man}/podman-pod-stats.1.md (100%) rename docs/{ => source/man}/podman-pod-stop.1.md (100%) rename docs/{ => source/man}/podman-pod-top.1.md (100%) rename docs/{ => source/man}/podman-pod-unpause.1.md (100%) rename docs/{ => source/man}/podman-pod.1.md (100%) rename docs/{ => source/man}/podman-port.1.md (100%) rename docs/{ => source/man}/podman-ps.1.md (100%) rename docs/{ => source/man}/podman-pull.1.md (100%) rename docs/{ => source/man}/podman-push.1.md (100%) rename docs/{ => source/man}/podman-remote.1.md (100%) rename docs/{ => source/man}/podman-restart.1.md (100%) rename docs/{ => source/man}/podman-rm.1.md (100%) rename docs/{ => source/man}/podman-rmi.1.md (100%) rename docs/{ => source/man}/podman-run.1.md (100%) rename docs/{ => source/man}/podman-save.1.md (100%) rename docs/{ => source/man}/podman-search.1.md (100%) rename docs/{ => source/man}/podman-start.1.md (100%) rename docs/{ => source/man}/podman-stats.1.md (100%) rename docs/{ => source/man}/podman-stop.1.md (100%) rename docs/{ => source/man}/podman-system-df.1.md (100%) rename docs/{ => source/man}/podman-system-migrate.1.md (100%) rename docs/{ => source/man}/podman-system-prune.1.md (100%) rename docs/{ => source/man}/podman-system-renumber.1.md (100%) rename docs/{ => source/man}/podman-system.1.md (100%) rename docs/{ => source/man}/podman-tag.1.md (100%) rename docs/{ => source/man}/podman-top.1.md (100%) rename docs/{ => source/man}/podman-umount.1.md (100%) rename docs/{ => source/man}/podman-unpause.1.md (100%) rename docs/{ => source/man}/podman-unshare.1.md (100%) rename docs/{ => source/man}/podman-varlink.1.md (100%) rename docs/{ => source/man}/podman-version.1.md (100%) rename docs/{ => source/man}/podman-volume-create.1.md (100%) rename docs/{ => source/man}/podman-volume-inspect.1.md (100%) rename docs/{ => source/man}/podman-volume-ls.1.md (100%) rename docs/{ => source/man}/podman-volume-prune.1.md (100%) rename docs/{ => source/man}/podman-volume-rm.1.md (100%) rename docs/{ => source/man}/podman-volume.1.md (100%) rename docs/{ => source/man}/podman-wait.1.md (100%) rename docs/{ => source/man}/podman.1.md (100%) create mode 100644 docs/source/managecontainers.rst create mode 100644 docs/source/network.rst create mode 100644 docs/source/play.rst create mode 100644 docs/source/pod.rst create mode 100644 docs/source/system.rst create mode 100644 docs/source/volume.rst diff --git a/Makefile b/Makefile index d4d123d697..587ab2ec24 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ export GOPROXY=https://proxy.golang.org GO ?= go DESTDIR ?= -EPOCH_TEST_COMMIT ?= 2b0892e757c878cdb087dd22b8986bccef0276ed +EPOCH_TEST_COMMIT ?= ac73fd3fe5dcbf2647d589f9c9f37fe9531ed663 HEAD ?= HEAD CHANGELOG_BASE ?= HEAD~ CHANGELOG_TARGET ?= HEAD @@ -205,9 +205,7 @@ clean: ## Clean artifacts libpod/pod_ffjson.go \ libpod/container_easyjson.go \ libpod/pod_easyjson.go \ - $(MANPAGES) ||: - find . -name \*~ -delete - find . -name \#\* -delete + docs/build libpodimage: ## Build the libpod image ${CONTAINER_RUNTIME} build -t ${LIBPOD_IMAGE} . @@ -312,13 +310,17 @@ install.catatonit: test-binaries: test/checkseccomp/checkseccomp test/goecho/goecho install.catatonit -MANPAGES_MD ?= $(wildcard docs/*.md pkg/*/docs/*.md) +MANPAGES_MD ?= $(wildcard docs/source/man/*.md pkg/*/docs/*.md) MANPAGES ?= $(MANPAGES_MD:%.md=%) +MANPAGES_DEST ?= $(subst source,build,$(MANPAGES)) $(MANPAGES): %: %.md .gopathok - @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $@ + @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $(subst source,build,$@) -docs: $(MANPAGES) ## Generate documentation +docdir: + mkdir -p docs/build/man + +docs: docdir $(MANPAGES) ## Generate documentation install-podman-remote-docs: podman-remote docs rm -rf docs/remote @@ -408,8 +410,8 @@ install.bin: podman install.man: docs install ${SELINUXOPT} -d -m 755 $(DESTDIR)$(MANDIR)/man1 install ${SELINUXOPT} -d -m 755 $(DESTDIR)$(MANDIR)/man5 - install ${SELINUXOPT} -m 644 $(filter %.1,$(MANPAGES)) -t $(DESTDIR)$(MANDIR)/man1 - install ${SELINUXOPT} -m 644 $(filter %.5,$(MANPAGES)) -t $(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.config: @@ -444,16 +446,16 @@ install.systemd: install ${SELINUXOPT} -m 644 contrib/varlink/podman.conf ${DESTDIR}${TMPFILESDIR}/podman.conf uninstall: - for i in $(filter %.1,$(MANPAGES)); do \ + for i in $(filter %.1,$(MANPAGES_DEST)); do \ rm -f $(DESTDIR)$(MANDIR)/man1/$$(basename $${i}); \ done; \ - for i in $(filter %.5,$(MANPAGES)); do \ + for i in $(filter %.5,$(MANPAGES_DEST)); do \ rm -f $(DESTDIR)$(MANDIR)/man5/$$(basename $${i}); \ done .PHONY: .gitvalidation .gitvalidation: .gopathok - GIT_CHECK_EXCLUDE="./vendor:docs/rtd/make.bat" $(GOBIN)/git-validation -v -run DCO,short-subject,dangling-whitespace -range $(EPOCH_TEST_COMMIT)..$(HEAD) + GIT_CHECK_EXCLUDE="./vendor:docs/make.bat" $(GOBIN)/git-validation -v -run DCO,short-subject,dangling-whitespace -range $(EPOCH_TEST_COMMIT)..$(HEAD) .PHONY: install.tools install.tools: .install.gitvalidation .install.gometalinter .install.md2man .install.ginkgo .install.golangci-lint ## Install needed tools diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000..fb67e266cc --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,23 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +clean: + rm -fr build/ + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/rtd/make.bat b/docs/make.bat similarity index 100% rename from docs/rtd/make.bat rename to docs/make.bat diff --git a/docs/podman-remote.sh b/docs/podman-remote.sh index 2f8e76d1b6..d8ce4a359b 100755 --- a/docs/podman-remote.sh +++ b/docs/podman-remote.sh @@ -53,9 +53,8 @@ function darwin_fn() { local markdown=$1 local file=$(basename $markdown) local dir=$(dirname $markdown) - - if [[ -f $dir/links/$file ]]; then - markdown=$dir/links/$file + if [[ -f $dir/../../links/$file ]]; then + markdown=$dir/../../links/$file fi install $markdown $TARGET } diff --git a/docs/rtd/requirements.txt b/docs/requirements.txt similarity index 100% rename from docs/rtd/requirements.txt rename to docs/requirements.txt diff --git a/docs/rtd/Makefile b/docs/rtd/Makefile deleted file mode 100644 index 50af6490a3..0000000000 --- a/docs/rtd/Makefile +++ /dev/null @@ -1,123 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -clean: - rm -fr build/ - rm -f source/man/podman-*.1.md - -copy: - cp -v ../podman-attach.1.md source/man/ - cp -v ../podman-build.1.md source/man/ - cp -v ../podman-commit.1.md source/man/ - # container - cp -v ../podman-container-checkpoint.1.md source/man/ - cp -v ../podman-container-exists.1.md source/man/ - cp -v ../podman-container-restore.1.md source/man/ - cp -v ../podman-container-cleanup.1.md source/man/ - cp -v ../podman-container-prune.1.md source/man/ - cp -v ../podman-container-runlabel.1.md source/man/ - cp -v ../podman-cp.1.md source/man/ - cp -v ../podman-create.1.md source/man/ - cp -v ../podman-diff.1.md source/man/ - cp -v ../podman-events.1.md source/man/ - cp -v ../podman-exec.1.md source/man/ - cp -v ../podman-export.1.md source/man/ - # generate - cp -v ../podman-generate-systemd.1.md source/man/ - cp -v ../podman-generate-kube.1.md source/man/ - # healthcheck - cp -v ../podman-healthcheck-run.1.md source/man/ - #cp -v ../podman-help.1.md source/ - cp -v ../podman-history.1.md source/man/ - # image - cp -v ../podman-image-prune.1.md source/man/ - cp -v ../podman-image-tree.1.md source/man/ - cp -v ../podman-image-trust.1.md source/man/ - cp -v ../podman-image-exists.1.md source/man/ - cp -v ../podman-image-sign.1.md source/man/ - cp -v ../podman-images.1.md source/man/ - cp -v ../podman-import.1.md source/man/ - cp -v ../podman-info.1.md source/man/ - cp -v ../podman-init.1.md source/man/ - cp -v ../podman-inspect.1.md source/man/ - cp -v ../podman-kill.1.md source/man/ - cp -v ../podman-load.1.md source/man/ - cp -v ../podman-login.1.md source/man/ - cp -v ../podman-logout.1.md source/man/ - cp -v ../podman-logs.1.md source/man/ - cp -v ../podman-mount.1.md source/man/ - # network - cp -v ../podman-network-create.1.md source/man/ - cp -v ../podman-network-ls.1.md source/man/ - cp -v ../podman-network-inspect.1.md source/man/ - cp -v ../podman-network-rm.1.md source/man/ - cp -v ../podman-pause.1.md source/man/ - # play - cp -v ../podman-play-kube.1.md source/man/ - # pod - cp -v ../podman-pod-create.1.md source/man/ - cp -v ../podman-pod-pause.1.md source/man/ - cp -v ../podman-pod-rm.1.md source/man/ - cp -v ../podman-pod-top.1.md source/man/ - cp -v ../podman-pod-exists.1.md source/man/ - cp -v ../podman-pod-prune.1.md source/man/ - cp -v ../podman-pod-start.1.md source/man/ - cp -v ../podman-pod-unpause.1.md source/man/ - cp -v ../podman-pod-inspect.1.md source/man/ - cp -v ../podman-pod-ps.1.md source/man/ - cp -v ../podman-pod-stats.1.md source/man/ - cp -v ../podman-pod-kill.1.md source/man/ - cp -v ../podman-pod-restart.1.md source/man/ - cp -v ../podman-pod-stop.1.md source/man/ - cp -v ../podman-port.1.md source/man/ - cp -v ../podman-ps.1.md source/man/ - cp -v ../podman-pull.1.md source/man/ - cp -v ../podman-push.1.md source/man/ - cp -v ../podman-restart.1.md source/man/ - cp -v ../podman-rm.1.md source/man/ - cp -v ../podman-rmi.1.md source/man/ - cp -v ../podman-run.1.md source/man/ - cp -v ../podman-save.1.md source/man/ - cp -v ../podman-search.1.md source/man/ - cp -v ../podman-start.1.md source/man/ - cp -v ../podman-stats.1.md source/man/ - cp -v ../podman-stop.1.md source/man/ - # system - cp -v ../podman-system-migrate.1.md source/man/ - cp -v ../podman-system-renumber.1.md source/man/ - cp -v ../podman-system-df.1.md source/man/ - cp -v ../podman-system-prune.1.md source/man/ - cp -v ../podman-top.1.md source/man/ - cp -v ../podman-umount.1.md source/man/ - cp -v ../podman-unpause.1.md source/man/ - cp -v ../podman-unshare.1.md source/man/ - cp -v ../podman-varlink.1.md source/man/ - cp -v ../podman-version.1.md source/man/ - # volume - cp -v ../podman-volume-inspect.1.md source/man/ - cp -v ../podman-volume-prune.1.md source/man/ - cp -v ../podman-volume-create.1.md source/man/ - cp -v ../podman-volume-ls.1.md source/man/ - cp -v ../podman-volume-rm.1.md source/man/ - cp -v ../podman-wait.1.md source/man/ - -.PHONY: help Makefile copy - -html: copy - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/rtd/source/man/generate.rst b/docs/rtd/source/man/generate.rst deleted file mode 100644 index e82a157356..0000000000 --- a/docs/rtd/source/man/generate.rst +++ /dev/null @@ -1,6 +0,0 @@ -Generate -======== - -:doc:`kube ` Generate Kubernetes pod YAML from a container or pod - -:doc:`systemd ` Generate a systemd unit file for a Podman container diff --git a/docs/rtd/source/man/healthcheck.rst b/docs/rtd/source/man/healthcheck.rst deleted file mode 100644 index 697c1358b5..0000000000 --- a/docs/rtd/source/man/healthcheck.rst +++ /dev/null @@ -1,4 +0,0 @@ -HealthCheck -=========== - -:doc:`run ` run the health check of a container diff --git a/docs/rtd/source/man/image.rst b/docs/rtd/source/man/image.rst deleted file mode 100644 index ad963cd414..0000000000 --- a/docs/rtd/source/man/image.rst +++ /dev/null @@ -1,35 +0,0 @@ -Image -===== - - -:doc:`build ` Build an image using instructions from Containerfiles - -:doc:`exists ` Check if an image exists in local storage - -:doc:`history ` Show history of a specified image - -:doc:`import ` Import a tarball to create a filesystem image - -:doc:`inspect ` Display the configuration of an image - -:doc:`list ` List images in local storage - -:doc:`load ` Load an image from container archive - -:doc:`prune ` Remove unused images - -:doc:`pull ` Pull an image from a registry - -:doc:`push ` Push an image to a specified destination - -:doc:`rm ` Removes one or more images from local storage - -:doc:`save ` Save image to an archive - -:doc:`sign ` Sign an image - -:doc:`tag ` Add an additional name to a local image - -:doc:`tree ` Prints layer hierarchy of an image in a tree format - -:doc:`trust ` Manage container image trust policy diff --git a/docs/rtd/source/man/managecontainers.rst b/docs/rtd/source/man/managecontainers.rst deleted file mode 100644 index 20e8c0679b..0000000000 --- a/docs/rtd/source/man/managecontainers.rst +++ /dev/null @@ -1,64 +0,0 @@ -Manage Containers -================= - -:doc:`attach ` Attach to a running container - -:doc:`checkpoint ` Checkpoints one or more containers - -:doc:`cleanup ` Cleanup network and mountpoints of one or more containers - -:doc:`commit ` Create new image based on the changed container - -:doc:`cp ` Copy files/folders between a container and the local filesystem - -:doc:`create ` Create but do not start a container - -:doc:`diff ` Inspect changes on container's file systems - -:doc:`exec ` Run a process in a running container - -:doc:`exists ` Check if a container exists in local storage - -:doc:`export ` Export container's filesystem contents as a tar archive - -:doc:`init ` Initialize one or more containers - -:doc:`inspect ` Display the configuration of a container or image - -:doc:`kill ` Kill one or more running containers with a specific signal - -:doc:`list ` List containers - -:doc:`logs ` Fetch the logs of a container - -:doc:`mount ` Mount a working container's root filesystem - -:doc:`pause ` Pause all the processes in one or more containers - -:doc:`port ` List port mappings or a specific mapping for the container - -:doc:`restart ` Restart one or more containers - -:doc:`prune ` Remove all stopped containers - -:doc:`restore ` Restores one or more containers from a checkpoint - -:doc:`rm ` Remove one or more containers - -:doc:`run ` Run a command in a new container - -:doc:`runlabel ` Execute the command described by an image label - -:doc:`start ` Start one or more containers - -:doc:`stats ` Display a live stream of container resource usage statistics - -:doc:`stop ` Stop one or more containers - -:doc:`top ` Display the running processes of a container - -:doc:`umount ` Unmounts working container's root filesystem - -:doc:`unpause ` Unpause the processes in one or more containers - -:doc:`wait ` Block on one or more containers diff --git a/docs/rtd/source/man/network.rst b/docs/rtd/source/man/network.rst deleted file mode 100644 index 6d6a4c0229..0000000000 --- a/docs/rtd/source/man/network.rst +++ /dev/null @@ -1,10 +0,0 @@ -Network -===== - -:doc:`create ` network create - -:doc:`inspect ` network inspect - -:doc:`ls ` network list - -:doc:`rm ` network rm \ No newline at end of file diff --git a/docs/rtd/source/man/play.rst b/docs/rtd/source/man/play.rst deleted file mode 100644 index 93e1a9a1ef..0000000000 --- a/docs/rtd/source/man/play.rst +++ /dev/null @@ -1,4 +0,0 @@ -Play -==== - -:doc:`kube ` Play a pod based on Kubernetes YAML diff --git a/docs/rtd/source/man/pod.rst b/docs/rtd/source/man/pod.rst deleted file mode 100644 index 13c1740f84..0000000000 --- a/docs/rtd/source/man/pod.rst +++ /dev/null @@ -1,30 +0,0 @@ -Pod -=== - -:doc:`create ` Create a new empty pod - -:doc:`exists ` Check if a pod exists in local storage - -:doc:`inspect ` Displays a pod configuration - -:doc:`kill ` Send the specified signal or SIGKILL to containers in pod - -:doc:`pause ` Pause one or more pods - -:doc:`prune ` Remove all stopped pods - -:doc:`ps ` List pods - -:doc:`restart ` Restart one or more pods - -:doc:`rm ` Remove one or more pods - -:doc:`start ` Start one or more pods - -:doc:`stats ` Display a live stream of resource usage statistics for the containers in one or more pods - -:doc:`stop ` Stop one or more pods - -:doc:`top ` Display the running processes of containers in a pod - -:doc:`unpause ` Unpause one or more pods diff --git a/docs/rtd/source/man/system.rst b/docs/rtd/source/man/system.rst deleted file mode 100644 index 764ec01c17..0000000000 --- a/docs/rtd/source/man/system.rst +++ /dev/null @@ -1,12 +0,0 @@ -System -====== - -:doc:`df ` Show podman disk usage - -:doc:`info ` Display podman system information - -:doc:`migrate ` Migrate containers - -:doc:`prune ` Remove unused data - -:doc:`renumber ` Migrate lock numbers diff --git a/docs/rtd/source/man/volume.rst b/docs/rtd/source/man/volume.rst deleted file mode 100644 index ee18e4b2e0..0000000000 --- a/docs/rtd/source/man/volume.rst +++ /dev/null @@ -1,11 +0,0 @@ -Volume -====== -:doc:`create ` Create a new volume - -:doc:`inspect ` Display detailed information on one or more volumes - -:doc:`ls ` List volumes - -:doc:`prune ` Remove all unused volumes - -:doc:`rm ` Remove one or more volumes \ No newline at end of file diff --git a/docs/rtd/source/Commands.rst b/docs/source/Commands.rst similarity index 86% rename from docs/rtd/source/Commands.rst rename to docs/source/Commands.rst index f6ba5b20dd..bc34da60b9 100644 --- a/docs/rtd/source/Commands.rst +++ b/docs/source/Commands.rst @@ -8,7 +8,7 @@ Commands :doc:`commit ` Create new image based on the changed container -:doc:`containers ` Manage Containers +:doc:`containers ` Manage Containers :doc:`cp ` Copy files/folders between a container and the local filesystem @@ -22,13 +22,13 @@ Commands :doc:`export ` Export container's filesystem contents as a tar archive -:doc:`generate ` Generated structured data +:doc:`generate ` Generated structured data -:doc:`healthcheck ` Manage Healthcheck +:doc:`healthcheck ` Manage Healthcheck :doc:`history ` Show history of a specified image -:doc:`image ` Manage images +:doc:`image ` Manage images :doc:`images ` List images in local storage @@ -52,13 +52,13 @@ Commands :doc:`mount ` Mount a working container's root filesystem -:doc:`network ` Manage Networks +:doc:`network ` Manage Networks :doc:`pause ` Pause all the processes in one or more containers -:doc:`play ` Play a pod +:doc:`play ` Play a pod -:doc:`pod ` Manage pods +:doc:`pod ` Manage pods :doc:`port ` List port mappings or a specific mapping for the container @@ -86,7 +86,7 @@ Commands :doc:`stop ` Stop one or more containers -:doc:`system ` Manage podman +:doc:`system ` Manage podman :doc:`tag ` Add an additional name to a local image @@ -102,6 +102,6 @@ Commands :doc:`version ` Display the Podman Version Information -:doc:`volume ` Manage volumes +:doc:`volume ` Manage volumes :doc:`wait ` Block on one or more containers \ No newline at end of file diff --git a/docs/rtd/source/Introduction.rst b/docs/source/Introduction.rst similarity index 100% rename from docs/rtd/source/Introduction.rst rename to docs/source/Introduction.rst diff --git a/docs/rtd/source/Reference.rst b/docs/source/Reference.rst similarity index 100% rename from docs/rtd/source/Reference.rst rename to docs/source/Reference.rst diff --git a/docs/rtd/source/Tutorials.rst b/docs/source/Tutorials.rst similarity index 100% rename from docs/rtd/source/Tutorials.rst rename to docs/source/Tutorials.rst diff --git a/docs/rtd/source/conf.py b/docs/source/conf.py similarity index 100% rename from docs/rtd/source/conf.py rename to docs/source/conf.py diff --git a/docs/source/generate.rst b/docs/source/generate.rst new file mode 100644 index 0000000000..79af69146d --- /dev/null +++ b/docs/source/generate.rst @@ -0,0 +1,6 @@ +Generate +======== + +:doc:`kube ` Generate Kubernetes pod YAML from a container or pod + +:doc:`systemd ` Generate a systemd unit file for a Podman container diff --git a/docs/source/healthcheck.rst b/docs/source/healthcheck.rst new file mode 100644 index 0000000000..dc10ceb62c --- /dev/null +++ b/docs/source/healthcheck.rst @@ -0,0 +1,4 @@ +HealthCheck +=========== + +:doc:`run ` run the health check of a container diff --git a/docs/source/image.rst b/docs/source/image.rst new file mode 100644 index 0000000000..b28ad76134 --- /dev/null +++ b/docs/source/image.rst @@ -0,0 +1,35 @@ +Image +===== + + +:doc:`build ` Build an image using instructions from Containerfiles + +:doc:`exists ` Check if an image exists in local storage + +:doc:`history ` Show history of a specified image + +:doc:`import ` Import a tarball to create a filesystem image + +:doc:`inspect ` Display the configuration of an image + +:doc:`list ` List images in local storage + +:doc:`load ` Load an image from container archive + +:doc:`prune ` Remove unused images + +:doc:`pull ` Pull an image from a registry + +:doc:`push ` Push an image to a specified destination + +:doc:`rm ` Removes one or more images from local storage + +:doc:`save ` Save image to an archive + +:doc:`sign ` Sign an image + +:doc:`tag ` Add an additional name to a local image + +:doc:`tree ` Prints layer hierarchy of an image in a tree format + +:doc:`trust ` Manage container image trust policy diff --git a/docs/rtd/source/index.rst b/docs/source/index.rst similarity index 100% rename from docs/rtd/source/index.rst rename to docs/source/index.rst diff --git a/docs/podman-attach.1.md b/docs/source/man/podman-attach.1.md similarity index 100% rename from docs/podman-attach.1.md rename to docs/source/man/podman-attach.1.md diff --git a/docs/podman-build.1.md b/docs/source/man/podman-build.1.md similarity index 100% rename from docs/podman-build.1.md rename to docs/source/man/podman-build.1.md diff --git a/docs/podman-commit.1.md b/docs/source/man/podman-commit.1.md similarity index 100% rename from docs/podman-commit.1.md rename to docs/source/man/podman-commit.1.md diff --git a/docs/podman-container-checkpoint.1.md b/docs/source/man/podman-container-checkpoint.1.md similarity index 100% rename from docs/podman-container-checkpoint.1.md rename to docs/source/man/podman-container-checkpoint.1.md diff --git a/docs/podman-container-cleanup.1.md b/docs/source/man/podman-container-cleanup.1.md similarity index 100% rename from docs/podman-container-cleanup.1.md rename to docs/source/man/podman-container-cleanup.1.md diff --git a/docs/podman-container-exists.1.md b/docs/source/man/podman-container-exists.1.md similarity index 100% rename from docs/podman-container-exists.1.md rename to docs/source/man/podman-container-exists.1.md diff --git a/docs/podman-container-prune.1.md b/docs/source/man/podman-container-prune.1.md similarity index 100% rename from docs/podman-container-prune.1.md rename to docs/source/man/podman-container-prune.1.md diff --git a/docs/podman-container-restore.1.md b/docs/source/man/podman-container-restore.1.md similarity index 100% rename from docs/podman-container-restore.1.md rename to docs/source/man/podman-container-restore.1.md diff --git a/docs/podman-container-runlabel.1.md b/docs/source/man/podman-container-runlabel.1.md similarity index 100% rename from docs/podman-container-runlabel.1.md rename to docs/source/man/podman-container-runlabel.1.md diff --git a/docs/podman-container.1.md b/docs/source/man/podman-container.1.md similarity index 100% rename from docs/podman-container.1.md rename to docs/source/man/podman-container.1.md diff --git a/docs/podman-cp.1.md b/docs/source/man/podman-cp.1.md similarity index 100% rename from docs/podman-cp.1.md rename to docs/source/man/podman-cp.1.md diff --git a/docs/podman-create.1.md b/docs/source/man/podman-create.1.md similarity index 100% rename from docs/podman-create.1.md rename to docs/source/man/podman-create.1.md diff --git a/docs/podman-diff.1.md b/docs/source/man/podman-diff.1.md similarity index 100% rename from docs/podman-diff.1.md rename to docs/source/man/podman-diff.1.md diff --git a/docs/podman-events.1.md b/docs/source/man/podman-events.1.md similarity index 100% rename from docs/podman-events.1.md rename to docs/source/man/podman-events.1.md diff --git a/docs/podman-exec.1.md b/docs/source/man/podman-exec.1.md similarity index 100% rename from docs/podman-exec.1.md rename to docs/source/man/podman-exec.1.md diff --git a/docs/podman-export.1.md b/docs/source/man/podman-export.1.md similarity index 100% rename from docs/podman-export.1.md rename to docs/source/man/podman-export.1.md diff --git a/docs/podman-generate-kube.1.md b/docs/source/man/podman-generate-kube.1.md similarity index 100% rename from docs/podman-generate-kube.1.md rename to docs/source/man/podman-generate-kube.1.md diff --git a/docs/podman-generate-systemd.1.md b/docs/source/man/podman-generate-systemd.1.md similarity index 100% rename from docs/podman-generate-systemd.1.md rename to docs/source/man/podman-generate-systemd.1.md diff --git a/docs/podman-generate.1.md b/docs/source/man/podman-generate.1.md similarity index 100% rename from docs/podman-generate.1.md rename to docs/source/man/podman-generate.1.md diff --git a/docs/podman-healthcheck-run.1.md b/docs/source/man/podman-healthcheck-run.1.md similarity index 100% rename from docs/podman-healthcheck-run.1.md rename to docs/source/man/podman-healthcheck-run.1.md diff --git a/docs/podman-healthcheck.1.md b/docs/source/man/podman-healthcheck.1.md similarity index 100% rename from docs/podman-healthcheck.1.md rename to docs/source/man/podman-healthcheck.1.md diff --git a/docs/podman-history.1.md b/docs/source/man/podman-history.1.md similarity index 100% rename from docs/podman-history.1.md rename to docs/source/man/podman-history.1.md diff --git a/docs/podman-image-exists.1.md b/docs/source/man/podman-image-exists.1.md similarity index 100% rename from docs/podman-image-exists.1.md rename to docs/source/man/podman-image-exists.1.md diff --git a/docs/podman-image-prune.1.md b/docs/source/man/podman-image-prune.1.md similarity index 100% rename from docs/podman-image-prune.1.md rename to docs/source/man/podman-image-prune.1.md diff --git a/docs/podman-image-sign.1.md b/docs/source/man/podman-image-sign.1.md similarity index 100% rename from docs/podman-image-sign.1.md rename to docs/source/man/podman-image-sign.1.md diff --git a/docs/podman-image-tree.1.md b/docs/source/man/podman-image-tree.1.md similarity index 100% rename from docs/podman-image-tree.1.md rename to docs/source/man/podman-image-tree.1.md diff --git a/docs/podman-image-trust.1.md b/docs/source/man/podman-image-trust.1.md similarity index 100% rename from docs/podman-image-trust.1.md rename to docs/source/man/podman-image-trust.1.md diff --git a/docs/podman-image.1.md b/docs/source/man/podman-image.1.md similarity index 100% rename from docs/podman-image.1.md rename to docs/source/man/podman-image.1.md diff --git a/docs/podman-images.1.md b/docs/source/man/podman-images.1.md similarity index 100% rename from docs/podman-images.1.md rename to docs/source/man/podman-images.1.md diff --git a/docs/podman-import.1.md b/docs/source/man/podman-import.1.md similarity index 100% rename from docs/podman-import.1.md rename to docs/source/man/podman-import.1.md diff --git a/docs/podman-info.1.md b/docs/source/man/podman-info.1.md similarity index 100% rename from docs/podman-info.1.md rename to docs/source/man/podman-info.1.md diff --git a/docs/podman-init.1.md b/docs/source/man/podman-init.1.md similarity index 100% rename from docs/podman-init.1.md rename to docs/source/man/podman-init.1.md diff --git a/docs/podman-inspect.1.md b/docs/source/man/podman-inspect.1.md similarity index 100% rename from docs/podman-inspect.1.md rename to docs/source/man/podman-inspect.1.md diff --git a/docs/podman-kill.1.md b/docs/source/man/podman-kill.1.md similarity index 100% rename from docs/podman-kill.1.md rename to docs/source/man/podman-kill.1.md diff --git a/docs/podman-load.1.md b/docs/source/man/podman-load.1.md similarity index 100% rename from docs/podman-load.1.md rename to docs/source/man/podman-load.1.md diff --git a/docs/podman-login.1.md b/docs/source/man/podman-login.1.md similarity index 100% rename from docs/podman-login.1.md rename to docs/source/man/podman-login.1.md diff --git a/docs/podman-logout.1.md b/docs/source/man/podman-logout.1.md similarity index 100% rename from docs/podman-logout.1.md rename to docs/source/man/podman-logout.1.md diff --git a/docs/podman-logs.1.md b/docs/source/man/podman-logs.1.md similarity index 100% rename from docs/podman-logs.1.md rename to docs/source/man/podman-logs.1.md diff --git a/docs/podman-mount.1.md b/docs/source/man/podman-mount.1.md similarity index 100% rename from docs/podman-mount.1.md rename to docs/source/man/podman-mount.1.md diff --git a/docs/podman-network-create.1.md b/docs/source/man/podman-network-create.1.md similarity index 100% rename from docs/podman-network-create.1.md rename to docs/source/man/podman-network-create.1.md diff --git a/docs/podman-network-inspect.1.md b/docs/source/man/podman-network-inspect.1.md similarity index 100% rename from docs/podman-network-inspect.1.md rename to docs/source/man/podman-network-inspect.1.md diff --git a/docs/podman-network-ls.1.md b/docs/source/man/podman-network-ls.1.md similarity index 100% rename from docs/podman-network-ls.1.md rename to docs/source/man/podman-network-ls.1.md diff --git a/docs/podman-network-rm.1.md b/docs/source/man/podman-network-rm.1.md similarity index 100% rename from docs/podman-network-rm.1.md rename to docs/source/man/podman-network-rm.1.md diff --git a/docs/podman-network.1.md b/docs/source/man/podman-network.1.md similarity index 100% rename from docs/podman-network.1.md rename to docs/source/man/podman-network.1.md diff --git a/docs/podman-pause.1.md b/docs/source/man/podman-pause.1.md similarity index 100% rename from docs/podman-pause.1.md rename to docs/source/man/podman-pause.1.md diff --git a/docs/podman-play-kube.1.md b/docs/source/man/podman-play-kube.1.md similarity index 100% rename from docs/podman-play-kube.1.md rename to docs/source/man/podman-play-kube.1.md diff --git a/docs/podman-play.1.md b/docs/source/man/podman-play.1.md similarity index 100% rename from docs/podman-play.1.md rename to docs/source/man/podman-play.1.md diff --git a/docs/podman-pod-create.1.md b/docs/source/man/podman-pod-create.1.md similarity index 100% rename from docs/podman-pod-create.1.md rename to docs/source/man/podman-pod-create.1.md diff --git a/docs/podman-pod-exists.1.md b/docs/source/man/podman-pod-exists.1.md similarity index 100% rename from docs/podman-pod-exists.1.md rename to docs/source/man/podman-pod-exists.1.md diff --git a/docs/podman-pod-inspect.1.md b/docs/source/man/podman-pod-inspect.1.md similarity index 100% rename from docs/podman-pod-inspect.1.md rename to docs/source/man/podman-pod-inspect.1.md diff --git a/docs/podman-pod-kill.1.md b/docs/source/man/podman-pod-kill.1.md similarity index 100% rename from docs/podman-pod-kill.1.md rename to docs/source/man/podman-pod-kill.1.md diff --git a/docs/podman-pod-pause.1.md b/docs/source/man/podman-pod-pause.1.md similarity index 100% rename from docs/podman-pod-pause.1.md rename to docs/source/man/podman-pod-pause.1.md diff --git a/docs/podman-pod-prune.1.md b/docs/source/man/podman-pod-prune.1.md similarity index 100% rename from docs/podman-pod-prune.1.md rename to docs/source/man/podman-pod-prune.1.md diff --git a/docs/podman-pod-ps.1.md b/docs/source/man/podman-pod-ps.1.md similarity index 100% rename from docs/podman-pod-ps.1.md rename to docs/source/man/podman-pod-ps.1.md diff --git a/docs/podman-pod-restart.1.md b/docs/source/man/podman-pod-restart.1.md similarity index 100% rename from docs/podman-pod-restart.1.md rename to docs/source/man/podman-pod-restart.1.md diff --git a/docs/podman-pod-rm.1.md b/docs/source/man/podman-pod-rm.1.md similarity index 100% rename from docs/podman-pod-rm.1.md rename to docs/source/man/podman-pod-rm.1.md diff --git a/docs/podman-pod-start.1.md b/docs/source/man/podman-pod-start.1.md similarity index 100% rename from docs/podman-pod-start.1.md rename to docs/source/man/podman-pod-start.1.md diff --git a/docs/podman-pod-stats.1.md b/docs/source/man/podman-pod-stats.1.md similarity index 100% rename from docs/podman-pod-stats.1.md rename to docs/source/man/podman-pod-stats.1.md diff --git a/docs/podman-pod-stop.1.md b/docs/source/man/podman-pod-stop.1.md similarity index 100% rename from docs/podman-pod-stop.1.md rename to docs/source/man/podman-pod-stop.1.md diff --git a/docs/podman-pod-top.1.md b/docs/source/man/podman-pod-top.1.md similarity index 100% rename from docs/podman-pod-top.1.md rename to docs/source/man/podman-pod-top.1.md diff --git a/docs/podman-pod-unpause.1.md b/docs/source/man/podman-pod-unpause.1.md similarity index 100% rename from docs/podman-pod-unpause.1.md rename to docs/source/man/podman-pod-unpause.1.md diff --git a/docs/podman-pod.1.md b/docs/source/man/podman-pod.1.md similarity index 100% rename from docs/podman-pod.1.md rename to docs/source/man/podman-pod.1.md diff --git a/docs/podman-port.1.md b/docs/source/man/podman-port.1.md similarity index 100% rename from docs/podman-port.1.md rename to docs/source/man/podman-port.1.md diff --git a/docs/podman-ps.1.md b/docs/source/man/podman-ps.1.md similarity index 100% rename from docs/podman-ps.1.md rename to docs/source/man/podman-ps.1.md diff --git a/docs/podman-pull.1.md b/docs/source/man/podman-pull.1.md similarity index 100% rename from docs/podman-pull.1.md rename to docs/source/man/podman-pull.1.md diff --git a/docs/podman-push.1.md b/docs/source/man/podman-push.1.md similarity index 100% rename from docs/podman-push.1.md rename to docs/source/man/podman-push.1.md diff --git a/docs/podman-remote.1.md b/docs/source/man/podman-remote.1.md similarity index 100% rename from docs/podman-remote.1.md rename to docs/source/man/podman-remote.1.md diff --git a/docs/podman-restart.1.md b/docs/source/man/podman-restart.1.md similarity index 100% rename from docs/podman-restart.1.md rename to docs/source/man/podman-restart.1.md diff --git a/docs/podman-rm.1.md b/docs/source/man/podman-rm.1.md similarity index 100% rename from docs/podman-rm.1.md rename to docs/source/man/podman-rm.1.md diff --git a/docs/podman-rmi.1.md b/docs/source/man/podman-rmi.1.md similarity index 100% rename from docs/podman-rmi.1.md rename to docs/source/man/podman-rmi.1.md diff --git a/docs/podman-run.1.md b/docs/source/man/podman-run.1.md similarity index 100% rename from docs/podman-run.1.md rename to docs/source/man/podman-run.1.md diff --git a/docs/podman-save.1.md b/docs/source/man/podman-save.1.md similarity index 100% rename from docs/podman-save.1.md rename to docs/source/man/podman-save.1.md diff --git a/docs/podman-search.1.md b/docs/source/man/podman-search.1.md similarity index 100% rename from docs/podman-search.1.md rename to docs/source/man/podman-search.1.md diff --git a/docs/podman-start.1.md b/docs/source/man/podman-start.1.md similarity index 100% rename from docs/podman-start.1.md rename to docs/source/man/podman-start.1.md diff --git a/docs/podman-stats.1.md b/docs/source/man/podman-stats.1.md similarity index 100% rename from docs/podman-stats.1.md rename to docs/source/man/podman-stats.1.md diff --git a/docs/podman-stop.1.md b/docs/source/man/podman-stop.1.md similarity index 100% rename from docs/podman-stop.1.md rename to docs/source/man/podman-stop.1.md diff --git a/docs/podman-system-df.1.md b/docs/source/man/podman-system-df.1.md similarity index 100% rename from docs/podman-system-df.1.md rename to docs/source/man/podman-system-df.1.md diff --git a/docs/podman-system-migrate.1.md b/docs/source/man/podman-system-migrate.1.md similarity index 100% rename from docs/podman-system-migrate.1.md rename to docs/source/man/podman-system-migrate.1.md diff --git a/docs/podman-system-prune.1.md b/docs/source/man/podman-system-prune.1.md similarity index 100% rename from docs/podman-system-prune.1.md rename to docs/source/man/podman-system-prune.1.md diff --git a/docs/podman-system-renumber.1.md b/docs/source/man/podman-system-renumber.1.md similarity index 100% rename from docs/podman-system-renumber.1.md rename to docs/source/man/podman-system-renumber.1.md diff --git a/docs/podman-system.1.md b/docs/source/man/podman-system.1.md similarity index 100% rename from docs/podman-system.1.md rename to docs/source/man/podman-system.1.md diff --git a/docs/podman-tag.1.md b/docs/source/man/podman-tag.1.md similarity index 100% rename from docs/podman-tag.1.md rename to docs/source/man/podman-tag.1.md diff --git a/docs/podman-top.1.md b/docs/source/man/podman-top.1.md similarity index 100% rename from docs/podman-top.1.md rename to docs/source/man/podman-top.1.md diff --git a/docs/podman-umount.1.md b/docs/source/man/podman-umount.1.md similarity index 100% rename from docs/podman-umount.1.md rename to docs/source/man/podman-umount.1.md diff --git a/docs/podman-unpause.1.md b/docs/source/man/podman-unpause.1.md similarity index 100% rename from docs/podman-unpause.1.md rename to docs/source/man/podman-unpause.1.md diff --git a/docs/podman-unshare.1.md b/docs/source/man/podman-unshare.1.md similarity index 100% rename from docs/podman-unshare.1.md rename to docs/source/man/podman-unshare.1.md diff --git a/docs/podman-varlink.1.md b/docs/source/man/podman-varlink.1.md similarity index 100% rename from docs/podman-varlink.1.md rename to docs/source/man/podman-varlink.1.md diff --git a/docs/podman-version.1.md b/docs/source/man/podman-version.1.md similarity index 100% rename from docs/podman-version.1.md rename to docs/source/man/podman-version.1.md diff --git a/docs/podman-volume-create.1.md b/docs/source/man/podman-volume-create.1.md similarity index 100% rename from docs/podman-volume-create.1.md rename to docs/source/man/podman-volume-create.1.md diff --git a/docs/podman-volume-inspect.1.md b/docs/source/man/podman-volume-inspect.1.md similarity index 100% rename from docs/podman-volume-inspect.1.md rename to docs/source/man/podman-volume-inspect.1.md diff --git a/docs/podman-volume-ls.1.md b/docs/source/man/podman-volume-ls.1.md similarity index 100% rename from docs/podman-volume-ls.1.md rename to docs/source/man/podman-volume-ls.1.md diff --git a/docs/podman-volume-prune.1.md b/docs/source/man/podman-volume-prune.1.md similarity index 100% rename from docs/podman-volume-prune.1.md rename to docs/source/man/podman-volume-prune.1.md diff --git a/docs/podman-volume-rm.1.md b/docs/source/man/podman-volume-rm.1.md similarity index 100% rename from docs/podman-volume-rm.1.md rename to docs/source/man/podman-volume-rm.1.md diff --git a/docs/podman-volume.1.md b/docs/source/man/podman-volume.1.md similarity index 100% rename from docs/podman-volume.1.md rename to docs/source/man/podman-volume.1.md diff --git a/docs/podman-wait.1.md b/docs/source/man/podman-wait.1.md similarity index 100% rename from docs/podman-wait.1.md rename to docs/source/man/podman-wait.1.md diff --git a/docs/podman.1.md b/docs/source/man/podman.1.md similarity index 100% rename from docs/podman.1.md rename to docs/source/man/podman.1.md diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst new file mode 100644 index 0000000000..0607f129d6 --- /dev/null +++ b/docs/source/managecontainers.rst @@ -0,0 +1,64 @@ +Manage Containers +================= + +:doc:`attach ` Attach to a running container + +:doc:`checkpoint ` Checkpoints one or more containers + +:doc:`cleanup ` Cleanup network and mountpoints of one or more containers + +:doc:`commit ` Create new image based on the changed container + +:doc:`cp ` Copy files/folders between a container and the local filesystem + +:doc:`create ` Create but do not start a container + +:doc:`diff ` Inspect changes on container's file systems + +:doc:`exec ` Run a process in a running container + +:doc:`exists ` Check if a container exists in local storage + +:doc:`export ` Export container's filesystem contents as a tar archive + +:doc:`init ` Initialize one or more containers + +:doc:`inspect ` Display the configuration of a container or image + +:doc:`kill ` Kill one or more running containers with a specific signal + +:doc:`list ` List containers + +:doc:`logs ` Fetch the logs of a container + +:doc:`mount ` Mount a working container's root filesystem + +:doc:`pause ` Pause all the processes in one or more containers + +:doc:`port ` List port mappings or a specific mapping for the container + +:doc:`restart ` Restart one or more containers + +:doc:`prune ` Remove all stopped containers + +:doc:`restore ` Restores one or more containers from a checkpoint + +:doc:`rm ` Remove one or more containers + +:doc:`run ` Run a command in a new container + +:doc:`runlabel ` Execute the command described by an image label + +:doc:`start ` Start one or more containers + +:doc:`stats ` Display a live stream of container resource usage statistics + +:doc:`stop ` Stop one or more containers + +:doc:`top ` Display the running processes of a container + +:doc:`umount ` Unmounts working container's root filesystem + +:doc:`unpause ` Unpause the processes in one or more containers + +:doc:`wait ` Block on one or more containers diff --git a/docs/source/network.rst b/docs/source/network.rst new file mode 100644 index 0000000000..aa379bf468 --- /dev/null +++ b/docs/source/network.rst @@ -0,0 +1,10 @@ +Network +===== + +:doc:`create ` network create + +:doc:`inspect ` network inspect + +:doc:`ls ` network list + +:doc:`rm ` network rm \ No newline at end of file diff --git a/docs/source/play.rst b/docs/source/play.rst new file mode 100644 index 0000000000..5e5c02ee1b --- /dev/null +++ b/docs/source/play.rst @@ -0,0 +1,4 @@ +Play +==== + +:doc:`kube ` Play a pod based on Kubernetes YAML diff --git a/docs/source/pod.rst b/docs/source/pod.rst new file mode 100644 index 0000000000..94ed9604aa --- /dev/null +++ b/docs/source/pod.rst @@ -0,0 +1,30 @@ +Pod +=== + +:doc:`create ` Create a new empty pod + +:doc:`exists ` Check if a pod exists in local storage + +:doc:`inspect ` Displays a pod configuration + +:doc:`kill ` Send the specified signal or SIGKILL to containers in pod + +:doc:`pause ` Pause one or more pods + +:doc:`prune ` Remove all stopped pods + +:doc:`ps ` List pods + +:doc:`restart ` Restart one or more pods + +:doc:`rm ` Remove one or more pods + +:doc:`start ` Start one or more pods + +:doc:`stats ` Display a live stream of resource usage statistics for the containers in one or more pods + +:doc:`stop ` Stop one or more pods + +:doc:`top ` Display the running processes of containers in a pod + +:doc:`unpause ` Unpause one or more pods diff --git a/docs/source/system.rst b/docs/source/system.rst new file mode 100644 index 0000000000..a354094540 --- /dev/null +++ b/docs/source/system.rst @@ -0,0 +1,12 @@ +System +====== + +:doc:`df ` Show podman disk usage + +:doc:`info ` Display podman system information + +:doc:`migrate ` Migrate containers + +:doc:`prune ` Remove unused data + +:doc:`renumber ` Migrate lock numbers diff --git a/docs/source/volume.rst b/docs/source/volume.rst new file mode 100644 index 0000000000..a0f31ac34b --- /dev/null +++ b/docs/source/volume.rst @@ -0,0 +1,11 @@ +Volume +====== +:doc:`create ` Create a new volume + +:doc:`inspect ` Display detailed information on one or more volumes + +:doc:`ls ` List volumes + +:doc:`prune ` Remove all unused volumes + +:doc:`rm ` Remove one or more volumes \ No newline at end of file diff --git a/hack/man-page-checker b/hack/man-page-checker index 30d0b21136..6e5cad6b24 100755 --- a/hack/man-page-checker +++ b/hack/man-page-checker @@ -18,7 +18,7 @@ die() { exit 1 } -cd $(dirname $0)/../docs || die "Please run me from top-level libpod dir" +cd $(dirname $0)/../docs/source/man || die "Please run me from top-level libpod dir" rc=0 diff --git a/hack/podman-commands.sh b/hack/podman-commands.sh index 7530e20d06..bd35b03bce 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' Date: Tue, 29 Oct 2019 17:27:12 -0700 Subject: [PATCH 2/2] 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 Signed-off-by: baude --- .gitignore | 2 + Makefile | 41 ++++----- docs/Readme.md | 21 +++++ docs/{podman-remote.sh => remote-docs.sh} | 56 ++++++------ docs/source/Commands.rst | 86 +++++++++---------- docs/source/generate.rst | 4 +- docs/source/healthcheck.rst | 2 +- docs/source/image.rst | 32 +++---- docs/source/managecontainers.rst | 62 ++++++------- .../markdown}/links/podman-container-attach.1 | 0 .../markdown}/links/podman-container-commit.1 | 0 .../markdown}/links/podman-container-cp.1 | 0 .../markdown}/links/podman-container-create.1 | 0 .../markdown}/links/podman-container-diff.1 | 0 .../markdown}/links/podman-container-exec.1 | 0 .../markdown}/links/podman-container-export.1 | 0 .../markdown}/links/podman-container-init.1 | 0 .../links/podman-container-inspect.1 | 0 .../markdown}/links/podman-container-kill.1 | 0 .../markdown}/links/podman-container-list.1 | 0 .../markdown}/links/podman-container-logs.1 | 0 .../markdown}/links/podman-container-ls.1 | 0 .../markdown}/links/podman-container-mount.1 | 0 .../markdown}/links/podman-container-pause.1 | 0 .../markdown}/links/podman-container-port.1 | 0 .../markdown}/links/podman-container-ps.1 | 0 .../links/podman-container-restart.1 | 0 .../markdown}/links/podman-container-rm.1 | 0 .../markdown}/links/podman-container-run.1 | 0 .../markdown}/links/podman-container-start.1 | 0 .../markdown}/links/podman-container-stats.1 | 0 .../markdown}/links/podman-container-stop.1 | 0 .../markdown}/links/podman-container-top.1 | 0 .../markdown}/links/podman-container-umount.1 | 0 .../links/podman-container-unmount.1 | 0 .../links/podman-container-unpause.1 | 0 .../markdown}/links/podman-container-wait.1 | 0 .../{ => source/markdown}/links/podman-help.1 | 0 .../markdown}/links/podman-image-build.1 | 0 .../markdown}/links/podman-image-history.1 | 0 .../markdown}/links/podman-image-import.1 | 0 .../markdown}/links/podman-image-inspect.1 | 0 .../markdown}/links/podman-image-list.1 | 0 .../markdown}/links/podman-image-load.1 | 0 .../markdown}/links/podman-image-ls.1 | 0 .../markdown}/links/podman-image-pull.1 | 0 .../markdown}/links/podman-image-push.1 | 0 .../markdown}/links/podman-image-rm.1 | 0 .../markdown}/links/podman-image-save.1 | 0 .../markdown}/links/podman-image-tag.1 | 0 .../{ => source/markdown}/links/podman-list.1 | 0 docs/{ => source/markdown}/links/podman-ls.1 | 0 .../markdown}/links/podman-system-info.1 | 0 .../markdown}/links/podman-unmount.1 | 0 .../{man => markdown}/podman-attach.1.md | 0 .../{man => markdown}/podman-build.1.md | 0 .../{man => markdown}/podman-commit.1.md | 0 .../podman-container-checkpoint.1.md | 0 .../podman-container-cleanup.1.md | 0 .../podman-container-exists.1.md | 0 .../podman-container-prune.1.md | 0 .../podman-container-restore.1.md | 0 .../podman-container-runlabel.1.md | 0 .../{man => markdown}/podman-container.1.md | 0 docs/source/{man => markdown}/podman-cp.1.md | 0 .../{man => markdown}/podman-create.1.md | 0 .../source/{man => markdown}/podman-diff.1.md | 0 .../{man => markdown}/podman-events.1.md | 0 .../source/{man => markdown}/podman-exec.1.md | 0 .../{man => markdown}/podman-export.1.md | 0 .../podman-generate-kube.1.md | 0 .../podman-generate-systemd.1.md | 0 .../{man => markdown}/podman-generate.1.md | 0 .../podman-healthcheck-run.1.md | 0 .../{man => markdown}/podman-healthcheck.1.md | 0 .../{man => markdown}/podman-history.1.md | 0 .../podman-image-exists.1.md | 0 .../{man => markdown}/podman-image-prune.1.md | 0 .../{man => markdown}/podman-image-sign.1.md | 0 .../{man => markdown}/podman-image-tree.1.md | 0 .../{man => markdown}/podman-image-trust.1.md | 0 .../{man => markdown}/podman-image.1.md | 0 .../{man => markdown}/podman-images.1.md | 0 .../{man => markdown}/podman-import.1.md | 0 .../source/{man => markdown}/podman-info.1.md | 0 .../source/{man => markdown}/podman-init.1.md | 0 .../{man => markdown}/podman-inspect.1.md | 0 .../source/{man => markdown}/podman-kill.1.md | 0 .../source/{man => markdown}/podman-load.1.md | 0 .../{man => markdown}/podman-login.1.md | 0 .../{man => markdown}/podman-logout.1.md | 0 .../source/{man => markdown}/podman-logs.1.md | 0 .../{man => markdown}/podman-mount.1.md | 0 .../podman-network-create.1.md | 0 .../podman-network-inspect.1.md | 0 .../{man => markdown}/podman-network-ls.1.md | 0 .../{man => markdown}/podman-network-rm.1.md | 0 .../{man => markdown}/podman-network.1.md | 0 .../{man => markdown}/podman-pause.1.md | 0 .../{man => markdown}/podman-play-kube.1.md | 0 .../source/{man => markdown}/podman-play.1.md | 0 .../{man => markdown}/podman-pod-create.1.md | 0 .../{man => markdown}/podman-pod-exists.1.md | 0 .../{man => markdown}/podman-pod-inspect.1.md | 0 .../{man => markdown}/podman-pod-kill.1.md | 0 .../{man => markdown}/podman-pod-pause.1.md | 0 .../{man => markdown}/podman-pod-prune.1.md | 0 .../{man => markdown}/podman-pod-ps.1.md | 0 .../{man => markdown}/podman-pod-restart.1.md | 0 .../{man => markdown}/podman-pod-rm.1.md | 0 .../{man => markdown}/podman-pod-start.1.md | 0 .../{man => markdown}/podman-pod-stats.1.md | 0 .../{man => markdown}/podman-pod-stop.1.md | 0 .../{man => markdown}/podman-pod-top.1.md | 0 .../{man => markdown}/podman-pod-unpause.1.md | 0 docs/source/{man => markdown}/podman-pod.1.md | 0 .../source/{man => markdown}/podman-port.1.md | 0 docs/source/{man => markdown}/podman-ps.1.md | 0 .../source/{man => markdown}/podman-pull.1.md | 0 .../source/{man => markdown}/podman-push.1.md | 0 .../{man => markdown}/podman-remote.1.md | 0 .../{man => markdown}/podman-restart.1.md | 0 docs/source/{man => markdown}/podman-rm.1.md | 0 docs/source/{man => markdown}/podman-rmi.1.md | 0 docs/source/{man => markdown}/podman-run.1.md | 0 .../source/{man => markdown}/podman-save.1.md | 0 .../{man => markdown}/podman-search.1.md | 0 .../{man => markdown}/podman-start.1.md | 0 .../{man => markdown}/podman-stats.1.md | 0 .../source/{man => markdown}/podman-stop.1.md | 0 .../{man => markdown}/podman-system-df.1.md | 0 .../podman-system-migrate.1.md | 0 .../podman-system-prune.1.md | 0 .../podman-system-renumber.1.md | 0 .../{man => markdown}/podman-system.1.md | 0 docs/source/{man => markdown}/podman-tag.1.md | 0 docs/source/{man => markdown}/podman-top.1.md | 0 .../{man => markdown}/podman-umount.1.md | 0 .../{man => markdown}/podman-unpause.1.md | 0 .../{man => markdown}/podman-unshare.1.md | 0 .../{man => markdown}/podman-varlink.1.md | 0 .../{man => markdown}/podman-version.1.md | 0 .../podman-volume-create.1.md | 0 .../podman-volume-inspect.1.md | 0 .../{man => markdown}/podman-volume-ls.1.md | 0 .../podman-volume-prune.1.md | 0 .../{man => markdown}/podman-volume-rm.1.md | 0 .../{man => markdown}/podman-volume.1.md | 0 .../source/{man => markdown}/podman-wait.1.md | 0 docs/source/{man => markdown}/podman.1.md | 0 docs/source/network.rst | 8 +- docs/source/play.rst | 2 +- docs/source/pod.rst | 28 +++--- docs/source/system.rst | 10 +-- docs/source/volume.rst | 10 +-- hack/man-page-checker | 2 +- hack/podman-commands.sh | 4 +- 157 files changed, 195 insertions(+), 175 deletions(-) create mode 100644 docs/Readme.md rename docs/{podman-remote.sh => remote-docs.sh} (57%) rename docs/{ => source/markdown}/links/podman-container-attach.1 (100%) rename docs/{ => source/markdown}/links/podman-container-commit.1 (100%) rename docs/{ => source/markdown}/links/podman-container-cp.1 (100%) rename docs/{ => source/markdown}/links/podman-container-create.1 (100%) rename docs/{ => source/markdown}/links/podman-container-diff.1 (100%) rename docs/{ => source/markdown}/links/podman-container-exec.1 (100%) rename docs/{ => source/markdown}/links/podman-container-export.1 (100%) rename docs/{ => source/markdown}/links/podman-container-init.1 (100%) rename docs/{ => source/markdown}/links/podman-container-inspect.1 (100%) rename docs/{ => source/markdown}/links/podman-container-kill.1 (100%) rename docs/{ => source/markdown}/links/podman-container-list.1 (100%) rename docs/{ => source/markdown}/links/podman-container-logs.1 (100%) rename docs/{ => source/markdown}/links/podman-container-ls.1 (100%) rename docs/{ => source/markdown}/links/podman-container-mount.1 (100%) rename docs/{ => source/markdown}/links/podman-container-pause.1 (100%) rename docs/{ => source/markdown}/links/podman-container-port.1 (100%) rename docs/{ => source/markdown}/links/podman-container-ps.1 (100%) rename docs/{ => source/markdown}/links/podman-container-restart.1 (100%) rename docs/{ => source/markdown}/links/podman-container-rm.1 (100%) rename docs/{ => source/markdown}/links/podman-container-run.1 (100%) rename docs/{ => source/markdown}/links/podman-container-start.1 (100%) rename docs/{ => source/markdown}/links/podman-container-stats.1 (100%) rename docs/{ => source/markdown}/links/podman-container-stop.1 (100%) rename docs/{ => source/markdown}/links/podman-container-top.1 (100%) rename docs/{ => source/markdown}/links/podman-container-umount.1 (100%) rename docs/{ => source/markdown}/links/podman-container-unmount.1 (100%) rename docs/{ => source/markdown}/links/podman-container-unpause.1 (100%) rename docs/{ => source/markdown}/links/podman-container-wait.1 (100%) rename docs/{ => source/markdown}/links/podman-help.1 (100%) rename docs/{ => source/markdown}/links/podman-image-build.1 (100%) rename docs/{ => source/markdown}/links/podman-image-history.1 (100%) rename docs/{ => source/markdown}/links/podman-image-import.1 (100%) rename docs/{ => source/markdown}/links/podman-image-inspect.1 (100%) rename docs/{ => source/markdown}/links/podman-image-list.1 (100%) rename docs/{ => source/markdown}/links/podman-image-load.1 (100%) rename docs/{ => source/markdown}/links/podman-image-ls.1 (100%) rename docs/{ => source/markdown}/links/podman-image-pull.1 (100%) rename docs/{ => source/markdown}/links/podman-image-push.1 (100%) rename docs/{ => source/markdown}/links/podman-image-rm.1 (100%) rename docs/{ => source/markdown}/links/podman-image-save.1 (100%) rename docs/{ => source/markdown}/links/podman-image-tag.1 (100%) rename docs/{ => source/markdown}/links/podman-list.1 (100%) rename docs/{ => source/markdown}/links/podman-ls.1 (100%) rename docs/{ => source/markdown}/links/podman-system-info.1 (100%) rename docs/{ => source/markdown}/links/podman-unmount.1 (100%) rename docs/source/{man => markdown}/podman-attach.1.md (100%) rename docs/source/{man => markdown}/podman-build.1.md (100%) rename docs/source/{man => markdown}/podman-commit.1.md (100%) rename docs/source/{man => markdown}/podman-container-checkpoint.1.md (100%) rename docs/source/{man => markdown}/podman-container-cleanup.1.md (100%) rename docs/source/{man => markdown}/podman-container-exists.1.md (100%) rename docs/source/{man => markdown}/podman-container-prune.1.md (100%) rename docs/source/{man => markdown}/podman-container-restore.1.md (100%) rename docs/source/{man => markdown}/podman-container-runlabel.1.md (100%) rename docs/source/{man => markdown}/podman-container.1.md (100%) rename docs/source/{man => markdown}/podman-cp.1.md (100%) rename docs/source/{man => markdown}/podman-create.1.md (100%) rename docs/source/{man => markdown}/podman-diff.1.md (100%) rename docs/source/{man => markdown}/podman-events.1.md (100%) rename docs/source/{man => markdown}/podman-exec.1.md (100%) rename docs/source/{man => markdown}/podman-export.1.md (100%) rename docs/source/{man => markdown}/podman-generate-kube.1.md (100%) rename docs/source/{man => markdown}/podman-generate-systemd.1.md (100%) rename docs/source/{man => markdown}/podman-generate.1.md (100%) rename docs/source/{man => markdown}/podman-healthcheck-run.1.md (100%) rename docs/source/{man => markdown}/podman-healthcheck.1.md (100%) rename docs/source/{man => markdown}/podman-history.1.md (100%) rename docs/source/{man => markdown}/podman-image-exists.1.md (100%) rename docs/source/{man => markdown}/podman-image-prune.1.md (100%) rename docs/source/{man => markdown}/podman-image-sign.1.md (100%) rename docs/source/{man => markdown}/podman-image-tree.1.md (100%) rename docs/source/{man => markdown}/podman-image-trust.1.md (100%) rename docs/source/{man => markdown}/podman-image.1.md (100%) rename docs/source/{man => markdown}/podman-images.1.md (100%) rename docs/source/{man => markdown}/podman-import.1.md (100%) rename docs/source/{man => markdown}/podman-info.1.md (100%) rename docs/source/{man => markdown}/podman-init.1.md (100%) rename docs/source/{man => markdown}/podman-inspect.1.md (100%) rename docs/source/{man => markdown}/podman-kill.1.md (100%) rename docs/source/{man => markdown}/podman-load.1.md (100%) rename docs/source/{man => markdown}/podman-login.1.md (100%) rename docs/source/{man => markdown}/podman-logout.1.md (100%) rename docs/source/{man => markdown}/podman-logs.1.md (100%) rename docs/source/{man => markdown}/podman-mount.1.md (100%) rename docs/source/{man => markdown}/podman-network-create.1.md (100%) rename docs/source/{man => markdown}/podman-network-inspect.1.md (100%) rename docs/source/{man => markdown}/podman-network-ls.1.md (100%) rename docs/source/{man => markdown}/podman-network-rm.1.md (100%) rename docs/source/{man => markdown}/podman-network.1.md (100%) rename docs/source/{man => markdown}/podman-pause.1.md (100%) rename docs/source/{man => markdown}/podman-play-kube.1.md (100%) rename docs/source/{man => markdown}/podman-play.1.md (100%) rename docs/source/{man => markdown}/podman-pod-create.1.md (100%) rename docs/source/{man => markdown}/podman-pod-exists.1.md (100%) rename docs/source/{man => markdown}/podman-pod-inspect.1.md (100%) rename docs/source/{man => markdown}/podman-pod-kill.1.md (100%) rename docs/source/{man => markdown}/podman-pod-pause.1.md (100%) rename docs/source/{man => markdown}/podman-pod-prune.1.md (100%) rename docs/source/{man => markdown}/podman-pod-ps.1.md (100%) rename docs/source/{man => markdown}/podman-pod-restart.1.md (100%) rename docs/source/{man => markdown}/podman-pod-rm.1.md (100%) rename docs/source/{man => markdown}/podman-pod-start.1.md (100%) rename docs/source/{man => markdown}/podman-pod-stats.1.md (100%) rename docs/source/{man => markdown}/podman-pod-stop.1.md (100%) rename docs/source/{man => markdown}/podman-pod-top.1.md (100%) rename docs/source/{man => markdown}/podman-pod-unpause.1.md (100%) rename docs/source/{man => markdown}/podman-pod.1.md (100%) rename docs/source/{man => markdown}/podman-port.1.md (100%) rename docs/source/{man => markdown}/podman-ps.1.md (100%) rename docs/source/{man => markdown}/podman-pull.1.md (100%) rename docs/source/{man => markdown}/podman-push.1.md (100%) rename docs/source/{man => markdown}/podman-remote.1.md (100%) rename docs/source/{man => markdown}/podman-restart.1.md (100%) rename docs/source/{man => markdown}/podman-rm.1.md (100%) rename docs/source/{man => markdown}/podman-rmi.1.md (100%) rename docs/source/{man => markdown}/podman-run.1.md (100%) rename docs/source/{man => markdown}/podman-save.1.md (100%) rename docs/source/{man => markdown}/podman-search.1.md (100%) rename docs/source/{man => markdown}/podman-start.1.md (100%) rename docs/source/{man => markdown}/podman-stats.1.md (100%) rename docs/source/{man => markdown}/podman-stop.1.md (100%) rename docs/source/{man => markdown}/podman-system-df.1.md (100%) rename docs/source/{man => markdown}/podman-system-migrate.1.md (100%) rename docs/source/{man => markdown}/podman-system-prune.1.md (100%) rename docs/source/{man => markdown}/podman-system-renumber.1.md (100%) rename docs/source/{man => markdown}/podman-system.1.md (100%) rename docs/source/{man => markdown}/podman-tag.1.md (100%) rename docs/source/{man => markdown}/podman-top.1.md (100%) rename docs/source/{man => markdown}/podman-umount.1.md (100%) rename docs/source/{man => markdown}/podman-unpause.1.md (100%) rename docs/source/{man => markdown}/podman-unshare.1.md (100%) rename docs/source/{man => markdown}/podman-varlink.1.md (100%) rename docs/source/{man => markdown}/podman-version.1.md (100%) rename docs/source/{man => markdown}/podman-volume-create.1.md (100%) rename docs/source/{man => markdown}/podman-volume-inspect.1.md (100%) rename docs/source/{man => markdown}/podman-volume-ls.1.md (100%) rename docs/source/{man => markdown}/podman-volume-prune.1.md (100%) rename docs/source/{man => markdown}/podman-volume-rm.1.md (100%) rename docs/source/{man => markdown}/podman-volume.1.md (100%) rename docs/source/{man => markdown}/podman-wait.1.md (100%) rename docs/source/{man => markdown}/podman.1.md (100%) diff --git a/.gitignore b/.gitignore index 5983845827..54b63518f1 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 587ab2ec24..73442eb7ce 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 0000000000..4514afa77a --- /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 similarity index 57% rename from docs/podman-remote.sh rename to docs/remote-docs.sh index d8ce4a359b..1440b09267 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 bc34da60b9..276a9c4fb4 100644 --- a/docs/source/Commands.rst +++ b/docs/source/Commands.rst @@ -2,106 +2,106 @@ Commands ======== -:doc:`attach ` Attach to a running container +:doc:`attach ` Attach to a running container -:doc:`build ` Build an image using instructions from Containerfiles +:doc:`build ` Build an image using instructions from Containerfiles -:doc:`commit ` Create new image based on the changed container +:doc:`commit ` Create new image based on the changed container :doc:`containers ` Manage Containers -:doc:`cp ` Copy files/folders between a container and the local filesystem +:doc:`cp ` Copy files/folders between a container and the local filesystem -:doc:`create ` Create but do not start a container +:doc:`create ` Create but do not start a container -:doc:`diff ` Inspect changes on container's file systems +:doc:`diff ` Inspect changes on container's file systems -:doc:`events ` Show podman events +:doc:`events ` Show podman events -:doc:`exec ` Run a process in a running container +:doc:`exec ` Run a process in a running container -:doc:`export ` Export container's filesystem contents as a tar archive +:doc:`export ` Export container's filesystem contents as a tar archive :doc:`generate ` Generated structured data :doc:`healthcheck ` Manage Healthcheck -:doc:`history ` Show history of a specified image +:doc:`history ` Show history of a specified image :doc:`image ` Manage images -:doc:`images ` List images in local storage +:doc:`images ` List images in local storage -:doc:`import ` Import a tarball to create a filesystem image +:doc:`import ` Import a tarball to create a filesystem image -:doc:`info ` Display podman system information +:doc:`info ` Display podman system information -:doc:`init ` Initialize one or more containers +:doc:`init ` Initialize one or more containers -:doc:`inspect ` Display the configuration of a container or image +:doc:`inspect ` Display the configuration of a container or image -:doc:`kill ` Kill one or more running containers with a specific signal +:doc:`kill ` Kill one or more running containers with a specific signal -:doc:`load ` Load an image from container archive +:doc:`load ` Load an image from container archive -:doc:`login ` Login to a container registry +:doc:`login ` Login to a container registry -:doc:`logout ` Logout of a container registry +:doc:`logout ` Logout of a container registry -:doc:`logs ` Fetch the logs of a container +:doc:`logs ` Fetch the logs of a container -:doc:`mount ` Mount a working container's root filesystem +:doc:`mount ` Mount a working container's root filesystem :doc:`network ` Manage Networks -:doc:`pause ` Pause all the processes in one or more containers +:doc:`pause ` Pause all the processes in one or more containers :doc:`play ` Play a pod :doc:`pod ` Manage pods -:doc:`port ` List port mappings or a specific mapping for the container +:doc:`port ` List port mappings or a specific mapping for the container -:doc:`ps ` List containers +:doc:`ps ` List containers -:doc:`pull ` Pull an image from a registry +:doc:`pull ` Pull an image from a registry -:doc:`push ` Push an image to a specified destination +:doc:`push ` Push an image to a specified destination -:doc:`restart ` Restart one or more containers +:doc:`restart ` Restart one or more containers -:doc:`rm ` Remove one or more containers +:doc:`rm ` Remove one or more containers -:doc:`rmi ` Removes one or more images from local storage +:doc:`rmi ` Removes one or more images from local storage -:doc:`run ` Run a command in a new container +:doc:`run ` Run a command in a new container -:doc:`save ` Save image to an archive +:doc:`save ` Save image to an archive -:doc:`search ` Search registry for image +:doc:`search ` Search registry for image -:doc:`start ` Start one or more containers +:doc:`start ` Start one or more containers -:doc:`stats ` Display a live stream of container resource usage statistics +:doc:`stats ` Display a live stream of container resource usage statistics -:doc:`stop ` Stop one or more containers +:doc:`stop ` Stop one or more containers :doc:`system ` Manage podman -:doc:`tag ` Add an additional name to a local image +:doc:`tag ` Add an additional name to a local image -:doc:`top ` Display the running processes of a container +:doc:`top ` Display the running processes of a container -:doc:`umount ` Unmounts working container's root filesystem +:doc:`umount ` Unmounts working container's root filesystem -:doc:`unpause ` Unpause the processes in one or more containers +:doc:`unpause ` Unpause the processes in one or more containers -:doc:`unshare ` Run a command in a modified user namespace +:doc:`unshare ` Run a command in a modified user namespace -:doc:`varlink ` Run varlink interface +:doc:`varlink ` Run varlink interface -:doc:`version ` Display the Podman Version Information +:doc:`version ` Display the Podman Version Information :doc:`volume ` Manage volumes -:doc:`wait ` Block on one or more containers \ No newline at end of file +:doc:`wait ` 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 79af69146d..fd267ce625 100644 --- a/docs/source/generate.rst +++ b/docs/source/generate.rst @@ -1,6 +1,6 @@ Generate ======== -:doc:`kube ` Generate Kubernetes pod YAML from a container or pod +:doc:`kube ` Generate Kubernetes pod YAML from a container or pod -:doc:`systemd ` Generate a systemd unit file for a Podman container +:doc:`systemd ` Generate a systemd unit file for a Podman container diff --git a/docs/source/healthcheck.rst b/docs/source/healthcheck.rst index dc10ceb62c..2e2f88fbcc 100644 --- a/docs/source/healthcheck.rst +++ b/docs/source/healthcheck.rst @@ -1,4 +1,4 @@ HealthCheck =========== -:doc:`run ` run the health check of a container +:doc:`run ` run the health check of a container diff --git a/docs/source/image.rst b/docs/source/image.rst index b28ad76134..a8c6171e1d 100644 --- a/docs/source/image.rst +++ b/docs/source/image.rst @@ -2,34 +2,34 @@ Image ===== -:doc:`build ` Build an image using instructions from Containerfiles +:doc:`build ` Build an image using instructions from Containerfiles -:doc:`exists ` Check if an image exists in local storage +:doc:`exists ` Check if an image exists in local storage -:doc:`history ` Show history of a specified image +:doc:`history ` Show history of a specified image -:doc:`import ` Import a tarball to create a filesystem image +:doc:`import ` Import a tarball to create a filesystem image -:doc:`inspect ` Display the configuration of an image +:doc:`inspect ` Display the configuration of an image -:doc:`list ` List images in local storage +:doc:`list ` List images in local storage -:doc:`load ` Load an image from container archive +:doc:`load ` Load an image from container archive -:doc:`prune ` Remove unused images +:doc:`prune ` Remove unused images -:doc:`pull ` Pull an image from a registry +:doc:`pull ` Pull an image from a registry -:doc:`push ` Push an image to a specified destination +:doc:`push ` Push an image to a specified destination -:doc:`rm ` Removes one or more images from local storage +:doc:`rm ` Removes one or more images from local storage -:doc:`save ` Save image to an archive +:doc:`save ` Save image to an archive -:doc:`sign ` Sign an image +:doc:`sign ` Sign an image -:doc:`tag ` Add an additional name to a local image +:doc:`tag ` Add an additional name to a local image -:doc:`tree ` Prints layer hierarchy of an image in a tree format +:doc:`tree ` Prints layer hierarchy of an image in a tree format -:doc:`trust ` Manage container image trust policy +:doc:`trust ` Manage container image trust policy diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst index 0607f129d6..5c5a83a829 100644 --- a/docs/source/managecontainers.rst +++ b/docs/source/managecontainers.rst @@ -1,64 +1,64 @@ Manage Containers ================= -:doc:`attach ` Attach to a running container +:doc:`attach ` Attach to a running container -:doc:`checkpoint ` Checkpoints one or more containers +:doc:`checkpoint ` Checkpoints one or more containers -:doc:`cleanup ` Cleanup network and mountpoints of one or more containers +:doc:`cleanup ` Cleanup network and mountpoints of one or more containers -:doc:`commit ` Create new image based on the changed container +:doc:`commit ` Create new image based on the changed container -:doc:`cp ` Copy files/folders between a container and the local filesystem +:doc:`cp ` Copy files/folders between a container and the local filesystem -:doc:`create ` Create but do not start a container +:doc:`create ` Create but do not start a container -:doc:`diff ` Inspect changes on container's file systems +:doc:`diff ` Inspect changes on container's file systems -:doc:`exec ` Run a process in a running container +:doc:`exec ` Run a process in a running container -:doc:`exists ` Check if a container exists in local storage +:doc:`exists ` Check if a container exists in local storage -:doc:`export ` Export container's filesystem contents as a tar archive +:doc:`export ` Export container's filesystem contents as a tar archive -:doc:`init ` Initialize one or more containers +:doc:`init ` Initialize one or more containers -:doc:`inspect ` Display the configuration of a container or image +:doc:`inspect ` Display the configuration of a container or image -:doc:`kill ` Kill one or more running containers with a specific signal +:doc:`kill ` Kill one or more running containers with a specific signal -:doc:`list ` List containers +:doc:`list ` List containers -:doc:`logs ` Fetch the logs of a container +:doc:`logs ` Fetch the logs of a container -:doc:`mount ` Mount a working container's root filesystem +:doc:`mount ` Mount a working container's root filesystem -:doc:`pause ` Pause all the processes in one or more containers +:doc:`pause ` Pause all the processes in one or more containers -:doc:`port ` List port mappings or a specific mapping for the container +:doc:`port ` List port mappings or a specific mapping for the container -:doc:`restart ` Restart one or more containers +:doc:`restart ` Restart one or more containers -:doc:`prune ` Remove all stopped containers +:doc:`prune ` Remove all stopped containers -:doc:`restore ` Restores one or more containers from a checkpoint +:doc:`restore ` Restores one or more containers from a checkpoint -:doc:`rm ` Remove one or more containers +:doc:`rm ` Remove one or more containers -:doc:`run ` Run a command in a new container +:doc:`run ` Run a command in a new container -:doc:`runlabel ` Execute the command described by an image label +:doc:`runlabel ` Execute the command described by an image label -:doc:`start ` Start one or more containers +:doc:`start ` Start one or more containers -:doc:`stats ` Display a live stream of container resource usage statistics +:doc:`stats ` Display a live stream of container resource usage statistics -:doc:`stop ` Stop one or more containers +:doc:`stop ` Stop one or more containers -:doc:`top ` Display the running processes of a container +:doc:`top ` Display the running processes of a container -:doc:`umount ` Unmounts working container's root filesystem +:doc:`umount ` Unmounts working container's root filesystem -:doc:`unpause ` Unpause the processes in one or more containers +:doc:`unpause ` Unpause the processes in one or more containers -:doc:`wait ` Block on one or more containers +:doc:`wait ` Block on one or more containers diff --git a/docs/links/podman-container-attach.1 b/docs/source/markdown/links/podman-container-attach.1 similarity index 100% rename from docs/links/podman-container-attach.1 rename to 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 similarity index 100% rename from docs/links/podman-container-commit.1 rename to 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 similarity index 100% rename from docs/links/podman-container-cp.1 rename to 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 similarity index 100% rename from docs/links/podman-container-create.1 rename to 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 similarity index 100% rename from docs/links/podman-container-diff.1 rename to 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 similarity index 100% rename from docs/links/podman-container-exec.1 rename to 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 similarity index 100% rename from docs/links/podman-container-export.1 rename to 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 similarity index 100% rename from docs/links/podman-container-init.1 rename to 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 similarity index 100% rename from docs/links/podman-container-inspect.1 rename to 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 similarity index 100% rename from docs/links/podman-container-kill.1 rename to 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 similarity index 100% rename from docs/links/podman-container-list.1 rename to 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 similarity index 100% rename from docs/links/podman-container-logs.1 rename to 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 similarity index 100% rename from docs/links/podman-container-ls.1 rename to 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 similarity index 100% rename from docs/links/podman-container-mount.1 rename to 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 similarity index 100% rename from docs/links/podman-container-pause.1 rename to 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 similarity index 100% rename from docs/links/podman-container-port.1 rename to 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 similarity index 100% rename from docs/links/podman-container-ps.1 rename to 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 similarity index 100% rename from docs/links/podman-container-restart.1 rename to 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 similarity index 100% rename from docs/links/podman-container-rm.1 rename to 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 similarity index 100% rename from docs/links/podman-container-run.1 rename to 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 similarity index 100% rename from docs/links/podman-container-start.1 rename to 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 similarity index 100% rename from docs/links/podman-container-stats.1 rename to 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 similarity index 100% rename from docs/links/podman-container-stop.1 rename to 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 similarity index 100% rename from docs/links/podman-container-top.1 rename to 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 similarity index 100% rename from docs/links/podman-container-umount.1 rename to 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 similarity index 100% rename from docs/links/podman-container-unmount.1 rename to 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 similarity index 100% rename from docs/links/podman-container-unpause.1 rename to 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 similarity index 100% rename from docs/links/podman-container-wait.1 rename to docs/source/markdown/links/podman-container-wait.1 diff --git a/docs/links/podman-help.1 b/docs/source/markdown/links/podman-help.1 similarity index 100% rename from docs/links/podman-help.1 rename to 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 similarity index 100% rename from docs/links/podman-image-build.1 rename to 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 similarity index 100% rename from docs/links/podman-image-history.1 rename to 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 similarity index 100% rename from docs/links/podman-image-import.1 rename to 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 similarity index 100% rename from docs/links/podman-image-inspect.1 rename to 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 similarity index 100% rename from docs/links/podman-image-list.1 rename to 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 similarity index 100% rename from docs/links/podman-image-load.1 rename to 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 similarity index 100% rename from docs/links/podman-image-ls.1 rename to 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 similarity index 100% rename from docs/links/podman-image-pull.1 rename to 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 similarity index 100% rename from docs/links/podman-image-push.1 rename to 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 similarity index 100% rename from docs/links/podman-image-rm.1 rename to 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 similarity index 100% rename from docs/links/podman-image-save.1 rename to 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 similarity index 100% rename from docs/links/podman-image-tag.1 rename to docs/source/markdown/links/podman-image-tag.1 diff --git a/docs/links/podman-list.1 b/docs/source/markdown/links/podman-list.1 similarity index 100% rename from docs/links/podman-list.1 rename to docs/source/markdown/links/podman-list.1 diff --git a/docs/links/podman-ls.1 b/docs/source/markdown/links/podman-ls.1 similarity index 100% rename from docs/links/podman-ls.1 rename to 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 similarity index 100% rename from docs/links/podman-system-info.1 rename to docs/source/markdown/links/podman-system-info.1 diff --git a/docs/links/podman-unmount.1 b/docs/source/markdown/links/podman-unmount.1 similarity index 100% rename from docs/links/podman-unmount.1 rename to 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 similarity index 100% rename from docs/source/man/podman-attach.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-build.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-commit.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-container-checkpoint.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-container-cleanup.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-container-exists.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-container-prune.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-container-restore.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-container-runlabel.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-container.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-cp.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-create.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-diff.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-events.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-exec.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-export.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-generate-kube.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-generate-systemd.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-generate.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-healthcheck-run.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-healthcheck.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-history.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-image-exists.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-image-prune.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-image-sign.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-image-tree.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-image-trust.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-image.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-images.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-import.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-info.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-init.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-inspect.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-kill.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-load.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-login.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-logout.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-logs.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-mount.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-network-create.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-network-inspect.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-network-ls.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-network-rm.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-network.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pause.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-play-kube.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-play.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-create.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-exists.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-inspect.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-kill.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-pause.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-prune.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-ps.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-restart.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-rm.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-start.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-stats.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-stop.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-top.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod-unpause.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pod.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-port.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-ps.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-pull.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-push.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-remote.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-restart.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-rm.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-rmi.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-run.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-save.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-search.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-start.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-stats.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-stop.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-system-df.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-system-migrate.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-system-prune.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-system-renumber.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-system.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-tag.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-top.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-umount.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-unpause.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-unshare.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-varlink.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-version.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-volume-create.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-volume-inspect.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-volume-ls.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-volume-prune.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-volume-rm.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-volume.1.md rename to 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 similarity index 100% rename from docs/source/man/podman-wait.1.md rename to docs/source/markdown/podman-wait.1.md diff --git a/docs/source/man/podman.1.md b/docs/source/markdown/podman.1.md similarity index 100% rename from docs/source/man/podman.1.md rename to docs/source/markdown/podman.1.md diff --git a/docs/source/network.rst b/docs/source/network.rst index aa379bf468..c1c53bc34f 100644 --- a/docs/source/network.rst +++ b/docs/source/network.rst @@ -1,10 +1,10 @@ Network ===== -:doc:`create ` network create +:doc:`create ` network create -:doc:`inspect ` network inspect +:doc:`inspect ` network inspect -:doc:`ls ` network list +:doc:`ls ` network list -:doc:`rm ` network rm \ No newline at end of file +:doc:`rm ` network rm \ No newline at end of file diff --git a/docs/source/play.rst b/docs/source/play.rst index 5e5c02ee1b..8f00d2f453 100644 --- a/docs/source/play.rst +++ b/docs/source/play.rst @@ -1,4 +1,4 @@ Play ==== -:doc:`kube ` Play a pod based on Kubernetes YAML +:doc:`kube ` Play a pod based on Kubernetes YAML diff --git a/docs/source/pod.rst b/docs/source/pod.rst index 94ed9604aa..391686ce51 100644 --- a/docs/source/pod.rst +++ b/docs/source/pod.rst @@ -1,30 +1,30 @@ Pod === -:doc:`create ` Create a new empty pod +:doc:`create ` Create a new empty pod -:doc:`exists ` Check if a pod exists in local storage +:doc:`exists ` Check if a pod exists in local storage -:doc:`inspect ` Displays a pod configuration +:doc:`inspect ` Displays a pod configuration -:doc:`kill ` Send the specified signal or SIGKILL to containers in pod +:doc:`kill ` Send the specified signal or SIGKILL to containers in pod -:doc:`pause ` Pause one or more pods +:doc:`pause ` Pause one or more pods -:doc:`prune ` Remove all stopped pods +:doc:`prune ` Remove all stopped pods -:doc:`ps ` List pods +:doc:`ps ` List pods -:doc:`restart ` Restart one or more pods +:doc:`restart ` Restart one or more pods -:doc:`rm ` Remove one or more pods +:doc:`rm ` Remove one or more pods -:doc:`start ` Start one or more pods +:doc:`start ` Start one or more pods -:doc:`stats ` Display a live stream of resource usage statistics for the containers in one or more pods +:doc:`stats ` Display a live stream of resource usage statistics for the containers in one or more pods -:doc:`stop ` Stop one or more pods +:doc:`stop ` Stop one or more pods -:doc:`top ` Display the running processes of containers in a pod +:doc:`top ` Display the running processes of containers in a pod -:doc:`unpause ` Unpause one or more pods +:doc:`unpause ` Unpause one or more pods diff --git a/docs/source/system.rst b/docs/source/system.rst index a354094540..2f2b7ea8ff 100644 --- a/docs/source/system.rst +++ b/docs/source/system.rst @@ -1,12 +1,12 @@ System ====== -:doc:`df ` Show podman disk usage +:doc:`df ` Show podman disk usage -:doc:`info ` Display podman system information +:doc:`info ` Display podman system information -:doc:`migrate ` Migrate containers +:doc:`migrate ` Migrate containers -:doc:`prune ` Remove unused data +:doc:`prune ` Remove unused data -:doc:`renumber ` Migrate lock numbers +:doc:`renumber ` Migrate lock numbers diff --git a/docs/source/volume.rst b/docs/source/volume.rst index a0f31ac34b..43fe870544 100644 --- a/docs/source/volume.rst +++ b/docs/source/volume.rst @@ -1,11 +1,11 @@ Volume ====== -:doc:`create ` Create a new volume +:doc:`create ` Create a new volume -:doc:`inspect ` Display detailed information on one or more volumes +:doc:`inspect ` Display detailed information on one or more volumes -:doc:`ls ` List volumes +:doc:`ls ` List volumes -:doc:`prune ` Remove all unused volumes +:doc:`prune ` Remove all unused volumes -:doc:`rm ` Remove one or more volumes \ No newline at end of file +:doc:`rm ` Remove one or more volumes \ No newline at end of file diff --git a/hack/man-page-checker b/hack/man-page-checker index 6e5cad6b24..99d2805396 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 bd35b03bce..32f94fc7b4 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'