diff options
| -rw-r--r-- | Makefile | 18 | ||||
| -rwxr-xr-x | build_tools/prep_tarball | 4 | ||||
| -rw-r--r-- | doc/tex/Makefile | 35 | ||||
| -rw-r--r-- | doc/tex/README.txt | 24 | ||||
| -rw-r--r-- | doc/tex/ael.tex (renamed from doc/ael.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/ajam.tex (renamed from doc/ajam.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/app-sms.tex (renamed from doc/app-sms.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/ast_agi_commands.tex (renamed from doc/ast_agi_commands.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/ast_appdocs.tex (renamed from doc/ast_appdocs.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/ast_cli_commands.tex (renamed from doc/ast_cli_commands.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/ast_funcdocs.tex (renamed from doc/ast_funcdocs.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/ast_manager_actiondocs.tex (renamed from doc/ast_manager_actiondocs.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/asterisk-conf.tex (renamed from doc/asterisk-conf.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/asterisk.tex (renamed from doc/asterisk.tex) | 4 | ||||
| -rw-r--r-- | doc/tex/billing.tex (renamed from doc/billing.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/cdrdriver.tex (renamed from doc/cdrdriver.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/chaniax.tex (renamed from doc/chaniax.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/channelvariables.tex (renamed from doc/channelvariables.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/cliprompt.tex (renamed from doc/cliprompt.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/configuration.tex (renamed from doc/configuration.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/dundi.tex (renamed from doc/dundi.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/enum.tex (renamed from doc/enum.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/extensions.tex (renamed from doc/extensions.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/freetds.tex (renamed from doc/freetds.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/hardware.tex (renamed from doc/hardware.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/ices.tex (renamed from doc/ices.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/imapstorage.tex (renamed from doc/imapstorage.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/jitterbuffer.tex (renamed from doc/jitterbuffer.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/localchannel.tex (renamed from doc/localchannel.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/manager.tex (renamed from doc/manager.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/misdn.tex (renamed from doc/misdn.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/mp3.tex (renamed from doc/mp3.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/odbcstorage.tex (renamed from doc/odbcstorage.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/privacy.tex (renamed from doc/privacy.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/qos.tex (renamed from doc/qos.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/queuelog.tex (renamed from doc/queuelog.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/queues-with-callback-members.tex (renamed from doc/queues-with-callback-members.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/realtime.tex (renamed from doc/realtime.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/security.tex (renamed from doc/security.tex) | 0 | ||||
| -rw-r--r-- | doc/tex/sla.tex (renamed from doc/sla.tex) | 0 |
40 files changed, 64 insertions, 21 deletions
@@ -699,22 +699,4 @@ menuselect-tree: $(foreach dir,$(filter-out main,$(MOD_SUBDIRS)),$(wildcard $(di asterisk.pdf: doc/asterisk.pdf -doc/asterisk.pdf: $(wildcard doc/*.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 doc/asterisk.pdf. ***" - @echo "**********************************************" - @cp doc/asterisk.tex doc/asterisk.tex.orig - @sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' doc/asterisk.tex - @cd doc && $(RUBBER) --pdf asterisk.tex - @mv doc/asterisk.tex.orig doc/asterisk.tex -endif - .PHONY: menuselect main sounds clean dist-clean distclean all prereqs cleantest uninstall _uninstall uninstall-all dont-optimize $(SUBDIRS_INSTALL) $(SUBDIRS_CLEAN) $(SUBDIRS_UNINSTALL) $(SUBDIRS) $(MOD_SUBDIRS_EMBED_LDSCRIPT) $(MOD_SUBDIRS_EMBED_LDFLAGS) $(MOD_SUBDIRS_EMBED_LIBS) menuselect.makeopts diff --git a/build_tools/prep_tarball b/build_tools/prep_tarball index dbdbd46b2..d8a55be3d 100755 --- a/build_tools/prep_tarball +++ b/build_tools/prep_tarball @@ -9,4 +9,6 @@ make -C sounds all MENUSELECT_CORE_SOUNDS=CORE-SOUNDS-EN-GSM MENUSELECT_MOH=MOH- make menuselect-tree -cd doc && rubber --pdf asterisk.tex +VERSION=`cat .version` +sed -i -e "s/ASTERISKVERSION/${VERSION}/" doc/tex/asterisk.tex +cd doc/tex && rubber --pdf asterisk.tex diff --git a/doc/tex/Makefile b/doc/tex/Makefile new file mode 100644 index 000000000..2ccf892d3 --- /dev/null +++ b/doc/tex/Makefile @@ -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 + diff --git a/doc/tex/README.txt b/doc/tex/README.txt new file mode 100644 index 000000000..460d330a0 --- /dev/null +++ b/doc/tex/README.txt @@ -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. diff --git a/doc/ael.tex b/doc/tex/ael.tex index 416b67e34..416b67e34 100644 --- a/doc/ael.tex +++ b/doc/tex/ael.tex diff --git a/doc/ajam.tex b/doc/tex/ajam.tex index b5e184931..b5e184931 100644 --- a/doc/ajam.tex +++ b/doc/tex/ajam.tex diff --git a/doc/app-sms.tex b/doc/tex/app-sms.tex index b588761d8..b588761d8 100644 --- a/doc/app-sms.tex +++ b/doc/tex/app-sms.tex diff --git a/doc/ast_agi_commands.tex b/doc/tex/ast_agi_commands.tex index 5a63d3a3e..5a63d3a3e 100644 --- a/doc/ast_agi_commands.tex +++ b/doc/tex/ast_agi_commands.tex diff --git a/doc/ast_appdocs.tex b/doc/tex/ast_appdocs.tex index d4f36d4ce..d4f36d4ce 100644 --- a/doc/ast_appdocs.tex +++ b/doc/tex/ast_appdocs.tex diff --git a/doc/ast_cli_commands.tex b/doc/tex/ast_cli_commands.tex index e7e58b4e4..e7e58b4e4 100644 --- a/doc/ast_cli_commands.tex +++ b/doc/tex/ast_cli_commands.tex diff --git a/doc/ast_funcdocs.tex b/doc/tex/ast_funcdocs.tex index 280308b25..280308b25 100644 --- a/doc/ast_funcdocs.tex +++ b/doc/tex/ast_funcdocs.tex diff --git a/doc/ast_manager_actiondocs.tex b/doc/tex/ast_manager_actiondocs.tex index 4c08c2055..4c08c2055 100644 --- a/doc/ast_manager_actiondocs.tex +++ b/doc/tex/ast_manager_actiondocs.tex diff --git a/doc/asterisk-conf.tex b/doc/tex/asterisk-conf.tex index 119a1cc24..119a1cc24 100644 --- a/doc/asterisk-conf.tex +++ b/doc/tex/asterisk-conf.tex diff --git a/doc/asterisk.tex b/doc/tex/asterisk.tex index 10ad7f039..e6bbf3820 100644 --- a/doc/asterisk.tex +++ b/doc/tex/asterisk.tex @@ -22,7 +22,7 @@ This document contains various pieces of information that are useful for reference purposes. \section{License Information} - \input{../LICENSE} + \input{../../LICENSE} \subsection{Hold Music} Digium has licensed the music included with the Asterisk distribution From FreePlayMusic @@ -81,7 +81,7 @@ reference purposes. \section{Introduction} \input{dundi.tex} \section{Peering Agreement} - \input{PEERING} + \input{../PEERING} \chapter{ENUM} \input{enum.tex} diff --git a/doc/billing.tex b/doc/tex/billing.tex index e1d3131fa..e1d3131fa 100644 --- a/doc/billing.tex +++ b/doc/tex/billing.tex diff --git a/doc/cdrdriver.tex b/doc/tex/cdrdriver.tex index 00c99daea..00c99daea 100644 --- a/doc/cdrdriver.tex +++ b/doc/tex/cdrdriver.tex diff --git a/doc/chaniax.tex b/doc/tex/chaniax.tex index 954e068b0..954e068b0 100644 --- a/doc/chaniax.tex +++ b/doc/tex/chaniax.tex diff --git a/doc/channelvariables.tex b/doc/tex/channelvariables.tex index 8b50d0459..8b50d0459 100644 --- a/doc/channelvariables.tex +++ b/doc/tex/channelvariables.tex diff --git a/doc/cliprompt.tex b/doc/tex/cliprompt.tex index 859943120..859943120 100644 --- a/doc/cliprompt.tex +++ b/doc/tex/cliprompt.tex diff --git a/doc/configuration.tex b/doc/tex/configuration.tex index a501928bb..a501928bb 100644 --- a/doc/configuration.tex +++ b/doc/tex/configuration.tex diff --git a/doc/dundi.tex b/doc/tex/dundi.tex index c932da48c..c932da48c 100644 --- a/doc/dundi.tex +++ b/doc/tex/dundi.tex diff --git a/doc/enum.tex b/doc/tex/enum.tex index 699042d18..699042d18 100644 --- a/doc/enum.tex +++ b/doc/tex/enum.tex diff --git a/doc/extensions.tex b/doc/tex/extensions.tex index 28a49f092..28a49f092 100644 --- a/doc/extensions.tex +++ b/doc/tex/extensions.tex diff --git a/doc/freetds.tex b/doc/tex/freetds.tex index 8dcbec29a..8dcbec29a 100644 --- a/doc/freetds.tex +++ b/doc/tex/freetds.tex diff --git a/doc/hardware.tex b/doc/tex/hardware.tex index 3d7cabd82..3d7cabd82 100644 --- a/doc/hardware.tex +++ b/doc/tex/hardware.tex diff --git a/doc/ices.tex b/doc/tex/ices.tex index 77267b506..77267b506 100644 --- a/doc/ices.tex +++ b/doc/tex/ices.tex diff --git a/doc/imapstorage.tex b/doc/tex/imapstorage.tex index fccdc43bb..fccdc43bb 100644 --- a/doc/imapstorage.tex +++ b/doc/tex/imapstorage.tex diff --git a/doc/jitterbuffer.tex b/doc/tex/jitterbuffer.tex index 5122f1286..5122f1286 100644 --- a/doc/jitterbuffer.tex +++ b/doc/tex/jitterbuffer.tex diff --git a/doc/localchannel.tex b/doc/tex/localchannel.tex index 76cf44566..76cf44566 100644 --- a/doc/localchannel.tex +++ b/doc/tex/localchannel.tex diff --git a/doc/manager.tex b/doc/tex/manager.tex index 4c505ce5e..4c505ce5e 100644 --- a/doc/manager.tex +++ b/doc/tex/manager.tex diff --git a/doc/misdn.tex b/doc/tex/misdn.tex index 3b1ca17ae..3b1ca17ae 100644 --- a/doc/misdn.tex +++ b/doc/tex/misdn.tex diff --git a/doc/mp3.tex b/doc/tex/mp3.tex index b1713fc1d..b1713fc1d 100644 --- a/doc/mp3.tex +++ b/doc/tex/mp3.tex diff --git a/doc/odbcstorage.tex b/doc/tex/odbcstorage.tex index 97d1c94f1..97d1c94f1 100644 --- a/doc/odbcstorage.tex +++ b/doc/tex/odbcstorage.tex diff --git a/doc/privacy.tex b/doc/tex/privacy.tex index eed47644d..eed47644d 100644 --- a/doc/privacy.tex +++ b/doc/tex/privacy.tex diff --git a/doc/qos.tex b/doc/tex/qos.tex index b86107fe5..b86107fe5 100644 --- a/doc/qos.tex +++ b/doc/tex/qos.tex diff --git a/doc/queuelog.tex b/doc/tex/queuelog.tex index dd2047af6..dd2047af6 100644 --- a/doc/queuelog.tex +++ b/doc/tex/queuelog.tex diff --git a/doc/queues-with-callback-members.tex b/doc/tex/queues-with-callback-members.tex index b1a7d8fd2..b1a7d8fd2 100644 --- a/doc/queues-with-callback-members.tex +++ b/doc/tex/queues-with-callback-members.tex diff --git a/doc/realtime.tex b/doc/tex/realtime.tex index c08dbc8a5..c08dbc8a5 100644 --- a/doc/realtime.tex +++ b/doc/tex/realtime.tex diff --git a/doc/security.tex b/doc/tex/security.tex index 188f42cab..188f42cab 100644 --- a/doc/security.tex +++ b/doc/tex/security.tex diff --git a/doc/sla.tex b/doc/tex/sla.tex index efcd6b43f..efcd6b43f 100644 --- a/doc/sla.tex +++ b/doc/tex/sla.tex |