Added new 'make dist' target for ease in updating the manuals
This commit is contained in:
parent
e1018645da
commit
54ee631cd8
3 changed files with 20 additions and 6 deletions
2
doc/asciidoc/.gitignore
vendored
Normal file
2
doc/asciidoc/.gitignore
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
*.1
|
||||
*.5
|
|
@ -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
|
||||
|
|
|
@ -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:
|
||||
|
||||
|
|
Loading…
Reference in a new issue