Initial revision
This commit is contained in:
slidedraw
163
cole/doc/HACKING
Normal file
163
cole/doc/HACKING
Normal file
@@ -0,0 +1,163 @@
|
||||
/*
|
||||
cole - A free C OLE library.
|
||||
Copyright 1998, 1999 Roberto Arturo Tena Sanchez
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*/
|
||||
/*
|
||||
Arturo Tena <arturo@directmail.org>
|
||||
*/
|
||||
|
||||
|
||||
Pre-hacking:
|
||||
************
|
||||
|
||||
If you want to play, you'll need:
|
||||
+ An ANSI C system (libraries and C compiler).
|
||||
+ GNU m4, GNU automake-1.4, GNU autoconf 2.13 and GNU libtool 1.3.2
|
||||
if you want to change `configure.in' or some `Makefile.am'.
|
||||
+ DocBook 3.x tools and gtk-doc
|
||||
(from GNOME CVS (http://cvs.gnome.org/)) if you want to make
|
||||
a distribution.
|
||||
|
||||
|
||||
Tests:
|
||||
******
|
||||
|
||||
If you write a new public call, write their documentation: see comments before the implementation of other public calls, and write a test and put in in `examples' directory.
|
||||
|
||||
|
||||
API:
|
||||
****
|
||||
|
||||
The API 2.x must be modelled after `stdio.h' ANSI C calls, but cleanner. This
|
||||
means the arguments must be the minimal that the call _really_ needs.
|
||||
|
||||
The last argument of most of calls must be `COLERRNO *colerrno'. This must be set if an error is found when calling some other call or a system call, but colerrno can be NULL, so always use `if (colerrno != NULL) *colerrno = COLE_...'.
|
||||
|
||||
All the public calls neet to have a `COLERRNO *colerrno' argument, except those that simply can not fail.
|
||||
|
||||
If you create a new error code, insert it in the list of the colerrno argument in the document comment above the function with the new error code, insert in enum _COLERRNO, add a comment there, add an entry in cole_perror and review all the sources that call the function that have the new error code in order to catch the new error (inclusive utils and examples directories).
|
||||
|
||||
When writting a call that calls another calls which returns colerrno, say in documentation something like: ` * @colerrno: error value (COLE_AAA, errors from calls cole_XXX(), cole_XXY() and COLE_XXZ())' if the call that you are writting calls cole_XXX, cole_XXY and COLE_XXZ and returns COLE_AAA by itself.
|
||||
|
||||
|
||||
Implementation:
|
||||
***************
|
||||
|
||||
When you write the code to check the return value from a function with switch, always write a default case (in the most cases the default case will return a COLE_UNKNOWN). If you use if's, write an else case.
|
||||
|
||||
|
||||
Documentation:
|
||||
**************
|
||||
|
||||
If you modified `cole-manual.sgml', you must run `make html' in the `doc'
|
||||
subdirectory.
|
||||
|
||||
If you modified the templates, you must run `make sgml' and then `make html'
|
||||
in the `doc' subdirectory.
|
||||
|
||||
If you modified `cole-sections.txt'... well, I guess you must run
|
||||
`make templates' and then `make sgml' and then `make html' in the `doc'
|
||||
subdirectory (but I'm not sure because I'm lerning this gtk-doc thing).
|
||||
|
||||
If you changed the existing comment of a function, structure, etc, you must
|
||||
run `make sgml' and then `make html' in the `doc' subdirectory.
|
||||
|
||||
If you changed the parameters of some function, run `make templates' and then
|
||||
`make sgml' and then `make html'.
|
||||
|
||||
If you added, renamed or deleted some function, well you tell me what to do.
|
||||
|
||||
All targets in the `Makefile' in the `doc' subdirectory modifies sources, that
|
||||
way the documentation can be updated when checked in CVS.
|
||||
|
||||
Before you regenerate documentation, must have a build directory with all the
|
||||
code compiled, because `cole.h' file is needed.
|
||||
|
||||
|
||||
FlashPix file format:
|
||||
*********************
|
||||
|
||||
Seems to me that "Root Entry" pps number is zero (like MS files), but it has
|
||||
no name! I mean, pps_list[0].type == 5, but pps_list[0].name[0] == 0.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**********************
|
||||
* OLD HACKING DOCUMENT
|
||||
**********************
|
||||
|
||||
|
||||
Hacking:
|
||||
********
|
||||
|
||||
Ok, next few lines are for people trying to understand the cole code.
|
||||
|
||||
to code a OLE2 file (which is done by OLEcode) is done it two fases:
|
||||
process and generate.
|
||||
|
||||
process insert all the information in the Structure, and generate reads
|
||||
this Structure and write the actual output_file (wich is an ole2 file) by
|
||||
copying real files and some parts of Structure to output_file.
|
||||
|
||||
in the generate stage we know the actual blocks where each stream is
|
||||
stored, so in this stage this start block is written in Root.
|
||||
|
||||
functions of process stage starts with process_* and add_*.
|
||||
functions of generating stage starts with generate_* and write_*.
|
||||
|
||||
the size property of `Root Entry' pps is the actual size of sbfile, and
|
||||
always is a multiple of 0x40.
|
||||
|
||||
A graph of Structure following:
|
||||
|
||||
[missing, remember me I must do it]
|
||||
|
||||
size of Input (Input.size) is never used, it's no necessary. In any case,
|
||||
what info we should write there? Same case as Input.blocks.
|
||||
|
||||
somewhere in process stage, name of real files are copied by reference,
|
||||
that means two vars will point to the same memory posittion. one var is
|
||||
in pps_entry * stream_list names, and the other is in sbfile and Input in
|
||||
Structure. But it's ok.
|
||||
|
||||
notes:
|
||||
a ole2 file can or not contain small streams. if there are, it will
|
||||
have SDepot, although in Structure always SDepot exist,
|
||||
SDepot->size == sbfile->size == 0 if file do not contain small streams
|
||||
|
||||
it seems to me a ole2 file could not have big streams, just small streams. BUT it will at least one block that is taken by BDepot, because in BDepot store block chains for SDepot and Root
|
||||
|
||||
It seems that Solaris doesn't like directories as targets... must be a file.
|
||||
This is a problem in doc/Makefile.
|
||||
|
||||
about the code:
|
||||
it's spaguetticode. I know. Long var names. I know. Help me to fix it.
|
||||
comments are generally after the line it comments, as explanation of what
|
||||
i have done.
|
||||
|
||||
advices:
|
||||
when doing a change, verify the program works with files with SDepot and
|
||||
files with out SDepot (files with or without small streams)
|
||||
|
||||
if you change the version number, change it both in configure.in file and in doc/cole-manual.sgml.
|
||||
|
||||
92
cole/doc/Makefile.am
Normal file
92
cole/doc/Makefile.am
Normal file
@@ -0,0 +1,92 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
|
||||
EXTRA_DIST = cole-manual.sgml \
|
||||
introduction.sgml \
|
||||
compile.sgml \
|
||||
using.sgml \
|
||||
bugs.sgml \
|
||||
gpl.sgml \
|
||||
legal.sgml \
|
||||
HACKING \
|
||||
cole-manual.sgml-old
|
||||
|
||||
dist-hook: all
|
||||
cp $(srcdir)/cole-sections.txt $(distdir)
|
||||
cp -r $(srcdir)/tmpl $(distdir)
|
||||
cp -r $(srcdir)/cole-manual $(distdir)
|
||||
|
||||
|
||||
|
||||
# Headers to scan for declarations
|
||||
scanned_headers = ../internal.h ../support.h ./cole.h
|
||||
|
||||
|
||||
# The name of the module.
|
||||
DOC_MODULE = cole
|
||||
|
||||
# The top-level SGML file.
|
||||
DOC_MAIN_SGML_FILE = cole-manual.sgml
|
||||
|
||||
# The directory containing the source code (if it contains documentation).
|
||||
DOC_SOURCE_DIR = $(top_srcdir)
|
||||
|
||||
# The directory where the documentation will be installed
|
||||
TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE)
|
||||
|
||||
|
||||
|
||||
scan:
|
||||
cp $(top_builddir)/cole.h $(srcdir); \
|
||||
(cd $(srcdir); \
|
||||
gtkdoc-scan --module=$(DOC_MODULE) $(scanned_headers); \
|
||||
rm cole.h)
|
||||
templates: scan
|
||||
(cd $(srcdir); \
|
||||
gtkdoc-mktmpl --module=$(DOC_MODULE))
|
||||
sgml:
|
||||
(cd $(srcdir); \
|
||||
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR))
|
||||
html:
|
||||
(cd $(srcdir); \
|
||||
cat ../BUGS | sed "s/>/>/g" | sed "s/</</g" > BUGS; \
|
||||
db2html $(DOC_MAIN_SGML_FILE); \
|
||||
rm BUGS)
|
||||
rtf:
|
||||
(cd $(srcdir); \
|
||||
cat ../BUGS | sed "s/>/>/g" | sed "s/</</g" > BUGS; \
|
||||
db2rtf $(DOC_MAIN_SGML_FILE); \
|
||||
-rm BUGS)
|
||||
ps:
|
||||
(cd $(srcdir); \
|
||||
cat ../BUGS | sed "s/>/>/g" | sed "s/</</g" | sed "s/&/&/g" > BUGS; \
|
||||
db2ps $(DOC_MAIN_SGML_FILE); \
|
||||
-rm BUGS)
|
||||
|
||||
regenerate-all: templates sgml html
|
||||
|
||||
|
||||
|
||||
clean-local:
|
||||
(cd $(srcdir); \
|
||||
rm -f *~ *.bak *.hierarchy *.signals *.args; \
|
||||
rm -fr DBTOHTML_OUTPUT_DIR* *.junk $(DOC_MODULE)-decl-list.txt)
|
||||
|
||||
maintainer-clean-local: clean
|
||||
(cd $(srcdir); \
|
||||
rm -rf sgml html cole-manual tmpl/*.bak; \
|
||||
rm -rf $(DOC_MODULE)-decl.txt)
|
||||
|
||||
|
||||
|
||||
# if db2html generate subdirectories, it's broken the next rule
|
||||
# install-data-local: all
|
||||
# $(INSTALL) -d $(TARGET_DIR)
|
||||
# $(INSTALL) ./cole-manual/* $(TARGET_DIR)
|
||||
|
||||
|
||||
|
||||
## Solaris make doesn't like directory as a target...
|
||||
|
||||
.PHONY : ps rtf html sgml templates scan
|
||||
|
||||
256
cole/doc/Makefile.in
Normal file
256
cole/doc/Makefile.in
Normal file
@@ -0,0 +1,256 @@
|
||||
# Makefile.in generated automatically by automake 1.4 from Makefile.am
|
||||
|
||||
# Copyright (C) 1994, 1995-8, 1999 Free Software Foundation, Inc.
|
||||
# This Makefile.in is free software; the Free Software Foundation
|
||||
# gives unlimited permission to copy and/or distribute it,
|
||||
# with or without modifications, as long as this notice is preserved.
|
||||
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
|
||||
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
||||
# PARTICULAR PURPOSE.
|
||||
|
||||
|
||||
SHELL = @SHELL@
|
||||
|
||||
srcdir = @srcdir@
|
||||
top_srcdir = @top_srcdir@
|
||||
VPATH = @srcdir@
|
||||
prefix = @prefix@
|
||||
exec_prefix = @exec_prefix@
|
||||
|
||||
bindir = @bindir@
|
||||
sbindir = @sbindir@
|
||||
libexecdir = @libexecdir@
|
||||
datadir = @datadir@
|
||||
sysconfdir = @sysconfdir@
|
||||
sharedstatedir = @sharedstatedir@
|
||||
localstatedir = @localstatedir@
|
||||
libdir = @libdir@
|
||||
infodir = @infodir@
|
||||
mandir = @mandir@
|
||||
includedir = @includedir@
|
||||
oldincludedir = /usr/include
|
||||
|
||||
DESTDIR =
|
||||
|
||||
pkgdatadir = $(datadir)/@PACKAGE@
|
||||
pkglibdir = $(libdir)/@PACKAGE@
|
||||
pkgincludedir = $(includedir)/@PACKAGE@
|
||||
|
||||
top_builddir = ..
|
||||
|
||||
ACLOCAL = @ACLOCAL@
|
||||
AUTOCONF = @AUTOCONF@
|
||||
AUTOMAKE = @AUTOMAKE@
|
||||
AUTOHEADER = @AUTOHEADER@
|
||||
|
||||
INSTALL = @INSTALL@
|
||||
INSTALL_PROGRAM = @INSTALL_PROGRAM@ $(AM_INSTALL_PROGRAM_FLAGS)
|
||||
INSTALL_DATA = @INSTALL_DATA@
|
||||
INSTALL_SCRIPT = @INSTALL_SCRIPT@
|
||||
transform = @program_transform_name@
|
||||
|
||||
NORMAL_INSTALL = :
|
||||
PRE_INSTALL = :
|
||||
POST_INSTALL = :
|
||||
NORMAL_UNINSTALL = :
|
||||
PRE_UNINSTALL = :
|
||||
POST_UNINSTALL = :
|
||||
host_alias = @host_alias@
|
||||
host_triplet = @host@
|
||||
AS = @AS@
|
||||
CC = @CC@
|
||||
COLE_MAJOR = @COLE_MAJOR@
|
||||
COLE_MICRO = @COLE_MICRO@
|
||||
COLE_MINOR = @COLE_MINOR@
|
||||
DLLTOOL = @DLLTOOL@
|
||||
HOST_ALIAS_NAME = @HOST_ALIAS_NAME@
|
||||
HOST_CANONICAL_NAME = @HOST_CANONICAL_NAME@
|
||||
HOST_CPU = @HOST_CPU@
|
||||
HOST_OS = @HOST_OS@
|
||||
HOST_VENDOR = @HOST_VENDOR@
|
||||
LD = @LD@
|
||||
LIBTOOL = @LIBTOOL@
|
||||
LN_S = @LN_S@
|
||||
MAKEINFO = @MAKEINFO@
|
||||
NM = @NM@
|
||||
PACKAGE = @PACKAGE@
|
||||
RANLIB = @RANLIB@
|
||||
USE_SYMBOL_UNDERSCORE = @USE_SYMBOL_UNDERSCORE@
|
||||
VERSION = @VERSION@
|
||||
VERSION_INFO = @VERSION_INFO@
|
||||
|
||||
EXTRA_DIST = cole-manual.sgml introduction.sgml compile.sgml using.sgml bugs.sgml gpl.sgml legal.sgml HACKING cole-manual.sgml-old
|
||||
|
||||
|
||||
# Headers to scan for declarations
|
||||
scanned_headers = ../internal.h ../support.h ./cole.h
|
||||
|
||||
# The name of the module.
|
||||
DOC_MODULE = cole
|
||||
|
||||
# The top-level SGML file.
|
||||
DOC_MAIN_SGML_FILE = cole-manual.sgml
|
||||
|
||||
# The directory containing the source code (if it contains documentation).
|
||||
DOC_SOURCE_DIR = $(top_srcdir)
|
||||
|
||||
# The directory where the documentation will be installed
|
||||
TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE)
|
||||
mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
|
||||
CONFIG_HEADER = ../config.h
|
||||
CONFIG_CLEAN_FILES =
|
||||
DIST_COMMON = Makefile.am Makefile.in
|
||||
|
||||
|
||||
DISTFILES = $(DIST_COMMON) $(SOURCES) $(HEADERS) $(TEXINFOS) $(EXTRA_DIST)
|
||||
|
||||
TAR = gtar
|
||||
GZIP_ENV = --best
|
||||
all: all-redirect
|
||||
.SUFFIXES:
|
||||
$(srcdir)/Makefile.in: Makefile.am $(top_srcdir)/configure.in $(ACLOCAL_M4)
|
||||
cd $(top_srcdir) && $(AUTOMAKE) --gnu --include-deps doc/Makefile
|
||||
|
||||
Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
|
||||
cd $(top_builddir) \
|
||||
&& CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status
|
||||
|
||||
tags: TAGS
|
||||
TAGS:
|
||||
|
||||
|
||||
distdir = $(top_builddir)/$(PACKAGE)-$(VERSION)/$(subdir)
|
||||
|
||||
subdir = doc
|
||||
|
||||
distdir: $(DISTFILES)
|
||||
@for file in $(DISTFILES); do \
|
||||
d=$(srcdir); \
|
||||
if test -d $$d/$$file; then \
|
||||
cp -pr $$d/$$file $(distdir)/$$file; \
|
||||
else \
|
||||
test -f $(distdir)/$$file \
|
||||
|| ln $$d/$$file $(distdir)/$$file 2> /dev/null \
|
||||
|| cp -p $$d/$$file $(distdir)/$$file || :; \
|
||||
fi; \
|
||||
done
|
||||
$(MAKE) $(AM_MAKEFLAGS) top_distdir="$(top_distdir)" distdir="$(distdir)" dist-hook
|
||||
info-am:
|
||||
info: info-am
|
||||
dvi-am:
|
||||
dvi: dvi-am
|
||||
check-am: all-am
|
||||
check: check-am
|
||||
installcheck-am:
|
||||
installcheck: installcheck-am
|
||||
install-exec-am:
|
||||
install-exec: install-exec-am
|
||||
|
||||
install-data-am:
|
||||
install-data: install-data-am
|
||||
|
||||
install-am: all-am
|
||||
@$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
|
||||
install: install-am
|
||||
uninstall-am:
|
||||
uninstall: uninstall-am
|
||||
all-am: Makefile
|
||||
all-redirect: all-am
|
||||
install-strip:
|
||||
$(MAKE) $(AM_MAKEFLAGS) AM_INSTALL_PROGRAM_FLAGS=-s install
|
||||
installdirs:
|
||||
|
||||
|
||||
mostlyclean-generic:
|
||||
|
||||
clean-generic:
|
||||
|
||||
distclean-generic:
|
||||
-rm -f Makefile $(CONFIG_CLEAN_FILES)
|
||||
-rm -f config.cache config.log stamp-h stamp-h[0-9]*
|
||||
|
||||
maintainer-clean-generic:
|
||||
mostlyclean-am: mostlyclean-generic
|
||||
|
||||
mostlyclean: mostlyclean-am
|
||||
|
||||
clean-am: clean-generic mostlyclean-am clean-local
|
||||
|
||||
clean: clean-am
|
||||
|
||||
distclean-am: distclean-generic clean-am
|
||||
-rm -f libtool
|
||||
|
||||
distclean: distclean-am
|
||||
|
||||
maintainer-clean-am: maintainer-clean-generic distclean-am \
|
||||
maintainer-clean-local
|
||||
@echo "This command is intended for maintainers to use;"
|
||||
@echo "it deletes files that may require special tools to rebuild."
|
||||
|
||||
maintainer-clean: maintainer-clean-am
|
||||
|
||||
.PHONY: tags distdir info-am info dvi-am dvi check check-am \
|
||||
installcheck-am installcheck install-exec-am install-exec \
|
||||
install-data-am install-data install-am install uninstall-am uninstall \
|
||||
all-redirect all-am all installdirs mostlyclean-generic \
|
||||
distclean-generic clean-generic maintainer-clean-generic clean \
|
||||
mostlyclean distclean maintainer-clean
|
||||
|
||||
|
||||
dist-hook: all
|
||||
cp $(srcdir)/cole-sections.txt $(distdir)
|
||||
cp -r $(srcdir)/tmpl $(distdir)
|
||||
cp -r $(srcdir)/cole-manual $(distdir)
|
||||
|
||||
scan:
|
||||
cp $(top_builddir)/cole.h $(srcdir); \
|
||||
(cd $(srcdir); \
|
||||
gtkdoc-scan --module=$(DOC_MODULE) $(scanned_headers); \
|
||||
rm cole.h)
|
||||
templates: scan
|
||||
(cd $(srcdir); \
|
||||
gtkdoc-mktmpl --module=$(DOC_MODULE))
|
||||
sgml:
|
||||
(cd $(srcdir); \
|
||||
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR))
|
||||
html:
|
||||
(cd $(srcdir); \
|
||||
cat ../BUGS | sed "s/>/>/g" | sed "s/</</g" > BUGS; \
|
||||
db2html $(DOC_MAIN_SGML_FILE); \
|
||||
rm BUGS)
|
||||
rtf:
|
||||
(cd $(srcdir); \
|
||||
cat ../BUGS | sed "s/>/>/g" | sed "s/</</g" > BUGS; \
|
||||
db2rtf $(DOC_MAIN_SGML_FILE); \
|
||||
-rm BUGS)
|
||||
ps:
|
||||
(cd $(srcdir); \
|
||||
cat ../BUGS | sed "s/>/>/g" | sed "s/</</g" | sed "s/&/&/g" > BUGS; \
|
||||
db2ps $(DOC_MAIN_SGML_FILE); \
|
||||
-rm BUGS)
|
||||
|
||||
regenerate-all: templates sgml html
|
||||
|
||||
clean-local:
|
||||
(cd $(srcdir); \
|
||||
rm -f *~ *.bak *.hierarchy *.signals *.args; \
|
||||
rm -fr DBTOHTML_OUTPUT_DIR* *.junk $(DOC_MODULE)-decl-list.txt)
|
||||
|
||||
maintainer-clean-local: clean
|
||||
(cd $(srcdir); \
|
||||
rm -rf sgml html cole-manual tmpl/*.bak; \
|
||||
rm -rf $(DOC_MODULE)-decl.txt)
|
||||
|
||||
# if db2html generate subdirectories, it's broken the next rule
|
||||
# install-data-local: all
|
||||
# $(INSTALL) -d $(TARGET_DIR)
|
||||
# $(INSTALL) ./cole-manual/* $(TARGET_DIR)
|
||||
|
||||
.PHONY : ps rtf html sgml templates scan
|
||||
|
||||
# Tell versions [3.59,3.63) of GNU make to not export all variables.
|
||||
# Otherwise a system limit (for SysV at least) may be exceeded.
|
||||
.NOEXPORT:
|
||||
39
cole/doc/bugs.sgml
Normal file
39
cole/doc/bugs.sgml
Normal file
@@ -0,0 +1,39 @@
|
||||
|
||||
<para>
|
||||
cole developers have done their best effort to fix all the bugs of cole. But may be some of the are still hidden in the code. If you found one (or many!), please send a report to the maintainer (&maintainer-email-ulink;). When sending a report, please:
|
||||
</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Describe with detail the behavior of cole and why you think it's a bug.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Configure cole using the argument <link linkend="how-to-compile">--enable-verbose</link> and send the output showing the bug.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Send the content of the variables <link linkend="cole-version">cole_version</link> and <link linkend="cole-host-info">cole_host_info</link> that the cole release you are using have. You wil have to write a little program to do this, but it will help much. =)
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If you can, send the most small source code that shows the bug in action. May be you want to send the Structured Storage file you have been processing.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can send the files <filename>config.log</filename> and <filename>config.cache</filename> (which were created by <filename>configure</filename>) if you want.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<para>
|
||||
Thank you very much.
|
||||
</para>
|
||||
<para>
|
||||
Following is the <filename>BUGS</filename> file for this release.
|
||||
</para>
|
||||
<screen>&BUGS-File;</screen>
|
||||
|
||||
73
cole/doc/cole-manual.sgml
Normal file
73
cole/doc/cole-manual.sgml
Normal file
@@ -0,0 +1,73 @@
|
||||
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
|
||||
<!entity Introduction SYSTEM "introduction.sgml">
|
||||
<!entity Using-cole SYSTEM "using.sgml">
|
||||
<!entity Bugs SYSTEM "bugs.sgml">
|
||||
<!entity BUGS-File SYSTEM "BUGS">
|
||||
<!entity GPL-License-Chapter SYSTEM "gpl.sgml">
|
||||
<!entity Legal SYSTEM "legal.sgml">
|
||||
<!entity cole-Internals SYSTEM "sgml/internals.sgml">
|
||||
<!entity cole-API SYSTEM "sgml/api.sgml">
|
||||
<!entity How-To-Compile SYSTEM "compile.sgml">
|
||||
|
||||
<!entity author-name-full "Roberto Arturo Tena Sánchez">
|
||||
<!entity maintainer-email-ulink "<ulink
|
||||
URL="mailto:arturo@directmail.org"
|
||||
><arturo@directmail.org></ulink>">
|
||||
]>
|
||||
|
||||
<book id="index">
|
||||
|
||||
|
||||
<bookinfo>
|
||||
<title>cole Library Reference Manual</title>
|
||||
<copyright>
|
||||
<year>1998, 1999</year>
|
||||
<holder>&author-name-full;</holder>
|
||||
</copyright>
|
||||
</bookinfo>
|
||||
|
||||
|
||||
<chapter id="introduction">
|
||||
<title>Introduction</title>
|
||||
&Introduction;
|
||||
</chapter>
|
||||
|
||||
|
||||
<chapter id="how-to-compile">
|
||||
<title>How to compile cole</title>
|
||||
&How-To-Compile;
|
||||
</chapter>
|
||||
|
||||
|
||||
<chapter id="libcole">
|
||||
<title>cole Library</title>
|
||||
<para>
|
||||
This is the documentation autogenerated from the source code. It have the cole <link linkend="cole-API">API</link> for this release, and some internal structures and internal calls.
|
||||
</para>
|
||||
<para>
|
||||
Note: what Microsoft calls <userinput>stream</userinput> is called <userinput>file</userinput> in this project, <userinput>storage</userinput> is called <userinput>directory</userinput> and <userinput>docfile</userinput> (a Structured Storage file) is called <userinput>filesystem</userinput>.
|
||||
</para>
|
||||
&Using-cole;
|
||||
|
||||
&cole-API;
|
||||
&cole-Internals;
|
||||
</chapter>
|
||||
|
||||
|
||||
<chapter id="bugs">
|
||||
<title>Bugs</title>
|
||||
&Bugs;
|
||||
</chapter>
|
||||
|
||||
|
||||
<chapter id="legal-issues">
|
||||
<title>Legal issues</title>
|
||||
&Legal;
|
||||
</chapter> <!-- legal-issues -->
|
||||
|
||||
|
||||
&GPL-License-Chapter;
|
||||
|
||||
|
||||
</book>
|
||||
|
||||
1148
cole/doc/cole-manual.sgml-old
Normal file
1148
cole/doc/cole-manual.sgml-old
Normal file
File diff suppressed because it is too large
Load Diff
223
cole/doc/cole-manual/bugs.html
Normal file
223
cole/doc/cole-manual/bugs.html
Normal file
@@ -0,0 +1,223 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>Bugs</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="Internals"
|
||||
HREF="cole-internals.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="Legal issues"
|
||||
HREF="legal-issues.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="cole-internals.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="legal-issues.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="CHAPTER"
|
||||
><H1
|
||||
><A
|
||||
NAME="BUGS"
|
||||
>Chapter 4. Bugs</A
|
||||
></H1
|
||||
><P
|
||||
> cole developers have done their best effort to fix all the bugs of cole. But may be some of the are still hidden in the code. If you found one (or many!), please send a report to the maintainer (<A
|
||||
HREF="mailto:arturo@directmail.org"
|
||||
TARGET="_top"
|
||||
><arturo@directmail.org></A
|
||||
>). When sending a report, please:</P
|
||||
><P
|
||||
></P
|
||||
><OL
|
||||
TYPE="1"
|
||||
><LI
|
||||
><P
|
||||
> Describe with detail the behavior of cole and why you think it's a bug.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Configure cole using the argument <A
|
||||
HREF="how-to-compile.html"
|
||||
>--enable-verbose</A
|
||||
> and send the output showing the bug.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Send the content of the variables <A
|
||||
HREF="cole-api.html#COLE-VERSION"
|
||||
>cole_version</A
|
||||
> and <A
|
||||
HREF="cole-api.html#COLE-HOST-INFO"
|
||||
>cole_host_info</A
|
||||
> that the cole release you are using have. You wil have to write a little program to do this, but it will help much. =)
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> If you can, send the most small source code that shows the bug in action. May be you want to send the Structured Storage file you have been processing.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> You can send the files <TT
|
||||
CLASS="FILENAME"
|
||||
>config.log</TT
|
||||
> and <TT
|
||||
CLASS="FILENAME"
|
||||
>config.cache</TT
|
||||
> (which were created by <TT
|
||||
CLASS="FILENAME"
|
||||
>configure</TT
|
||||
>) if you want.
|
||||
</P
|
||||
></LI
|
||||
></OL
|
||||
><P
|
||||
> Thank you very much.</P
|
||||
><P
|
||||
> Following is the <TT
|
||||
CLASS="FILENAME"
|
||||
>BUGS</TT
|
||||
> file for this release.</P
|
||||
><TABLE
|
||||
BORDER="0"
|
||||
BGCOLOR="#E0E0E0"
|
||||
WIDTH="100%"
|
||||
><TR
|
||||
><TD
|
||||
><PRE
|
||||
CLASS="SCREEN"
|
||||
> Report bugs to the maintainer (see the file `AUTHORS' for details).
|
||||
Please, along with your detailed report, send the cole's output when compiled
|
||||
using `--enable-verbose' (see the files `README' and `INSTALL' for details).
|
||||
|
||||
|
||||
Current bugs:
|
||||
**************
|
||||
|
||||
None.
|
||||
|
||||
|
||||
Fixed bugs:
|
||||
************
|
||||
|
||||
Reported that cole can't read files biggers that 8Mb. UPDATE: oledecod.c is
|
||||
changed now to read additional blocks to the bbd. This fixes the bug.
|
||||
|
||||
Reported strange bug in cole 0.1.0 using Solaris using `../demo sprsheet.xls'
|
||||
in examples directory. We need more test there! UPDATE: Seems to be fixed in
|
||||
cole 1.0.0 with the endianess care code.
|
||||
|
||||
|
||||
Possible bugs:
|
||||
**************
|
||||
|
||||
* cole is not reentrant safe (it's in TODO):
|
||||
What happend if, in any program, one user tries to decode and/or code
|
||||
two files (the same or diferent)? Because static vars, will it get
|
||||
broke? I think yes, mmmh... </PRE
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="cole-internals.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="legal-issues.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>Internals</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>Legal issues</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
4305
cole/doc/cole-manual/cole-api.html
Normal file
4305
cole/doc/cole-manual/cole-api.html
Normal file
File diff suppressed because it is too large
Load Diff
2186
cole/doc/cole-manual/cole-internals.html
Normal file
2186
cole/doc/cole-manual/cole-internals.html
Normal file
File diff suppressed because it is too large
Load Diff
137
cole/doc/cole-manual/copyright-and-disclaimer.html
Normal file
137
cole/doc/cole-manual/copyright-and-disclaimer.html
Normal file
@@ -0,0 +1,137 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>Copyright and disclaimer</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="UP"
|
||||
TITLE="Legal issues"
|
||||
HREF="legal-issues.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="Trademarks"
|
||||
HREF="trademarks.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="GNU GENERAL PUBLIC LICENSE
|
||||
"
|
||||
HREF="gpl-license.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="trademarks.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
>Chapter 5. Legal issues</TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="gpl-license.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="COPYRIGHT-AND-DISCLAIMER"
|
||||
>Copyright and disclaimer</A
|
||||
></H1
|
||||
><P
|
||||
> This document is copyright 1999 by Roberto Arturo Tena S<>nchez. This document is free software; you can redistribute it and/or modify it under the terms of the <A
|
||||
HREF="gpl-license.html"
|
||||
>GNU General Public License</A
|
||||
> as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</P
|
||||
><P
|
||||
> This document is provided as is without any express or implied warranties. While every effort has been taken to ensure the accuracy of the information contained in this document, the author/maintainer/contributors assume(s) no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.</P
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="trademarks.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="gpl-license.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>Trademarks</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="legal-issues.html"
|
||||
>Up</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>GNU GENERAL PUBLIC LICENSE</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
20
cole/doc/cole-manual/docbook.css
Executable file
20
cole/doc/cole-manual/docbook.css
Executable file
@@ -0,0 +1,20 @@
|
||||
.BOOK .TITLE { text-align: center }
|
||||
.BOOK .SUBTITLE { text-align: center }
|
||||
.BOOK .CORPAUTHOR { text-align: center }
|
||||
.BOOK .AUTHOR { text-align: center }
|
||||
.BOOK .AFFILIATION { text-align: center }
|
||||
.BOOK .EDITEDBY { text-align: center }
|
||||
.BOOK .EDITOR { text-align: center }
|
||||
.BOOK .GRAPHIC { text-align: center }
|
||||
|
||||
.ARTICLE .TITLE { text-align: center }
|
||||
.ARTICLE .SUBTITLE { text-align: center }
|
||||
.ARTICLE .CORPAUTHOR { text-align: center }
|
||||
.ARTICLE .AUTHOR { text-align: center }
|
||||
.ARTICLE .AFFILIATION { text-align: center }
|
||||
.ARTICLE .EDITEDBY { text-align: center }
|
||||
.ARTICLE .EDITOR { text-align: center }
|
||||
.ARTICLE .GRAPHIC { text-align: center }
|
||||
.ARTICLE .ABSTRACT { margin-left: 0.5in;
|
||||
margin-right: 0.5in;
|
||||
font-style: italic }
|
||||
199
cole/doc/cole-manual/features.html
Normal file
199
cole/doc/cole-manual/features.html
Normal file
@@ -0,0 +1,199 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>Features</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="UP"
|
||||
TITLE="Introduction"
|
||||
HREF="introduction.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="Introduction"
|
||||
HREF="introduction.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="Requirements to compile"
|
||||
HREF="requirements-to-compile.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="introduction.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
>Chapter 1. Introduction</TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="requirements-to-compile.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="FEATURES"
|
||||
>Features</A
|
||||
></H1
|
||||
><P
|
||||
>cole 2.x release series:</P
|
||||
><P
|
||||
></P
|
||||
><UL
|
||||
><LI
|
||||
><P
|
||||
> Can open Structured Storage files generated with programs from Microsoft, StarDivision and FlashPix.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Is written in C, for better performance.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Should compile in UNIX-like systems with ANSI C libraries and a ANSI C compiler.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Has a new good-looking API, modelled after ANSI C <TT
|
||||
CLASS="FILENAME"
|
||||
>stdio.h</TT
|
||||
> routines.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Uses standard automake, autoconf and libtool generated files.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Provides a standard <TT
|
||||
CLASS="FILENAME"
|
||||
>configure</TT
|
||||
> script.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Builds shared (dynamic) libraries if the plattform and libtool support it.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Provides standard targets in the Makefile (ie. <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>install</B
|
||||
></TT
|
||||
>, <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>clean</B
|
||||
></TT
|
||||
>, etc).
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Can use (thanks to the <TT
|
||||
CLASS="FILENAME"
|
||||
>configure</TT
|
||||
> script) plattform dependent system calls for better performance.
|
||||
</P
|
||||
></LI
|
||||
></UL
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="introduction.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="requirements-to-compile.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>Introduction</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="introduction.html"
|
||||
>Up</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>Requirements to compile</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
236
cole/doc/cole-manual/gpl-license-how-to-apply.html
Normal file
236
cole/doc/cole-manual/gpl-license-how-to-apply.html
Normal file
@@ -0,0 +1,236 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>How to Apply These Terms to Your New Programs
|
||||
</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="UP"
|
||||
TITLE="GNU GENERAL PUBLIC LICENSE
|
||||
"
|
||||
HREF="gpl-license.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
"
|
||||
HREF="gpl-license-terms.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="gpl-license-terms.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
>Chapter 6. GNU GENERAL PUBLIC LICENSE</TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
> </TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="GPL-LICENSE-HOW-TO-APPLY"
|
||||
>How to Apply These Terms to Your New Programs</A
|
||||
></H1
|
||||
><P
|
||||
>If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
</P
|
||||
><P
|
||||
>To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
</P
|
||||
><TABLE
|
||||
BORDER="0"
|
||||
BGCOLOR="#E0E0E0"
|
||||
WIDTH="100%"
|
||||
><TR
|
||||
><TD
|
||||
><PRE
|
||||
CLASS="SCREEN"
|
||||
><I
|
||||
CLASS="EMPHASIS"
|
||||
>one line to give the program's name and a brief idea of what it does.</I
|
||||
>
|
||||
Copyright (C) <I
|
||||
CLASS="EMPHASIS"
|
||||
>year</I
|
||||
> <I
|
||||
CLASS="EMPHASIS"
|
||||
>name of author</I
|
||||
>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</PRE
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><P
|
||||
>Also add information on how to contact you by electronic and paper mail.
|
||||
</P
|
||||
><P
|
||||
>If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
</P
|
||||
><TABLE
|
||||
BORDER="0"
|
||||
BGCOLOR="#E0E0E0"
|
||||
WIDTH="100%"
|
||||
><TR
|
||||
><TD
|
||||
><PRE
|
||||
CLASS="SCREEN"
|
||||
>Gnomovision version 69, Copyright (C) <I
|
||||
CLASS="EMPHASIS"
|
||||
>year</I
|
||||
> <I
|
||||
CLASS="EMPHASIS"
|
||||
>name of author</I
|
||||
>
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
|
||||
type `show w'. This is free software, and you are welcome
|
||||
to redistribute it under certain conditions; type `show c'
|
||||
for details.</PRE
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><P
|
||||
>The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
</P
|
||||
><P
|
||||
>You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
</P
|
||||
><TABLE
|
||||
BORDER="0"
|
||||
BGCOLOR="#E0E0E0"
|
||||
WIDTH="100%"
|
||||
><TR
|
||||
><TD
|
||||
><PRE
|
||||
CLASS="SCREEN"
|
||||
>Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<I
|
||||
CLASS="EMPHASIS"
|
||||
>signature of Ty Coon</I
|
||||
>, 1 April 1989
|
||||
Ty Coon, President of Vice</PRE
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><P
|
||||
>This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Library General
|
||||
Public License instead of this License.
|
||||
</P
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="gpl-license-terms.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="gpl-license.html"
|
||||
>Up</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
385
cole/doc/cole-manual/gpl-license-terms.html
Normal file
385
cole/doc/cole-manual/gpl-license-terms.html
Normal file
@@ -0,0 +1,385 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="UP"
|
||||
TITLE="GNU GENERAL PUBLIC LICENSE
|
||||
"
|
||||
HREF="gpl-license.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="GNU GENERAL PUBLIC LICENSE
|
||||
"
|
||||
HREF="gpl-license.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="How to Apply These Terms to Your New Programs
|
||||
"
|
||||
HREF="gpl-license-how-to-apply.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="gpl-license.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
>Chapter 6. GNU GENERAL PUBLIC LICENSE</TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="gpl-license-how-to-apply.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="GPL-LICENSE-TERMS"
|
||||
>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A
|
||||
></H1
|
||||
><P
|
||||
>0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
</P
|
||||
><P
|
||||
>Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
</P
|
||||
><P
|
||||
>1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
</P
|
||||
><P
|
||||
>You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
</P
|
||||
><P
|
||||
>2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
</P
|
||||
><P
|
||||
>a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
</P
|
||||
><P
|
||||
>b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
</P
|
||||
><P
|
||||
>c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
</P
|
||||
><P
|
||||
>These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
</P
|
||||
><P
|
||||
>Thus, it's not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
</P
|
||||
><P
|
||||
>In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
</P
|
||||
><P
|
||||
>3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
</P
|
||||
><P
|
||||
>a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
</P
|
||||
><P
|
||||
>b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
</P
|
||||
><P
|
||||
>c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
</P
|
||||
><P
|
||||
>The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
</P
|
||||
><P
|
||||
>If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
</P
|
||||
><P
|
||||
>4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program 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.
|
||||
</P
|
||||
><P
|
||||
>5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
</P
|
||||
><P
|
||||
>6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
</P
|
||||
><P
|
||||
>7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
</P
|
||||
><P
|
||||
>If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
</P
|
||||
><P
|
||||
>It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it's up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
</P
|
||||
><P
|
||||
>This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
</P
|
||||
><P
|
||||
>8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
</P
|
||||
><P
|
||||
>9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public 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.
|
||||
</P
|
||||
><P
|
||||
>Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
</P
|
||||
><P
|
||||
>10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
</P
|
||||
><P
|
||||
>NO WARRANTY
|
||||
</P
|
||||
><P
|
||||
>11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
</P
|
||||
><P
|
||||
>12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
</P
|
||||
><P
|
||||
>END OF TERMS AND CONDITIONS
|
||||
</P
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="gpl-license.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="gpl-license-how-to-apply.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>GNU GENERAL PUBLIC LICENSE</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="gpl-license.html"
|
||||
>Up</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>How to Apply These Terms to Your New Programs</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
225
cole/doc/cole-manual/gpl-license.html
Normal file
225
cole/doc/cole-manual/gpl-license.html
Normal file
@@ -0,0 +1,225 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>GNU GENERAL PUBLIC LICENSE
|
||||
</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="Copyright and disclaimer"
|
||||
HREF="copyright-and-disclaimer.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
"
|
||||
HREF="gpl-license-terms.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="copyright-and-disclaimer.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="gpl-license-terms.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="CHAPTER"
|
||||
><H1
|
||||
><A
|
||||
NAME="GPL-LICENSE"
|
||||
>Chapter 6. GNU GENERAL PUBLIC LICENSE
|
||||
</A
|
||||
></H1
|
||||
><DIV
|
||||
CLASS="TOC"
|
||||
><DL
|
||||
><DT
|
||||
><B
|
||||
>Table of Contents</B
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="gpl-license.html#GPL-LICENSE-PREAMBLE"
|
||||
>Preamble</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="gpl-license-terms.html"
|
||||
>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="gpl-license-how-to-apply.html"
|
||||
>How to Apply These Terms to Your New Programs</A
|
||||
></DT
|
||||
></DL
|
||||
></DIV
|
||||
><P
|
||||
>Version 2, June 1991
|
||||
</P
|
||||
><P
|
||||
>Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
</P
|
||||
><P
|
||||
>Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it's not allowed.
|
||||
</P
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="GPL-LICENSE-PREAMBLE"
|
||||
>Preamble</A
|
||||
></H1
|
||||
><P
|
||||
>The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Library General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
</P
|
||||
><P
|
||||
>When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
</P
|
||||
><P
|
||||
>To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
</P
|
||||
><P
|
||||
>For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
</P
|
||||
><P
|
||||
>We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
</P
|
||||
><P
|
||||
>Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
</P
|
||||
><P
|
||||
>Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
</P
|
||||
><P
|
||||
>The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
</P
|
||||
></DIV
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="copyright-and-disclaimer.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="gpl-license-terms.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>Copyright and disclaimer</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
330
cole/doc/cole-manual/how-to-compile.html
Normal file
330
cole/doc/cole-manual/how-to-compile.html
Normal file
@@ -0,0 +1,330 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>How to compile cole</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="Requirements to compile"
|
||||
HREF="requirements-to-compile.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="cole Library"
|
||||
HREF="libcole.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="requirements-to-compile.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="libcole.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="CHAPTER"
|
||||
><H1
|
||||
><A
|
||||
NAME="HOW-TO-COMPILE"
|
||||
>Chapter 2. How to compile cole</A
|
||||
></H1
|
||||
><P
|
||||
> The file <TT
|
||||
CLASS="FILENAME"
|
||||
>INSTALL</TT
|
||||
> in the source code gives detailed instructions on how to configure, compile and install cole.</P
|
||||
><P
|
||||
> Briefly, you need to run the GNU standard <TT
|
||||
CLASS="FILENAME"
|
||||
>configure</TT
|
||||
> script, with the arguments you want. To see the arguments that <TT
|
||||
CLASS="FILENAME"
|
||||
>configure</TT
|
||||
> accepts, run <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>./configure --help</B
|
||||
></TT
|
||||
>. The most usual argument is <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>--prefix=PREFIX</B
|
||||
></TT
|
||||
>, which tells configure to install cole in the directory <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>PREFIX</B
|
||||
></TT
|
||||
>. After that, you need to run <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>make</B
|
||||
></TT
|
||||
> to compile cole, and <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>make install</B
|
||||
></TT
|
||||
> to install it.</P
|
||||
><P
|
||||
> The <TT
|
||||
CLASS="FILENAME"
|
||||
>configure</TT
|
||||
> script accepts, besides the standard arguments, the following flags:</P
|
||||
><P
|
||||
></P
|
||||
><TABLE
|
||||
BORDER="0"
|
||||
><TR
|
||||
><TD
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>--enable-osf-check</B
|
||||
></TT
|
||||
>. Turn on short align for OSF compiler. If you have errors while compiling under OSF1, enable this flag.
|
||||
</TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>--enable-verbose</B
|
||||
></TT
|
||||
>. Turn on verbose. It is useful if you want to send a bug report. It is useful for cole developers too.
|
||||
</TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>--enable-debug</B
|
||||
></TT
|
||||
> Turn on GNU CC debug flags. It is useful for cole developers, so may be you don't want to use it.
|
||||
</TD
|
||||
></TR
|
||||
></TABLE
|
||||
><P
|
||||
></P
|
||||
><P
|
||||
> A tipical session is shown below.</P
|
||||
><TABLE
|
||||
BORDER="0"
|
||||
BGCOLOR="#E0E0E0"
|
||||
WIDTH="100%"
|
||||
><TR
|
||||
><TD
|
||||
><PRE
|
||||
CLASS="SCREEN"
|
||||
><TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>ls</B
|
||||
></TT
|
||||
>
|
||||
cole-2.0.0.tar.gz
|
||||
<TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>gzip -d cole-2.0.0.tar.gz</B
|
||||
></TT
|
||||
>
|
||||
<TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>tar -xf cole-2.0.0.tar</B
|
||||
></TT
|
||||
>
|
||||
<TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>ls</B
|
||||
></TT
|
||||
>
|
||||
cole-2.0.0.tar cole-2.0.0/
|
||||
<TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>cd cole-2.0.0</B
|
||||
></TT
|
||||
>
|
||||
<TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>./configure --prefix=/opt</B
|
||||
></TT
|
||||
>
|
||||
...
|
||||
Configured cole release 2.0.0
|
||||
<TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>make</B
|
||||
></TT
|
||||
>
|
||||
...
|
||||
<TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>make install</B
|
||||
></TT
|
||||
>
|
||||
...
|
||||
<TT
|
||||
CLASS="PROMPT"
|
||||
>$</TT
|
||||
> <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>make clean</B
|
||||
></TT
|
||||
>
|
||||
...</PRE
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><P
|
||||
> When installing, a shell script named <TT
|
||||
CLASS="FILENAME"
|
||||
>cole-config</TT
|
||||
> will be installed in <TT
|
||||
CLASS="FILENAME"
|
||||
>PREFIX/bin</TT
|
||||
> if you used the the <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>--prefix=PREFIX</B
|
||||
></TT
|
||||
> argument, or in <TT
|
||||
CLASS="FILENAME"
|
||||
>/usr/local/bin</TT
|
||||
> if you didn't. That directory must be listed in the content of the enviroment variable PATH when configuring another program that uses cole.</P
|
||||
><P
|
||||
> If you system support it, will be compiled and installed shared libraries, to minimize size of the executables. By this reason, is important to include the directory <TT
|
||||
CLASS="FILENAME"
|
||||
>PREFIX/bin</TT
|
||||
> or <TT
|
||||
CLASS="FILENAME"
|
||||
>/usr/local/bin</TT
|
||||
> (which appropiate) in the file that your system command <TT
|
||||
CLASS="FILENAME"
|
||||
>ldconfig</TT
|
||||
> reads in order to regenerate the list of shared libraries (in some systems, you can list the directory in the content of the enviroment variable LD_LIBRARY_PATH instead).</P
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="requirements-to-compile.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="libcole.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>Requirements to compile</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>cole Library</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
193
cole/doc/cole-manual/index.html
Normal file
193
cole/doc/cole-manual/index.html
Normal file
@@ -0,0 +1,193 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>cole Library Reference Manual</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="Introduction"
|
||||
HREF="introduction.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="BOOK"
|
||||
><A
|
||||
NAME="INDEX"
|
||||
></A
|
||||
><DIV
|
||||
CLASS="TITLEPAGE"
|
||||
><H1
|
||||
CLASS="TITLE"
|
||||
><A
|
||||
NAME="AEN2"
|
||||
>cole Library Reference Manual</A
|
||||
></H1
|
||||
><P
|
||||
CLASS="COPYRIGHT"
|
||||
>Copyright © 1998, 1999 by <SPAN
|
||||
CLASS="HOLDER"
|
||||
>Roberto Arturo Tena S<>nchez</SPAN
|
||||
></P
|
||||
><HR></DIV
|
||||
><DIV
|
||||
CLASS="TOC"
|
||||
><DL
|
||||
><DT
|
||||
><B
|
||||
>Table of Contents</B
|
||||
></DT
|
||||
><DT
|
||||
>1. <A
|
||||
HREF="introduction.html"
|
||||
>Introduction</A
|
||||
></DT
|
||||
><DD
|
||||
><DL
|
||||
><DT
|
||||
><A
|
||||
HREF="introduction.html#WHAT-IS-COLE"
|
||||
>What is cole?</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="features.html"
|
||||
>Features</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="requirements-to-compile.html"
|
||||
>Requirements to compile</A
|
||||
></DT
|
||||
></DL
|
||||
></DD
|
||||
><DT
|
||||
>2. <A
|
||||
HREF="how-to-compile.html"
|
||||
>How to compile cole</A
|
||||
></DT
|
||||
><DT
|
||||
>3. <A
|
||||
HREF="libcole.html"
|
||||
>cole Library</A
|
||||
></DT
|
||||
><DD
|
||||
><DL
|
||||
><DT
|
||||
><A
|
||||
HREF="cole-api.html"
|
||||
>API</A
|
||||
> — Public cole API for the present release.</DT
|
||||
><DT
|
||||
><A
|
||||
HREF="cole-internals.html"
|
||||
>Internals</A
|
||||
> — cole internals - don't trust in anything here, because it may (and will) change.</DT
|
||||
></DL
|
||||
></DD
|
||||
><DT
|
||||
>4. <A
|
||||
HREF="bugs.html"
|
||||
>Bugs</A
|
||||
></DT
|
||||
><DT
|
||||
>5. <A
|
||||
HREF="legal-issues.html"
|
||||
>Legal issues</A
|
||||
></DT
|
||||
><DD
|
||||
><DL
|
||||
><DT
|
||||
><A
|
||||
HREF="legal-issues.html#DISTRIBUTION-AND-FREEDOM"
|
||||
>Distribution and Freedom</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="trademarks.html"
|
||||
>Trademarks</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="copyright-and-disclaimer.html"
|
||||
>Copyright and disclaimer</A
|
||||
></DT
|
||||
></DL
|
||||
></DD
|
||||
><DT
|
||||
>6. <A
|
||||
HREF="gpl-license.html"
|
||||
>GNU GENERAL PUBLIC LICENSE</A
|
||||
></DT
|
||||
><DD
|
||||
><DL
|
||||
><DT
|
||||
><A
|
||||
HREF="gpl-license.html#GPL-LICENSE-PREAMBLE"
|
||||
>Preamble</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="gpl-license-terms.html"
|
||||
>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="gpl-license-how-to-apply.html"
|
||||
>How to Apply These Terms to Your New Programs</A
|
||||
></DT
|
||||
></DL
|
||||
></DD
|
||||
></DL
|
||||
></DIV
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="introduction.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>Introduction</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
189
cole/doc/cole-manual/introduction.html
Normal file
189
cole/doc/cole-manual/introduction.html
Normal file
@@ -0,0 +1,189 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>Introduction</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="Features"
|
||||
HREF="features.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="features.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="CHAPTER"
|
||||
><H1
|
||||
><A
|
||||
NAME="INTRODUCTION"
|
||||
>Chapter 1. Introduction</A
|
||||
></H1
|
||||
><DIV
|
||||
CLASS="TOC"
|
||||
><DL
|
||||
><DT
|
||||
><B
|
||||
>Table of Contents</B
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="introduction.html#WHAT-IS-COLE"
|
||||
>What is cole?</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="features.html"
|
||||
>Features</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="requirements-to-compile.html"
|
||||
>Requirements to compile</A
|
||||
></DT
|
||||
></DL
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="WHAT-IS-COLE"
|
||||
>What is cole?</A
|
||||
></H1
|
||||
><P
|
||||
> cole is a free C OLE library.</P
|
||||
><P
|
||||
> cole is <A
|
||||
HREF="legal-issues.html#DISTRIBUTION-AND-FREEDOM"
|
||||
>distributed</A
|
||||
> under the terms of the <A
|
||||
HREF="gpl-license.html"
|
||||
>GNU General Public License</A
|
||||
> (GPL) to give an impulse to the Free Software. cole distribution license is compatible with the <A
|
||||
HREF="http://www.opensource.org/"
|
||||
TARGET="_top"
|
||||
>Open Source</A
|
||||
> definition.</P
|
||||
><P
|
||||
> Using cole, you can access Microsoft' Structured Storage files. The most popular Microsoft's programs generate Structured Storage files, incluiding the Microsoft' suite for offices. StarDivision' suite (StarOffice) generate Structured Storage files too. FlashPix file format is Structured Storage too.</P
|
||||
><P
|
||||
> What is a Structured Storage file? Inside a Structured Storage file there is a filesystem, with directories and files, which Microsoft calls containers and streams. Using cole you can travel through such filesystem and access the files.</P
|
||||
><P
|
||||
> cole doesn't know about internal structure of a stream, it only reads the raw data. You can use the Microsoft's documentation available at <A
|
||||
HREF="http://msdn.microsoft.com/"
|
||||
TARGET="_top"
|
||||
>http://msdn.microsoft.com</A
|
||||
> or the information available at <A
|
||||
HREF="http://www.wotsit.org/"
|
||||
TARGET="_top"
|
||||
>http://www.wotsit.org</A
|
||||
> to know the binary file format of the streams. If you know anything in the side of StarDivision email me. FlashPix file format is well documented.</P
|
||||
><P
|
||||
> cole was developed using the information available at <A
|
||||
HREF="http://wwwwbs.cs.tu-berlin.de/~schwartz/pmh/guide.html"
|
||||
TARGET="_top"
|
||||
>http://wwwwbs.cs.tu-berlin.de/~schwartz/pmh/guide.html</A
|
||||
> and the OLE::Storage Perl module from the same site, and no information from any other source (incluiding Microsoft) has been used.</P
|
||||
></DIV
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="features.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>cole Library Reference Manual</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>Features</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
184
cole/doc/cole-manual/legal-issues.html
Normal file
184
cole/doc/cole-manual/legal-issues.html
Normal file
@@ -0,0 +1,184 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>Legal issues</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="Bugs"
|
||||
HREF="bugs.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="Trademarks"
|
||||
HREF="trademarks.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="bugs.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="trademarks.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="CHAPTER"
|
||||
><H1
|
||||
><A
|
||||
NAME="LEGAL-ISSUES"
|
||||
>Chapter 5. Legal issues</A
|
||||
></H1
|
||||
><DIV
|
||||
CLASS="TOC"
|
||||
><DL
|
||||
><DT
|
||||
><B
|
||||
>Table of Contents</B
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="legal-issues.html#DISTRIBUTION-AND-FREEDOM"
|
||||
>Distribution and Freedom</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="trademarks.html"
|
||||
>Trademarks</A
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="copyright-and-disclaimer.html"
|
||||
>Copyright and disclaimer</A
|
||||
></DT
|
||||
></DL
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="DISTRIBUTION-AND-FREEDOM"
|
||||
>Distribution and Freedom</A
|
||||
></H1
|
||||
><P
|
||||
> cole is Free Software, which means is distributed under a license that protect your freedom. cole distribution license is compatible with the <A
|
||||
HREF="http://www.opensource.org/"
|
||||
TARGET="_top"
|
||||
>Open Source</A
|
||||
> definition.</P
|
||||
><P
|
||||
> cole is distributed under the terms of the <A
|
||||
HREF="gpl-license.html"
|
||||
>GNU General Public License</A
|
||||
> (GPL). A copy of the license is in the file <TT
|
||||
CLASS="FILENAME"
|
||||
>COPYING</TT
|
||||
> in the source code and in this document. Particulary, this means at least two things:</P
|
||||
><P
|
||||
></P
|
||||
><OL
|
||||
TYPE="1"
|
||||
><LI
|
||||
><P
|
||||
> All the code statically or dinamically linked against cole must be distributed under the terms of a license compatible with GPL.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> If you change the cole source code and you want to distribute a compiled version, you must release the changed cole source code too.
|
||||
</P
|
||||
></LI
|
||||
></OL
|
||||
></DIV
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="bugs.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="trademarks.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>Bugs</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>Trademarks</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
273
cole/doc/cole-manual/libcole.html
Normal file
273
cole/doc/cole-manual/libcole.html
Normal file
@@ -0,0 +1,273 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>cole Library</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="How to compile cole"
|
||||
HREF="how-to-compile.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="API"
|
||||
HREF="cole-api.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="how-to-compile.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="cole-api.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="CHAPTER"
|
||||
><H1
|
||||
><A
|
||||
NAME="LIBCOLE"
|
||||
>Chapter 3. cole Library</A
|
||||
></H1
|
||||
><DIV
|
||||
CLASS="TOC"
|
||||
><DL
|
||||
><DT
|
||||
><B
|
||||
>Table of Contents</B
|
||||
></DT
|
||||
><DT
|
||||
><A
|
||||
HREF="cole-api.html"
|
||||
>API</A
|
||||
> — Public cole API for the present release.</DT
|
||||
><DT
|
||||
><A
|
||||
HREF="cole-internals.html"
|
||||
>Internals</A
|
||||
> — cole internals - don't trust in anything here, because it may (and will) change.</DT
|
||||
></DL
|
||||
></DIV
|
||||
><P
|
||||
> This is the documentation autogenerated from the source code. It have the cole <A
|
||||
HREF="cole-api.html"
|
||||
>API</A
|
||||
> for this release, and some internal structures and internal calls.
|
||||
</P
|
||||
><P
|
||||
> Note: what Microsoft calls <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>stream</B
|
||||
></TT
|
||||
> is called <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>file</B
|
||||
></TT
|
||||
> in this project, <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>storage</B
|
||||
></TT
|
||||
> is called <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>directory</B
|
||||
></TT
|
||||
> and <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>docfile</B
|
||||
></TT
|
||||
> (a Structured Storage file) is called <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>filesystem</B
|
||||
></TT
|
||||
>.
|
||||
</P
|
||||
><P
|
||||
> The files in the subdirectory <TT
|
||||
CLASS="FILENAME"
|
||||
>examples</TT
|
||||
> in the source code show the complete public <A
|
||||
HREF="cole-api.html"
|
||||
>API</A
|
||||
> in action. Briefly, if you know how to use the <TT
|
||||
CLASS="FILENAME"
|
||||
>stdio.h</TT
|
||||
> ANSI C calls, cole API will be very easy for you.</P
|
||||
><P
|
||||
> If you use <TT
|
||||
CLASS="FILENAME"
|
||||
>autoconf</TT
|
||||
> in your own proyect, the included file <TT
|
||||
CLASS="FILENAME"
|
||||
>cole.m4</TT
|
||||
> may be useful for you. It contains the m4 macro AM_PATH_COLE that detect the presense or ausence of the cole library in the system being configured. To use it:</P
|
||||
><P
|
||||
></P
|
||||
><OL
|
||||
TYPE="1"
|
||||
><LI
|
||||
><P
|
||||
> If cole is not installed in your system (i.e. <TT
|
||||
CLASS="FILENAME"
|
||||
>aclocal</TT
|
||||
> can't find <TT
|
||||
CLASS="FILENAME"
|
||||
>cole.m4</TT
|
||||
>), add the content of <TT
|
||||
CLASS="FILENAME"
|
||||
>cole.m4</TT
|
||||
> to your own <TT
|
||||
CLASS="FILENAME"
|
||||
>acinclude.m4</TT
|
||||
> file (create it in case you haven't one).
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Add a line like <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>AM_PATH_COLE(2.0.0, [LIBS="$LIBS $COLE_LIBS" CFLAGS="$CFLAGS $COLE_CFLAGS"])</B
|
||||
></TT
|
||||
> to your <TT
|
||||
CLASS="FILENAME"
|
||||
>configure.in</TT
|
||||
> file. Here we are requesting for cole release 2.0.0, and adding the necessary flags to LIBS and CFLAGS.
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Run <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>aclocal</B
|
||||
></TT
|
||||
> to generate the file <TT
|
||||
CLASS="FILENAME"
|
||||
>aclocal.m4</TT
|
||||
>. This file will have many m4 macros, incluiding the cole m4 macro, and
|
||||
</P
|
||||
></LI
|
||||
><LI
|
||||
><P
|
||||
> Run <TT
|
||||
CLASS="USERINPUT"
|
||||
><B
|
||||
>autoconf</B
|
||||
></TT
|
||||
> to generate the script <TT
|
||||
CLASS="FILENAME"
|
||||
>configure</TT
|
||||
>.
|
||||
</P
|
||||
></LI
|
||||
></OL
|
||||
><P
|
||||
> Many <A
|
||||
HREF="cole-api.html"
|
||||
>API</A
|
||||
> calls take an argument at the end called <A
|
||||
HREF="cole-api.html#COLERRNO"
|
||||
><TT
|
||||
CLASS="PARAMETER"
|
||||
><I
|
||||
>colerrno</I
|
||||
></TT
|
||||
></A
|
||||
>. If it's not NULL and the call failed, it store the error code for fail, if any (if the call was successfully ended, its value is not modified).</P
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="how-to-compile.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="cole-api.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>How to compile cole</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
> </TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>API</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
137
cole/doc/cole-manual/requirements-to-compile.html
Normal file
137
cole/doc/cole-manual/requirements-to-compile.html
Normal file
@@ -0,0 +1,137 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>Requirements to compile</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="UP"
|
||||
TITLE="Introduction"
|
||||
HREF="introduction.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="Features"
|
||||
HREF="features.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="How to compile cole"
|
||||
HREF="how-to-compile.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="features.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
>Chapter 1. Introduction</TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="how-to-compile.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="REQUIREMENTS-TO-COMPILE"
|
||||
>Requirements to compile</A
|
||||
></H1
|
||||
><P
|
||||
> To have a system with ANSI C libraries, a ANSI C compiler, a <TT
|
||||
CLASS="FILENAME"
|
||||
>make</TT
|
||||
> program and the shell <TT
|
||||
CLASS="FILENAME"
|
||||
>/bin/sh</TT
|
||||
>.</P
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="features.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="how-to-compile.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>Features</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="introduction.html"
|
||||
>Up</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>How to compile cole</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
BIN
cole/doc/cole-manual/stylesheet-images/caution.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/caution.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 KiB |
BIN
cole/doc/cole-manual/stylesheet-images/home.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/home.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 995 B |
BIN
cole/doc/cole-manual/stylesheet-images/important.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/important.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
BIN
cole/doc/cole-manual/stylesheet-images/next.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/next.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 964 B |
BIN
cole/doc/cole-manual/stylesheet-images/note.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/note.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 KiB |
BIN
cole/doc/cole-manual/stylesheet-images/prev.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/prev.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 944 B |
BIN
cole/doc/cole-manual/stylesheet-images/tip.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/tip.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 KiB |
BIN
cole/doc/cole-manual/stylesheet-images/toc-blank.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/toc-blank.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 95 B |
BIN
cole/doc/cole-manual/stylesheet-images/toc-minus.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/toc-minus.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 843 B |
BIN
cole/doc/cole-manual/stylesheet-images/toc-plus.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/toc-plus.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 846 B |
BIN
cole/doc/cole-manual/stylesheet-images/up.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/up.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 922 B |
BIN
cole/doc/cole-manual/stylesheet-images/warning.gif
Executable file
BIN
cole/doc/cole-manual/stylesheet-images/warning.gif
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 KiB |
147
cole/doc/cole-manual/trademarks.html
Normal file
147
cole/doc/cole-manual/trademarks.html
Normal file
@@ -0,0 +1,147 @@
|
||||
<HTML
|
||||
><HEAD
|
||||
><TITLE
|
||||
>Trademarks</TITLE
|
||||
><META
|
||||
NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.41"><LINK
|
||||
REL="HOME"
|
||||
TITLE="cole Library Reference Manual"
|
||||
HREF="index.html"><LINK
|
||||
REL="UP"
|
||||
TITLE="Legal issues"
|
||||
HREF="legal-issues.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE="Legal issues"
|
||||
HREF="legal-issues.html"><LINK
|
||||
REL="NEXT"
|
||||
TITLE="Copyright and disclaimer"
|
||||
HREF="copyright-and-disclaimer.html"></HEAD
|
||||
><BODY
|
||||
><DIV
|
||||
CLASS="NAVHEADER"
|
||||
><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>cole Library Reference Manual</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="left"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="legal-issues.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="80%"
|
||||
ALIGN="center"
|
||||
VALIGN="bottom"
|
||||
>Chapter 5. Legal issues</TD
|
||||
><TD
|
||||
WIDTH="10%"
|
||||
ALIGN="right"
|
||||
VALIGN="bottom"
|
||||
><A
|
||||
HREF="copyright-and-disclaimer.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
></TABLE
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"></DIV
|
||||
><DIV
|
||||
CLASS="SECT1"
|
||||
><H1
|
||||
CLASS="SECT1"
|
||||
><A
|
||||
NAME="TRADEMARKS"
|
||||
>Trademarks</A
|
||||
></H1
|
||||
><P
|
||||
> "Microsoft Word", "Microsoft Excel", "Microsoft Publisher" and "Microsoft Power Point" are trademarks of Microsoft Corporation.</P
|
||||
><P
|
||||
>"StarOffice" may be is a trademark of StarDivision.</P
|
||||
><P
|
||||
>"FlashPix" may be is a trademark.</P
|
||||
><P
|
||||
>"UNIX" is a trademark.</P
|
||||
><P
|
||||
> "Free Software" is not trademark of anyone, but it's an important term in the Free Software community, and for the Free Software Foundation.</P
|
||||
><P
|
||||
> All other trademarks are the property of their respective owners.</P
|
||||
><P
|
||||
> If another trademark is mentioned in this document and it needs to be listed above, please email to the maintainer (<A
|
||||
HREF="mailto:arturo@directmail.org"
|
||||
TARGET="_top"
|
||||
><arturo@directmail.org></A
|
||||
>).</P
|
||||
></DIV
|
||||
><DIV
|
||||
CLASS="NAVFOOTER"
|
||||
><HR
|
||||
ALIGN="LEFT"
|
||||
WIDTH="100%"><TABLE
|
||||
WIDTH="100%"
|
||||
BORDER="0"
|
||||
CELLPADDING="0"
|
||||
CELLSPACING="0"
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="legal-issues.html"
|
||||
>Prev</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="index.html"
|
||||
>Home</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="copyright-and-disclaimer.html"
|
||||
>Next</A
|
||||
></TD
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="left"
|
||||
VALIGN="top"
|
||||
>Legal issues</TD
|
||||
><TD
|
||||
WIDTH="34%"
|
||||
ALIGN="center"
|
||||
VALIGN="top"
|
||||
><A
|
||||
HREF="legal-issues.html"
|
||||
>Up</A
|
||||
></TD
|
||||
><TD
|
||||
WIDTH="33%"
|
||||
ALIGN="right"
|
||||
VALIGN="top"
|
||||
>Copyright and disclaimer</TD
|
||||
></TR
|
||||
></TABLE
|
||||
></DIV
|
||||
></BODY
|
||||
></HTML
|
||||
>
|
||||
93
cole/doc/cole-sections.txt
Normal file
93
cole/doc/cole-sections.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
<SECTION>
|
||||
<FILE>internals</FILE>
|
||||
<TITLE>Internals</TITLE>
|
||||
COLEFS
|
||||
COLEDIRENT
|
||||
COLEDIR
|
||||
COLEFILE
|
||||
F32
|
||||
F64
|
||||
U8
|
||||
U16
|
||||
U32
|
||||
fil_sreadU16
|
||||
fil_sreadU32
|
||||
fil_sreadF64
|
||||
fil_swriteU16
|
||||
fil_swriteU32
|
||||
verbose_return
|
||||
test
|
||||
test_exitf
|
||||
test_call
|
||||
test_call_exitf
|
||||
report_bug
|
||||
assert_return
|
||||
verbose_d
|
||||
verbose
|
||||
verbose_wonl
|
||||
verboseU8
|
||||
verboseU16
|
||||
verboseU32
|
||||
verboseS
|
||||
verboseS_wonl
|
||||
warning
|
||||
verboseU32Array
|
||||
verboseU8Array_force
|
||||
verboseU8Array
|
||||
</SECTION>
|
||||
|
||||
|
||||
<INCLUDE>cole/cole.h</INCLUDE>
|
||||
|
||||
<SECTION>
|
||||
<FILE>api</FILE>
|
||||
<TITLE>API</TITLE>
|
||||
COLE_MAJOR_VERSION
|
||||
COLE_MINOR_VERSION
|
||||
COLE_MICRO_VERSION
|
||||
cole_major_version
|
||||
cole_minor_version
|
||||
cole_micro_version
|
||||
cole_version
|
||||
cole_host_info
|
||||
COLERRNO
|
||||
cole_perror
|
||||
COLEFS
|
||||
COLEDIR
|
||||
COLEDIRENT
|
||||
COLEFILE
|
||||
cole_mount
|
||||
cole_umount
|
||||
cole_print_tree
|
||||
cole_locate_filename
|
||||
cole_recurse_tree
|
||||
cole_fopen
|
||||
cole_fopen_direntry
|
||||
cole_fclose
|
||||
cole_fread
|
||||
cole_feof
|
||||
cole_fsize
|
||||
cole_ftell
|
||||
cole_fseek
|
||||
cole_frewind
|
||||
cole_opendir_rootdir
|
||||
cole_opendir_direntry
|
||||
cole_closedir
|
||||
cole_visiteddirentry
|
||||
cole_nextdirentry
|
||||
cole_direntry_isdir
|
||||
cole_direntry_isfile
|
||||
cole_dir_getname
|
||||
cole_dir_getsize
|
||||
cole_dir_getsec1
|
||||
cole_dir_getsec2
|
||||
cole_dir_getdays1
|
||||
cole_dir_getdays2
|
||||
cole_direntry_getname
|
||||
cole_direntry_getsize
|
||||
cole_direntry_getdays1
|
||||
cole_direntry_getsec1
|
||||
cole_direntry_getdays2
|
||||
cole_direntry_getsec2
|
||||
</SECTION>
|
||||
|
||||
48
cole/doc/compile.sgml
Normal file
48
cole/doc/compile.sgml
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
<para>
|
||||
The file <filename>INSTALL</filename> in the source code gives detailed instructions on how to configure, compile and install cole.
|
||||
</para>
|
||||
<para>
|
||||
Briefly, you need to run the GNU standard <filename>configure</filename> script, with the arguments you want. To see the arguments that <filename>configure</filename> accepts, run <userinput>./configure --help</userinput>. The most usual argument is <userinput>--prefix=PREFIX</userinput>, which tells configure to install cole in the directory <userinput>PREFIX</userinput>. After that, you need to run <userinput>make</userinput> to compile cole, and <userinput>make install</userinput> to install it.
|
||||
</para>
|
||||
<para>
|
||||
The <filename>configure</filename> script accepts, besides the standard arguments, the following flags:
|
||||
</para>
|
||||
<simplelist>
|
||||
<member>
|
||||
<userinput>--enable-osf-check</userinput>. Turn on short align for OSF compiler. If you have errors while compiling under OSF1, enable this flag.
|
||||
</member>
|
||||
<member>
|
||||
<userinput>--enable-verbose</userinput>. Turn on verbose. It is useful if you want to send a bug report. It is useful for cole developers too.
|
||||
</member>
|
||||
<member>
|
||||
<userinput>--enable-debug</userinput> Turn on GNU CC debug flags. It is useful for cole developers, so may be you don't want to use it.
|
||||
</member>
|
||||
</simplelist>
|
||||
<para>
|
||||
A tipical session is shown below.
|
||||
</para>
|
||||
<screen>
|
||||
<prompt>$</prompt> <userinput>ls</userinput>
|
||||
cole-2.0.0.tar.gz
|
||||
<prompt>$</prompt> <userinput>gzip -d cole-2.0.0.tar.gz</userinput>
|
||||
<prompt>$</prompt> <userinput>tar -xf cole-2.0.0.tar</userinput>
|
||||
<prompt>$</prompt> <userinput>ls</userinput>
|
||||
cole-2.0.0.tar cole-2.0.0/
|
||||
<prompt>$</prompt> <userinput>cd cole-2.0.0</userinput>
|
||||
<prompt>$</prompt> <userinput>./configure --prefix=/opt</userinput>
|
||||
...
|
||||
Configured cole release 2.0.0
|
||||
<prompt>$</prompt> <userinput>make</userinput>
|
||||
...
|
||||
<prompt>$</prompt> <userinput>make install</userinput>
|
||||
...
|
||||
<prompt>$</prompt> <userinput>make clean</userinput>
|
||||
...</screen>
|
||||
<para>
|
||||
When installing, a shell script named <filename>cole-config</filename> will be installed in <filename>PREFIX/bin</filename> if you used the the <userinput>--prefix=PREFIX</userinput> argument, or in <filename>/usr/local/bin</filename> if you didn't. That directory must be listed in the content of the enviroment variable PATH when configuring another program that uses cole.
|
||||
</para>
|
||||
<para>
|
||||
If you system support it, will be compiled and installed shared libraries, to minimize size of the executables. By this reason, is important to include the directory <filename>PREFIX/bin</filename> or <filename>/usr/local/bin</filename> (which appropiate) in the file that your system command <filename>ldconfig</filename> reads in order to regenerate the list of shared libraries (in some systems, you can list the directory in the content of the enviroment variable LD_LIBRARY_PATH instead).
|
||||
</para>
|
||||
|
||||
412
cole/doc/gpl.sgml
Normal file
412
cole/doc/gpl.sgml
Normal file
@@ -0,0 +1,412 @@
|
||||
|
||||
<chapter id="gpl-license">
|
||||
<title>
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
</title>
|
||||
<para>
|
||||
Version 2, June 1991
|
||||
</para>
|
||||
<para>
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
</para>
|
||||
<para>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it's not allowed.
|
||||
</para>
|
||||
|
||||
|
||||
<sect1 id="gpl-license-preamble">
|
||||
<title>
|
||||
Preamble
|
||||
</title>
|
||||
<para>
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Library General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
</para>
|
||||
<para>
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
</para>
|
||||
<para>
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
</para>
|
||||
<para>
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
</para>
|
||||
<para>
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
</para>
|
||||
<para>
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
</para>
|
||||
<para>
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
</para>
|
||||
<para>
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
</para>
|
||||
</sect1> <!-- gpl-preamble -->
|
||||
|
||||
|
||||
<sect1 id="gpl-license-terms">
|
||||
<title>
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
</title>
|
||||
<para>
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
</para>
|
||||
<para>
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
</para>
|
||||
<para>
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
</para>
|
||||
<para>
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
</para>
|
||||
<para>
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
</para>
|
||||
<para>
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
</para>
|
||||
<para>
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
</para>
|
||||
<para>
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
</para>
|
||||
<para>
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
</para>
|
||||
<para>
|
||||
Thus, it's not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
</para>
|
||||
<para>
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
</para>
|
||||
<para>
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
</para>
|
||||
<para>
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
</para>
|
||||
<para>
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
</para>
|
||||
<para>
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
</para>
|
||||
<para>
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
</para>
|
||||
<para>
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
</para>
|
||||
<para>
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program 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.
|
||||
</para>
|
||||
<para>
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
</para>
|
||||
<para>
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
</para>
|
||||
<para>
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
</para>
|
||||
<para>
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
</para>
|
||||
<para>
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it's up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
</para>
|
||||
<para>
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
</para>
|
||||
<para>
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
</para>
|
||||
<para>
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public 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.
|
||||
</para>
|
||||
<para>
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
</para>
|
||||
<para>
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
</para>
|
||||
<para>
|
||||
NO WARRANTY
|
||||
</para>
|
||||
<para>
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
</para>
|
||||
<para>
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
</para>
|
||||
<para>
|
||||
END OF TERMS AND CONDITIONS
|
||||
</para>
|
||||
</sect1> <!-- gpl-terms -->
|
||||
|
||||
|
||||
<sect1 id="gpl-license-how-to-apply">
|
||||
<title>
|
||||
How to Apply These Terms to Your New Programs
|
||||
</title>
|
||||
<para>
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
</para>
|
||||
<para>
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
</para>
|
||||
<screen>
|
||||
<emphasis>one line to give the program's name and a brief idea of what it does.</emphasis>
|
||||
Copyright (C) <emphasis>year</emphasis> <emphasis>name of author</emphasis>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</screen>
|
||||
<para>
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
</para>
|
||||
<para>
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
</para>
|
||||
<screen>
|
||||
Gnomovision version 69, Copyright (C) <emphasis>year</emphasis> <emphasis>name of author</emphasis>
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
|
||||
type `show w'. This is free software, and you are welcome
|
||||
to redistribute it under certain conditions; type `show c'
|
||||
for details.</screen>
|
||||
<para>
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
</para>
|
||||
<para>
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
</para>
|
||||
<screen>
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<emphasis>signature of Ty Coon</emphasis>, 1 April 1989
|
||||
Ty Coon, President of Vice</screen>
|
||||
<para>
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Library General
|
||||
Public License instead of this License.
|
||||
</para>
|
||||
</sect1> <!-- gpl-how-to-apply -->
|
||||
</chapter> <!-- gpl -->
|
||||
|
||||
89
cole/doc/introduction.sgml
Normal file
89
cole/doc/introduction.sgml
Normal file
@@ -0,0 +1,89 @@
|
||||
|
||||
|
||||
<sect1 id="what-is-cole">
|
||||
<title>What is cole?</title>
|
||||
<!-- NOTE: this section must have the same content of the `README' file -->
|
||||
<para>
|
||||
cole is a free C OLE library.
|
||||
</para>
|
||||
<para>
|
||||
cole is <link linkend="distribution-and-freedom">distributed</link> under the terms of the <link linkend="gpl-license">GNU General Public License</link> (GPL) to give an impulse to the Free Software. cole distribution license is compatible with the <ulink URL="http://www.opensource.org/">Open Source</ulink> definition.
|
||||
</para>
|
||||
<para>
|
||||
Using cole, you can access Microsoft' Structured Storage files. The most popular Microsoft's programs generate Structured Storage files, incluiding the Microsoft' suite for offices. StarDivision' suite (StarOffice) generate Structured Storage files too. FlashPix file format is Structured Storage too.
|
||||
</para>
|
||||
<para>
|
||||
What is a Structured Storage file? Inside a Structured Storage file there is a filesystem, with directories and files, which Microsoft calls containers and streams. Using cole you can travel through such filesystem and access the files.
|
||||
</para>
|
||||
<para>
|
||||
cole doesn't know about internal structure of a stream, it only reads the raw data. You can use the Microsoft's documentation available at <ulink URL="http://msdn.microsoft.com/">http://msdn.microsoft.com</ulink> or the information available at <ulink URL="http://www.wotsit.org/">http://www.wotsit.org</ulink> to know the binary file format of the streams. If you know anything in the side of StarDivision email me. FlashPix file format is well documented.
|
||||
</para>
|
||||
<para>
|
||||
cole was developed using the information available at <ulink URL="http://wwwwbs.cs.tu-berlin.de/~schwartz/pmh/guide.html">http://wwwwbs.cs.tu-berlin.de/~schwartz/pmh/guide.html</ulink> and the OLE::Storage Perl module from the same site, and no information from any other source (incluiding Microsoft) has been used.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1 id="features">
|
||||
<title>Features</title>
|
||||
<para>
|
||||
cole 2.x release series:
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Can open Structured Storage files generated with programs from Microsoft, StarDivision and FlashPix.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Is written in C, for better performance.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Should compile in UNIX-like systems with ANSI C libraries and a ANSI C compiler.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Has a new good-looking API, modelled after ANSI C <filename>stdio.h</filename> routines.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Uses standard automake, autoconf and libtool generated files.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Provides a standard <filename>configure</filename> script.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Builds shared (dynamic) libraries if the plattform and libtool support it.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Provides standard targets in the Makefile (ie. <userinput>install</userinput>, <userinput>clean</userinput>, etc).
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Can use (thanks to the <filename>configure</filename> script) plattform dependent system calls for better performance.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1 id="requirements-to-compile">
|
||||
<title>Requirements to compile</title>
|
||||
<para>
|
||||
To have a system with ANSI C libraries, a ANSI C compiler, a <filename>make</filename> program and the shell <filename>/bin/sh</filename>.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
60
cole/doc/legal.sgml
Normal file
60
cole/doc/legal.sgml
Normal file
@@ -0,0 +1,60 @@
|
||||
|
||||
<sect1 id="distribution-and-freedom">
|
||||
<title>Distribution and Freedom</title>
|
||||
<para>
|
||||
cole is Free Software, which means is distributed under a license that protect your freedom. cole distribution license is compatible with the <ulink URL="http://www.opensource.org/">Open Source</ulink> definition.
|
||||
</para>
|
||||
<para>
|
||||
cole is distributed under the terms of the <link linkend="gpl-license">GNU General Public License</link> (GPL). A copy of the license is in the file <filename>COPYING</filename> in the source code and in this document. Particulary, this means at least two things:
|
||||
</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
All the code statically or dinamically linked against cole must be distributed under the terms of a license compatible with GPL.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If you change the cole source code and you want to distribute a compiled version, you must release the changed cole source code too.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1 id="trademarks">
|
||||
<title>Trademarks</title>
|
||||
<para>
|
||||
"Microsoft Word", "Microsoft Excel", "Microsoft Publisher" and "Microsoft Power Point" are trademarks of Microsoft Corporation.
|
||||
</para>
|
||||
<para>
|
||||
"StarOffice" may be is a trademark of StarDivision.
|
||||
</para>
|
||||
<para>
|
||||
"FlashPix" may be is a trademark.
|
||||
</para>
|
||||
<para>
|
||||
"UNIX" is a trademark.
|
||||
</para>
|
||||
<para>
|
||||
"Free Software" is not trademark of anyone, but it's an important term in the Free Software community, and for the Free Software Foundation.
|
||||
</para>
|
||||
<para>
|
||||
All other trademarks are the property of their respective owners.
|
||||
</para>
|
||||
<para>
|
||||
If another trademark is mentioned in this document and it needs to be listed above, please email to the maintainer (&maintainer-email-ulink;).
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1 id="copyright-and-disclaimer">
|
||||
<title>Copyright and disclaimer</title>
|
||||
<para>
|
||||
This document is copyright 1999 by &author-name-full;. This document is free software; you can redistribute it and/or modify it under the terms of the <link linkend="gpl-license">GNU General Public License</link> as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
|
||||
</para>
|
||||
<para>
|
||||
This document is provided as is without any express or implied warranties. While every effort has been taken to ensure the accuracy of the information contained in this document, the author/maintainer/contributors assume(s) no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
1
cole/doc/tmpl/.cvsignore
Normal file
1
cole/doc/tmpl/.cvsignore
Normal file
@@ -0,0 +1 @@
|
||||
*.bak
|
||||
434
cole/doc/tmpl/api.sgml
Normal file
434
cole/doc/tmpl/api.sgml
Normal file
@@ -0,0 +1,434 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
API
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Public cole API for the present release.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Note: The separator character for filename components is '/'. So, a filename argument can be something like "/Macros/VB/Project1".
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO COLE_MAJOR_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO COLE_MINOR_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO COLE_MICRO_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_major_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_minor_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_micro_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_host_info ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM COLERRNO ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_perror ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@s:
|
||||
@colerrno:
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEFS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEDIR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEDIRENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEFILE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_mount ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filename:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_umount ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_print_tree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_locate_filename ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@filename:
|
||||
@info:
|
||||
@action:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_recurse_tree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@info:
|
||||
@inroot:
|
||||
@indirentry:
|
||||
@indir:
|
||||
@outdir:
|
||||
@visitdir:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fopen ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@filename:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fopen_direntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@colefilesystem:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fclose ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fread ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@ptr:
|
||||
@size:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_feof ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fsize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_ftell ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fseek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@delta:
|
||||
@direction:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_frewind ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_opendir_rootdir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_opendir_direntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_closedir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_visiteddirentry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_nextdirentry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_isdir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_isfile ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getname ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getsize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getsec1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getsec2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getdays1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getdays2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getname ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getsize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getdays1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getsec1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getdays2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getsec2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
75
cole/doc/tmpl/cole-unused.sgml
Normal file
75
cole/doc/tmpl/cole-unused.sgml
Normal file
@@ -0,0 +1,75 @@
|
||||
<!-- ##### FUNCTION cole_opendir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION OLEcode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@OLEfilename:
|
||||
@trunc:
|
||||
@stream_list:
|
||||
@root:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION freeOLEtree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tree:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION cole_ferror ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION verbosePPSTree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pps_list:
|
||||
@root_pps:
|
||||
@level:
|
||||
|
||||
<!-- ##### FUNCTION OLEdecode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@OLEfilename:
|
||||
@stream_list:
|
||||
@root:
|
||||
@_BDepot:
|
||||
@_SDepot:
|
||||
@_sbfile:
|
||||
@_input:
|
||||
@max_level:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION cole_fclearerror ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
|
||||
284
cole/doc/tmpl/internals.sgml
Normal file
284
cole/doc/tmpl/internals.sgml
Normal file
@@ -0,0 +1,284 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Internals
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
cole internals - don't trust in anything here, because it may (and will) change.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Contains calls to access directly the file system, and endianess care calls.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT COLEFS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEDIRENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEDIR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEFILE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO F32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO F64 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO U8 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO U16 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO U32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_sreadU16 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@in:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_sreadU32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@in:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_sreadF64 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@in:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_swriteU16 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_swriteU32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### MACRO verbose_return ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO test ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@retval:
|
||||
|
||||
|
||||
<!-- ##### MACRO test_exitf ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@retval:
|
||||
@func:
|
||||
|
||||
|
||||
<!-- ##### MACRO test_call ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@typeretval:
|
||||
|
||||
|
||||
<!-- ##### MACRO test_call_exitf ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@typeretval:
|
||||
@func:
|
||||
|
||||
|
||||
<!-- ##### MACRO report_bug ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@prog:
|
||||
|
||||
|
||||
<!-- ##### MACRO assert_return ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@prog:
|
||||
@t:
|
||||
@retval:
|
||||
|
||||
|
||||
<!-- ##### MACRO verbose_d ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@n:
|
||||
|
||||
|
||||
<!-- ##### MACRO verbose ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@s:
|
||||
|
||||
|
||||
<!-- ##### MACRO verbose_wonl ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@s:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU8 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU16 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseS_wonl ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO warning ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU32Array ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@len:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU8Array_force ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@rec:
|
||||
@len:
|
||||
@reclen:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU8Array ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@rec:
|
||||
@len:
|
||||
@reclen:
|
||||
|
||||
|
||||
33
cole/doc/using.sgml
Normal file
33
cole/doc/using.sgml
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
<para>
|
||||
The files in the subdirectory <filename>examples</filename> in the source code show the complete public <link linkend="cole-API">API</link> in action. Briefly, if you know how to use the <filename>stdio.h</filename> ANSI C calls, cole API will be very easy for you.
|
||||
</para>
|
||||
<para>
|
||||
If you use <filename>autoconf</filename> in your own proyect, the included file <filename>cole.m4</filename> may be useful for you. It contains the m4 macro AM_PATH_COLE that detect the presense or ausence of the cole library in the system being configured. To use it:
|
||||
</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
If cole is not installed in your system (i.e. <filename>aclocal</filename> can't find <filename>cole.m4</filename>), add the content of <filename>cole.m4</filename> to your own <filename>acinclude.m4</filename> file (create it in case you haven't one).
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Add a line like <userinput>AM_PATH_COLE(2.0.0, [LIBS="$LIBS $COLE_LIBS" CFLAGS="$CFLAGS $COLE_CFLAGS"])</userinput> to your <filename>configure.in</filename> file. Here we are requesting for cole release 2.0.0, and adding the necessary flags to LIBS and CFLAGS.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Run <userinput>aclocal</userinput> to generate the file <filename>aclocal.m4</filename>. This file will have many m4 macros, incluiding the cole m4 macro, and
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Run <userinput>autoconf</userinput> to generate the script <filename>configure</filename>.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<para>
|
||||
Many <link linkend="cole-API">API</link> calls take an argument at the end called <link linkend="COLERRNO"><parameter>colerrno</parameter></link>. If it's not NULL and the call failed, it store the error code for fail, if any (if the call was successfully ended, its value is not modified).
|
||||
</para>
|
||||
|
||||
Reference in New Issue
Block a user