From c317da8deb13107aab09ef94dc433ebb169496d5 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Thu, 5 Sep 2024 06:24:37 -0400 Subject: [PATCH] Add podman-rootless.7 man page This is a follow up to 5389eee7376cf81fbfdaf58cd58d38b287f5da23 to add rooltess.md information to man pages to help users discover solutions to troubleshooting and rooless issues. Specicifally I was surprised when binding to ports < 1024 was not covered in podman-troubleshooting.7 man page. Signed-off-by: Daniel J Walsh --- Makefile | 6 +++++- docs/Makefile | 2 +- docs/source/markdown/.gitignore | 1 + docs/source/markdown/podman-build.1.md.in | 3 +++ docs/source/markdown/podman-create.1.md.in | 8 ++++++++ docs/source/markdown/podman-run.1.md.in | 3 +++ docs/source/markdown/podman.1.md | 3 +++ 7 files changed, 24 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index db73caae6e..006247367c 100644 --- a/Makefile +++ b/Makefile @@ -95,7 +95,7 @@ OCI_RUNTIME ?= "" MANPAGES_SOURCE_DIR = docs/source/markdown MANPAGES_MD_IN ?= $(wildcard $(MANPAGES_SOURCE_DIR)/*.md.in) MANPAGES_MD_GENERATED ?= $(MANPAGES_MD_IN:%.md.in=%.md) -MANPAGES_MD ?= $(sort $(wildcard $(MANPAGES_SOURCE_DIR)/*.md) $(MANPAGES_MD_GENERATED) $(MANPAGES_SOURCE_DIR)/podman-troubleshooting.7.md) +MANPAGES_MD ?= $(sort $(wildcard $(MANPAGES_SOURCE_DIR)/*.md) $(MANPAGES_MD_GENERATED) $(MANPAGES_SOURCE_DIR)/podman-troubleshooting.7.md $(MANPAGES_SOURCE_DIR)/podman-rootless.7.md) MANPAGES ?= $(MANPAGES_MD:%.md=%) MANPAGES_DEST ?= $(subst markdown,man, $(subst source,build,$(MANPAGES))) @@ -525,6 +525,10 @@ $(MANPAGES_SOURCE_DIR)/podman-troubleshooting.7.md: troubleshooting.md ( echo "% podman-troubleshooting 7"; echo; sed -e '/logo.*\.png/d' <$< ) >$@.tmp.$$ && \ mv $@.tmp.$$ $@ +$(MANPAGES_SOURCE_DIR)/podman-rootless.7.md: rootless.md + ( echo "% podman-rootless 7"; echo; sed -e '/logo.*\.png/d' <$< ) >$@.tmp.$$ && \ + mv $@.tmp.$$ $@ + $(MANPAGES): OUTFILE=$(subst source/markdown,build/man,$@) $(MANPAGES): %: %.md .install.md2man docdir diff --git a/docs/Makefile b/docs/Makefile index 698a3ca1d8..4e982e27fb 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -15,7 +15,7 @@ help: clean: $(RM) -fr build - cd source/markdown && $(RM) -f $$(<.gitignore) podman-troubleshooting.7.md + cd source/markdown && $(RM) -f $$(<.gitignore) .PHONY: help Makefile diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index 99b3161bc8..7cef2f7d80 100644 --- a/docs/source/markdown/.gitignore +++ b/docs/source/markdown/.gitignore @@ -59,6 +59,7 @@ podman-stats.1.md podman-stop.1.md podman-top.1.md podman-troubleshooting.7.md +podman-rootless.7.md podman-unmount.1.md podman-unpause.1.md podman-update.1.md diff --git a/docs/source/markdown/podman-build.1.md.in b/docs/source/markdown/podman-build.1.md.in index 7fb5b27368..98545a03cd 100644 --- a/docs/source/markdown/podman-build.1.md.in +++ b/docs/source/markdown/podman-build.1.md.in @@ -714,6 +714,9 @@ useradd to stop creating the lastlog file. See [podman-troubleshooting(7)](https://github.com/containers/podman/blob/main/troubleshooting.md) for solutions to common issues. +See [podman-rootless(7)](https://github.com/containers/podman/blob/main/rootless.md) +for rootless issues. + ## HISTORY Aug 2020, Additional options and .containerignore added by Dan Walsh `` diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 486eca3ddf..d0a939e873 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -528,6 +528,14 @@ NOTE: Use the environment variable `TMPDIR` to change the temporary storage loca ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-save(1)](podman-save.1.md)**, **[podman-ps(1)](podman-ps.1.md)**, **[podman-attach(1)](podman-attach.1.md)**, **[podman-pod-create(1)](podman-pod-create.1.md)**, **[podman-port(1)](podman-port.1.md)**, **[podman-start(1)](podman-start.1.md)**, **[podman-kill(1)](podman-kill.1.md)**, **[podman-stop(1)](podman-stop.1.md)**, **[podman-generate-systemd(1)](podman-generate-systemd.1.md)**, **[podman-rm(1)](podman-rm.1.md)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[systemd.unit(5)](https://www.freedesktop.org/software/systemd/man/systemd.unit.html)**, **[setsebool(8)](https://man7.org/linux/man-pages/man8/setsebool.8.html)**, **[slirp4netns(1)](https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[fuse-overlayfs(1)](https://github.com/containers/fuse-overlayfs/blob/main/fuse-overlayfs.1.md)**, **proc(5)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**, **personality(2)** +### Troubleshooting + +See [podman-troubleshooting(7)](https://github.com/containers/podman/blob/main/troubleshooting.md) +for solutions to common issues. + +See [podman-rootless(7)](https://github.com/containers/podman/blob/main/rootless.md) +for rootless issues. + ## HISTORY October 2017, converted from Docker documentation to Podman by Dan Walsh for Podman `` diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index f2e75701ee..da546a3354 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -909,6 +909,9 @@ NOTE: Use the environment variable `TMPDIR` to change the temporary storage loca See [podman-troubleshooting(7)](https://github.com/containers/podman/blob/main/troubleshooting.md) for solutions to common issues. +See [podman-rootless(7)](https://github.com/containers/podman/blob/main/rootless.md) +for rootless issues. + ## HISTORY September 2018, updated by Kunal Kushwaha `` diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 892c1924f4..ee62f1b529 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -474,5 +474,8 @@ The Network File System (NFS) and other distributed file systems (for example: L See [podman-troubleshooting(7)](https://github.com/containers/podman/blob/main/troubleshooting.md) for solutions to common issues. +See [podman-rootless(7)](https://github.com/containers/podman/blob/main/rootless.md) +for rootless issues. + ## HISTORY Dec 2016, Originally compiled by Dan Walsh