diff options
author | baude <bbaude@redhat.com> | 2019-10-24 14:54:57 -0500 |
---|---|---|
committer | baude <bbaude@redhat.com> | 2019-10-31 12:31:39 -0500 |
commit | 52b92023edeba3a5e2c466d92d742e54b14a85cb (patch) | |
tree | 44e6193d49afd1277b7d07b0df41fc80d31b3adb | |
parent | 5af166ff513265b17aee92a9ce3a1522090d7dec (diff) | |
download | podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2 podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip |
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 <bbaude@redhat.com>
-rw-r--r-- | Makefile | 26 | ||||
-rw-r--r-- | docs/Makefile | 23 | ||||
-rw-r--r-- | docs/make.bat (renamed from docs/rtd/make.bat) | 0 | ||||
-rwxr-xr-x | docs/podman-remote.sh | 5 | ||||
-rw-r--r-- | docs/requirements.txt (renamed from docs/rtd/requirements.txt) | 0 | ||||
-rw-r--r-- | docs/rtd/Makefile | 123 | ||||
-rw-r--r-- | docs/rtd/source/man/generate.rst | 6 | ||||
-rw-r--r-- | docs/rtd/source/man/healthcheck.rst | 4 | ||||
-rw-r--r-- | docs/rtd/source/man/image.rst | 35 | ||||
-rw-r--r-- | docs/rtd/source/man/managecontainers.rst | 64 | ||||
-rw-r--r-- | docs/rtd/source/man/network.rst | 10 | ||||
-rw-r--r-- | docs/rtd/source/man/play.rst | 4 | ||||
-rw-r--r-- | docs/rtd/source/man/pod.rst | 30 | ||||
-rw-r--r-- | docs/rtd/source/man/system.rst | 12 | ||||
-rw-r--r-- | docs/rtd/source/man/volume.rst | 11 | ||||
-rw-r--r-- | docs/source/Commands.rst (renamed from docs/rtd/source/Commands.rst) | 18 | ||||
-rw-r--r-- | docs/source/Introduction.rst (renamed from docs/rtd/source/Introduction.rst) | 0 | ||||
-rw-r--r-- | docs/source/Reference.rst (renamed from docs/rtd/source/Reference.rst) | 0 | ||||
-rw-r--r-- | docs/source/Tutorials.rst (renamed from docs/rtd/source/Tutorials.rst) | 0 | ||||
-rw-r--r-- | docs/source/conf.py (renamed from docs/rtd/source/conf.py) | 0 | ||||
-rw-r--r-- | docs/source/generate.rst | 6 | ||||
-rw-r--r-- | docs/source/healthcheck.rst | 4 | ||||
-rw-r--r-- | docs/source/image.rst | 35 | ||||
-rw-r--r-- | docs/source/index.rst (renamed from docs/rtd/source/index.rst) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-attach.1.md (renamed from docs/podman-attach.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-build.1.md (renamed from docs/podman-build.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-commit.1.md (renamed from docs/podman-commit.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-container-checkpoint.1.md (renamed from docs/podman-container-checkpoint.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-container-cleanup.1.md (renamed from docs/podman-container-cleanup.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-container-exists.1.md (renamed from docs/podman-container-exists.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-container-prune.1.md (renamed from docs/podman-container-prune.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-container-restore.1.md (renamed from docs/podman-container-restore.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-container-runlabel.1.md (renamed from docs/podman-container-runlabel.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-container.1.md (renamed from docs/podman-container.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-cp.1.md (renamed from docs/podman-cp.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-create.1.md (renamed from docs/podman-create.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-diff.1.md (renamed from docs/podman-diff.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-events.1.md (renamed from docs/podman-events.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-exec.1.md (renamed from docs/podman-exec.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-export.1.md (renamed from docs/podman-export.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-generate-kube.1.md (renamed from docs/podman-generate-kube.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-generate-systemd.1.md (renamed from docs/podman-generate-systemd.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-generate.1.md (renamed from docs/podman-generate.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-healthcheck-run.1.md (renamed from docs/podman-healthcheck-run.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-healthcheck.1.md (renamed from docs/podman-healthcheck.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-history.1.md (renamed from docs/podman-history.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-image-exists.1.md (renamed from docs/podman-image-exists.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-image-prune.1.md (renamed from docs/podman-image-prune.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-image-sign.1.md (renamed from docs/podman-image-sign.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-image-tree.1.md (renamed from docs/podman-image-tree.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-image-trust.1.md (renamed from docs/podman-image-trust.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-image.1.md (renamed from docs/podman-image.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-images.1.md (renamed from docs/podman-images.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-import.1.md (renamed from docs/podman-import.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-info.1.md (renamed from docs/podman-info.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-init.1.md (renamed from docs/podman-init.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-inspect.1.md (renamed from docs/podman-inspect.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-kill.1.md (renamed from docs/podman-kill.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-load.1.md (renamed from docs/podman-load.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-login.1.md (renamed from docs/podman-login.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-logout.1.md (renamed from docs/podman-logout.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-logs.1.md (renamed from docs/podman-logs.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-mount.1.md (renamed from docs/podman-mount.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-network-create.1.md (renamed from docs/podman-network-create.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-network-inspect.1.md (renamed from docs/podman-network-inspect.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-network-ls.1.md (renamed from docs/podman-network-ls.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-network-rm.1.md (renamed from docs/podman-network-rm.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-network.1.md (renamed from docs/podman-network.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pause.1.md (renamed from docs/podman-pause.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-play-kube.1.md (renamed from docs/podman-play-kube.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-play.1.md (renamed from docs/podman-play.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-create.1.md (renamed from docs/podman-pod-create.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-exists.1.md (renamed from docs/podman-pod-exists.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-inspect.1.md (renamed from docs/podman-pod-inspect.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-kill.1.md (renamed from docs/podman-pod-kill.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-pause.1.md (renamed from docs/podman-pod-pause.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-prune.1.md (renamed from docs/podman-pod-prune.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-ps.1.md (renamed from docs/podman-pod-ps.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-restart.1.md (renamed from docs/podman-pod-restart.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-rm.1.md (renamed from docs/podman-pod-rm.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-start.1.md (renamed from docs/podman-pod-start.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-stats.1.md (renamed from docs/podman-pod-stats.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-stop.1.md (renamed from docs/podman-pod-stop.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-top.1.md (renamed from docs/podman-pod-top.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod-unpause.1.md (renamed from docs/podman-pod-unpause.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pod.1.md (renamed from docs/podman-pod.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-port.1.md (renamed from docs/podman-port.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-ps.1.md (renamed from docs/podman-ps.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-pull.1.md (renamed from docs/podman-pull.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-push.1.md (renamed from docs/podman-push.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-remote.1.md (renamed from docs/podman-remote.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-restart.1.md (renamed from docs/podman-restart.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-rm.1.md (renamed from docs/podman-rm.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-rmi.1.md (renamed from docs/podman-rmi.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-run.1.md (renamed from docs/podman-run.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-save.1.md (renamed from docs/podman-save.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-search.1.md (renamed from docs/podman-search.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-start.1.md (renamed from docs/podman-start.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-stats.1.md (renamed from docs/podman-stats.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-stop.1.md (renamed from docs/podman-stop.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-system-df.1.md (renamed from docs/podman-system-df.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-system-migrate.1.md (renamed from docs/podman-system-migrate.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-system-prune.1.md (renamed from docs/podman-system-prune.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-system-renumber.1.md (renamed from docs/podman-system-renumber.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-system.1.md (renamed from docs/podman-system.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-tag.1.md (renamed from docs/podman-tag.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-top.1.md (renamed from docs/podman-top.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-umount.1.md (renamed from docs/podman-umount.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-unpause.1.md (renamed from docs/podman-unpause.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-unshare.1.md (renamed from docs/podman-unshare.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-varlink.1.md (renamed from docs/podman-varlink.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-version.1.md (renamed from docs/podman-version.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-volume-create.1.md (renamed from docs/podman-volume-create.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-volume-inspect.1.md (renamed from docs/podman-volume-inspect.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-volume-ls.1.md (renamed from docs/podman-volume-ls.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-volume-prune.1.md (renamed from docs/podman-volume-prune.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-volume-rm.1.md (renamed from docs/podman-volume-rm.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-volume.1.md (renamed from docs/podman-volume.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman-wait.1.md (renamed from docs/podman-wait.1.md) | 0 | ||||
-rw-r--r-- | docs/source/man/podman.1.md (renamed from docs/podman.1.md) | 0 | ||||
-rw-r--r-- | docs/source/managecontainers.rst | 64 | ||||
-rw-r--r-- | docs/source/network.rst | 10 | ||||
-rw-r--r-- | docs/source/play.rst | 4 | ||||
-rw-r--r-- | docs/source/pod.rst | 30 | ||||
-rw-r--r-- | docs/source/system.rst | 12 | ||||
-rw-r--r-- | docs/source/volume.rst | 11 | ||||
-rwxr-xr-x | hack/man-page-checker | 2 | ||||
-rwxr-xr-x | hack/podman-commands.sh | 6 |
128 files changed, 228 insertions, 327 deletions
@@ -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 000000000..fb67e266c --- /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 index 6247f7e23..6247f7e23 100644 --- a/docs/rtd/make.bat +++ b/docs/make.bat diff --git a/docs/podman-remote.sh b/docs/podman-remote.sh index 2f8e76d1b..d8ce4a359 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 index 44af373ac..44af373ac 100644 --- a/docs/rtd/requirements.txt +++ b/docs/requirements.txt diff --git a/docs/rtd/Makefile b/docs/rtd/Makefile deleted file mode 100644 index 50af6490a..000000000 --- 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 e82a15735..000000000 --- a/docs/rtd/source/man/generate.rst +++ /dev/null @@ -1,6 +0,0 @@ -Generate -======== - -:doc:`kube <podman-generate-kube.1>` Generate Kubernetes pod YAML from a container or pod - -:doc:`systemd <podman-generate-systemd.1>` 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 697c1358b..000000000 --- a/docs/rtd/source/man/healthcheck.rst +++ /dev/null @@ -1,4 +0,0 @@ -HealthCheck -=========== - -:doc:`run <podman-healthcheck-run.1>` 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 ad963cd41..000000000 --- a/docs/rtd/source/man/image.rst +++ /dev/null @@ -1,35 +0,0 @@ -Image -===== - - -:doc:`build <podman-build.1>` Build an image using instructions from Containerfiles - -:doc:`exists <podman-image-exists.1>` Check if an image exists in local storage - -:doc:`history <podman-history.1>` Show history of a specified image - -:doc:`import <podman-import.1>` Import a tarball to create a filesystem image - -:doc:`inspect <podman-inspect.1>` Display the configuration of an image - -:doc:`list <podman-images.1>` List images in local storage - -:doc:`load <podman-load.1>` Load an image from container archive - -:doc:`prune <podman-image-prune.1>` Remove unused images - -:doc:`pull <podman-pull.1>` Pull an image from a registry - -:doc:`push <podman-push.1>` Push an image to a specified destination - -:doc:`rm <podman-rmi.1>` Removes one or more images from local storage - -:doc:`save <podman-save.1>` Save image to an archive - -:doc:`sign <podman-image-sign.1>` Sign an image - -:doc:`tag <podman-tag.1>` Add an additional name to a local image - -:doc:`tree <podman-image-tree.1>` Prints layer hierarchy of an image in a tree format - -:doc:`trust <podman-image-trust.1>` 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 20e8c0679..000000000 --- a/docs/rtd/source/man/managecontainers.rst +++ /dev/null @@ -1,64 +0,0 @@ -Manage Containers -================= - -:doc:`attach <podman-attach.1>` Attach to a running container - -:doc:`checkpoint <podman-container-checkpoint.1>` Checkpoints one or more containers - -:doc:`cleanup <podman-container-cleanup.1>` Cleanup network and mountpoints of one or more containers - -:doc:`commit <podman-commit.1>` Create new image based on the changed container - -:doc:`cp <podman-cp.1>` Copy files/folders between a container and the local filesystem - -:doc:`create <podman-create.1>` Create but do not start a container - -:doc:`diff <podman-diff.1>` Inspect changes on container's file systems - -:doc:`exec <podman-exec.1>` Run a process in a running container - -:doc:`exists <podman-exists.1>` Check if a container exists in local storage - -:doc:`export <podman-export.1>` Export container's filesystem contents as a tar archive - -:doc:`init <podman-init.1>` Initialize one or more containers - -:doc:`inspect <podman-inspect.1>` Display the configuration of a container or image - -:doc:`kill <podman-kill.1>` Kill one or more running containers with a specific signal - -:doc:`list <podman-ps.1>` List containers - -:doc:`logs <podman-logs.1>` Fetch the logs of a container - -:doc:`mount <podman-mount.1>` Mount a working container's root filesystem - -:doc:`pause <podman-pause.1>` Pause all the processes in one or more containers - -:doc:`port <podman-port.1>` List port mappings or a specific mapping for the container - -:doc:`restart <podman-restart.1>` Restart one or more containers - -:doc:`prune <podman-container-prune.1>` Remove all stopped containers - -:doc:`restore <podman-container-restore.1>` Restores one or more containers from a checkpoint - -:doc:`rm <podman-rm.1>` Remove one or more containers - -:doc:`run <podman-run.1>` Run a command in a new container - -:doc:`runlabel <podman-container-runlabel.1>` Execute the command described by an image label - -:doc:`start <podman-start.1>` Start one or more containers - -:doc:`stats <podman-stats.1>` Display a live stream of container resource usage statistics - -:doc:`stop <podman-stop.1>` Stop one or more containers - -:doc:`top <podman-top.1>` Display the running processes of a container - -:doc:`umount <podman-umount.1>` Unmounts working container's root filesystem - -:doc:`unpause <podman-unpause.1>` Unpause the processes in one or more containers - -:doc:`wait <podman-wait.1>` 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 6d6a4c022..000000000 --- a/docs/rtd/source/man/network.rst +++ /dev/null @@ -1,10 +0,0 @@ -Network -===== - -:doc:`create <podman-network-create.1>` network create - -:doc:`inspect <podman-network-inspect.1>` network inspect - -:doc:`ls <podman-network-ls.1>` network list - -:doc:`rm <podman-network-rm.1>` 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 93e1a9a1e..000000000 --- a/docs/rtd/source/man/play.rst +++ /dev/null @@ -1,4 +0,0 @@ -Play -==== - -:doc:`kube <podman-play-kube.1>` 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 13c1740f8..000000000 --- a/docs/rtd/source/man/pod.rst +++ /dev/null @@ -1,30 +0,0 @@ -Pod -=== - -:doc:`create <podman-pod-create.1>` Create a new empty pod - -:doc:`exists <podman-pod-exists.1>` Check if a pod exists in local storage - -:doc:`inspect <podman-pod-inspect.1>` Displays a pod configuration - -:doc:`kill <podman-pod-kill.1>` Send the specified signal or SIGKILL to containers in pod - -:doc:`pause <podman-pause.1>` Pause one or more pods - -:doc:`prune <podman-pod-prune.1>` Remove all stopped pods - -:doc:`ps <podman-pod-ps.1>` List pods - -:doc:`restart <podman-pod-restart.1>` Restart one or more pods - -:doc:`rm <podman-pod-rm.1>` Remove one or more pods - -:doc:`start <podman-pod-start.1>` Start one or more pods - -:doc:`stats <podman-pod-stats.1>` Display a live stream of resource usage statistics for the containers in one or more pods - -:doc:`stop <podman-pod-stop.1>` Stop one or more pods - -:doc:`top <podman-pod-top.1>` Display the running processes of containers in a pod - -:doc:`unpause <podman-pod-unpause.1>` 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 764ec01c1..000000000 --- a/docs/rtd/source/man/system.rst +++ /dev/null @@ -1,12 +0,0 @@ -System -====== - -:doc:`df <podman-system-df.1>` Show podman disk usage - -:doc:`info <podman-info.1>` Display podman system information - -:doc:`migrate <podman-system-migrate.1>` Migrate containers - -:doc:`prune <podman-system-prune.1>` Remove unused data - -:doc:`renumber <podman-system-renumber.1>` Migrate lock numbers diff --git a/docs/rtd/source/man/volume.rst b/docs/rtd/source/man/volume.rst deleted file mode 100644 index ee18e4b2e..000000000 --- a/docs/rtd/source/man/volume.rst +++ /dev/null @@ -1,11 +0,0 @@ -Volume -====== -:doc:`create <podman-volume-create.1>` Create a new volume - -:doc:`inspect <podman-volume-inspect.1>` Display detailed information on one or more volumes - -:doc:`ls <podman-volume-ls.1>` List volumes - -:doc:`prune <podman-volume-prune.1>` Remove all unused volumes - -:doc:`rm <podman-volume-rm.1>` Remove one or more volumes
\ No newline at end of file diff --git a/docs/rtd/source/Commands.rst b/docs/source/Commands.rst index f6ba5b20d..bc34da60b 100644 --- a/docs/rtd/source/Commands.rst +++ b/docs/source/Commands.rst @@ -8,7 +8,7 @@ Commands :doc:`commit <man/podman-commit.1>` Create new image based on the changed container -:doc:`containers <man/managecontainers>` Manage Containers +:doc:`containers <managecontainers>` Manage Containers :doc:`cp <man/podman-cp.1>` Copy files/folders between a container and the local filesystem @@ -22,13 +22,13 @@ Commands :doc:`export <man/podman-export.1>` Export container's filesystem contents as a tar archive -:doc:`generate <man/generate>` Generated structured data +:doc:`generate <generate>` Generated structured data -:doc:`healthcheck <man/healthcheck>` Manage Healthcheck +:doc:`healthcheck <healthcheck>` Manage Healthcheck :doc:`history <man/podman-history.1>` Show history of a specified image -:doc:`image <man/image>` Manage images +:doc:`image <image>` Manage images :doc:`images <man/podman-images.1>` List images in local storage @@ -52,13 +52,13 @@ Commands :doc:`mount <man/podman-mount.1>` Mount a working container's root filesystem -:doc:`network <man/network>` Manage Networks +:doc:`network <network>` Manage Networks :doc:`pause <man/podman-pause.1>` Pause all the processes in one or more containers -:doc:`play <man/play>` Play a pod +:doc:`play <play>` Play a pod -:doc:`pod <man/pod>` Manage pods +:doc:`pod <pod>` Manage pods :doc:`port <man/podman-port.1>` List port mappings or a specific mapping for the container @@ -86,7 +86,7 @@ Commands :doc:`stop <man/podman-stop.1>` Stop one or more containers -:doc:`system <man/system>` Manage podman +:doc:`system <system>` Manage podman :doc:`tag <man/podman-tag.1>` Add an additional name to a local image @@ -102,6 +102,6 @@ Commands :doc:`version <man/podman-version.1>` Display the Podman Version Information -:doc:`volume <man/volume>` Manage volumes +:doc:`volume <volume>` Manage volumes :doc:`wait <man/podman-wait.1>` 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 index c516b3317..c516b3317 100644 --- a/docs/rtd/source/Introduction.rst +++ b/docs/source/Introduction.rst diff --git a/docs/rtd/source/Reference.rst b/docs/source/Reference.rst index 9a771c87f..9a771c87f 100644 --- a/docs/rtd/source/Reference.rst +++ b/docs/source/Reference.rst diff --git a/docs/rtd/source/Tutorials.rst b/docs/source/Tutorials.rst index 0c7e28c3b..0c7e28c3b 100644 --- a/docs/rtd/source/Tutorials.rst +++ b/docs/source/Tutorials.rst diff --git a/docs/rtd/source/conf.py b/docs/source/conf.py index d95290f72..d95290f72 100644 --- a/docs/rtd/source/conf.py +++ b/docs/source/conf.py diff --git a/docs/source/generate.rst b/docs/source/generate.rst new file mode 100644 index 000000000..79af69146 --- /dev/null +++ b/docs/source/generate.rst @@ -0,0 +1,6 @@ +Generate +======== + +:doc:`kube <man/podman-generate-kube.1>` Generate Kubernetes pod YAML from a container or pod + +:doc:`systemd <man/podman-generate-systemd.1>` Generate a systemd unit file for a Podman container diff --git a/docs/source/healthcheck.rst b/docs/source/healthcheck.rst new file mode 100644 index 000000000..dc10ceb62 --- /dev/null +++ b/docs/source/healthcheck.rst @@ -0,0 +1,4 @@ +HealthCheck +=========== + +:doc:`run <man/podman-healthcheck-run.1>` run the health check of a container diff --git a/docs/source/image.rst b/docs/source/image.rst new file mode 100644 index 000000000..b28ad7613 --- /dev/null +++ b/docs/source/image.rst @@ -0,0 +1,35 @@ +Image +===== + + +:doc:`build <man/podman-build.1>` Build an image using instructions from Containerfiles + +:doc:`exists <man/podman-image-exists.1>` Check if an image exists in local storage + +:doc:`history <man/podman-history.1>` Show history of a specified image + +:doc:`import <man/podman-import.1>` Import a tarball to create a filesystem image + +:doc:`inspect <man/podman-inspect.1>` Display the configuration of an image + +:doc:`list <man/podman-images.1>` List images in local storage + +:doc:`load <man/podman-load.1>` Load an image from container archive + +:doc:`prune <man/podman-image-prune.1>` Remove unused images + +:doc:`pull <man/podman-pull.1>` Pull an image from a registry + +:doc:`push <man/podman-push.1>` Push an image to a specified destination + +:doc:`rm <man/podman-rmi.1>` Removes one or more images from local storage + +:doc:`save <man/podman-save.1>` Save image to an archive + +:doc:`sign <man/podman-image-sign.1>` Sign an image + +:doc:`tag <man/podman-tag.1>` Add an additional name to a local image + +:doc:`tree <man/podman-image-tree.1>` Prints layer hierarchy of an image in a tree format + +:doc:`trust <man/podman-image-trust.1>` Manage container image trust policy diff --git a/docs/rtd/source/index.rst b/docs/source/index.rst index 9dd61a6a6..9dd61a6a6 100644 --- a/docs/rtd/source/index.rst +++ b/docs/source/index.rst diff --git a/docs/podman-attach.1.md b/docs/source/man/podman-attach.1.md index cef01f0f6..cef01f0f6 100644 --- a/docs/podman-attach.1.md +++ b/docs/source/man/podman-attach.1.md diff --git a/docs/podman-build.1.md b/docs/source/man/podman-build.1.md index 567d0ead3..567d0ead3 100644 --- a/docs/podman-build.1.md +++ b/docs/source/man/podman-build.1.md diff --git a/docs/podman-commit.1.md b/docs/source/man/podman-commit.1.md index 07a885ae2..07a885ae2 100644 --- a/docs/podman-commit.1.md +++ b/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 index 034d338bb..034d338bb 100644 --- a/docs/podman-container-checkpoint.1.md +++ b/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 index 69e21ce9f..69e21ce9f 100644 --- a/docs/podman-container-cleanup.1.md +++ b/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 index 4d988132b..4d988132b 100644 --- a/docs/podman-container-exists.1.md +++ b/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 index d8a4b7f4e..d8a4b7f4e 100644 --- a/docs/podman-container-prune.1.md +++ b/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 index 1d2cf0b3e..1d2cf0b3e 100644 --- a/docs/podman-container-restore.1.md +++ b/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 index 8511dd5cd..8511dd5cd 100644 --- a/docs/podman-container-runlabel.1.md +++ b/docs/source/man/podman-container-runlabel.1.md diff --git a/docs/podman-container.1.md b/docs/source/man/podman-container.1.md index 4ea7c7acc..4ea7c7acc 100644 --- a/docs/podman-container.1.md +++ b/docs/source/man/podman-container.1.md diff --git a/docs/podman-cp.1.md b/docs/source/man/podman-cp.1.md index 0f54b2e8b..0f54b2e8b 100644 --- a/docs/podman-cp.1.md +++ b/docs/source/man/podman-cp.1.md diff --git a/docs/podman-create.1.md b/docs/source/man/podman-create.1.md index 6617850fd..6617850fd 100644 --- a/docs/podman-create.1.md +++ b/docs/source/man/podman-create.1.md diff --git a/docs/podman-diff.1.md b/docs/source/man/podman-diff.1.md index 5b0434a07..5b0434a07 100644 --- a/docs/podman-diff.1.md +++ b/docs/source/man/podman-diff.1.md diff --git a/docs/podman-events.1.md b/docs/source/man/podman-events.1.md index bb1923574..bb1923574 100644 --- a/docs/podman-events.1.md +++ b/docs/source/man/podman-events.1.md diff --git a/docs/podman-exec.1.md b/docs/source/man/podman-exec.1.md index 4c17c056a..4c17c056a 100644 --- a/docs/podman-exec.1.md +++ b/docs/source/man/podman-exec.1.md diff --git a/docs/podman-export.1.md b/docs/source/man/podman-export.1.md index 4286d0e2f..4286d0e2f 100644 --- a/docs/podman-export.1.md +++ b/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 index f4b4cd482..f4b4cd482 100644 --- a/docs/podman-generate-kube.1.md +++ b/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 index b81e68a46..b81e68a46 100644 --- a/docs/podman-generate-systemd.1.md +++ b/docs/source/man/podman-generate-systemd.1.md diff --git a/docs/podman-generate.1.md b/docs/source/man/podman-generate.1.md index 50050f2c1..50050f2c1 100644 --- a/docs/podman-generate.1.md +++ b/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 index 21f2d9b20..21f2d9b20 100644 --- a/docs/podman-healthcheck-run.1.md +++ b/docs/source/man/podman-healthcheck-run.1.md diff --git a/docs/podman-healthcheck.1.md b/docs/source/man/podman-healthcheck.1.md index 91c3e4345..91c3e4345 100644 --- a/docs/podman-healthcheck.1.md +++ b/docs/source/man/podman-healthcheck.1.md diff --git a/docs/podman-history.1.md b/docs/source/man/podman-history.1.md index a67cb0286..a67cb0286 100644 --- a/docs/podman-history.1.md +++ b/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 index f6a89e2aa..f6a89e2aa 100644 --- a/docs/podman-image-exists.1.md +++ b/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 index b844a9f63..b844a9f63 100644 --- a/docs/podman-image-prune.1.md +++ b/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 index 62845e715..62845e715 100644 --- a/docs/podman-image-sign.1.md +++ b/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 index c4624e05c..c4624e05c 100644 --- a/docs/podman-image-tree.1.md +++ b/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 index 3fe4f7f52..3fe4f7f52 100644 --- a/docs/podman-image-trust.1.md +++ b/docs/source/man/podman-image-trust.1.md diff --git a/docs/podman-image.1.md b/docs/source/man/podman-image.1.md index 339a531dd..339a531dd 100644 --- a/docs/podman-image.1.md +++ b/docs/source/man/podman-image.1.md diff --git a/docs/podman-images.1.md b/docs/source/man/podman-images.1.md index 3ac07fc43..3ac07fc43 100644 --- a/docs/podman-images.1.md +++ b/docs/source/man/podman-images.1.md diff --git a/docs/podman-import.1.md b/docs/source/man/podman-import.1.md index 946b680dd..946b680dd 100644 --- a/docs/podman-import.1.md +++ b/docs/source/man/podman-import.1.md diff --git a/docs/podman-info.1.md b/docs/source/man/podman-info.1.md index 9721755ef..9721755ef 100644 --- a/docs/podman-info.1.md +++ b/docs/source/man/podman-info.1.md diff --git a/docs/podman-init.1.md b/docs/source/man/podman-init.1.md index 3b49cfb99..3b49cfb99 100644 --- a/docs/podman-init.1.md +++ b/docs/source/man/podman-init.1.md diff --git a/docs/podman-inspect.1.md b/docs/source/man/podman-inspect.1.md index f1630c713..f1630c713 100644 --- a/docs/podman-inspect.1.md +++ b/docs/source/man/podman-inspect.1.md diff --git a/docs/podman-kill.1.md b/docs/source/man/podman-kill.1.md index 617d25b85..617d25b85 100644 --- a/docs/podman-kill.1.md +++ b/docs/source/man/podman-kill.1.md diff --git a/docs/podman-load.1.md b/docs/source/man/podman-load.1.md index deb4fb5ec..deb4fb5ec 100644 --- a/docs/podman-load.1.md +++ b/docs/source/man/podman-load.1.md diff --git a/docs/podman-login.1.md b/docs/source/man/podman-login.1.md index 9d368e9f2..9d368e9f2 100644 --- a/docs/podman-login.1.md +++ b/docs/source/man/podman-login.1.md diff --git a/docs/podman-logout.1.md b/docs/source/man/podman-logout.1.md index 01dc52ecd..01dc52ecd 100644 --- a/docs/podman-logout.1.md +++ b/docs/source/man/podman-logout.1.md diff --git a/docs/podman-logs.1.md b/docs/source/man/podman-logs.1.md index 405f180d9..405f180d9 100644 --- a/docs/podman-logs.1.md +++ b/docs/source/man/podman-logs.1.md diff --git a/docs/podman-mount.1.md b/docs/source/man/podman-mount.1.md index 8f4deeca6..8f4deeca6 100644 --- a/docs/podman-mount.1.md +++ b/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 index c281d50d9..c281d50d9 100644 --- a/docs/podman-network-create.1.md +++ b/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 index dfa7e4b0c..dfa7e4b0c 100644 --- a/docs/podman-network-inspect.1.md +++ b/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 index 46e424593..46e424593 100644 --- a/docs/podman-network-ls.1.md +++ b/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 index c71f0d8fd..c71f0d8fd 100644 --- a/docs/podman-network-rm.1.md +++ b/docs/source/man/podman-network-rm.1.md diff --git a/docs/podman-network.1.md b/docs/source/man/podman-network.1.md index f05b2b78f..f05b2b78f 100644 --- a/docs/podman-network.1.md +++ b/docs/source/man/podman-network.1.md diff --git a/docs/podman-pause.1.md b/docs/source/man/podman-pause.1.md index dfd4da416..dfd4da416 100644 --- a/docs/podman-pause.1.md +++ b/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 index 2ac860a32..2ac860a32 100644 --- a/docs/podman-play-kube.1.md +++ b/docs/source/man/podman-play-kube.1.md diff --git a/docs/podman-play.1.md b/docs/source/man/podman-play.1.md index 364baad60..364baad60 100644 --- a/docs/podman-play.1.md +++ b/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 index cd1de6401..cd1de6401 100644 --- a/docs/podman-pod-create.1.md +++ b/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 index cf2852934..cf2852934 100644 --- a/docs/podman-pod-exists.1.md +++ b/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 index 831d28259..831d28259 100644 --- a/docs/podman-pod-inspect.1.md +++ b/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 index 596e15cea..596e15cea 100644 --- a/docs/podman-pod-kill.1.md +++ b/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 index 9533ed4a1..9533ed4a1 100644 --- a/docs/podman-pod-pause.1.md +++ b/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 index f79961b2f..f79961b2f 100644 --- a/docs/podman-pod-prune.1.md +++ b/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 index 65a7072ab..65a7072ab 100644 --- a/docs/podman-pod-ps.1.md +++ b/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 index 57f479102..57f479102 100644 --- a/docs/podman-pod-restart.1.md +++ b/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 index 6659534b4..6659534b4 100644 --- a/docs/podman-pod-rm.1.md +++ b/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 index 29960d6aa..29960d6aa 100644 --- a/docs/podman-pod-start.1.md +++ b/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 index 962edbda0..962edbda0 100644 --- a/docs/podman-pod-stats.1.md +++ b/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 index b3ce47d72..b3ce47d72 100644 --- a/docs/podman-pod-stop.1.md +++ b/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 index 48f10055a..48f10055a 100644 --- a/docs/podman-pod-top.1.md +++ b/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 index e0a88c2e3..e0a88c2e3 100644 --- a/docs/podman-pod-unpause.1.md +++ b/docs/source/man/podman-pod-unpause.1.md diff --git a/docs/podman-pod.1.md b/docs/source/man/podman-pod.1.md index b3d002a06..b3d002a06 100644 --- a/docs/podman-pod.1.md +++ b/docs/source/man/podman-pod.1.md diff --git a/docs/podman-port.1.md b/docs/source/man/podman-port.1.md index c9833f447..c9833f447 100644 --- a/docs/podman-port.1.md +++ b/docs/source/man/podman-port.1.md diff --git a/docs/podman-ps.1.md b/docs/source/man/podman-ps.1.md index 298de0b2b..298de0b2b 100644 --- a/docs/podman-ps.1.md +++ b/docs/source/man/podman-ps.1.md diff --git a/docs/podman-pull.1.md b/docs/source/man/podman-pull.1.md index de9688f5e..de9688f5e 100644 --- a/docs/podman-pull.1.md +++ b/docs/source/man/podman-pull.1.md diff --git a/docs/podman-push.1.md b/docs/source/man/podman-push.1.md index 3f0350bcd..3f0350bcd 100644 --- a/docs/podman-push.1.md +++ b/docs/source/man/podman-push.1.md diff --git a/docs/podman-remote.1.md b/docs/source/man/podman-remote.1.md index 04010abaf..04010abaf 100644 --- a/docs/podman-remote.1.md +++ b/docs/source/man/podman-remote.1.md diff --git a/docs/podman-restart.1.md b/docs/source/man/podman-restart.1.md index 08fa29244..08fa29244 100644 --- a/docs/podman-restart.1.md +++ b/docs/source/man/podman-restart.1.md diff --git a/docs/podman-rm.1.md b/docs/source/man/podman-rm.1.md index 207d9d61d..207d9d61d 100644 --- a/docs/podman-rm.1.md +++ b/docs/source/man/podman-rm.1.md diff --git a/docs/podman-rmi.1.md b/docs/source/man/podman-rmi.1.md index d911ee6cb..d911ee6cb 100644 --- a/docs/podman-rmi.1.md +++ b/docs/source/man/podman-rmi.1.md diff --git a/docs/podman-run.1.md b/docs/source/man/podman-run.1.md index d6d8f4c1e..d6d8f4c1e 100644 --- a/docs/podman-run.1.md +++ b/docs/source/man/podman-run.1.md diff --git a/docs/podman-save.1.md b/docs/source/man/podman-save.1.md index b2b0995d3..b2b0995d3 100644 --- a/docs/podman-save.1.md +++ b/docs/source/man/podman-save.1.md diff --git a/docs/podman-search.1.md b/docs/source/man/podman-search.1.md index 31de6f839..31de6f839 100644 --- a/docs/podman-search.1.md +++ b/docs/source/man/podman-search.1.md diff --git a/docs/podman-start.1.md b/docs/source/man/podman-start.1.md index 4c81d17bd..4c81d17bd 100644 --- a/docs/podman-start.1.md +++ b/docs/source/man/podman-start.1.md diff --git a/docs/podman-stats.1.md b/docs/source/man/podman-stats.1.md index 741873c3f..741873c3f 100644 --- a/docs/podman-stats.1.md +++ b/docs/source/man/podman-stats.1.md diff --git a/docs/podman-stop.1.md b/docs/source/man/podman-stop.1.md index b5ea670b0..b5ea670b0 100644 --- a/docs/podman-stop.1.md +++ b/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 index d0b1755ee..d0b1755ee 100644 --- a/docs/podman-system-df.1.md +++ b/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 index d5e3bcb95..d5e3bcb95 100644 --- a/docs/podman-system-migrate.1.md +++ b/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 index e6297dc0b..e6297dc0b 100644 --- a/docs/podman-system-prune.1.md +++ b/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 index 071eefe29..071eefe29 100644 --- a/docs/podman-system-renumber.1.md +++ b/docs/source/man/podman-system-renumber.1.md diff --git a/docs/podman-system.1.md b/docs/source/man/podman-system.1.md index bbd541066..bbd541066 100644 --- a/docs/podman-system.1.md +++ b/docs/source/man/podman-system.1.md diff --git a/docs/podman-tag.1.md b/docs/source/man/podman-tag.1.md index 291d95228..291d95228 100644 --- a/docs/podman-tag.1.md +++ b/docs/source/man/podman-tag.1.md diff --git a/docs/podman-top.1.md b/docs/source/man/podman-top.1.md index 1410aa651..1410aa651 100644 --- a/docs/podman-top.1.md +++ b/docs/source/man/podman-top.1.md diff --git a/docs/podman-umount.1.md b/docs/source/man/podman-umount.1.md index 100c47b32..100c47b32 100644 --- a/docs/podman-umount.1.md +++ b/docs/source/man/podman-umount.1.md diff --git a/docs/podman-unpause.1.md b/docs/source/man/podman-unpause.1.md index f5538d6d5..f5538d6d5 100644 --- a/docs/podman-unpause.1.md +++ b/docs/source/man/podman-unpause.1.md diff --git a/docs/podman-unshare.1.md b/docs/source/man/podman-unshare.1.md index 9052b97ab..9052b97ab 100644 --- a/docs/podman-unshare.1.md +++ b/docs/source/man/podman-unshare.1.md diff --git a/docs/podman-varlink.1.md b/docs/source/man/podman-varlink.1.md index 0d2ab1668..0d2ab1668 100644 --- a/docs/podman-varlink.1.md +++ b/docs/source/man/podman-varlink.1.md diff --git a/docs/podman-version.1.md b/docs/source/man/podman-version.1.md index 4499f6338..4499f6338 100644 --- a/docs/podman-version.1.md +++ b/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 index b354f396f..b354f396f 100644 --- a/docs/podman-volume-create.1.md +++ b/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 index ac5b6c977..ac5b6c977 100644 --- a/docs/podman-volume-inspect.1.md +++ b/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 index d431c7c6e..d431c7c6e 100644 --- a/docs/podman-volume-ls.1.md +++ b/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 index 25ea701a3..25ea701a3 100644 --- a/docs/podman-volume-prune.1.md +++ b/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 index 9a2fe8c99..9a2fe8c99 100644 --- a/docs/podman-volume-rm.1.md +++ b/docs/source/man/podman-volume-rm.1.md diff --git a/docs/podman-volume.1.md b/docs/source/man/podman-volume.1.md index 288e57b82..288e57b82 100644 --- a/docs/podman-volume.1.md +++ b/docs/source/man/podman-volume.1.md diff --git a/docs/podman-wait.1.md b/docs/source/man/podman-wait.1.md index ce1c70a5f..ce1c70a5f 100644 --- a/docs/podman-wait.1.md +++ b/docs/source/man/podman-wait.1.md diff --git a/docs/podman.1.md b/docs/source/man/podman.1.md index f6fa1a457..f6fa1a457 100644 --- a/docs/podman.1.md +++ b/docs/source/man/podman.1.md diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst new file mode 100644 index 000000000..0607f129d --- /dev/null +++ b/docs/source/managecontainers.rst @@ -0,0 +1,64 @@ +Manage Containers +================= + +:doc:`attach <man/podman-attach.1>` Attach to a running container + +:doc:`checkpoint <man/podman-container-checkpoint.1>` Checkpoints one or more containers + +:doc:`cleanup <man/podman-container-cleanup.1>` Cleanup network and mountpoints of one or more containers + +:doc:`commit <man/podman-commit.1>` Create new image based on the changed container + +:doc:`cp <man/podman-cp.1>` Copy files/folders between a container and the local filesystem + +:doc:`create <man/podman-create.1>` Create but do not start a container + +:doc:`diff <man/podman-diff.1>` Inspect changes on container's file systems + +:doc:`exec <man/podman-exec.1>` Run a process in a running container + +:doc:`exists <man/podman-container-exists.1>` Check if a container exists in local storage + +:doc:`export <man/podman-export.1>` Export container's filesystem contents as a tar archive + +:doc:`init <man/podman-init.1>` Initialize one or more containers + +:doc:`inspect <man/podman-inspect.1>` Display the configuration of a container or image + +:doc:`kill <man/podman-kill.1>` Kill one or more running containers with a specific signal + +:doc:`list <man/podman-ps.1>` List containers + +:doc:`logs <man/podman-logs.1>` Fetch the logs of a container + +:doc:`mount <man/podman-mount.1>` Mount a working container's root filesystem + +:doc:`pause <man/podman-pause.1>` Pause all the processes in one or more containers + +:doc:`port <man/podman-port.1>` List port mappings or a specific mapping for the container + +:doc:`restart <man/podman-restart.1>` Restart one or more containers + +:doc:`prune <man/podman-container-prune.1>` Remove all stopped containers + +:doc:`restore <man/podman-container-restore.1>` Restores one or more containers from a checkpoint + +:doc:`rm <man/podman-rm.1>` Remove one or more containers + +:doc:`run <man/podman-run.1>` Run a command in a new container + +:doc:`runlabel <man/podman-container-runlabel.1>` Execute the command described by an image label + +:doc:`start <man/podman-start.1>` Start one or more containers + +:doc:`stats <man/podman-stats.1>` Display a live stream of container resource usage statistics + +:doc:`stop <man/podman-stop.1>` Stop one or more containers + +:doc:`top <man/podman-top.1>` Display the running processes of a container + +:doc:`umount <man/podman-umount.1>` Unmounts working container's root filesystem + +:doc:`unpause <man/podman-unpause.1>` Unpause the processes in one or more containers + +:doc:`wait <man/podman-wait.1>` Block on one or more containers diff --git a/docs/source/network.rst b/docs/source/network.rst new file mode 100644 index 000000000..aa379bf46 --- /dev/null +++ b/docs/source/network.rst @@ -0,0 +1,10 @@ +Network +===== + +:doc:`create <man/podman-network-create.1>` network create + +:doc:`inspect <man/podman-network-inspect.1>` network inspect + +:doc:`ls <man/podman-network-ls.1>` network list + +:doc:`rm <man/podman-network-rm.1>` 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 000000000..5e5c02ee1 --- /dev/null +++ b/docs/source/play.rst @@ -0,0 +1,4 @@ +Play +==== + +:doc:`kube <man/podman-play-kube.1>` Play a pod based on Kubernetes YAML diff --git a/docs/source/pod.rst b/docs/source/pod.rst new file mode 100644 index 000000000..94ed9604a --- /dev/null +++ b/docs/source/pod.rst @@ -0,0 +1,30 @@ +Pod +=== + +:doc:`create <man/podman-pod-create.1>` Create a new empty pod + +:doc:`exists <man/podman-pod-exists.1>` Check if a pod exists in local storage + +:doc:`inspect <man/podman-pod-inspect.1>` Displays a pod configuration + +:doc:`kill <man/podman-pod-kill.1>` Send the specified signal or SIGKILL to containers in pod + +:doc:`pause <man/podman-pause.1>` Pause one or more pods + +:doc:`prune <man/podman-pod-prune.1>` Remove all stopped pods + +:doc:`ps <man/podman-pod-ps.1>` List pods + +:doc:`restart <man/podman-pod-restart.1>` Restart one or more pods + +:doc:`rm <man/podman-pod-rm.1>` Remove one or more pods + +:doc:`start <man/podman-pod-start.1>` Start one or more pods + +:doc:`stats <man/podman-pod-stats.1>` Display a live stream of resource usage statistics for the containers in one or more pods + +:doc:`stop <man/podman-pod-stop.1>` Stop one or more pods + +:doc:`top <man/podman-pod-top.1>` Display the running processes of containers in a pod + +:doc:`unpause <man/podman-pod-unpause.1>` Unpause one or more pods diff --git a/docs/source/system.rst b/docs/source/system.rst new file mode 100644 index 000000000..a35409454 --- /dev/null +++ b/docs/source/system.rst @@ -0,0 +1,12 @@ +System +====== + +:doc:`df <man/podman-system-df.1>` Show podman disk usage + +:doc:`info <man/podman-info.1>` Display podman system information + +:doc:`migrate <man/podman-system-migrate.1>` Migrate containers + +:doc:`prune <man/podman-system-prune.1>` Remove unused data + +:doc:`renumber <man/podman-system-renumber.1>` Migrate lock numbers diff --git a/docs/source/volume.rst b/docs/source/volume.rst new file mode 100644 index 000000000..a0f31ac34 --- /dev/null +++ b/docs/source/volume.rst @@ -0,0 +1,11 @@ +Volume +====== +:doc:`create <man/podman-volume-create.1>` Create a new volume + +:doc:`inspect <man/podman-volume-inspect.1>` Display detailed information on one or more volumes + +:doc:`ls <man/podman-volume-ls.1>` List volumes + +:doc:`prune <man/podman-volume-prune.1>` Remove all unused volumes + +:doc:`rm <man/podman-volume-rm.1>` Remove one or more volumes
\ No newline at end of file diff --git a/hack/man-page-checker b/hack/man-page-checker index 30d0b2113..6e5cad6b2 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 7530e20d0..bd35b03bc 100755 --- a/hack/podman-commands.sh +++ b/hack/podman-commands.sh @@ -34,7 +34,7 @@ function podman_man() { # This md file has a table of the form: # | [podman-cmd(1)\[(podman-cmd.1.md) | Description ... | # For all such, print the 'cmd' portion (the one in brackets). - sed -ne 's/^|\s\+\[podman-\([a-z]\+\)(1.*/\1/p' <docs/$1.1.md + sed -ne 's/^|\s\+\[podman-\([a-z]\+\)(1.*/\1/p' <docs/source/man/$1.1.md # Special case: there is no podman-help man page, nor need for such. echo "help" @@ -48,7 +48,7 @@ function podman_man() { # | cmd | [podman-cmd(1)](podman-cmd.1.md) | Description ... | # For all such we find, with 'podman- in the second column, print the # first column (with whitespace trimmed) - awk -F\| '$3 ~ /podman-/ { gsub(" ","",$2); print $2 }' < docs/$1.1.md + awk -F\| '$3 ~ /podman-/ { gsub(" ","",$2); print $2 }' < docs/source/man/$1.1.md fi } @@ -93,7 +93,7 @@ if [ $rc -ne 0 ]; then * podman man pages. * * The 'checking:' header indicates the specific command (and possibly -* subcommand) being tested, e.g. podman --help vs docs/podman.1.md. +* subcommand) being tested, e.g. podman --help vs docs/source/podman.1.md. * * A '-' indicates a subcommand present in 'podman --help' but not the * corresponding man page. |