More enum docs.
[gnutls.git] / doc / Makefile.am
blob7766ec2840f45d714ab0aa1620aa58b5ecac166f
1 ## Process this file with automake to produce Makefile.in
2 # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
3 # 2009, 2010 Free Software Foundation, Inc.
5 # Author: Nikos Mavrogiannopoulos
7 # This file is part of GNUTLS.
9 # This file is free software; you can redistribute it and/or modify it
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # This file is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this file; if not, write to the Free Software Foundation,
21 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 EXTRA_DIST = TODO README.gaa certtool.cfg gnutls.ps gnutls.pdf  \
24         gnutls.html doxygen/Doxyfile.in doxygen/Doxyfile.orig   \
25         texinfo.css
27 SUBDIRS = examples cyclo scripts manpages credentials
28 if ENABLE_GTK_DOC
29 SUBDIRS += reference
30 endif
32 info_TEXINFOS = gnutls.texi
33 gnutls_TEXINFOS = gnutls.texi fdl-1.3.texi lgpl-2.1.texi gpl-3.0.texi
35 # Examples.
36 gnutls_TEXINFOS += examples/ex-client1.c examples/ex-client2.c          \
37         examples/ex-session-info.c examples/ex-verify.c                 \
38         examples/ex-cert-select.c examples/ex-client-resume.c           \
39         examples/ex-client-srp.c examples/ex-client-tlsia.c             \
40         examples/ex-rfc2818.c examples/ex-serv1.c                       \
41         examples/ex-serv-export.c examples/ex-serv-anon.c               \
42         examples/ex-serv-pgp.c examples/ex-serv-srp.c                   \
43         examples/ex-alert.c examples/ex-x509-info.c examples/ex-crq.c   \
44         examples/ex-pkcs12.c
46 # Images.  Make sure there are eps + png + pdf of each, plus the source dia.
47 gnutls_TEXINFOS += gnutls-internals.dia gnutls-internals.eps            \
48                    gnutls-internals.png gnutls-internals.pdf
49 gnutls_TEXINFOS += gnutls-layers.dia gnutls-layers.eps                  \
50                    gnutls-layers.png gnutls-layers.pdf
51 gnutls_TEXINFOS += gnutls-pgp.dia gnutls-pgp.eps gnutls-pgp.png         \
52                    gnutls-pgp.pdf
53 gnutls_TEXINFOS += gnutls-x509.dia gnutls-x509.eps gnutls-x509.png      \
54                    gnutls-x509.pdf
55 gnutls_TEXINFOS += gnutls-logo.eps gnutls-logo.png gnutls-logo.pdf
57 # Images.  Make sure there are eps + png + pdf of each, plus the source dia.
58 gnutls_TEXINFOS += gnutls-certificate-user-use-case.dia \
59         gnutls-certificate-user-use-case.eps            \
60         gnutls-certificate-user-use-case.pdf            \
61         gnutls-certificate-user-use-case.png
62 gnutls_TEXINFOS += gnutls-client-server-use-case.dia    \
63         gnutls-client-server-use-case.eps               \
64         gnutls-client-server-use-case.pdf               \
65         gnutls-client-server-use-case.png
66 gnutls_TEXINFOS += gnutls-extensions_st.dia gnutls-extensions_st.eps    \
67         gnutls-extensions_st.pdf gnutls-extensions_st.png
68 gnutls_TEXINFOS += gnutls-handshake-sequence.dia                        \
69         gnutls-handshake-sequence.eps gnutls-handshake-sequence.pdf     \
70         gnutls-handshake-sequence.png
71 gnutls_TEXINFOS += gnutls-handshake-state.dia                   \
72         gnutls-handshake-state.eps gnutls-handshake-state.pdf   \
73         gnutls-handshake-state.png
74 gnutls_TEXINFOS += gnutls-mod_auth_st.dia gnutls-mod_auth_st.eps        \
75         gnutls-mod_auth_st.pdf gnutls-mod_auth_st.png
76 gnutls_TEXINFOS += gnutls-objects.dia gnutls-objects.eps        \
77         gnutls-objects.pdf gnutls-objects.png
79 imagesdir = $(infodir)
80 images_DATA = gnutls-certificate-user-use-case.png              \
81         gnutls-extensions_st.png gnutls-handshake-state.png     \
82         gnutls-layers.png gnutls-mod_auth_st.png gnutls-pgp.png \
83         gnutls-client-server-use-case.png                       \
84         gnutls-handshake-sequence.png gnutls-internals.png      \
85         gnutls-logo.png gnutls-objects.png gnutls-x509.png
87 AM_MAKEINFOFLAGS = -I $(top_srcdir)/doc
88 TEXI2DVI = texi2dvi $(AM_MAKEINFOFLAGS)
89 AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) \
90         --no-split --css-include=$(srcdir)/texinfo.css
92 MAINTAINERCLEANFILES =
94 # Generated texinfos.
96 gnutls_TEXINFOS += gnutls-api.texi extra-api.texi ia-api.texi   \
97         x509-api.texi pgp-api.texi
98 MAINTAINERCLEANFILES += gnutls-api.texi extra-api.texi ia-api.texi      \
99         x509-api.texi pgp-api.texi
101 gnutls-api.texi: $(srcdir)/../lib/*.c
102         echo "" > $@-tmp
103         for i in $^; do \
104                 echo -n "Creating documentation for file $$i... " && \
105                 $(srcdir)/scripts/gdoc -texinfo $$i >> $@-tmp && \
106                 echo "ok"; \
107         done
108         $(srcdir)/scripts/sort2.pl < $@-tmp > $@-tmp2
109         rm -f $@-tmp
110         mv $@-tmp2 $@
112 x509-api.texi: $(srcdir)/../lib/x509/*.c
113         echo "" > $@-tmp
114         for i in $^; do \
115                 echo -n "Creating documentation for file $$i... " && \
116                 $(srcdir)/scripts/gdoc -texinfo $$i >> $@-tmp && \
117                 echo "ok"; \
118         done
119         $(srcdir)/scripts/sort2.pl < $@-tmp > $@-tmp2
120         rm -f $@-tmp
121         mv $@-tmp2 $@
123 pgp-api.texi: $(srcdir)/../lib/openpgp/*.c
124         echo "" > $@-tmp
125         for i in $^; do \
126                 echo -n "Creating documentation for file $$i... " && \
127                 $(srcdir)/scripts/gdoc -texinfo $$i >> $@-tmp && \
128                 echo "ok"; \
129         done
130         $(srcdir)/scripts/sort2.pl < $@-tmp > $@-tmp2
131         rm -f $@-tmp
132         mv $@-tmp2 $@
134 extra-api.texi: $(srcdir)/../libextra/gnutls_extra.c
135         echo "" > $@-tmp
136         for i in $^; do \
137                 echo -n "Creating documentation for file $$i... " && \
138                 $(srcdir)/scripts/gdoc -texinfo $$i >> $@-tmp && \
139                 echo "ok"; \
140         done
141         $(srcdir)/scripts/sort2.pl < $@-tmp > $@-tmp2
142         rm -f $@-tmp
143         mv $@-tmp2 $@
145 ia-api.texi: $(srcdir)/../libextra/gnutls_ia.c
146         echo "" > $@-tmp
147         for i in $^; do \
148                 echo -n "Creating documentation for file $$i... " && \
149                 $(srcdir)/scripts/gdoc -texinfo $$i >> $@-tmp && \
150                 echo "ok"; \
151         done
152         $(srcdir)/scripts/sort2.pl < $@-tmp > $@-tmp2
153         rm -f $@-tmp
154         mv $@-tmp2 $@
156 # Generated texinfos.
158 gnutls_TEXINFOS += error_codes.texi algorithms.texi
159 MAINTAINERCLEANFILES += error_codes.texi algorithms.texi
161 AM_CPPFLAGS = -I$(top_srcdir)/lib/includes -I$(top_builddir)/lib/includes
163 noinst_PROGRAMS = errcodes printlist
165 errcodes_SOURCES = errcodes.c
166 errcodes_LDADD = ../lib/libgnutls.la ../gl/libgnu.la
168 printlist_SOURCES = printlist.c
169 printlist_LDADD = ../lib/libgnutls.la ../gl/libgnu.la
171 error_codes.texi: $(top_srcdir)/lib/gnutls_errors.c $(srcdir)/errcodes.c
172         make $(builddir)/errcodes
173         $(builddir)/errcodes > $@-tmp
174         mv $@-tmp $@
176 algorithms.texi: $(srcdir)/printlist.c
177         make $(builddir)/printlist
178         $(builddir)/printlist > $@-tmp
179         mv $@-tmp $@
181 # Guile texinfos.
183 guile_texi           = core.c.texi extra.c.texi
184 gnutls_TEXINFOS      += guile.texi $(guile_texi)
185 BUILT_SOURCES        = $(guile_texi)
186 MAINTAINERCLEANFILES += $(guile_texi)
187 EXTRA_DIST           += $(guile_texi) extract-guile-c-doc.scm
189 if HAVE_GUILE
191 GUILE_FOR_BUILD =                               \
192   GUILE_AUTO_COMPILE=0                          \
193   $(GUILE) -L $(top_srcdir)/guile/modules
195 SNARF_CPPFLAGS = -I$(top_srcdir) -I$(top_builddir)                      \
196          -I$(top_srcdir)/lib/includes -I$(top_builddir)/lib/includes    \
197          -I$(top_srcdir)/libextra/includes                              \
198          -I$(top_srcdir)/guile/src -I$(top_builddir)/guile/src
200 core.c.texi: $(top_srcdir)/guile/src/core.c
201         $(MAKE) -C ../guile/src built-sources &&                        \
202         $(GUILE_FOR_BUILD) -l "$(srcdir)/extract-guile-c-doc.scm"       \
203            -e '(apply main (cdr (command-line)))'                       \
204            -- "$^" "$(CPP)" "$(SNARF_CPPFLAGS) $(CPPFLAGS)"             \
205            > "$@"
207 extra.c.texi: $(top_srcdir)/guile/src/extra.c
208         $(MAKE) -C ../guile/src built-sources &&                        \
209         $(GUILE_FOR_BUILD) -l "$(srcdir)/extract-guile-c-doc.scm"       \
210            -e '(apply main (cdr (command-line)))'                       \
211            -- "$^" "$(CPP)" "$(SNARF_CPPFLAGS) $(CPPFLAGS)"             \
212            > "$@"
215 else !HAVE_GUILE
217 core.c.texi:
218         echo "(Guile not available, documentation not generated.)" > $@
220 extra.c.texi:
221         echo "(Guile not available, documentation not generated.)" > $@
224 endif !HAVE_GUILE