XCLE



Splash text utilities

Instructions manual


XCLE: eXtensible Concatenative Language Engine
Copyright (C) 2000-2006 Yann LANDRIN-SCHWEITZER a.k.a. Varkhan


This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


Author: Yann LANDRIN-SCHWEITZER
Contact: varkhan@varkhan.net
Homepage: http://www.varkhan.net/


XCLE_Splash utilities


Function XCLE_versionid

unsigned long XCLE_versionid(void) ;
Returns a binary identifier for the current version of XCLE.

Returns:
A binary version identifier.


Note:
The version identifier is composed of the major version number, on the
first byte, the minor version number on the second byte, and the release
number on the third byte.




Function XCLE_version

const char * XCLE_version(void) ;
Returns a version string for the current version of XCLE.

Returns:
A string version identifier.


Note:
The version identifier takes the form "X.Y.Z", where X is the major version
number, Y the minor version number and Z the release number.




Function XCLE_copyright

const char * XCLE_copyright(void) ;
Returns a copyright string for the XCLE library.

Returns:
The copyright string for XCLE.




Function XCLE_license

const char * XCLE_license(void) ;
Returns a short license information for the XCLE library.

Returns:
The string "XCLE is distributed under the LGPL License"




Function XCLE_splash

const char * XCLE_splash(void) ;
Returns the full name of the XCLE library.

Returns:
The string "XCLE: eXtensible Concatenative Language Engine"




Function XCLE_author

const char * XCLE_author(void) ;
Returns the author(s) name and contact information.

Returns:
A string containing one author record per line.


Note:
Each author record should contain, separaed by double dashes:
_ the author's full name,
_ the author's mail address,
_ the author's web page.




Function XCLE_syntax

const char * XCLE_syntax(void) ;
Returns a long string displaying basic synatx information for the XCL language.

Returns:
A string containing one object recor dper line.


Note:
Each line contains each object's type, common name, class and typical
string representation.





Generated by textdoc2html - 2006-02-22