aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/asciidoc/.gitignore2
-rw-r--r--doc/asciidoc/Makefile11
-rw-r--r--doc/asciidoc/README.txt13
3 files changed, 20 insertions, 6 deletions
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*.1
2*.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 @@
5SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt fbsetroot.txt startfluxbox.txt 5SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt fbsetroot.txt startfluxbox.txt
6SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt 6SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt
7 7
8MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in) 8MAN = $(SRC1:.txt=.1) $(SRC5:.txt=.5)
9MANdotIN = $(addsuffix .in,$(MAN))
10DISTFILES = $(addprefix ../,$(MANdotIN))
9 11
10all: $(MAN) 12all: $(MAN)
11 13
12install-above: all 14dist: $(DISTFILES)
13 cp $(MAN) ../
14 15
15clean: 16clean:
16 rm -fv $(MAN) 17 rm -fv $(MAN)
@@ -21,10 +22,10 @@ clean:
21%.5 : %.xml 22%.5 : %.xml
22 xmlto man $< 23 xmlto man $<
23 24
24%.1.in: %.1 25../%.1.in: %.1
25 cp $< $@ 26 cp $< $@
26 27
27%.5.in: %.5 28../%.5.in: %.5
28 cp $< $@ 29 cp $< $@
29 30
30%.xml : %.txt 31%.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
2fluxbox in ascii-doc format. how does it work? 2fluxbox in ascii-doc format. how does it work?
3 3
4well, just edit fluxbox.txt from this directory. save it. 4well, just edit fluxbox.txt from this directory. save it.
5then we can produce pretty much any format we like: 5then we can produce pretty much any format we like: man, pdf, docbook, html,
6etc.
7
8For simplicity the Makefile here is set up to refresh the man pages that will be
9installed with fluxbox. Just run 'make dist' in this directory. It requires
10that you have a recent asciidoc package installed from
11http://www.methods.co.nz/asciidoc/ and xmlto from
12https://fedorahosted.org/xmlto/browser. The result will be new fluxbox.1.in
13files in the parent directory. These and your altered .txt files should be
14checked into git.
15
16Here are the nuts and bolts to create other formats:
6 17
7man: 18man:
8 19