[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnue] r8253 - trunk/gnue-appserver/doc/api
From: |
reinhard |
Subject: |
[gnue] r8253 - trunk/gnue-appserver/doc/api |
Date: |
Mon, 3 Apr 2006 18:20:32 -0500 (CDT) |
Author: reinhard
Date: 2006-03-24 04:09:47 -0600 (Fri, 24 Mar 2006)
New Revision: 8253
Removed:
trunk/gnue-appserver/doc/api/fdl.texi
trunk/gnue-appserver/doc/api/version.texi
Modified:
trunk/gnue-appserver/doc/api/Makefile
trunk/gnue-appserver/doc/api/api.texi
Log:
Updated API documentation.
Modified: trunk/gnue-appserver/doc/api/Makefile
===================================================================
--- trunk/gnue-appserver/doc/api/Makefile 2006-03-24 08:22:29 UTC (rev
8252)
+++ trunk/gnue-appserver/doc/api/Makefile 2006-03-24 10:09:47 UTC (rev
8253)
@@ -1,22 +1,38 @@
-all: txt html dvi pdf ps aux-clean
+DOC=$(shell basename `pwd`)
+MAIN=${DOC}.texi
+SOURCES=${MAIN}
-txt:
- LANG=C makeinfo --no-headers --output=api.txt api.texi
+all: ${DOC}.txt ${DOC}.html ${DOC}.dvi ${DOC}.pdf ${DOC}.ps aux-clean
-html:
- LANG=C makeinfo --html --no-split api.texi
+version.texi: ${SOURCES}
+ echo -n "@set UPDATED " > version.texi
+ grep '$$Date:' ${SOURCES} | cut --delimiter=' ' --fields=3 | sort |
tail -n 1 >> version.texi
+ echo -n "@set EDITION " >> version.texi
+ (cd ../..; echo "import src; print src.VERSION" | gcvs) >> version.texi
-dvi:
- LANG=C texi2dvi api.texi
+${DOC}.txt: ${MAIN} ${SOURCES} version.texi
+ LANG=C makeinfo --no-headers --output=${DOC}.txt ${MAIN}
-pdf:
- LANG=C texi2pdf api.texi
+${DOC}.html: ${MAIN} ${SOURCES} version.texi
+ LANG=C makeinfo --html ${MAIN}
+ echo "<html>" > ${DOC}.html
+ echo " <head>" >> ${DOC}.html
+ echo " <meta http-equiv=\"Refresh\" content=\"0;
URL=${DOC}/index.html\">" >> ${DOC}.html
+ echo " </head>" >> ${DOC}.html
+ echo "</html>" >> ${DOC}.html
-ps: api.dvi
- dvips api -o api.ps
+${DOC}.dvi: ${MAIN} ${SOURCES} version.texi
+ LANG=C texi2dvi ${MAIN}
+${DOC}.pdf: ${MAIN} ${SOURCES} version.texi
+ LANG=C texi2pdf ${MAIN}
+
+${DOC}.ps: ${DOC}.dvi
+ dvips ${DOC} -o ${DOC}.ps
+
aux-clean:
rm -f *.aux *.cp *.fn *.ky *.log *.pg *.toc *.tp *.vr *.??s
clean: aux-clean
- rm -f *.dvi *.txt *.html *.pdf *.ps
+ rm -f version.texi ${DOC}.dvi ${DOC}.txt ${DOC}.html ${DOC}.pdf
${DOC}.ps
+ rm -rf ${DOC}
Modified: trunk/gnue-appserver/doc/api/api.texi
===================================================================
--- trunk/gnue-appserver/doc/api/api.texi 2006-03-24 08:22:29 UTC (rev
8252)
+++ trunk/gnue-appserver/doc/api/api.texi 2006-03-24 10:09:47 UTC (rev
8253)
@@ -4,7 +4,11 @@
@include version.texi
@setcontentsaftertitlepage
@syncodeindex tp fn
+
address@hidden $Date: $
+
@c ----------------------------------------------------------------------------
+
@ifnottex
@chapheading The GNU Enterprise Application Server
@@ -12,18 +16,32 @@
Edition @value{EDITION}, @value{UPDATED}
-Copyright @copyright{} 2002-2004 Free Software Foundation
+Copyright @copyright{} 2002-2006 Free Software Foundation
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1
-or any later version published by the Free Software Foundation;
-with no Invariant Sections, with no Front-Cover Texts, and with no
-Back-Cover Texts.
+Permission is granted to make and distribute verbatim copies of this manual
+provided the copyright notice and this permission notice are preserved on all
+copies.
-A copy of the license is included in the section entitled ``GNU
-Free Documentation License''.
address@hidden
+Permission is granted to process this file through TeX and print the results,
+provided the printed document carries copying permission notice identical to
+this one except for the removal of this paragraph (this paragraph not being
+relevant to the printed manual).
address@hidden ignore
+
+Permission is granted to copy and distribute modified versions of this manual
+under the conditions for verbatim copying, provided that the entire resulting
+derived work is distributed under the terms of a permission notice identical to
+this one.
+
+Permission is granted to copy and distribute translations of this manual into
+another language, under the above conditions for modified versions, except that
+this permission notice may be stated in a translation approved by the
+Foundation.
@end ifnottex
+
@c ----------------------------------------------------------------------------
+
@titlepage
@title The GNU Enterprise Application Server
@subtitle Application Programmer's Interface
@@ -31,34 +49,52 @@
@author Reinhard M@"uller
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 2002 Free Software Foundation
+Copyright @copyright{} 2002-2006 Free Software Foundation
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1
-or any later version published by the Free Software Foundation;
-with no Invariant Sections, with no Front-Cover Texts, and with no
-Back-Cover Texts.
+Permission is granted to make and distribute verbatim copies of this manual
+provided the copyright notice and this permission notice are preserved on all
+copies.
-A copy of the license is included in the section entitled ``GNU
-Free Documentation License''.
+Permission is granted to copy and distribute modified versions of this manual
+under the conditions for verbatim copying, provided that the entire resulting
+derived work is distributed under the terms of a permission notice identical to
+this one.
+
+Permission is granted to copy and distribute translations of this manual into
+another language, under the above conditions for modified versions, except that
+this permission notice may be stated in a translation approved by the
+Foundation.
@end titlepage
@c ----------------------------------------------------------------------------
address@hidden Top,
Data Types
address@hidden Top,
Introduction
@c ----------------------------------------------------------------------------
@menu
+* Introduction::
* Data Types::
* API Functions::
* System Classes::
-* FDL:: GNU Free Documentation License
* Index::
@end menu
@c ----------------------------------------------------------------------------
address@hidden Data Types, API Functions,
Top, Top
address@hidden Introduction, Data Types,
Top, Top
@c ----------------------------------------------------------------------------
address@hidden Introduction
+
+This document describes the RPC interface provided by GNUe Appserver. Using
+this information, you can create a front end to GNUe Appserver.
+
+This document is @emph{not} about writing database applications with GNU
+Enterprise. You only have to read this document if you are not satisfied with
+GNUe Forms, and want to write a different front end to Appserver.
+
address@hidden
----------------------------------------------------------------------------
address@hidden Data Types, API Functions,
Introduction, Top
address@hidden
----------------------------------------------------------------------------
+
@chapter Data Types
In the API definition, we will make use of the following data type
@@ -96,16 +132,10 @@
of rows to 32767.
@end deftp
address@hidden {Data Type} session_id
-This is a 32 bit integer value identifying a session. There is no
-special meaning one could read from the value.
address@hidden deftp
+The RPC API is object oriented. Some of the methods described here return
+object instances, of which methods can be called subsequently. Handling of
+these objects depends on the RPC transport method.
address@hidden {Data Type} list_id
-This is a 32 bit integer value identifying a list. There is no special
-meaning one could read from the value.
address@hidden deftp
-
@c ----------------------------------------------------------------------------
@node API Functions, System Classes, Data Types, Top
@c ----------------------------------------------------------------------------
@@ -126,40 +156,27 @@
@section Session Management
address@hidden session_id open (@var{auth_parameters})
address@hidden session open (@var{auth_parameters})
Opens a connection to Appserver using the given parameters for
authentication. The number and type of the parameters still have to
-be decided. The return value is a handle to the session that has to
-be passed to all subsequent function calls.
+be decided. The return value is a session object.
An Exception is raised if the server cannot be contacted or authentication
fails.
@end deftypefun
address@hidden void close (session_id @var{session}, boolean @var{commit})
-Closes the connection identified by @var{session}. If @var{commit} is
-TRUE, an uncommitted transaction of this session is implicitly
-committed; if @var{commit} is FALSE, it is implicitly rolled back.
-After this call, @var{session} will no longer be a valid session
-identifier.
address@hidden session void commit ()
+Commits the current transaction of the session, making all changes permanent.
-An Exception is raised if @var{session} is not a valid session identifier.
address@hidden deftypefun
+Exceptions can happen if a OnValidate procedure raises an exception, or if a
+non-nullable property is not set.
address@hidden deftypemethod
address@hidden void commit (session_id @var{session})
-Commits the current transaction of @var{session}, making all changes
-permanent.
-
-An Exception is raised if @var{session} is not a valid session identifier.
address@hidden deftypefun
-
address@hidden void rollback (session_id @var{session})
-Discards all changes done in @var{session} since the last @code{commit}
address@hidden session void rollback (session_id @var{session})
+Discards all changes done in this session since the last @code{commit}
or @code{rollback}.
address@hidden deftypemethod
-An Exception is raised if @var{session} is not a valid session identifier.
address@hidden deftypefun
-
@c ----------------------------------------------------------------------------
@section Handling Lists Of Objects
@@ -167,8 +184,7 @@
These functions provide a means for getting data for a list of objects
fulfilling certain conditions.
address@hidden list_id request (session_id @var{session}, string
@var{classname},
-stringlist @var{conditions}, stringlist @var{sortorder}, stringlist
@var{properties})
address@hidden session list request (string @var{classname}, stringlist
@var{conditions}, stringlist @var{sortorder}, stringlist @var{properties})
Requests a list of objects of class @var{classname} matching the
@var{conditions}. Appserver prepares to send the values of the properties
listed in @var{properties} on subsequent calls to @code{fetch}, where
@@ -179,39 +195,27 @@
@var{classname}, @var{conditions}, @var{sort_order}, and @var{properties}
must contain fully referenced identifiers for classes or properties.
-This function only returns a list identifier. No actual data is passed
+This function only returns a list object. No actual data is passed
over the network when calling this function.
-An Exception is raised if @var{session} is not a valid session identifier, the
-requested class does not exist, the current user has no access to the
-requested class, or any of the given @var{properties} does not exist.
address@hidden deftypefun
+An Exception is raised if the requested class does not exist, the current user
+has no access to the requested class, or any of the given @var{properties} does
+not exist.
address@hidden deftypemethod
address@hidden integer count (session_id @var{session}, list_id @var{list})
-Returns the number of objects contained in @var{list}, where @var{list}
-is the return value of a previous call to @code{request}.
address@hidden list integer count ()
+Returns the number of objects contained in the list.
address@hidden deftypemethod
-An Exception is raised if @var{session} is not a valid session identifier or
address@hidden is not a valid list identifier.
address@hidden deftypefun
-
address@hidden stringtable fetch (session_id @var{session}, list_id @var{list},
integer @var{start}, integer @var{count}, boolean @var{close})
address@hidden list stringtable fetch (integer @var{start}, integer @var{count})
Returns a 2-dimensional array of data with @var{count} rows, where column 0
always holds the object_id of the object, and the remaining columns contain
the values for the properties defined in the previous call to @code{request}.
Negative values for @var{start} indicate position from the end of the list.
Negative values for @var{count} are invalid. Count may not be greater than
32767.
address@hidden deftypemethod
-If @var{close} is TRUE, then the list is "closed", all server-side memory
-allocated with the management of this list is freed and the id @var{list}
-may no longer be used in calls to @code{count} or @code{fetch}. However,
-object_ids and other data already received remains valid.
-
-An Exception is raised if @var{session} is not a valid session identifier or
address@hidden is not a valid list identifier.
address@hidden deftypefun
-
@c ----------------------------------------------------------------------------
@section Handling Specific Objects
@@ -222,7 +226,7 @@
have to be determined before these functions can be used, for example by
using the list handling functions described above.
address@hidden stringtable load (session_id @var{session}, string
@var{classname}, stringlist @var{object_ids}, stringlist @var{properties})
address@hidden session stringtable load (string @var{classname}, stringlist
@var{object_ids}, stringlist @var{properties})
Returns a 2-dimensional array of data with a row for every entry in
the @var{object_ids} list and a column for every entry in @var{properties}.
Unlike @code{fetch}, this function does @emph{not} automatically return
@@ -233,13 +237,12 @@
of the @var{properties}. This is a temporary hack and will be removed again in
a future version!
-An Exception is raised if @var{session} is not a valid session identifier, the
-requested class does not exist, the current user has no access to the
-requested class, any of the given @var{object_ids} does not exist, or any of
-the given @var{properties} does not exist.
address@hidden deftypefun
+An Exception is raised if the requested class does not exist, the current user
+has no access to the requested class, any of the given @var{object_ids} does
+not exist, or any of the given @var{properties} does not exist.
address@hidden deftypemethod
address@hidden stringlist store (session_id @var{session}, string
@var{classname}, stringlist @var{object_ids}, stringlist @var{properties},
stringtable @var{values})
address@hidden session stringlist store (string @var{classname}, stringlist
@var{object_ids}, stringlist @var{properties}, stringtable @var{values})
Stores the data in @var{values} in the objects identified by @var{object_ids}.
Every row in @var{values} matches an entry in @var{object_ids}, while every
column matches an entry in @var{properties}.
@@ -253,23 +256,22 @@
Note that after calling @code{store}, @code{commit} has to be called to make
the changes persistent, while a call to @code{rollback} can undo the changes.
-An Exception is raised if @var{session} is not a valid session identifier, the
-requested class does not exist, the current user has no access to the
-requested class, any of the given @var{object_ids} does not exist, any of
-the given @var{properties} does not exist, or any of the @var{values} does not
-fit the corresponding property.
address@hidden deftypefun
+An Exception is raised if the requested class does not exist, the current user
+has no access to the requested class, any of the given @var{object_ids} does
+not exist, any of the given @var{properties} does not exist, or any of the
address@hidden does not fit the corresponding property.
address@hidden deftypemethod
address@hidden void delete (session_id @var{session}, string @var{classname},
stringlist @var{object_ids})
address@hidden session void delete (string @var{classname}, stringlist
@var{object_ids})
Deletes the objects of class @var{classname} identified through
@var{object_ids}.
-An Exception is raised if @var{session} is not a valid session identifier, the
-requested class does not exist, the current user has no access to the
-requested class, or any of the given @var{object_ids} does not exist.
address@hidden deftypefun
+An Exception is raised if the requested class does not exist, the current user
+has no access to the requested class, or any of the given @var{object_ids} does
+not exist.
address@hidden deftypemethod
address@hidden stringlist call (session_id @var{session}, string
@var{classname}, stringlist @var{object_ids}, string @var{procedurename},
stringlist @var{parameters})
address@hidden session stringlist call (session_id @var{session}, string
@var{classname}, stringlist @var{object_ids}, string @var{procedurename},
stringlist @var{parameters})
Calls the procedure @var{procedurename} for every object identified through
the @var{object_ids} and passes the same @var{parameters} to every call.
The number of entries in @var{parameters} must match the parameter count
@@ -277,14 +279,13 @@
This function returns a list of strings that contains the results of the
procedure calls for each object.
-An Exception is raised if @var{session} is not a valid session identifier, the
-requested class does not exist, the current user has no access to the
-requested class, any of the given @var{object_ids} does not exist, or the given
-procedure is not defined.
address@hidden deftypefun
+An Exception is raised if the requested class does not exist, the current user
+has no access to the requested class, any of the given @var{object_ids} does
+not exist, or the given procedure is not defined.
address@hidden deftypemethod
@c ----------------------------------------------------------------------------
address@hidden System Classes, FDL, API
Functions, Top
address@hidden System Classes, Index, API
Functions, Top
@c ----------------------------------------------------------------------------
@chapter System Classes
@@ -556,21 +557,11 @@
@end defcv
@c ----------------------------------------------------------------------------
-
address@hidden
-
address@hidden Index, (null), System
Classes, Top
@c ----------------------------------------------------------------------------
address@hidden FDL, Index, System
Classes, Top
address@hidden
----------------------------------------------------------------------------
address@hidden fdl.texi
address@hidden Data Type and Function Index
address@hidden
----------------------------------------------------------------------------
address@hidden Index, (null),
FDL, Top
address@hidden
----------------------------------------------------------------------------
-
address@hidden Data Type and Function Index
-
@printindex fn
@bye
Deleted: trunk/gnue-appserver/doc/api/fdl.texi
===================================================================
--- trunk/gnue-appserver/doc/api/fdl.texi 2006-03-24 08:22:29 UTC (rev
8252)
+++ trunk/gnue-appserver/doc/api/fdl.texi 2006-03-24 10:09:47 UTC (rev
8253)
@@ -1,401 +0,0 @@
address@hidden GNU Free Documentation License
-
address@hidden FDL, GNU Free Documentation License
address@hidden Version 1.1, March 2000
-
address@hidden
-Copyright @copyright{} 2000 Free Software Foundation, Inc.
-59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
-
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
address@hidden display
-
address@hidden 0
address@hidden
-PREAMBLE
-
-The purpose of this License is to make a manual, textbook, or other
-written document @dfn{free} in the sense of freedom: to assure everyone
-the effective freedom to copy and redistribute it, with or without
-modifying it, either commercially or noncommercially. Secondarily,
-this License preserves for the author and publisher a way to get
-credit for their work, while not being considered responsible for
-modifications made by others.
-
-This License is a kind of ``copyleft'', which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
address@hidden
-APPLICABILITY AND DEFINITIONS
-
-This License applies to any manual or other work that contains a
-notice placed by the copyright holder saying it can be distributed
-under the terms of this License. The ``Document'', below, refers to any
-such manual or work. Any member of the public is a licensee, and is
-addressed as ``you''.
-
-A ``Modified Version'' of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A ``Secondary Section'' is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (For example, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The ``Invariant Sections'' are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License.
-
-The ``Cover Texts'' are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License.
-
-A ``Transparent'' copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, whose contents can be viewed and edited directly and
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup has been designed to thwart or discourage
-subsequent modification by readers is not Transparent. A copy that is
-not ``Transparent'' is called ``Opaque''.
-
-Examples of suitable formats for Transparent copies include plain
address@hidden without markup, Texinfo input format, address@hidden input
format,
address@hidden or @acronym{XML} using a publicly available
address@hidden, and standard-conforming simple @acronym{HTML} designed
-for human modification. Opaque formats include PostScript,
address@hidden, proprietary formats that can be read and edited only by
-proprietary word processors, @acronym{SGML} or @acronym{XML} for which
-the @acronym{DTD} and/or processing tools are not generally available,
-and the machine-generated @acronym{HTML} produced by some word
-processors for output purposes only.
-
-The ``Title Page'' means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, ``Title Page'' means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
address@hidden
-VERBATIM COPYING
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
address@hidden
-COPYING IN QUANTITY
-
-If you publish printed copies of the Document numbering more than 100,
-and the Document's license notice requires Cover Texts, you must enclose
-the copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a publicly-accessible computer-network location containing a complete
-Transparent copy of the Document, free of added material, which the
-general network-using public has access to download anonymously at no
-charge using public-standard network protocols. If you use the latter
-option, you must take reasonably prudent steps, when you begin
-distribution of Opaque copies in quantity, to ensure that this
-Transparent copy will remain thus accessible at the stated location
-until at least one year after the last time you distribute an Opaque
-copy (directly or through your agents or retailers) of that edition to
-the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
address@hidden
-MODIFICATIONS
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
address@hidden A
address@hidden
-Use in the Title Page (and on the covers, if any) a title distinct
-from that of the Document, and from those of previous versions
-(which should, if there were any, be listed in the History section
-of the Document). You may use the same title as a previous version
-if the original publisher of that version gives permission.
-
address@hidden
-List on the Title Page, as authors, one or more persons or entities
-responsible for authorship of the modifications in the Modified
-Version, together with at least five of the principal authors of the
-Document (all of its principal authors, if it has less than five).
-
address@hidden
-State on the Title page the name of the publisher of the
-Modified Version, as the publisher.
-
address@hidden
-Preserve all the copyright notices of the Document.
-
address@hidden
-Add an appropriate copyright notice for your modifications
-adjacent to the other copyright notices.
-
address@hidden
-Include, immediately after the copyright notices, a license notice
-giving the public permission to use the Modified Version under the
-terms of this License, in the form shown in the Addendum below.
-
address@hidden
-Preserve in that license notice the full lists of Invariant Sections
-and required Cover Texts given in the Document's license notice.
-
address@hidden
-Include an unaltered copy of this License.
-
address@hidden
-Preserve the section entitled ``History'', and its title, and add to
-it an item stating at least the title, year, new authors, and
-publisher of the Modified Version as given on the Title Page. If
-there is no section entitled ``History'' in the Document, create one
-stating the title, year, authors, and publisher of the Document as
-given on its Title Page, then add an item describing the Modified
-Version as stated in the previous sentence.
-
address@hidden
-Preserve the network location, if any, given in the Document for
-public access to a Transparent copy of the Document, and likewise
-the network locations given in the Document for previous versions
-it was based on. These may be placed in the ``History'' section.
-You may omit a network location for a work that was published at
-least four years before the Document itself, or if the original
-publisher of the version it refers to gives permission.
-
address@hidden
-In any section entitled ``Acknowledgments'' or ``Dedications'',
-preserve the section's title, and preserve in the section all the
-substance and tone of each of the contributor acknowledgments
-and/or dedications given therein.
-
address@hidden
-Preserve all the Invariant Sections of the Document,
-unaltered in their text and in their titles. Section numbers
-or the equivalent are not considered part of the section titles.
-
address@hidden
-Delete any section entitled ``Endorsements''. Such a section
-may not be included in the Modified Version.
-
address@hidden
-Do not retitle any existing section as ``Endorsements''
-or to conflict in title with any Invariant Section.
address@hidden enumerate
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section entitled ``Endorsements'', provided it contains
-nothing but endorsements of your Modified Version by various
-parties---for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
address@hidden
-COMBINING DOCUMENTS
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections entitled ``History''
-in the various original documents, forming one section entitled
-``History''; likewise combine any sections entitled ``Acknowledgments'',
-and any sections entitled ``Dedications''. You must delete all sections
-entitled ``Endorsements.''
-
address@hidden
-COLLECTIONS OF DOCUMENTS
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
address@hidden
-AGGREGATION WITH INDEPENDENT WORKS
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, does not as a whole count as a Modified Version
-of the Document, provided no compilation copyright is claimed for the
-compilation. Such a compilation is called an ``aggregate'', and this
-License does not apply to the other self-contained works thus compiled
-with the Document, on account of their being thus compiled, if they
-are not themselves derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one quarter
-of the entire aggregate, the Document's Cover Texts may be placed on
-covers that surround only the Document within the aggregate.
-Otherwise they must appear on covers around the whole aggregate.
-
address@hidden
-TRANSLATION
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License provided that you also include the
-original English version of this License. In case of a disagreement
-between the translation and the original English version of this
-License, the original English version will prevail.
-
address@hidden
-TERMINATION
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
address@hidden
-FUTURE REVISIONS OF THIS LICENSE
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
address@hidden://www.gnu.org/copyleft/}.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License ``or any later version'' applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
address@hidden enumerate
-
address@hidden
address@hidden ADDENDUM: How to use this License for your documents
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
address@hidden
address@hidden
- Copyright (C) @var{year} @var{your name}.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.1
- or any later version published by the Free Software Foundation;
- with the Invariant Sections being @var{list their titles}, with the
- Front-Cover Texts being @var{list}, and with the Back-Cover Texts being
@var{list}.
- A copy of the license is included in the section entitled ``GNU
- Free Documentation License''.
address@hidden group
address@hidden smallexample
-
-If you have no Invariant Sections, write ``with no Invariant Sections''
-instead of saying which ones are invariant. If you have no
-Front-Cover Texts, write ``no Front-Cover Texts'' instead of
-``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
address@hidden Local Variables:
address@hidden ispell-local-pdict: "ispell-dict"
address@hidden End:
-
Deleted: trunk/gnue-appserver/doc/api/version.texi
===================================================================
--- trunk/gnue-appserver/doc/api/version.texi 2006-03-24 08:22:29 UTC (rev
8252)
+++ trunk/gnue-appserver/doc/api/version.texi 2006-03-24 10:09:47 UTC (rev
8253)
@@ -1,2 +0,0 @@
address@hidden UPDATED 2004-08-03
address@hidden EDITION 0.1
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [gnue] r8253 - trunk/gnue-appserver/doc/api,
reinhard <=