mirror of
https://github.com/asterisk/asterisk.git
synced 2025-10-16 01:36:48 +00:00
* Move LaTeX docs into a tex/ subdirectory of the doc/ dir
* Add a Makefile in doc/tex/ for generating PDF and HTML * Add a README.txt file to doc/tex/ to document which tools are used and what web sites to visit for getting them. * Update build_tools/prep_tarball to put the proper Asterisk version string in the automatically generated PDF for release tarballs git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@72982 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
24
doc/tex/README.txt
Normal file
24
doc/tex/README.txt
Normal file
@@ -0,0 +1,24 @@
|
||||
Asterisk Reference Documentation
|
||||
--------------------------------
|
||||
|
||||
1) To generate a PDF from this documentation, you will need the rubber tool,
|
||||
and all of its dependencies. The web site for this tool is:
|
||||
|
||||
http://www.pps.jussieu.fr/~beffara/soft/rubber/
|
||||
|
||||
Then, once this tool is installed, running "make pdf" will generate
|
||||
the PDF automatically using this tool. The result will be asterisk.pdf.
|
||||
|
||||
NOTE: After installing rubber, you will need to re-run the top level
|
||||
configure script. It checks to see if rubber is installed, so that the
|
||||
asterisk.pdf Makefile target can produce a useful error message when it is
|
||||
not installed.
|
||||
|
||||
2) To generate HTML from this documentation, you will need the latex2html tool,
|
||||
and all of its dependencies. The web site for this tool is:
|
||||
|
||||
http://www.latex2html.org/
|
||||
|
||||
Then, once this tool is installed, running "make html" will generate the
|
||||
HTML documentation. The result will be an asterisk directory full of
|
||||
HTML files.
|
Reference in New Issue
Block a user