From 12803f91b7e7fadfc641145e8dcb9f5e158e9377 Mon Sep 17 00:00:00 2001 From: Pekka Riikonen Date: Mon, 11 Feb 2002 20:13:53 +0000 Subject: [PATCH] updates. --- Makefile.am.pre | 2 +- doc/box.gif | Bin 53 -> 0 bytes doc/box2.gif | Bin 54 -> 0 bytes lib/LIBINDEX | 44 ++++--- lib/Makefile.am.pre | 11 ++ {doc => lib/doc}/arch.gif | Bin lib/doc/box.gif | Bin 0 -> 59 bytes lib/doc/box2.gif | Bin 0 -> 60 bytes {doc => lib/doc}/dot.gif | Bin {doc => lib/doc}/index_pic.gif | Bin lib/doc/intro_reference.html | 123 ++++++++++++++++++ lib/{silcclient => doc}/silcclient_using.html | 0 {doc => lib/doc}/space.gif | Bin lib/silcclient/Makefile.am | 2 +- 14 files changed, 165 insertions(+), 17 deletions(-) delete mode 100644 doc/box.gif delete mode 100644 doc/box2.gif rename {doc => lib/doc}/arch.gif (100%) create mode 100644 lib/doc/box.gif create mode 100644 lib/doc/box2.gif rename {doc => lib/doc}/dot.gif (100%) rename {doc => lib/doc}/index_pic.gif (100%) create mode 100644 lib/doc/intro_reference.html rename lib/{silcclient => doc}/silcclient_using.html (100%) rename {doc => lib/doc}/space.gif (100%) diff --git a/Makefile.am.pre b/Makefile.am.pre index 4f460611..80d922b5 100644 --- a/Makefile.am.pre +++ b/Makefile.am.pre @@ -73,7 +73,7 @@ toolkit-install: -mkdir -p $(docdir)/toolkit/ -$(INSTALL_DATA) $(srcdir)/doc/toolkit/silc* $(docdir)/toolkit -$(INSTALL_DATA) $(srcdir)/doc/toolkit/index* $(docdir)/toolkit - -$(INSTALL_DATA) $(srcdir)/doc/*.gif $(docdir)/toolkit + -$(INSTALL_DATA) $(srcdir)/lib/doc/*.gif $(docdir)/toolkit examples-install: -mkdir -p $(docdir)/examples/ diff --git a/doc/box.gif b/doc/box.gif deleted file mode 100644 index e679f85adae01a0609d2cb87aa37dd7ebe949766..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 53 zcmZ?wbhEHb -SILC Toolkit Reference Manual -
+SILC Toolkit Reference Manual +
-Copyright © 2001 - 2002 The SILC Project
-Version: @VERSION@
+Version: @VERSION@
+Copyright © 2001 - 2002 The SILC Project
Updated: @DATE@ -

-Note that this document is still under work and does not -include yet all references for SILC Toolkit interfaces. -

+



+Welcome to the SILC Toolkit Reference Manual. The manual is a complete +developer guide and reference for the SILC application programmer. The manual +is intended for application programmers who would like to integrate the SILC +support into their application, and to create new SILC applications. +

+The guide is especially targeted to SILC client application developers, and +provides full reference for the SILC Client Library, and a developer guide to +create new SILC client applications. +

+The application programming interfaces are automatically generated from the +Toolkit sources, and the documentation is constantly evolving. New versions +of the Toolkit always delivers the latest version of this reference manual. +

+ @BODY@ -

-Resource Links -

-
  • SILC Project Website
    -
  • SILC Protocol Documentation
    -
  • SILC White Paper
    -
  • SILC FAQ
    +

    +Resource Links +

    +Please refer to these outside links for more information about the SILC +project and SILC Protocol. +

    +
  • SILC Project Website
    +
  • SILC Protocol Documentation
    +
  • SILC White Paper
    +
  • SILC FAQ
    diff --git a/lib/Makefile.am.pre b/lib/Makefile.am.pre index 8e356378..24d7acaa 100644 --- a/lib/Makefile.am.pre +++ b/lib/Makefile.am.pre @@ -101,3 +101,14 @@ libsilcclient.a: find $(SILCCLIENTLIB_DIRS) -type f -name *.o | xargs $(AR) cru libsilcclient.a $(RANLIB) libsilcclient.a +if SILC_DIST_TOOLKIT +SILC_EXTRA_DIST = doc +else +if SILC_DIST_SERVER +SILC_EXTRA_DIST = +else +SILC_EXTRA_DIST = +endif +endif + +EXTRA_DIST = $(SILC_EXTRA_DIST) diff --git a/doc/arch.gif b/lib/doc/arch.gif similarity index 100% rename from doc/arch.gif rename to lib/doc/arch.gif diff --git a/lib/doc/box.gif b/lib/doc/box.gif new file mode 100644 index 0000000000000000000000000000000000000000..5b9cfcdf92632c45241707f74908f24fa30fc7c0 GIT binary patch literal 59 zcmZ?wbhEHbIntroduction to the Manual +
     
    + +The SILC Toolkit reference manual is a fairly large set of documents. The +manual includes hundreds of individual document files totalling more than +7 MB of content space. This document is designed to help you understand +how the reference manual is organized, how it can be used efficiently, and +how to find the information you need. + +
     
     
    +Target Audience + +
     
    +This Toolkit reference manual is targeted at application developers who +would like add SILC support into their application, and to create new +SILC based applications. It is especially aimed at C and C++ programmers, +who would like to create SILC client applications, either based on command +line interface (CLI) or on graphical user interface (GUI). + +
     
     
    +Overview + +
     
    +The SILC Toolkit Reference Manual has collected the essential information +needed by application developers. The following guide and reference +information is included in this manual: + +
     
    +
  • Describing the documentation conventions
    +
  • Describing the Toolkit design
    +
  • Describing the SILC Protocol
    +
  • Describing the programming conventions and idioms
    +
  • Documenting the set of public APIs available for programmers
    +
  • Describing the usage of various libraries + +
     
    +You can download the latest SILC Toolkit from the +SILC Project Website, which includes the +latest version of the reference manual. The Toolkit package includes the +full sources of the Toolkit, and includes several example applications and +piece of example codes. + +
     
     
    +Using the Reference Manual + +
     
    +The API references are ogranized by libraries. Each library will include +list of interfaces it provides. Each of the interface in the library +provides list of public API items. Each of the item in the list is a hyper +link that opens the detailed page describing the API item. All API +references are automatically generated from the sources and they have a clear +structural layout. The references can provide cross links to other +references inside the specific interface or the specific library. + +
     
    +The list of the library interface items can also include links to guides +that describe the use of a specific library or interface. These are +intended as HOWTOs for programmers describing all aspects of the library +or interface. They make the application development easier by also providing +small examples. + +
     
    +All interfaces provided by the reference manual are public, and it does not +describe any internal or undocumented interfaces. Since the reference +manual is automatically generated, it is constantly evolving. It also +may omit some of the interfaces or libraries, that have not yet been +documented in the sources. + +
     
     
    +Document Layout + +
     
    +The document layout provides quick links to libraries, interfaces and +specific API items by including list of links in the left and/or right +side of the page in the web browser. These links can be used to directly +access the specific library, interface or API item. The link lists may include +other links to guides, and reference links to outside the reference manual +as well. + +
     
     
    +Reference Conventions + +
     
    +The structural layout of a API item describes the following information +about the item: + +
     
    +
  • Type. Types that can appear are Variable, Structure, Function. A name +that appears without type is constant, usually #define, enum or typedef. +Usually the source code of the constants are appended to the reference. + +
     
    +
  • Name. Describes the name of the item. All functions start with +silc_ prefix, macros start with SILC_ prefix, and type names +and structures start with Silc prefix. + +
     
    +
  • Synopsis. Functions also describe the synopsis of the function. + +
     
    +
  • Description. Each of the item is described in detail of what the item +does and how it can be used. + +
     
    +
  • Notes. Optionally the item may describe additional notes to the +detailed description. These usually describe various exeptions or other +important notes that the programmer should be aware of. + +
     
    +
  • Example. Optionally the item may include a piece of source code that +give short example of how the item may be used. + +
     
    +
  • See Also. Optionally the item may include list of links to other +items, or some other references that relate to the described item. + +
     
    +
  • Source. Optionally the item may include the actual source code from +the header file where the documentation was automatically generated. + +
     
    +Note that some of these informations are optional and not all API items +include all of these informations. \ No newline at end of file diff --git a/lib/silcclient/silcclient_using.html b/lib/doc/silcclient_using.html similarity index 100% rename from lib/silcclient/silcclient_using.html rename to lib/doc/silcclient_using.html diff --git a/doc/space.gif b/lib/doc/space.gif similarity index 100% rename from doc/space.gif rename to lib/doc/space.gif diff --git a/lib/silcclient/Makefile.am b/lib/silcclient/Makefile.am index ccacb703..5dafa974 100644 --- a/lib/silcclient/Makefile.am +++ b/lib/silcclient/Makefile.am @@ -42,6 +42,6 @@ include_HEADERS= \ silcapi.h endif -EXTRA_DIST = *.h client_ops_example.c *.html +EXTRA_DIST = *.h client_ops_example.c include $(top_srcdir)/Makefile.defines.in -- 2.24.0