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