fluxbox/doc/asciidoc
Mark Tiefenbruck 1d19662c89 Add RelativeSmart documentation to the asciidoc source. Thanks to
Alexey Ugnichev for pointing out its disappearance.
2021-07-24 20:13:46 -07:00
..
de Add documentation for edge snap feature when resizing. 2016-01-04 21:54:30 +01:00
es remove rootcommand from init file 2008-10-04 18:49:00 -07:00
client-patterns.txt Documentation: white-spaces and minor formatting 2015-01-05 16:52:06 +01:00
fbrun.txt add support for dedicated completion data 2016-07-23 16:58:04 +02:00
fbsetbg.txt Prepare manpages for 1.3.7 2015-02-08 11:20:53 +01:00
fbsetroot.txt Prepare manpages for 1.3.7 2015-02-08 11:20:53 +01:00
fluxbox-apps.txt add apps key to ignore XSizeHints 2016-08-27 08:54:26 +02:00
fluxbox-keys.txt implement ON_SLIT actions 2016-09-21 20:52:14 +02:00
fluxbox-menu.txt Fix menu docs, esp. items allowed in window menu 2019-04-22 10:53:04 -07:00
fluxbox-remote.txt Prepare manpages for 1.3.7 2015-02-08 11:20:53 +01:00
fluxbox-style.txt fix manpage fluxbox-style 2017-04-24 20:58:25 +02:00
fluxbox.txt Add RelativeSmart documentation to the asciidoc source. Thanks to 2021-07-24 20:13:46 -07:00
Makefile build-sys: move to non-recursive build 2013-05-26 10:38:11 +01:00
README.txt Reformat a paragraph in doc/asciidoc/README.txt 2020-04-19 14:53:54 +02:00
startfluxbox.txt Prepare manpages for 1.3.7 2015-02-08 11:20:53 +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://pagure.io/xmlto. 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.