doc/include.am

   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
  15 all_mans = doc/tor doc/tor-gencert doc/tor-resolve doc/torify
  16
  17 if USE_ASCIIDOC
  18 nodist_man1_MANS = $(all_mans:=.1)
  19 doc_DATA = $(all_mans:=.html)
  20 html_in = $(all_mans:=.html.in)
  21 man_in = $(all_mans:=.1.in)
  22 txt_in = $(all_mans:=.1.txt)
  23 else
  24 html_in =
  25 man_in =
  26 txt_in =
  27 nodist_man1_MANS =
  28 doc_DATA =
  29 endif
  30
  31 EXTRA_DIST+= doc/asciidoc-helper.sh                     \
  32              $(html_in) $(man_in) $(txt_in)                     \
  33              doc/state-contents.txt                             \
  34              doc/torrc_format.txt                               \
  35              doc/TUNING                                         \
  36              doc/HACKING/README.1st.md                          \
  37              doc/HACKING/CodingStandards.md                     \
  38              doc/HACKING/GettingStarted.md                      \
  39              doc/HACKING/HelpfulTools.md                        \
  40              doc/HACKING/HowToReview.md                         \
  41              doc/HACKING/ReleasingTor.md                        \
  42              doc/HACKING/WritingTests.md
  43
  44 docdir = @docdir@
  45
  46 asciidoc_product = $(nodist_man1_MANS) $(doc_DATA)
  47
  48 # Generate the html documentation from asciidoc, but don't do
  49 # machine-specific replacements yet
  50 $(html_in) :
  51         $(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh html @ASCIIDOC@ $(top_srcdir)/$@
  52
  53 # Generate the manpage from asciidoc, but don't do
  54 # machine-specific replacements yet
  55 $(man_in) :
  56         $(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh man @A2X@ $(top_srcdir)/$@
  57
  58 doc/tor.1.in: doc/tor.1.txt
  59 doc/torify.1.in: doc/torify.1.txt
  60 doc/tor-gencert.1.in: doc/tor-gencert.1.txt
  61 doc/tor-resolve.1.in: doc/tor-resolve.1.txt
  62
  63 doc/tor.html.in: doc/tor.1.txt
  64 doc/torify.html.in: doc/torify.1.txt
  65 doc/tor-gencert.html.in: doc/tor-gencert.1.txt
  66 doc/tor-resolve.html.in: doc/tor-resolve.1.txt
  67
  68 # use config.status to swap all machine-specific magic strings
  69 # in the asciidoc with their replacements.
  70 $(asciidoc_product) :
  71         $(AM_V_GEN)$(MKDIR_P) $(@D)
  72         $(AM_V_at)if test -e $(top_srcdir)/$@.in && ! test -e $@.in ; then \
  73                 cp $(top_srcdir)/$@.in $@; \
  74         fi
  75         $(AM_V_at)$(top_builddir)/config.status -q --file=$@;
  76
  77 doc/tor.html: doc/tor.html.in
  78 doc/tor-gencert.html: doc/tor-gencert.html.in
  79 doc/tor-resolve.html: doc/tor-resolve.html.in
  80 doc/torify.html: doc/torify.html.in
  81
  82 doc/tor.1: doc/tor.1.in
  83 doc/tor-gencert.1: doc/tor-gencert.1.in
  84 doc/tor-resolve.1: doc/tor-resolve.1.in
  85 doc/torify.1: doc/torify.1.in
  86
  87 CLEANFILES+= $(asciidoc_product)
  88 DISTCLEANFILES+= $(html_in) $(man_in)