summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorValery Febvre <vfebvre at easter-eggs.com>2004-04-19 15:22:15 +0000
committerValery Febvre <vfebvre at easter-eggs.com>2004-04-19 15:22:15 +0000
commit66f2b28ef4ec640286116f4752c19557239f75a9 (patch)
treea9a5c05a06bbe2117de8f37e9dc2f9538f991e1e /docs
parent231a650450a1bd1e421773c41e903d67b607ee3b (diff)
downloadlasso-66f2b28ef4ec640286116f4752c19557239f75a9.tar.gz
lasso-66f2b28ef4ec640286116f4752c19557239f75a9.tar.xz
lasso-66f2b28ef4ec640286116f4752c19557239f75a9.zip
*** empty log message ***
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/Makefile.am52
-rw-r--r--docs/reference/lasso.sgml144
-rw-r--r--docs/reference/lasso.types34
3 files changed, 145 insertions, 85 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 0468b52d..1a59ed3b 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,9 +1,10 @@
NULL=
TOP=$(top_srcdir)
MODULE=lasso
+DOC_MAIN_SGML_FILE=$(MODULE).sgml
SOURCE_DIR=$(TOP)/lasso
INCLUDE_DIR=$(TOP)/lasso
-SGML_CATALOG_FILES=/usr/share/sgml/docbook/sgml-dtd-3.0-1.0-8/catalog:/usr/share/sgml/openjade-1.3.1/catalog:/usr/share/sgml/docbook/dsssl-stylesheets/catalog
+##SGML_CATALOG_FILES=/usr/share/sgml/docbook/sgml-dtd-3.0-1.0-8/catalog:/usr/share/sgml/openjade-1.3.1/catalog:/usr/share/sgml/docbook/dsssl-stylesheets/catalog
EXTRA_DIST = \
chapters \
@@ -19,21 +20,24 @@ SCANOBJ_OPTIONS=
#
DOC_SOURCE_DIR=./code
DOC_SOURCE_FILES=\
- $(shell find $(SOURCE_DIR) -name '*.c' -print ) \
- $(shell find $(INCLUDE_DIR) -name '*.h' -print )
+ $(shell find $(SOURCE_DIR) -name '*.c' -print ) \
+ $(shell find $(INCLUDE_DIR) -name '*.h' -print )
# do nothing for all
all:
-docs: sgml html clean-sources
+#docs: sgml html clean-sources
+docs: sgml html
-html: sgml lasso.sgml lasso-index
- gtkdoc-mkhtml lasso lasso.sgml
+html: sgml $(DOC_MAIN_SGML_FILE) lasso-index
+ @echo '*** Building HTML ***'
+ test -d $(srcdir)/html || mkdir $(srcdir)/html
+ cd $(srcdir)/html && gtkdoc-mkhtml $(MODULE) ../$(DOC_MAIN_SGML_FILE)
-SCANOBJ_FILES = \
+SCANOBJ_FILES = \
$(MODULE).hierarchy \
- $(MODULE).signals \
- $(MODULE).interfaces \
+ $(MODULE).signals \
+ $(MODULE).interfaces \
$(MODULE).prerequisites \
$(MODULE).args
@@ -44,9 +48,10 @@ SCANOBJ_FILES = \
# targets to make more references
#
sgml: templates
+ @echo '*** Building SGML ***'
-@gtkdoc-mkdb --module=lasso \
- --main-sgml-file=lasso.sgml \
- --source-dir=$(DOC_SOURCE_DIR)/lasso/base
+ --main-sgml-file=$(DOC_MAIN_SGML_FILE) \
+ --source-dir=$(DOC_SOURCE_DIR)/lasso
-@(for i in `find sgml -name "*.sgml" -print` ; do \
cat $$i | \
sed 's!\(&lt;dsig:\)\([^/]*\)\(\/&gt;\)!<ulink URL=\"http://www.w3.org/TR/xmldsig-core/#sec-\2\">\1\2\3</ulink>!g' | \
@@ -57,7 +62,8 @@ sgml: templates
done);
templates: scan
- -@gtkdoc-mktmpl --module=lasso
+ @echo '*** Building TMPL ***'
+ -@gtkdoc-mktmpl --module=$(MODULE)
# CFLAGS and LDFLAGS for compiling scan program.
GTKDOC_CFLAGS = \
@@ -78,24 +84,27 @@ GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
scan: doc_sources
+ @echo '*** Scan sources ***'
if grep -l '^..*$$' $(MODULE).types > /dev/null ; then \
- CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANOBJ_OPTIONS) --module=$(MODULE) --output-dir=$(srcdir) ; \
+ CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANOBJ_OPTIONS) --module=$(MODULE) --output-dir=$(srcdir) ; \
else \
- for i in $(SCANOBJ_FILES) ; do \
- test -f $$i || touch $$i ; \
- done \
+ cd $(srcdir) ; \
+ for i in $(SCANOBJ_FILES) ; do \
+ test -f $$i || touch $$i ; \
+ done \
fi
-@gtkdoc-scan --module=$(MODULE) \
- --source-dir=$(DOC_SOURCE_DIR)/lasso/base
+ --source-dir=$(DOC_SOURCE_DIR)/lasso/
$(MODULE)-decl.txt $(SCANOBJ_FILES): scan
@true
#
# Prepare source files by coping them to "code" folder and
-# removing LASSO_EXPORT_* stuff that makes gtkdoc crazy
+# removing LASSO_EXPORT* stuff that makes gtkdoc crazy
#
doc_sources: $(DOC_SOURCE_FILES)
+ @echo '*** Prepare sources ***'
@(for i in $(DOC_SOURCE_FILES) ; do \
folder_name=`echo $$i | sed 's#$(TOP)/##' | sed 's#/[^/]*$$##'`; \
file_name=`echo $$i | sed 's#.*/##'`; \
@@ -108,14 +117,15 @@ doc_sources: $(DOC_SOURCE_FILES)
sed 's/LASSO_EXPORT//' > \
$(DOC_SOURCE_DIR)/$$folder_name/$$file_name; \
done);
- -@mkdir -p $(DOC_SOURCE_DIR)/lasso/base
- -@mv -f $(DOC_SOURCE_DIR)/lasso/*.c $(DOC_SOURCE_DIR)/lasso/base
+# -@mkdir -p $(DOC_SOURCE_DIR)/lasso
+# -@mv -f $(DOC_SOURCE_DIR)/lasso/*.c $(DOC_SOURCE_DIR)/lasso/base
#
# Create index for all functions. For macros and defines need to add -CAPS suffix
#
lasso-index: scan
- @grep -h '<NAME>.*</NAME>' lasso-*decl.txt | \
+ @echo '*** Create functions index ***'
+ @grep -h '<NAME>.*</NAME>' $(MODULE)-*decl.txt | \
grep -v '<NAME>extern</NAME>' | \
sort -u | \
sed 's#_#-#g' | \
diff --git a/docs/reference/lasso.sgml b/docs/reference/lasso.sgml
index b2ad7b2a..09bc4a38 100644
--- a/docs/reference/lasso.sgml
+++ b/docs/reference/lasso.sgml
@@ -1,63 +1,113 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!ENTITY LibAssertion SYSTEM "sgml/lib_assertion.sgml">
-<!ENTITY LibAuthnRequest SYSTEM "sgml/lib_authn_request.sgml">
-<!ENTITY LibAuthnResponse SYSTEM "sgml/lib_authn_response.sgml">
-<!ENTITY LibIDPEntries SYSTEM "sgml/lib_idp_entries.sgml">
-<!ENTITY LibIDPEntry SYSTEM "sgml/lib_idp_entry.sgml">
-<!ENTITY LibIDPList SYSTEM "sgml/lib_idp_list.sgml">
-<!ENTITY LibRequestAuthnContext SYSTEM "sgml/lib_request_authn_context.sgml">
-<!ENTITY LibScoping SYSTEM "sgml/lib_scoping.sgml">
-<!ENTITY SamlAdvice SYSTEM "sgml/saml_advice.sgml">
-<!ENTITY SamlAssertion SYSTEM "sgml/saml_assertion.sgml">
-<!ENTITY SamlNameIdentifier SYSTEM "sgml/saml_name_identifier.sgml">
-<!ENTITY SamlStatementAbstract SYSTEM "sgml/saml_statement_abstract.sgml">
-<!ENTITY SamlSubject SYSTEM "sgml/saml_subject.sgml">
-<!ENTITY SamlSubjectConfirmation SYSTEM "sgml/saml_subject_confirmation.sgml">
-<!ENTITY SamlSubjectStatementAbstract SYSTEM "sgml/saml_subject_statement_abstract.sgml">
-<!ENTITY SamlpRequestAbstract SYSTEM "sgml/samlp_request_abstract.sgml">
-<!ENTITY SamlpResponse SYSTEM "sgml/samlp_response.sgml">
-<!ENTITY SamlpResponseAbstract SYSTEM "sgml/samlp_response_abstract.sgml">
-<!ENTITY SamlpStatus SYSTEM "sgml/samlp_status.sgml">
-<!ENTITY SamlpStatusCode SYSTEM "sgml/samlp_status_code.sgml">
+<!ENTITY lasso-LassoDsSignature SYSTEM "sgml/ds_signature.sgml">
+<!ENTITY LassoLibAssertion SYSTEM "sgml/lib_assertion.sgml">
+<!ENTITY LassoLibAuthnRequest SYSTEM "sgml/lib_authn_request.sgml">
+<!ENTITY LassoLibAuthnResponse SYSTEM "sgml/lib_authn_response.sgml">
+<!ENTITY lasso-LassoLibIDPEntries SYSTEM "sgml/lib_idp_entries.sgml">
+<!ENTITY lasso-LassoLibIDPEntry SYSTEM "sgml/lib_idp_entry.sgml">
+<!ENTITY lasso-LassoLibIDPList SYSTEM "sgml/lib_idp_list.sgml">
+<!ENTITY LassoLibRequestAuthnContext SYSTEM "sgml/lib_request_authn_context.sgml">
+<!ENTITY LassoLibScoping SYSTEM "sgml/lib_scoping.sgml">
+<!ENTITY LassoSamlAdvice SYSTEM "sgml/saml_advice.sgml">
+<!ENTITY LassoSamlAssertion SYSTEM "sgml/saml_assertion.sgml">
+<!ENTITY lasso-LassoSamlAudienceRestrictionCondition SYSTEM "sgml/saml_audience_restriction_condition.sgml">
+<!ENTITY lasso-LassoSamlAuthenticationStatement SYSTEM "sgml/saml_authentication_statement.sgml">
+<!ENTITY lasso-LassoSamlAuthorityBinding SYSTEM "sgml/saml_authority_binding.sgml">
+<!ENTITY lasso-LassoSamlConditionAbstract SYSTEM "sgml/saml_condition_abstract.sgml">
+<!ENTITY lasso-LassoSamlConditions SYSTEM "sgml/saml_conditions.sgml">
+<!ENTITY LassoSamlNameIdentifier SYSTEM "sgml/saml_name_identifier.sgml">
+<!ENTITY LassoSamlStatementAbstract SYSTEM "sgml/saml_statement_abstract.sgml">
+<!ENTITY LassoSamlSubject SYSTEM "sgml/saml_subject.sgml">
+<!ENTITY LassoSamlSubjectConfirmation SYSTEM "sgml/saml_subject_confirmation.sgml">
+<!ENTITY lasso-LassoSamlSubjectLocality SYSTEM "sgml/saml_subject_locality.sgml">
+<!ENTITY LassoSamlSubjectStatementAbstract SYSTEM "sgml/saml_subject_statement_abstract.sgml">
+<!ENTITY LassoSamlpRequestAbstract SYSTEM "sgml/samlp_request_abstract.sgml">
+<!ENTITY LassoSamlpResponse SYSTEM "sgml/samlp_response.sgml">
+<!ENTITY LassoSamlpResponseAbstract SYSTEM "sgml/samlp_response_abstract.sgml">
+<!ENTITY LassoSamlpStatus SYSTEM "sgml/samlp_status.sgml">
+<!ENTITY LassoSamlpStatusCode SYSTEM "sgml/samlp_status_code.sgml">
<!ENTITY LassoNode SYSTEM "sgml/xml.sgml">
+<!ENTITY lasso-LassoLibLogoutRequest SYSTEM "sgml/lib_logout_request.sgml">
+<!ENTITY lasso-LassoLibFederationTerminationNotification SYSTEM "sgml/lib_federation_termination_notification.sgml">
+<!ENTITY lasso-LassoLibIDPProvidedNameIdentifier SYSTEM "sgml/lib_idp_provided_name_identifier.sgml">
+<!ENTITY lasso-LassoLibLogoutResponse SYSTEM "sgml/lib_logout_response.sgml">
+<!ENTITY lasso-LassoLibNameIdentifierMappingRequest SYSTEM "sgml/lib_name_identifier_mapping_request.sgml">
+<!ENTITY lasso-LassoLibNameIdentifierMappingResponse SYSTEM "sgml/lib_name_identifier_mapping_response.sgml">
+<!ENTITY lasso-LassoLibOLDProvidedNameIdentifier SYSTEM "sgml/lib_old_provided_name_identifier.sgml">
+<!ENTITY lasso-LassoLibRegisterNameIdentifierRequest SYSTEM "sgml/lib_register_name_identifier_request.sgml">
+<!ENTITY lasso-LassoLibRegisterNameIdentifierResponse SYSTEM "sgml/lib_register_name_identifier_response.sgml">
+<!ENTITY lasso-LassoLibSPProvidedNameIdentifier SYSTEM "sgml/lib_sp_provided_name_identifier.sgml">
+<!ENTITY lasso-LassoLibStatusResponse SYSTEM "sgml/lib_status_response.sgml">
+<!ENTITY lasso-LassoLibSubject SYSTEM "sgml/lib_subject.sgml">
+<!ENTITY lasso-LassoSamlpRequest SYSTEM "sgml/samlp_request.sgml">
+<!ENTITY lasso-LassoLibAuthnContext SYSTEM "sgml/lib_authn_context.sgml">
+<!ENTITY lasso-LassoLibAuthenticationStatement SYSTEM "sgml/lib_authentication_statement.sgml">
<!ENTITY lasso-export SYSTEM "sgml/export.sgml">
<!ENTITY lasso-lasso SYSTEM "sgml/lasso.sgml">
<!ENTITY lasso-version SYSTEM "sgml/version.sgml">
+<!ENTITY lasso-single-sign-on-and-federation SYSTEM "sgml/single_sign_on_and_federation.sgml">
+<!ENTITY lasso-federation-termination-notification SYSTEM "sgml/federation_termination_notification.sgml">
+<!ENTITY lasso-logout SYSTEM "sgml/logout.sgml">
+<!ENTITY lasso-register-name-identifier SYSTEM "sgml/register_name_identifier.sgml">
+<!ENTITY lasso-tools SYSTEM "sgml/tools.sgml">
]>
<book id="index">
<bookinfo>
- <title>Lasso Library Reference Manual</title>
+ <title>[Insert name here] Reference Manual</title>
</bookinfo>
<chapter>
- <title>Liberty Alliance</title>
- &LibAssertion;
- &LibAuthnRequest;
- &LibAuthnResponse;
- &LibIDPEntries;
- &LibIDPEntry;
- &LibIDPList;
- &LibRequestAuthnContext;
- &LibScoping;
-
+ <title>[Insert title here]</title>
+ &lasso-LassoDsSignature;
+ &LassoLibAssertion;
+ &LassoLibAuthnRequest;
+ &LassoLibAuthnResponse;
+ &lasso-LassoLibIDPEntries;
+ &lasso-LassoLibIDPEntry;
+ &lasso-LassoLibIDPList;
+ &LassoLibRequestAuthnContext;
+ &LassoLibScoping;
+ &LassoSamlAdvice;
+ &LassoSamlAssertion;
+ &lasso-LassoSamlAudienceRestrictionCondition;
+ &lasso-LassoSamlAuthenticationStatement;
+ &lasso-LassoSamlAuthorityBinding;
+ &lasso-LassoSamlConditionAbstract;
+ &lasso-LassoSamlConditions;
+ &LassoSamlNameIdentifier;
+ &LassoSamlStatementAbstract;
+ &LassoSamlSubject;
+ &LassoSamlSubjectConfirmation;
+ &lasso-LassoSamlSubjectLocality;
+ &LassoSamlSubjectStatementAbstract;
+ &LassoSamlpRequestAbstract;
+ &LassoSamlpResponse;
+ &LassoSamlpResponseAbstract;
+ &LassoSamlpStatus;
+ &LassoSamlpStatusCode;
&LassoNode;
+ &lasso-LassoLibLogoutRequest;
+ &lasso-LassoLibFederationTerminationNotification;
+ &lasso-LassoLibIDPProvidedNameIdentifier;
+ &lasso-LassoLibLogoutResponse;
+ &lasso-LassoLibNameIdentifierMappingRequest;
+ &lasso-LassoLibNameIdentifierMappingResponse;
+ &lasso-LassoLibOLDProvidedNameIdentifier;
+ &lasso-LassoLibRegisterNameIdentifierRequest;
+ &lasso-LassoLibRegisterNameIdentifierResponse;
+ &lasso-LassoLibSPProvidedNameIdentifier;
+ &lasso-LassoLibStatusResponse;
+ &lasso-LassoLibSubject;
+ &lasso-LassoSamlpRequest;
+ &lasso-LassoLibAuthnContext;
+ &lasso-LassoLibAuthenticationStatement;
+ &lasso-export;
&lasso-lasso;
&lasso-version;
- </chapter>
-
- <chapter>
- <title>Saml</title>
- &SamlAdvice;
- &SamlAssertion;
- &SamlNameIdentifier;
- &SamlStatementAbstract;
- &SamlSubject;
- &SamlSubjectConfirmation;
- &SamlSubjectStatementAbstract;
- &SamlpRequestAbstract;
- &SamlpResponse;
- &SamlpResponseAbstract;
- &SamlpStatus;
- &SamlpStatusCode;
+ &lasso-single-sign-on-and-federation;
+ &lasso-federation-termination-notification;
+ &lasso-logout;
+ &lasso-register-name-identifier;
+ &lasso-tools;
</chapter>
</book>
diff --git a/docs/reference/lasso.types b/docs/reference/lasso.types
index eeb48f07..026ec03c 100644
--- a/docs/reference/lasso.types
+++ b/docs/reference/lasso.types
@@ -1,19 +1,19 @@
#include <lasso/lasso.h>
-lib_assertion_get_type
-lib_authn_request_get_type
-lib_authn_response_get_type
-lib_request_authn_context_get_type
-lib_scoping_get_type
-saml_advice_get_type
-saml_assertion_get_type
-saml_name_identifier_get_type
-saml_statement_abstract_get_type
-saml_subject_get_type
-saml_subject_confirmation_get_type
-saml_subject_statement_abstract_get_type
-samlp_request_abstract_get_type
-samlp_response_get_type
-samlp_response_abstract_get_type
-samlp_status_get_type
-samlp_status_code_get_type
+lasso_lib_assertion_get_type
+lasso_lib_authn_request_get_type
+lasso_lib_authn_response_get_type
+lasso_lib_request_authn_context_get_type
+lasso_lib_scoping_get_type
+lasso_saml_advice_get_type
+lasso_saml_assertion_get_type
+lasso_saml_name_identifier_get_type
+lasso_saml_statement_abstract_get_type
+lasso_saml_subject_get_type
+lasso_saml_subject_confirmation_get_type
+lasso_saml_subject_statement_abstract_get_type
+lasso_samlp_request_abstract_get_type
+lasso_samlp_response_get_type
+lasso_samlp_response_abstract_get_type
+lasso_samlp_status_get_type
+lasso_samlp_status_code_get_type