doc/Makefile.am

   1 ## Process this file with automake to produce Makefile.in
   2 # Copyright (C) 2002, 2003, 2004, 2005, 2006 Simon Josefsson.
   3 #
   4 # This file is part of GNU SASL.
   5 #
   6 # GNU SASL is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2, or (at your option)
   9 # any later version.
  10 #
  11 # GNU SASL is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with GNU SASL; if not, write to the Free Software Foundation,
  18 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19
  20 if ENABLE_GTK_DOC
  21 SUBDIRS = reference
  22 endif
  23
  24 EXTRA_DIST = gdoc gdoc-error \
  25         controlflow.dia controlflow2.dia abstraction.dia \
  26         gsasl.html gsasl.ps gsasl.pdf texinfo.css \
  27         doxygen/Doxyfile.in doxygen/gdoc2doxygen
  28
  29 .dia.png:
  30         $(DIA) --export=$@ --export-to-format=png $<
  31
  32 .dia.eps:
  33         $(DIA) --export=$@ --export-to-format=eps $<
  34
  35 .eps.pdf:
  36         $(EPSTOPDF) $<
  37
  38 info_TEXINFOS = gsasl.texi
  39 gsasl_TEXINFOS = fdl.texi $(gdoc_TEXINFOS) \
  40         controlflow.eps controlflow.png controlflow.pdf \
  41         controlflow2.eps controlflow2.png controlflow2.pdf \
  42         abstraction.eps abstraction.png abstraction.pdf \
  43         gsasl-callback-password.texi gsasl-callback-authorization.texi \
  44         gsasl-callback-authentication.texi gsasl-callback-validate.texi \
  45         gsasl-callback-retrieve.texi gsasl-callback-cram-md5.texi \
  46         gsasl-callback-digest-md5.texi gsasl-callback-passcode.texi \
  47         gsasl-callback-gssapi.texi gsasl-callback-securid.texi \
  48         gsasl-callback-client-service.texi gsasl-callback-server-service.texi \
  49         gsasl-api-error-labels.texi
  50
  51 gsasl-api-error-labels.texi: $(top_srcdir)/lib/src/error.c
  52         $(PERL) $(srcdir)/gdoc-error $^ > $@
  53
  54 AM_MAKEINFOFLAGS = -I $(top_builddir)/doc -I $(top_srcdir)/examples
  55 TEXI2DVI = texi2dvi $(AM_MAKEINFOFLAGS)
  56 AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) \
  57         --no-split --number-sections --css-include=texinfo.css
  58
  59 dist_man_MANS = gsasl.1 $(gdoc_MANS)
  60 MAINTAINERCLEANFILES = $(dist_man_MANS)
  61
  62 gsasl.1: $(top_srcdir)/src/gsasl.c $(top_srcdir)/src/gsasl.ggo \
  63                 $(top_srcdir)/configure.ac
  64         $(HELP2MAN) \
  65                 --name="SASL library command line interface" \
  66                 --output=$@ $(top_builddir)/src/gsasl$(EXEEXT)
  67
  68 gdoc_MANS = man/gsasl_base64_to.3 man/gsasl_base64_from.3 man/gsasl_callback_set.3 man/gsasl_callback.3 man/gsasl_callback_hook_set.3 man/gsasl_callback_hook_get.3 man/gsasl_session_hook_set.3 man/gsasl_session_hook_get.3 man/gsasl_nonce.3 man/gsasl_random.3 man/gsasl_md5.3 man/gsasl_hmac_md5.3 man/gsasl_done.3 man/gsasl_strerror.3 man/gsasl_init.3 man/gsasl_client_mechlist.3 man/gsasl_server_mechlist.3 man/gsasl_simple_getpass.3 man/gsasl_client_listmech.3 man/gsasl_server_listmech.3 man/gsasl_client_step.3 man/gsasl_server_step.3 man/gsasl_client_step_base64.3 man/gsasl_server_step_base64.3 man/gsasl_client_finish.3 man/gsasl_server_finish.3 man/gsasl_client_ctx_get.3 man/gsasl_client_application_data_set.3 man/gsasl_client_application_data_get.3 man/gsasl_server_ctx_get.3 man/gsasl_server_application_data_set.3 man/gsasl_server_application_data_get.3 man/gsasl_randomize.3 man/gsasl_ctx_get.3 man/gsasl_encode_inline.3 man/gsasl_decode_inline.3 man/gsasl_application_data_set.3 man/gsasl_application_data_get.3 man/gsasl_appinfo_set.3 man/gsasl_appinfo_get.3 man/gsasl_server_suggest_mechanism.3 man/gsasl_client_callback_authentication_id_set.3 man/gsasl_client_callback_authentication_id_get.3 man/gsasl_client_callback_authorization_id_set.3 man/gsasl_client_callback_authorization_id_get.3 man/gsasl_client_callback_password_set.3 man/gsasl_client_callback_password_get.3 man/gsasl_client_callback_passcode_set.3 man/gsasl_client_callback_passcode_get.3 man/gsasl_client_callback_pin_set.3 man/gsasl_client_callback_pin_get.3 man/gsasl_client_callback_service_set.3 man/gsasl_client_callback_service_get.3 man/gsasl_client_callback_anonymous_set.3 man/gsasl_client_callback_anonymous_get.3 man/gsasl_client_callback_qop_set.3 man/gsasl_client_callback_qop_get.3 man/gsasl_client_callback_maxbuf_set.3 man/gsasl_client_callback_maxbuf_get.3 man/gsasl_client_callback_realm_set.3 man/gsasl_client_callback_realm_get.3 man/gsasl_server_callback_validate_set.3 man/gsasl_server_callback_validate_get.3 man/gsasl_server_callback_retrieve_set.3 man/gsasl_server_callback_retrieve_get.3 man/gsasl_server_callback_cram_md5_set.3 man/gsasl_server_callback_cram_md5_get.3 man/gsasl_server_callback_digest_md5_set.3 man/gsasl_server_callback_digest_md5_get.3 man/gsasl_server_callback_external_set.3 man/gsasl_server_callback_external_get.3 man/gsasl_server_callback_anonymous_set.3 man/gsasl_server_callback_anonymous_get.3 man/gsasl_server_callback_realm_set.3 man/gsasl_server_callback_realm_get.3 man/gsasl_server_callback_qop_set.3 man/gsasl_server_callback_qop_get.3 man/gsasl_server_callback_maxbuf_set.3 man/gsasl_server_callback_maxbuf_get.3 man/gsasl_server_callback_cipher_set.3 man/gsasl_server_callback_cipher_get.3 man/gsasl_server_callback_securid_set.3 man/gsasl_server_callback_securid_get.3 man/gsasl_server_callback_gssapi_set.3 man/gsasl_server_callback_gssapi_get.3 man/gsasl_server_callback_service_set.3 man/gsasl_server_callback_service_get.3 man/gsasl_stringprep_nfkc.3 man/gsasl_stringprep_saslprep.3 man/gsasl_stringprep_trace.3 man/gsasl_md5pwd_get_password.3 man/gsasl_base64_encode.3 man/gsasl_base64_decode.3 man/gsasl_property_set.3 man/gsasl_property_set_raw.3 man/gsasl_property_fast.3 man/gsasl_property_get.3 man/gsasl_register.3 man/gsasl_saslprep.3 man/gsasl_client_suggest_mechanism.3 man/gsasl_client_support_p.3 man/gsasl_server_support_p.3 man/gsasl_check_version.3 man/gsasl_encode.3 man/gsasl_decode.3 man/gsasl_finish.3 man/gsasl_client_start.3 man/gsasl_server_start.3 man/gsasl_step.3 man/gsasl_step64.3
  69 gdoc_TEXINFOS = texi/base64.c.texi texi/callback.c.texi texi/crypto.c.texi texi/done.c.texi texi/doxygen.c.texi texi/error.c.texi texi/init.c.texi texi/listmech.c.texi texi/md5pwd.c.texi texi/obsolete.c.texi texi/property.c.texi texi/register.c.texi texi/saslprep.c.texi texi/suggest.c.texi texi/supportp.c.texi texi/version.c.texi texi/xcode.c.texi texi/xfinish.c.texi texi/xstart.c.texi texi/xstep.c.texi texi/gsasl_base64_to.texi texi/gsasl_base64_from.texi texi/gsasl_callback_set.texi texi/gsasl_callback.texi texi/gsasl_callback_hook_set.texi texi/gsasl_callback_hook_get.texi texi/gsasl_session_hook_set.texi texi/gsasl_session_hook_get.texi texi/gsasl_nonce.texi texi/gsasl_random.texi texi/gsasl_md5.texi texi/gsasl_hmac_md5.texi texi/gsasl_done.texi texi/gsasl_strerror.texi texi/gsasl_init.texi texi/gsasl_client_mechlist.texi texi/gsasl_server_mechlist.texi texi/gsasl_simple_getpass.texi texi/gsasl_client_listmech.texi texi/gsasl_server_listmech.texi texi/gsasl_client_step.texi texi/gsasl_server_step.texi texi/gsasl_client_step_base64.texi texi/gsasl_server_step_base64.texi texi/gsasl_client_finish.texi texi/gsasl_server_finish.texi texi/gsasl_client_ctx_get.texi texi/gsasl_client_application_data_set.texi texi/gsasl_client_application_data_get.texi texi/gsasl_server_ctx_get.texi texi/gsasl_server_application_data_set.texi texi/gsasl_server_application_data_get.texi texi/gsasl_randomize.texi texi/gsasl_ctx_get.texi texi/gsasl_encode_inline.texi texi/gsasl_decode_inline.texi texi/gsasl_application_data_set.texi texi/gsasl_application_data_get.texi texi/gsasl_appinfo_set.texi texi/gsasl_appinfo_get.texi texi/gsasl_server_suggest_mechanism.texi texi/gsasl_client_callback_authentication_id_set.texi texi/gsasl_client_callback_authentication_id_get.texi texi/gsasl_client_callback_authorization_id_set.texi texi/gsasl_client_callback_authorization_id_get.texi texi/gsasl_client_callback_password_set.texi texi/gsasl_client_callback_password_get.texi texi/gsasl_client_callback_passcode_set.texi texi/gsasl_client_callback_passcode_get.texi texi/gsasl_client_callback_pin_set.texi texi/gsasl_client_callback_pin_get.texi texi/gsasl_client_callback_service_set.texi texi/gsasl_client_callback_service_get.texi texi/gsasl_client_callback_anonymous_set.texi texi/gsasl_client_callback_anonymous_get.texi texi/gsasl_client_callback_qop_set.texi texi/gsasl_client_callback_qop_get.texi texi/gsasl_client_callback_maxbuf_set.texi texi/gsasl_client_callback_maxbuf_get.texi texi/gsasl_client_callback_realm_set.texi texi/gsasl_client_callback_realm_get.texi texi/gsasl_server_callback_validate_set.texi texi/gsasl_server_callback_validate_get.texi texi/gsasl_server_callback_retrieve_set.texi texi/gsasl_server_callback_retrieve_get.texi texi/gsasl_server_callback_cram_md5_set.texi texi/gsasl_server_callback_cram_md5_get.texi texi/gsasl_server_callback_digest_md5_set.texi texi/gsasl_server_callback_digest_md5_get.texi texi/gsasl_server_callback_external_set.texi texi/gsasl_server_callback_external_get.texi texi/gsasl_server_callback_anonymous_set.texi texi/gsasl_server_callback_anonymous_get.texi texi/gsasl_server_callback_realm_set.texi texi/gsasl_server_callback_realm_get.texi texi/gsasl_server_callback_qop_set.texi texi/gsasl_server_callback_qop_get.texi texi/gsasl_server_callback_maxbuf_set.texi texi/gsasl_server_callback_maxbuf_get.texi texi/gsasl_server_callback_cipher_set.texi texi/gsasl_server_callback_cipher_get.texi texi/gsasl_server_callback_securid_set.texi texi/gsasl_server_callback_securid_get.texi texi/gsasl_server_callback_gssapi_set.texi texi/gsasl_server_callback_gssapi_get.texi texi/gsasl_server_callback_service_set.texi texi/gsasl_server_callback_service_get.texi texi/gsasl_stringprep_nfkc.texi texi/gsasl_stringprep_saslprep.texi texi/gsasl_stringprep_trace.texi texi/gsasl_md5pwd_get_password.texi texi/gsasl_base64_encode.texi texi/gsasl_base64_decode.texi texi/gsasl_property_set.texi texi/gsasl_property_set_raw.texi texi/gsasl_property_fast.texi texi/gsasl_property_get.texi texi/gsasl_register.texi texi/gsasl_saslprep.texi texi/gsasl_client_suggest_mechanism.texi texi/gsasl_client_support_p.texi texi/gsasl_server_support_p.texi texi/gsasl_check_version.texi texi/gsasl_encode.texi texi/gsasl_decode.texi texi/gsasl_finish.texi texi/gsasl_client_start.texi texi/gsasl_server_start.texi texi/gsasl_step.texi texi/gsasl_step64.texi
  70
  71 $(gdoc_MANS) $(gdoc_TEXINFOS):
  72         make update-makefile
  73         make Makefile
  74         make doit
  75
  76 GDOC_SRC = $(top_srcdir)/lib/src/*.c
  77
  78 update-makefile:
  79         @MANS=""; \
  80         TEXINFOS=""; \
  81         for i in $(GDOC_SRC); do \
  82                 BASE=`basename $$i`; \
  83                 TEXINFOS="$$TEXINFOS texi/$$BASE.texi"; \
  84         done; \
  85         FUNCS=`./gdoc -listfunc $(GDOC_SRC)`; \
  86         for i in $$FUNCS; do \
  87                 MANS="$$MANS man/$$i.3"; \
  88                 TEXINFOS="$$TEXINFOS texi/$$i.texi"; \
  89         done; \
  90         perl -pi -e "s,^gdoc_MANS =.*,gdoc_MANS =$$MANS,;" \
  91                 -e "s,^gdoc_TEXINFOS =.*,gdoc_TEXINFOS =$$TEXINFOS,;" \
  92                 Makefile.am
  93
  94 doit:
  95         @$(mkdir_p) man texi; \
  96         for i in `./gdoc -listfunc $(GDOC_SRC)`; do \
  97                 echo -n "Creating documentation for $$i... " && \
  98                 ./gdoc -man \
  99                         -module $(PACKAGE) -sourceversion $(VERSION) \
 100                         -bugsto $(PACKAGE_BUGREPORT) \
 101                         -includefuncprefix \
 102                         -seeinfo $(PACKAGE) -verbatimcopying \
 103                         -copyright "2002, 2003, 2004 Simon Josefsson" \
 104                         -function $$i \
 105                         $(GDOC_SRC) > man/$$i.3 && \
 106                 ./gdoc -texinfo -function $$i \
 107                         $(GDOC_SRC) > texi/$$i.texi && \
 108                 echo "ok"; \
 109         done; \
 110         for i in $(GDOC_SRC); do \
 111                 BASE=`basename $$i`; \
 112                 echo -n "Creating documentation for $$i... " && \
 113                 ./gdoc -texinfo $$i > texi/$$BASE.texi && \
 114                 echo "ok"; \
 115         done
 116
 117 .PHONY: update-makefile doit