include.am 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. # We use a two-step process to generate documentation from asciidoc files.
  2. #
  3. # First, we use asciidoc/a2x to process the asciidoc files into .1.in and
  4. # .html.in files (see the asciidoc-helper.sh script). These are the same as
  5. # the regular .1 and .html files, except that they still have some autoconf
  6. # variables set in them.
  7. #
  8. # Second, we use config.status to turn .1.in files into .1 files and
  9. # .html.in files into .html files.
  10. #
  11. # We do the steps in this order so that we can ship the .*.in files as
  12. # part of the source distribution, so that people without asciidoc can
  13. # just use the .1 and .html files.
  14. base_mans = doc/tor doc/tor-gencert doc/tor-resolve doc/torify
  15. all_mans = $(base_mans)
  16. if USE_FW_HELPER
  17. install_mans = $(all_mans)
  18. else
  19. install_mans = $(base_mans)
  20. endif
  21. if USE_ASCIIDOC
  22. nodist_man1_MANS = $(install_mans:=.1)
  23. doc_DATA = $(install_mans:=.html)
  24. html_in = $(all_mans:=.html.in)
  25. man_in = $(all_mans:=.1.in)
  26. txt_in = $(all_mans:=.1.txt)
  27. else
  28. html_in =
  29. man_in =
  30. txt_in =
  31. nodist_man1_MANS =
  32. doc_DATA =
  33. endif
  34. EXTRA_DIST+= doc/HACKING doc/asciidoc-helper.sh \
  35. $(html_in) $(man_in) $(txt_in) \
  36. doc/state-contents.txt \
  37. doc/torrc_format.txt \
  38. doc/TUNING \
  39. doc/WritingTests.txt
  40. docdir = @docdir@
  41. asciidoc_product = $(nodist_man1_MANS) $(doc_DATA)
  42. # Generate the html documentation from asciidoc, but don't do
  43. # machine-specific replacements yet
  44. $(html_in) :
  45. $(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh html @ASCIIDOC@ $(top_srcdir)/$@
  46. # Generate the manpage from asciidoc, but don't do
  47. # machine-specific replacements yet
  48. $(man_in) :
  49. $(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh man @A2X@ $(top_srcdir)/$@
  50. doc/tor.1.in: doc/tor.1.txt
  51. doc/torify.1.in: doc/torify.1.txt
  52. doc/tor-gencert.1.in: doc/tor-gencert.1.txt
  53. doc/tor-resolve.1.in: doc/tor-resolve.1.txt
  54. doc/tor.html.in: doc/tor.1.txt
  55. doc/torify.html.in: doc/torify.1.txt
  56. doc/tor-gencert.html.in: doc/tor-gencert.1.txt
  57. doc/tor-resolve.html.in: doc/tor-resolve.1.txt
  58. # use config.status to swap all machine-specific magic strings
  59. # in the asciidoc with their replacements.
  60. $(asciidoc_product) :
  61. $(AM_V_GEN)$(MKDIR_P) $(@D)
  62. $(AM_V_at)if test -e $(top_srcdir)/$@.in && ! test -e $@.in ; then \
  63. cp $(top_srcdir)/$@.in $@; \
  64. fi
  65. $(AM_V_at)$(top_builddir)/config.status -q --file=$@;
  66. doc/tor.html: doc/tor.html.in
  67. doc/tor-gencert.html: doc/tor-gencert.html.in
  68. doc/tor-resolve.html: doc/tor-resolve.html.in
  69. doc/torify.html: doc/torify.html.in
  70. doc/tor.1: doc/tor.1.in
  71. doc/tor-gencert.1: doc/tor-gencert.1.in
  72. doc/tor-resolve.1: doc/tor-resolve.1.in
  73. doc/torify.1: doc/torify.1.in
  74. CLEANFILES+= $(asciidoc_product) config.log
  75. DISTCLEANFILES+= $(html_in) $(man_in)