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