Merge pull request #641 from nathwill/man-libpod

add libpod.conf man page (closes #537)

3 files changed, 66 insertions, 0 deletions

diff --git a/Makefile b/Makefile
index bee8d7c00..c512a2d52 100644
--- a/Makefile
+++ b/Makefile
@@ -95,6 +95,7 @@ ifneq ($(GOPATH),)
 endif
 	rm -rf _output
 	rm -f docs/*.1
+	rm -f docs/*.5
 	rm -fr test/testdata/redis-image
 	find . -name \*~ -delete
 	find . -name \#\* -delete
@@ -152,6 +153,9 @@ MANPAGES    := $(MANPAGES_MD:%.md=%)
 docs/%.1: docs/%.1.md .gopathok
 	(go-md2man -in $< -out $@.tmp && touch $@.tmp && mv $@.tmp $@) || ($(GOPATH)/bin/go-md2man -in $< -out $@.tmp && touch $@.tmp && mv $@.tmp $@)
 
+docs/%.5: docs/%.5.md .gopathok
+	(go-md2man -in $< -out $@.tmp && touch $@.tmp && mv $@.tmp $@) || ($(GOPATH)/bin/go-md2man -in $< -out $@.tmp && touch $@.tmp && mv $@.tmp $@)
+
 docs: $(MANPAGES)
 
 docker-docs: docs
@@ -174,7 +178,9 @@ install.bin:
 
 install.man: docs
 	install ${SELINUXOPT} -d -m 755 $(MANDIR)/man1
+	install ${SELINUXOPT} -d -m 755 $(MANDIR)/man5
 	install ${SELINUXOPT} -m 644 $(filter %.1,$(MANPAGES)) -t $(MANDIR)/man1
+	install ${SELINUXOPT} -m 644 $(filter %.5,$(MANPAGES)) -t $(MANDIR)/man5
 
 install.config:
 	install ${SELINUXOPT} -D -m 644 libpod.conf ${SHAREDIR_CONTAINERS}/libpod.conf
@@ -191,7 +197,9 @@ install.cni:
 install.docker: docker-docs
 	install ${SELINUXOPT} -D -m 755 docker $(BINDIR)/docker
 	install ${SELINUXOPT} -d -m 755 $(MANDIR)/man1
+	install ${SELINUXOPT} -d -m 755 $(MANDIR)/man5
 	install ${SELINUXOPT} -m 644 docs/docker*.1 -t $(MANDIR)/man1
+	install ${SELINUXOPT} -m 644 docs/docker*.5 -t $(MANDIR)/man5
 
 install.systemd:
 	install ${SELINUXOPT} -m 644 contrib/varlink/io.projectatomic.podman.socket ${SYSTEMDDIR}/io.projectatomic.podman.socket
@@ -200,6 +208,9 @@ install.systemd:
 uninstall:
 	for i in $(filter %.1,$(MANPAGES)); do \
 		rm -f $(MANDIR)/man1/$$(basename $${i}); \
+	done; \
+	for i in $(filter %.5,$(MANPAGES)); do \
+		rm -f $(MANDIR)/man5/$$(basename $${i}); \
 	done
 
 .PHONY: .gitvalidation
diff --git a/contrib/spec/podman.spec.in b/contrib/spec/podman.spec.in
index 6a3199a9e..50d2aa65b 100644
--- a/contrib/spec/podman.spec.in
+++ b/contrib/spec/podman.spec.in
@@ -435,6 +435,7 @@ export GOPATH=%{buildroot}/%{gopath}:$(pwd)/vendor:%{gopath}
 %doc README.md CONTRIBUTING.md hooks.md install.md code-of-conduct.md transfer.md
 %{_bindir}/%{name}
 %{_mandir}/man1/*.1*
+%{_mandir}/man5/*.5*
 %{_datadir}/bash-completion/completions/*
 %config(noreplace) %{_sysconfdir}/cni/net.d/87-%{name}-bridge.conflist
 
diff --git a/docs/libpod.conf.5.md b/docs/libpod.conf.5.md
new file mode 100644
index 000000000..226371b6d
--- /dev/null
+++ b/docs/libpod.conf.5.md
@@ -0,0 +1,54 @@
+% libpod.conf(5) library for running OCI-based containers in Pods
+% Nathan Williams
+% APRIL 2018
+
+# NAME
+libpod.conf - libpod configuration file
+
+# DESCRIPTION
+The libpod.conf file is the default configuration file for all tools using
+libpod to manage containers.
+
+# OPTIONS
+
+**image_default_transport**=""
+  Default transport method for pulling and pushing images
+
+**runtime_path**=""
+  Paths to search for a valid OCI runtime binary
+
+**conmon_path**=""
+  Paths to search for the Conmon container manager binary
+
+**conmon_env_vars**=""
+  Environment variables to pass into Conmon
+
+**cgroup_manager**=""
+  Specify the CGroup Manager to use; valid values are "systemd" and "cgroupfs"
+
+**static_dir**=""
+  Directory for persistent libpod files (database, etc)
+  By default this will be configured relative to where containers/storage
+  stores containers
+
+**tmp_dir**=""
+  Directory for temporary files
+  Must be a tmpfs (wiped after reboot)
+
+**max_log_size**=""
+  Maximum size of log files (in bytes)
+
+**no_pivot_root**=""
+  Whether to use chroot instead of pivot_root in the runtime
+
+**cni_config_dir**=""
+  Directory containing CNI plugin configuration files
+
+**cni_plugin_dir**=""
+  Directories where CNI plugin binaries may be located
+
+# FILES
+/etc/containers/libpod.conf, default libpod configuration path
+
+# HISTORY
+Apr 2018, Originally compiled by Nathan Williams <nath.e.will@gmail.com>