Fix escaping and some of the formattting (closes issue #10285)
[asterisk/asterisk.git] / doc / tex / README.txt
1 Asterisk Reference Documentation
2 --------------------------------
3
4 1) To generate a PDF from this documentation, you will need the rubber tool,
5    and all of its dependencies.  The web site for this tool is:
6
7       http://www.pps.jussieu.fr/~beffara/soft/rubber/
8
9    Then, once this tool is installed, running "make pdf" will generate
10    the PDF automatically using this tool.  The result will be asterisk.pdf.
11
12    NOTE:  After installing rubber, you will need to re-run the top level
13    configure script.  It checks to see if rubber is installed, so that the
14    asterisk.pdf Makefile target can produce a useful error message when it is
15    not installed.
16
17 2) To generate HTML from this documentation, you will need the latex2html tool,
18    and all of its dependencies.  The web site for this tool is:
19
20       http://www.latex2html.org/
21
22    Then, once this tool is installed, running "make html" will generate the
23    HTML documentation.  The result will be an asterisk directory full of
24    HTML files.