docs/Makefile

PREFIX ?= /usr/local
DATADIR ?= ${PREFIX}/share
MANDIR ?= $(DATADIR)/man
GO ?= go
GOMD2MAN ?= go-md2man

docs: $(patsubst %.md,%,$(wildcard *.[0-9].md))

%.1: %.1.md
	$(GOMD2MAN) -in $^ -out $@

%.7: %.7.md
	$(GOMD2MAN) -in $^ -out $@

.PHONY: .install.md2man
.install.md2man:
	$(GO) install github.com/cpuguy83/go-md2man/v2@latest

.PHONY: install
install: docs
	install -d ${DESTDIR}/${MANDIR}/man1
	install -m 0644 *.1 ${DESTDIR}/${MANDIR}/man1
	install -d ${DESTDIR}/${MANDIR}/man7
	install -m 0644 *.7 ${DESTDIR}/${MANDIR}/man7

.PHONY: uninstall
uninstall:
	rm -f ${DESTDIR}/${MANDIR}/man1/*.1
	rm -f ${DESTDIR}/${MANDIR}/man7/*.7

.PHONY: clean
clean:
	$(RM) *.1 *.7
CI and Makefile updates - Run rustfmt in `make validate` and CI validation - Makefile: allow modification of PREFIX, DATADIR and MANDIR - .cirrus.yml uses make targets instead of cargo commands - Use `mandown` for manpage generation instead of `go-md2man` Fixes: #33 Needs rustfmt and mandown crates installed in CI image. Signed-off-by: Lokesh Mandvekar <lsm5@fedoraproject.org> 2021-10-20 12:48:47 -04:00			`PREFIX ?= /usr/local`
			`DATADIR ?= ${PREFIX}/share`
			`MANDIR ?= $(DATADIR)/man`
docs: Convert markdown with go-md2man instead of mandown Closes #768. Signed-off-by: Ben Brown <ben@demerara.io> 2023-08-08 17:02:06 +01:00			`GO ?= go`
			`GOMD2MAN ?= go-md2man`
Add man page and install to Makefile Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> 2021-10-14 10:58:58 -04:00
Add handling for firewalld's StrictForwardPorts setting This mostly amounts to throwing a sensible error in cases where the setting is enabled and the user has requested ports be forwarded. There are no tests at present because firewalld 2.3.x is currently restricted to Rawhide, and is required for effective testing. A manpage has also been added with details on how to work with the StrictForwardPorts setting (as well as some other tidbits on firewalld + Podman integration). Signed-off-by: Matt Heon <mheon@redhat.com> 2025-01-21 14:53:16 -05:00			`docs: $(patsubst %.md,%,$(wildcard *.[0-9].md))`
Add man page and install to Makefile Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> 2021-10-14 10:58:58 -04:00
			`%.1: %.1.md`
docs: Convert markdown with go-md2man instead of mandown Closes #768. Signed-off-by: Ben Brown <ben@demerara.io> 2023-08-08 17:02:06 +01:00			`$(GOMD2MAN) -in $^ -out $@`
Add man page and install to Makefile Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> 2021-10-14 10:58:58 -04:00
Add handling for firewalld's StrictForwardPorts setting This mostly amounts to throwing a sensible error in cases where the setting is enabled and the user has requested ports be forwarded. There are no tests at present because firewalld 2.3.x is currently restricted to Rawhide, and is required for effective testing. A manpage has also been added with details on how to work with the StrictForwardPorts setting (as well as some other tidbits on firewalld + Podman integration). Signed-off-by: Matt Heon <mheon@redhat.com> 2025-01-21 14:53:16 -05:00			`%.7: %.7.md`
			`$(GOMD2MAN) -in $^ -out $@`

docs: Convert markdown with go-md2man instead of mandown Closes #768. Signed-off-by: Ben Brown <ben@demerara.io> 2023-08-08 17:02:06 +01:00			`.PHONY: .install.md2man`
			`.install.md2man:`
			`$(GO) install github.com/cpuguy83/go-md2man/v2@latest`
CI: install mandown for validate Add target to install mandown, also fixes useless `command -v` exucuting in the makefile since it did't error out anyway when it was empty. Signed-off-by: Paul Holzinger <pholzing@redhat.com> 2022-12-14 16:43:46 +01:00
Add man page and install to Makefile Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> 2021-10-14 10:58:58 -04:00			`.PHONY: install`
docs/Makefile: several fixes - build docs on install if needed - clean should remove the .7 page - add uninstall target so users can remove the pages from the system Fixes #1179 Signed-off-by: Paul Holzinger <pholzing@redhat.com> 2025-02-18 16:52:48 +01:00			`install: docs`
Add man page and install to Makefile Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> 2021-10-14 10:58:58 -04:00			`install -d ${DESTDIR}/${MANDIR}/man1`
			`install -m 0644 *.1 ${DESTDIR}/${MANDIR}/man1`
Add handling for firewalld's StrictForwardPorts setting This mostly amounts to throwing a sensible error in cases where the setting is enabled and the user has requested ports be forwarded. There are no tests at present because firewalld 2.3.x is currently restricted to Rawhide, and is required for effective testing. A manpage has also been added with details on how to work with the StrictForwardPorts setting (as well as some other tidbits on firewalld + Podman integration). Signed-off-by: Matt Heon <mheon@redhat.com> 2025-01-21 14:53:16 -05:00			`install -d ${DESTDIR}/${MANDIR}/man7`
			`install -m 0644 *.7 ${DESTDIR}/${MANDIR}/man7`
Add man page and install to Makefile Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> 2021-10-14 10:58:58 -04:00
docs/Makefile: several fixes - build docs on install if needed - clean should remove the .7 page - add uninstall target so users can remove the pages from the system Fixes #1179 Signed-off-by: Paul Holzinger <pholzing@redhat.com> 2025-02-18 16:52:48 +01:00			`.PHONY: uninstall`
			`uninstall:`
			`rm -f ${DESTDIR}/${MANDIR}/man1/*.1`
			`rm -f ${DESTDIR}/${MANDIR}/man7/*.7`

Add man page and install to Makefile Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> 2021-10-14 10:58:58 -04:00			`.PHONY: clean`
			`clean:`
docs/Makefile: several fixes - build docs on install if needed - clean should remove the .7 page - add uninstall target so users can remove the pages from the system Fixes #1179 Signed-off-by: Paul Holzinger <pholzing@redhat.com> 2025-02-18 16:52:48 +01:00			`$(RM) .1 .7`