mirror of https://github.com/asterisk/asterisk
* 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-fbb531ad65f31.6.0
parent
94b934c8f6
commit
df1a340774
@ -0,0 +1,35 @@
|
|||||||
|
include ../../makeopts
|
||||||
|
|
||||||
|
pdf: asterisk.pdf
|
||||||
|
|
||||||
|
asterisk.pdf: $(wildcard *.tex)
|
||||||
|
ifeq ($(findstring rubber,$(RUBBER)),)
|
||||||
|
@echo "**********************************************"
|
||||||
|
@echo "** You must install the \"rubber\" tool ***"
|
||||||
|
@echo "** to generate the Asterisk reference PDF. ***"
|
||||||
|
@echo "**********************************************"
|
||||||
|
else
|
||||||
|
@echo "**********************************************"
|
||||||
|
@echo "** The Asterisk reference PDF will now be ***"
|
||||||
|
@echo "** generated. When complete, it will be ***"
|
||||||
|
@echo "** located at asterisk.pdf. ***"
|
||||||
|
@echo "**********************************************"
|
||||||
|
@cp asterisk.tex asterisk.tex.orig
|
||||||
|
@sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' asterisk.tex
|
||||||
|
@$(RUBBER) --pdf asterisk.tex
|
||||||
|
@mv asterisk.tex.orig asterisk.tex
|
||||||
|
endif
|
||||||
|
|
||||||
|
html:
|
||||||
|
@echo "**********************************************"
|
||||||
|
@echo "** The Asterisk reference HTML will now be ***"
|
||||||
|
@echo "** generated. When complete, it will be ***"
|
||||||
|
@echo "** located in the asterisk/ directory. ***"
|
||||||
|
@echo "** Note that the latex2html tool is ***"
|
||||||
|
@echo "** required for this to work. ***"
|
||||||
|
@echo "**********************************************"
|
||||||
|
@cp asterisk.tex asterisk.tex.orig
|
||||||
|
@sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' asterisk.tex
|
||||||
|
@latex2html asterisk.tex
|
||||||
|
@mv asterisk.tex.orig asterisk.tex
|
||||||
|
|
@ -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.
|
Loading…
Reference in new issue