shishi/doc Makefile.am shishi.texi Makefile.gdoci

[shishi-commit]

CVSROOT:        /cvsroot/shishi
Module name:    shishi
Branch:         
Changes by:     Simon Josefsson <address@hidden>        03/11/01 08:18:40

Modified files:
        doc            : Makefile.am shishi.texi 
Added files:
        doc            : Makefile.gdoci 

Log message:
        Add gdoc framework.
        Use it from Makefile.am
        Update @include paths in manual.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/shishi/shishi/doc/Makefile.gdoci?rev=1.1
http://savannah.gnu.org/cgi-bin/viewcvs/shishi/shishi/doc/Makefile.am.diff?tr1=1.29&tr2=1.30&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/shishi/shishi/doc/shishi.texi.diff?tr1=1.94&tr2=1.95&r1=text&r2=text

Patches:
Index: shishi/doc/Makefile.am
diff -u shishi/doc/Makefile.am:1.29 shishi/doc/Makefile.am:1.30
--- shishi/doc/Makefile.am:1.29 Sun Sep 28 12:07:02 2003
+++ shishi/doc/Makefile.am      Sat Nov  1 08:18:39 2003
@@ -18,97 +18,35 @@
 # the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 # Boston, MA 02111-1307, USA.
 
-SUBDIRS = reference man
+SUBDIRS = reference
 
-shishi_texi_auto_deps = shishi-api-init.texi shishi-api-utility.texi \
-       shishi-api-ticket.texi shishi-api-tkt.texi shishi-api-tkts.texi \
-       shishi-api-as.texi shishi-api-tgs.texi \
-       shishi-api-safe.texi shishi-api-priv.texi \
-       shishi-api-kdc.texi shishi-api-authenticator.texi shishi-api-ap.texi \
-       shishi-api-key.texi shishi-api-keys.texi shishi-api-hostkeys.texi \
-       shishi-api-crypto.texi shishi-api-nettle.texi shishi-api-version.texi \
-       shishi-api-crypto-ctx.texi \
-       shishi-api-error.texi shishi-api-error-labels.texi
-
-generated = shishi.txt shishi.html shishi.ps shishi.pdf \
-       $(shishi_texi_auto_deps)
-
-MAINTAINERCLEANFILES = $(generated)
-
-EXTRA_DIST = gdoc $(generated)
+EXTRA_DIST = gdoc shishi.txt shishi.html shishi.ps shishi.pdf
 
 info_TEXINFOS = shishi.texi
 ps_TEXINFOS = shishi.texi
 pdf_TEXINFOS = shishi.texi
-shishi_TEXINFOS = gpl.texi fdl.texi $(shishi_texi_auto_deps)
-
-shishi-api-init.texi: $(top_srcdir)/lib/init.c $(top_srcdir)/lib/cfg.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-utility.texi: $(top_srcdir)/lib/realm.c 
$(top_srcdir)/lib/principal.c $(top_srcdir)/lib/authorize.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-ticket.texi: $(top_srcdir)/lib/ticket.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-tkt.texi: $(top_srcdir)/lib/tkt.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-tkts.texi: $(top_srcdir)/lib/tkts.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-safe.texi: $(top_srcdir)/lib/safe.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-priv.texi: $(top_srcdir)/lib/priv.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-as.texi: $(top_srcdir)/lib/as.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-tgs.texi: $(top_srcdir)/lib/tgs.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-kdc.texi: $(top_srcdir)/lib/kdc.c $(top_srcdir)/lib/kdcreq.c 
$(top_srcdir)/lib/kdcrep.c $(top_srcdir)/lib/enckdcreppart.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-authenticator.texi: $(top_srcdir)/lib/authenticator.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-ap.texi: $(top_srcdir)/lib/ap.c $(top_srcdir)/lib/apreq.c 
$(top_srcdir)/lib/aprep.c $(top_srcdir)/lib/encapreppart.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
+shishi_TEXINFOS = gpl.texi fdl.texi $(gdoc_TEXINFOS) \
+       shishi-api-error-labels.texi
 
