README-epub 1.0 KB

1234567891011121314151617181920212223242526272829303132
  1. The file kawa-manual.epub contains the Kawa documentation packaged
  2. as an e-book in EPUB format. It should be readable by most standalone
  3. e-book readers. There are also plugins available for various browsers.
  4. You can also read the manual with the kawa --browse-manual option:
  5. $ kawa --browse-manual
  6. Here kawa is one of kawa or kawa.bat in the ../bin directory.
  7. This command starts a mini-web-server, and then creates a window or tab
  8. to read it using your default browser.
  9. You can specify some other browser - for example:
  10. $ kawa --browse-manual="firefox %U"
  11. This runs the command quoted, after Kawa replaces %U with a URL
  12. referencing Kawa's mini-web-server.
  13. An epub is essentially a zip archive, which you can unzip:
  14. cd $KAWA_HOME/doc
  15. unzip kawa-manual.epub
  16. Then you can use a plain browser with the URL
  17. file:$KAWA_HOME/doc/OEBPS/index.xhtml.
  18. You can generate the web-page-style html files from the source
  19. with 'cd doc && make web/index.html', but this requires
  20. various tools including xsltproc and the docbook style sheets.