From a1c11283af759c1045a8bb75815db325f415ded4 Mon Sep 17 00:00:00 2001 From: Werner Koch Date: Tue, 16 Feb 2016 12:58:53 +0100 Subject: doc: Add a gnupg-module-overview picture. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * doc/gnupg-module-overview.svg: New. * doc/debugging.texi (Component interaction): New. * doc/Makefile.am (EXTRA_DIST): Add PNG and PDF versions of gnupg-module-overview.svg. Remove two eps files. (BUILT_SOURCES): Add gnupg-module-overview.pdf and .png. Remove gnupg-card-architecture.epsl (gnupg_TEXINFOS): Add gnupg-module-overview.svg (gnupg.dvi): New. (DISTCLEANFILES): Remove build eps files. -- Many thanks to Emanuel Schütze for helping with the redesign of the module overview. The original file has been used by mere for years in talks but was never a proper part of GnuPG. The EPS files have been removed due to their size. Thus to build the "dvi" target the convert tool is required. Signed-off-by: Werner Koch --- doc/Makefile.am | 35 +- doc/debugging.texi | 27 +- doc/gnupg-module-overview.svg | 892 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 939 insertions(+), 15 deletions(-) create mode 100644 doc/gnupg-module-overview.svg diff --git a/doc/Makefile.am b/doc/Makefile.am index a1a570c38..c270283d4 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -33,15 +33,16 @@ helpfiles = help.txt help.be.txt help.ca.txt help.cs.txt \ help.sv.txt help.tr.txt help.zh_CN.txt help.zh_TW.txt EXTRA_DIST = samplekeys.asc mksamplekeys \ - gnupg-logo.eps gnupg-logo.pdf gnupg-logo.png gnupg-logo-tr.png\ - gnupg-card-architecture.eps gnupg-card-architecture.png \ - gnupg-card-architecture.pdf \ + gnupg-logo.eps gnupg-logo.pdf gnupg-logo.png gnupg-logo-tr.png \ + gnupg-module-overview.png gnupg-module-overview.pdf \ + gnupg-card-architecture.png gnupg-card-architecture.pdf \ FAQ gnupg7.texi mkdefsinc.c defsincdate \ opt-homedir.texi see-also-note.texi specify-user-id.texi \ gpgv.texi yat2m.c ChangeLog-2011 whats-new-in-2.1.txt -BUILT_SOURCES = gnupg-card-architecture.eps gnupg-card-architecture.png \ - gnupg-card-architecture.pdf defsincdate defs.inc +BUILT_SOURCES = gnupg-module-overview.png gnupg-module-overview.pdf \ + gnupg-card-architecture.png gnupg-card-architecture.pdf \ + defsincdate defs.inc info_TEXINFOS = gnupg.texi @@ -56,11 +57,18 @@ nobase_dist_doc_DATA = FAQ DETAILS HACKING DCO TRANSLATE OpenPGP KEYSERVER \ gnupg_TEXINFOS = \ gpg.texi gpgsm.texi gpg-agent.texi scdaemon.texi instguide.texi \ tools.texi debugging.texi glossary.texi contrib.texi gpl.texi \ - sysnotes.texi gnupg-card-architecture.fig dirmngr.texi \ + sysnotes.texi dirmngr.texi \ + gnupg-module-overview.svg \ + gnupg-card-architecture.fig \ howtos.texi howto-create-a-server-cert.texi gnupg.texi : defs.inc +# We need EPS files for "make distcheck" but we do not want to distribute +# them due to their size. Let's build them as needed. +gnupg.dvi : gnupg-module-overview.eps gnupg-card-architecture.eps + + DVIPS = TEXINPUTS="$(srcdir)$(PATH_SEPARATOR)$$TEXINPUTS" dvips AM_MAKEINFOFLAGS = -I $(srcdir) --css-ref=/share/site.css @@ -84,6 +92,8 @@ watchgnupg_SOURCE = gnupg.texi CLEANFILES = yat2m mkdefsinc defs.inc DISTCLEANFILES = gnupg.tmp gnupg.ops yat2m-stamp.tmp yat2m-stamp \ + gnupg-card-architecture.eps \ + gnupg-module-overview.eps \ $(myman_pages) gpg-zip.1 gnupg.7 yat2m: yat2m.c @@ -93,6 +103,14 @@ mkdefsinc: mkdefsinc.c Makefile ../config.h $(CC_FOR_BUILD) -I. -I.. -I$(srcdir) $(AM_CPPFLAGS) \ -o $@ $(srcdir)/mkdefsinc.c +.svg.eps: + convert `test -f '$<' || echo '$(srcdir)/'`$< $@ + +.svg.png: + convert `test -f '$<' || echo '$(srcdir)/'`$< $@ + +.svg.pdf: + convert `test -f '$<' || echo '$(srcdir)/'`$< $@ .fig.png: fig2dev -L png `test -f '$<' || echo '$(srcdir)/'`$< $@ @@ -147,10 +165,13 @@ defs.inc : defsincdate Makefile mkdefsinc $(gnupg_TEXINFOS) >$@ -online: gnupg.html gnupg.pdf +online: gnupg.html gnupg.pdf gnupg-module-overview.png \ + gnupg-card-architecture.png set -e; \ echo "Uploading current manuals to www.gnupg.org ..."; \ cp $(srcdir)/gnupg-logo-tr.png gnupg.html/; \ + cp gnupg-module-overview.png gnupg.html/; \ + cp gnupg-card-architecture.png gnupg.html/; \ user=werner ; webhost="ftp.gnupg.org" ; dashdevel="" ; \ if echo "@PACKAGE_VERSION@" | grep -- "-beta" >/dev/null; then \ dashdevel="-devel" ; \ diff --git a/doc/debugging.texi b/doc/debugging.texi index 7965dbc8f..debdd40f1 100644 --- a/doc/debugging.texi +++ b/doc/debugging.texi @@ -262,19 +262,30 @@ can't do anything about it without actually downloading the keys. @menu -* GnuPG-1 and GnuPG-2:: Relationship between the two branches. +* Component interaction:: How the components work together. +* GnuPG-1 and GnuPG-2:: Relationship between GnuPG 1.4 and 2.x. @end menu -@node GnuPG-1 and GnuPG-2 -@subsection Relationship between the two branches. -Here is a little picture showing how the components work together: +@node Component interaction +@subsection How the components work together. -@image{gnupg-card-architecture, 10cm} -@noindent -Lets try to explain it: +@float Figure,fig:moduleoverview +@caption{GnuPG module overview} +@center @image{gnupg-module-overview, 150mm,,GnuPG modules} +@end float + + +@node GnuPG-1 and GnuPG-2 +@subsection Relationship between GnuPG 1.4 and 2.x. + +Here is a little picture showing how the different GnuPG versions make +use of a smartcard: -TO BE DONE. +@float Figure,fig:cardarchitecture +@caption{GnuPG card architecture} +@center @image{gnupg-card-architecture, 150mm,, GnuPG card architecture} +@end float diff --git a/doc/gnupg-module-overview.svg b/doc/gnupg-module-overview.svg new file mode 100644 index 000000000..5b22f0d32 --- /dev/null +++ b/doc/gnupg-module-overview.svg @@ -0,0 +1,892 @@ + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keyserver + + + + + + + + + + gpg-agent + + + + + + + + + + + + + + gpgsm + + + gpg + + + + CRL/Certificate Cache + + + scdaemon + + + + Smartcard + + + + + watchgnupg + + + + Private Keys + + + GPGME aware Applications + + + Pinentry + + + + + Public Keys + + + dirmngr + + + + Log Socket + + + + + + + + gpgconf + + + + + + Config Files + + + + + CRLs/Certificates + + + + + + + GnuPG + + + + + + + + + + 2016-02-16 + + + + + + closely linked + + + + Assuan protocol + + + + + + architecture + + + + execute/access + + + + + + + process + + + + object + + + + + + configure + + + + -- cgit v1.2.3