From 54ee631cd815006fe918b7fac69e754df8cf06d1 Mon Sep 17 00:00:00 2001 From: Jim Ramsay <i.am@jimramsay.com> Date: Wed, 18 Feb 2009 15:59:44 -0500 Subject: Added new 'make dist' target for ease in updating the manuals --- doc/asciidoc/.gitignore | 2 ++ doc/asciidoc/Makefile | 11 ++++++----- doc/asciidoc/README.txt | 13 ++++++++++++- 3 files changed, 20 insertions(+), 6 deletions(-) create mode 100644 doc/asciidoc/.gitignore diff --git a/doc/asciidoc/.gitignore b/doc/asciidoc/.gitignore new file mode 100644 index 0000000..8c7bbbe --- /dev/null +++ b/doc/asciidoc/.gitignore @@ -0,0 +1,2 @@ +*.1 +*.5 diff --git a/doc/asciidoc/Makefile b/doc/asciidoc/Makefile index 5561a4a..666d437 100644 --- a/doc/asciidoc/Makefile +++ b/doc/asciidoc/Makefile @@ -5,12 +5,13 @@ SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt fbsetroot.txt startfluxbox.txt SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt -MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in) +MAN = $(SRC1:.txt=.1) $(SRC5:.txt=.5) +MANdotIN = $(addsuffix .in,$(MAN)) +DISTFILES = $(addprefix ../,$(MANdotIN)) all: $(MAN) -install-above: all - cp $(MAN) ../ +dist: $(DISTFILES) clean: rm -fv $(MAN) @@ -21,10 +22,10 @@ clean: %.5 : %.xml xmlto man $< -%.1.in: %.1 +../%.1.in: %.1 cp $< $@ -%.5.in: %.5 +../%.5.in: %.5 cp $< $@ %.xml : %.txt diff --git a/doc/asciidoc/README.txt b/doc/asciidoc/README.txt index 7547248..04f0c29 100644 --- a/doc/asciidoc/README.txt +++ b/doc/asciidoc/README.txt @@ -2,7 +2,18 @@ whats this? this is the attempt to write the documentation for fluxbox in ascii-doc format. how does it work? well, just edit fluxbox.txt from this directory. save it. -then we can produce pretty much any format we like: +then we can produce pretty much any format we like: man, pdf, docbook, html, +etc. + +For simplicity the Makefile here is set up to refresh the man pages that will be +installed with fluxbox. Just run 'make dist' in this directory. It requires +that you have a recent asciidoc package installed from +http://www.methods.co.nz/asciidoc/ and xmlto from +https://fedorahosted.org/xmlto/browser. The result will be new fluxbox.1.in +files in the parent directory. These and your altered .txt files should be +checked into git. + +Here are the nuts and bolts to create other formats: man: -- cgit v0.11.2