-shishi-api-key.texi: $(top_srcdir)/lib/key.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-keys.texi: $(top_srcdir)/lib/keys.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-hostkeys.texi: $(top_srcdir)/lib/hostkeys.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-shishi-api-crypto.texi: $(top_srcdir)/lib/crypto.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
+shishi.txt: shishi.texi $(shishi_TEXINFOS)
+       $(MAKEINFO) --no-header $< > $@
 
-shishi-api-crypto-ctx.texi: $(top_srcdir)/lib/crypto-ctx.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
+shishi.html: shishi.texi $(shishi_TEXINFOS)
+       $(MAKEINFO) --html --no-split --number-sections $<
 
-shishi-api-nettle.texi: $(top_srcdir)/lib/nettle.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
+dist_man_MANS = shishi.1 $(gdoc_MANS)
+DISTCLEANFILES = $(dist_man_MANS)
 
-shishi-api-error.texi: $(top_srcdir)/lib/error.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
+shishi.1: $(top_srcdir)/src/shishi.c $(top_builddir)/src/shishi
+       $(HELP2MAN) \
+               --name="kerberos 5 implementation" \
+               --help-option="--program-name shishi --help" \
+               --output=$@ $(top_builddir)/src/shishi
+
+GDOC_SRC = $(top_srcdir)/lib/*.c
+GDOC_TEXI_PREFIX = texi/
+GDOC_MAN_PREFIX = man/
+include $(srcdir)/Makefile.gdoci
 
 shishi-api-error-labels.texi: $(top_srcdir)/lib/error.c
        $(PERL) $(srcdir)/gdoc-error $^ > $@
-
-shishi-api-version.texi: $(top_srcdir)/lib/version.c
-       $(PERL) $(srcdir)/gdoc -texinfo $^ > $@
-
-# Texinfo:
-
-shishi.txt: shishi.texi $(shishi_TEXINFOS)
-       $(MAKEINFO) --no-header $< > $@
-
-shishi.html: shishi.texi $(shishi_TEXINFOS)
-       $(MAKEINFO) --html --no-split --number-sections $<
Index: shishi/doc/shishi.texi
diff -u shishi/doc/shishi.texi:1.94 shishi/doc/shishi.texi:1.95
--- shishi/doc/shishi.texi:1.94 Thu Oct  2 20:01:30 2003
+++ shishi/doc/shishi.texi      Sat Nov  1 08:18:40 2003
@@ -1676,7 +1676,7 @@
 with the dynamic linker an old version is actually used.  So you may
 want to check that the version is okay right after program startup.
 
address@hidden shishi-api-version.texi
address@hidden texi/shishi_check_version.texi
 
 The normal way to use the function is to put something similar to the
 following early in your @code{main}:
@@ -1817,7 +1817,8 @@
 @node Initialization Functions
 @section Initialization Functions
 
address@hidden shishi-api-init.texi
address@hidden texi/init.c.texi
address@hidden texi/cfg.c.texi
 
 
 @node Ticket Set Functions
@@ -1835,7 +1836,7 @@
 To manipulate each individual ticket, @xref{Ticket Functions}.  For
 low-level ASN.1 manipulation see @xref{Ticket (ASN.1) Functions}.
 
address@hidden shishi-api-tkts.texi
address@hidden texi/tkts.c.texi
 
 
 @node AP-REQ and AP-REP Functions
@@ -1874,7 +1875,10 @@
 }
 @end verbatim
 
address@hidden shishi-api-ap.texi
address@hidden texi/ap.c.texi
address@hidden texi/apreq.c.texi
address@hidden texi/aprep.c.texi
address@hidden texi/encapreppart.c.texi
 
 
 @node SAFE and PRIV Functions
@@ -1904,7 +1908,7 @@
    }
 @end verbatim
 
address@hidden shishi-api-safe.texi
address@hidden texi/safe.c.texi
 
 The ``KRB-PRIV'' is an ASN.1 structure used by application client and
 servers to exchange confidential data.  The confidentiality is keyed,
@@ -1930,13 +1934,13 @@
    }
 @end verbatim
 
address@hidden shishi-api-priv.texi
address@hidden texi/priv.c.texi
 
 
 @node Ticket Functions
 @section Ticket Functions
 
address@hidden shishi-api-tkt.texi
address@hidden texi/tkt.c.texi
 
 
 @node AS Functions
@@ -2015,7 +2019,7 @@
 }
 @end verbatim
 
address@hidden shishi-api-as.texi
address@hidden texi/as.c.texi
 
 
 @node TGS Functions
@@ -2096,13 +2100,13 @@
 }
 @end verbatim
 
address@hidden shishi-api-tgs.texi
address@hidden texi/tgs.c.texi
 
 
 @node Ticket (ASN.1) Functions
 @section Ticket (ASN.1) Functions
 
address@hidden shishi-api-ticket.texi
address@hidden texi/ticket.c.texi
 
 @node AS/TGS Functions
 @section AS/TGS Functions
@@ -2195,7 +2199,10 @@
 }
 @end verbatim
 
address@hidden shishi-api-kdc.texi
address@hidden texi/kdc.c.texi
address@hidden texi/kdcreq.c.texi
address@hidden texi/kdcrep.c.texi
address@hidden texi/enckdcreppart.c.texi
 
 
 @node Authenticator Functions
@@ -2221,7 +2228,7 @@
 }
 @end verbatim
 
address@hidden shishi-api-authenticator.texi
address@hidden texi/authenticator.c.texi
 
 
 @node Cryptographic Functions
@@ -2248,7 +2255,7 @@
 
 All functions that operate on this data structure are described now.
 
address@hidden shishi-api-key.texi
address@hidden texi/key.c.texi
 
 Applications that run uninteractively may need keying material.  In
 these cases, the keys are stored in a file, a file that is normally
@@ -2257,7 +2264,7 @@
 outputed by @code{shishi_key_print}.  All functions that handle these
 keys sets are described now.
 
address@hidden shishi-api-keys.texi
address@hidden texi/keys.c.texi
 
 The previous functions require that the filename is known.  For some
 applications, servers, it makes sense to provide a system default.
@@ -2265,13 +2272,13 @@
 Here are the functions that operate on hostkeys (they are mostly
 wrappers around generic key sets).
 
address@hidden shishi-api-hostkeys.texi
address@hidden texi/hostkeys.c.texi
 
 After creating the key structure, it can be used to encrypt and
 decrypt data, calculate checksum on data etc.  All available functions
 are described now.
 
address@hidden shishi-api-crypto.texi
address@hidden texi/crypto.c.texi
 
 An easier way to use encryption and decryption if your application
 repeatedly calls, e.g., @code{shishi_encrypt_ivupdate}, is to use the
@@ -2279,20 +2286,22 @@
 in a context, and the encryption and decryption operations update the
 IV within the context automatically.
 
address@hidden shishi-api-crypto-ctx.texi
address@hidden texi/crypto-ctx.c.texi
 
 Also included in Shishi is an interface to the really low-level
 cryptographic primitives.  They map directly on the underlying
 cryptographic library used (e.g., Nettle) and is used internally by
 Shishi.
 
address@hidden shishi-api-nettle.texi
address@hidden texi/nettle.c.texi
 
 
 @node Utility Functions
 @section Utility Functions
 
address@hidden shishi-api-utility.texi
address@hidden texi/realm.c.texi
address@hidden texi/principal.c.texi
address@hidden texi/authorize.c.texi
 
 
 @node Error Handling
@@ -2333,7 +2342,7 @@
 @node Error Functions
 @subsection Error Functions
 
address@hidden shishi-api-error.texi
address@hidden texi/error.c.texi
 
 @node Examples
 @section Examples