fluxbox/doc/asciidoc
2010-08-22 21:27:52 +02: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
.gitignore Added new 'make dist' target for ease in updating the manuals 2009-05-26 16:16:07 -04:00
client-patterns.txt Added fluxbox-apps(5) manpage 2009-05-26 16:14:01 -04:00
fbrun.txt Small edits for consistency 2009-05-26 16:16:07 -04:00
fbsetbg.txt fixed spelling 2010-01-14 07:35:21 +01:00
fbsetroot.txt fixed spelling 2010-01-14 07:35:21 +01:00
fluxbox-apps.txt Small edits for consistency 2009-05-26 16:16:07 -04:00
fluxbox-keys.txt implemented 'ActivateTab' action to (re)allow activation of tabs via mouse 2010-08-20 19:01:25 +02:00
fluxbox-menu.txt Small edits for consistency 2009-05-26 16:16:07 -04:00
fluxbox-remote.txt Small edits for consistency 2009-05-26 16:16:07 -04:00
fluxbox-style.txt Allow 'background: unset' 2009-05-26 16:36:13 -04:00
fluxbox.txt fixed spelling 2010-08-22 21:27:52 +02:00
Makefile Added new 'make dist' target for ease in updating the manuals 2009-05-26 16:16:07 -04:00
README.txt Added new 'make dist' target for ease in updating the manuals 2009-05-26 16:16:07 -04:00
startfluxbox.txt Small edits for consistency 2009-05-26 16:16:07 -04: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.