fluxbox/doc/asciidoc
Sami Kerola 7541054b29 build-sys: move to non-recursive build
This rather large change will attempts to make 'make' to work better.
See excellent paper 'Recursive Make Considered Harmful' by Peter Miller
for further explanation why several make files is worse than one for
whole project.

Note.  The tests are build with 'make check' rather than defining TEST.

Reference: http://miller.emu.id.au/pmiller/books/rmch/
Reference: http://karelzak.blogspot.co.uk/2013/02/non-recursive-automake.html
2013-05-26 10:38:11 +01:00
..
de split documenation into different directories 2008-08-20 23:03:25 +02:00
es remove rootcommand from init file 2008-10-04 18:49:00 -07:00
client-patterns.txt add fullscreen, maximizedhorizontal, and maximizedvertical tests to ClientPattern 2012-07-01 21:22:01 -07:00
fbrun.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00
fbsetbg.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00
fbsetroot.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00
fluxbox-apps.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00
fluxbox-keys.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00
fluxbox-menu.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00
fluxbox-remote.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00
fluxbox-style.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00
fluxbox.txt Workspace switching on the toolbar via the mouse buttons 2013-02-27 09:46:47 +01:00
Makefile build-sys: move to non-recursive build 2013-05-26 10:38:11 +01:00
README.txt Added new 'make dist' target for ease in updating the manuals 2009-05-26 16:16:07 -04:00
startfluxbox.txt Updated Changelog, NEWS, man-pages for 1.3.5 2013-02-13 11:00:22 +01:00

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: 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:

  $> asciidoc -b docbook -d manpage fluxbox.txt
  $> xmlto man fluxbox.xml

pdf:

  $> asciidoc -b docbook -d manpage fluxbox.txt
  $> docbook2pdf fluxbox.xml

docbook:

  $> asciidoc -b docbook-sgml -d manpage fluxbox.txt

html:

  $> asciidoc -b xhtml -d manpage fluxbox.txt

and many many more ways to do it.
what do we need? well, at least:

  http://www.methods.co.nz/asciidoc/
  http://cyberelk.net/tim/xmlto/

and the rest of the docbook-family + maybe pdftex.