Commit adb3e9cc authored by Raphal Poss's avatar Raphal Poss
Browse files

2005-01-15 Raphael Poss <raph@lrde.epita.fr>

        Cleanup documentation subsystem. Use reStructuredText more.

        * doc/xml/Makefile.am,
        * doc/beginner/Makefile.am,
        * doc/Makefile.am: Factor common code to...
        * doc/Makefile.doc: ...this file.

        * configure.ac: Also configure for RST2HTML.

        * README,
        * FAQ,
        * INSTALL: Rewrite to...
        * doc/README.txt,
        * doc/FAQ.txt,
        * doc/INSTALL.txt: ...these. Do not remove the originals yet.

        * doc/Makefile.am: Also generate HTML output.
        * doc/xml/Makefile.am: Likewise. Drop DVI output.

        * doc/beginner/Makefile.am: Simplify.

        * HEADER: Get rid of obsolete file.

parent 00c187af
2005-01-15 Raphael Poss <raph@lrde.epita.fr>
Cleanup documentation subsystem. Use reStructuredText more.
* doc/xml/Makefile.am,
* doc/beginner/Makefile.am,
* doc/Makefile.am: Factor common code to...
* doc/Makefile.doc: ...this file.
* configure.ac: Also configure for RST2HTML.
* README,
* FAQ,
* INSTALL: Rewrite to...
* doc/README.txt,
* doc/FAQ.txt,
* doc/INSTALL.txt: ...these. Do not remove the originals yet.
* doc/Makefile.am: Also generate HTML output.
* doc/xml/Makefile.am: Likewise. Drop DVI output.
* doc/beginner/Makefile.am: Simplify.
* HEADER: Get rid of obsolete file.
2005-01-15 Raphael Poss <raph@lrde.epita.fr>
Get rid of the dependency on sgml2latex, which comes from
......
// Vaucanson, a generic library for finite state machines.
// Copyright (C) 2003 Sakarovitch, Lombardy, Poss, Rey and Regis-Gianas.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
......@@ -90,6 +90,8 @@ AC_ARG_VAR([TEXI2DVI], [program to create DVI from TeX files])
AC_CHECK_PROGS([TEXI2DVI], [texi2dvi], [$am_aux_dir/missing texi2dvi])
AC_ARG_VAR([RST2TEX], [program to create TeX from reStructuredText documents])
AC_CHECK_PROGS([RST2TEX], [rst2latex rst2latex.py], [$am_aux_dir/missing rst2latex])
AC_ARG_VAR([RST2HTML], [program to create HTML from reStructuredText documents])
AC_CHECK_PROGS([RST2HTML], [rst2html rst2html.py], [$am_aux_dir/missing rst2html])
AC_ARG_VAR([TAR], [the tape archiver program])
AC_CHECK_PROGS([TAR], [tar], [$am_aux_dir/missing tar])
......
=======================================
Vaucanson_ Frequently Asked Questions
=======================================
:Date: January 2005
Here are answers to different questions you may have while compiling
or using Vaucanson_.
.. _Vaucanson: http://www.lrde.epita.fr/vaucanson
.. contents::
Compilation Problems
====================
I have a "NAN undeclared" error. What can I do?
-----------------------------------------------
Your C++ compiler does not support the C99 standard library. This is
a known bug (``NAN`` should not be used without checking for its
existence before) and will be corrected. Meanwhile, use another
compiler, such as the `GNU C++ Compiler`_ version 3.3 or above.
.. _GNU C++ Compiler: http://gcc.gnu.org
I have a conflit declaration for ``int getopt()``. How to solve it?
-------------------------------------------------------------------
The flag ``HAVE_DECL_GETOPT`` must be set. Compile with ``-DHAVE_DECL_GETOPT``.
To use this flag with the script ``configure``, call it with::
configure CPPFLAGS='-DHAVE_DECL_GETOPT'
Usage issues
============
None for the moment.
=========================================
Installation instructions for Vaucanson
=========================================
:Date: 2005-01-15
Installation instructions for Vaucanson_, a C++ generic library for
weighted finite state machine. See also the file ``README``.
.. _Vaucanson: http://www.lrde.epita.fr/vaucanson
.. contents::
Installation
============
To install Vaucanson on your system, type in the classical sequence at
the command prompt::
./configure
make check
make install (as root)
Note that an installation is specific to the compiler used to install
it. Indeed, the call to ``./configure`` enables some workarounds and,
consequently, users must compile with the same compiler to avoid
compatibility problems.
Additional features
-------------------
There is a Python interpreter in the package. It is disabled by
default because its compilation takes several hours. If you have time
to spare, use instead::
./configure --enable-vaucanswig
There is an XML I/O subsystem in the library. It is enabled by
default, but requires a working installation of another software
package called Xerces-C++. If you do not have this package, or if you
do not want to use XML I/O in Vaucanson, you can use::
./configure --disable-xml
Tweaking compilation options
----------------------------
Use ``CXXFLAGS_DEBUG`` or ``CXXFLAGS_OPTIMIZE`` to pass debug or optimization
flags, not ``CXXFLAGS``. For example::
./configure CXXFLAGS_DEBUG='-fstack-check -fbounds-check -ggdb'
This is because Vaucanson tries to use some particular default flags
with some specific compilers such as GCC or ICC. Using ``CXXFLAGS``
conflicts with those specific flags; ``CXXFLAGS_DEBUG`` and
``CXXFLAGS_OPTIMIZE`` override these default flags.
Requirements
============
Vaucanson was tested with the `GNU C++ Compiler (GCC)`_ version
3.[234], and should work with ICC_ 8.1. The code is written in
respect to the ISO-IEC 14882 (ISO C++) standard to permit a higher
portability in the future.
.. _GNU C++ Compiler (GCC): http://gcc.gnu.org/
.. _ICC: http://www.intel.com/software/products/compilers/
Moreover, high verbose mode of the testing suites uses the AT&T dot
format to save automaton in a human readable file. Use Graphviz_ to
visualize these .dot files.
.. _Graphviz: http://www.research.att.com/sw/tools/graphviz/
If you want to use the XML I/O system, you will need the Apache
`Xerces-C++`_ library version 2.3 or above.
.. _Xerces-C++: http://xml.apache.org/xerces-c/
Licence
=======
Vaucanson is released under the GNU Lesser General Public Licence.
See the file ``COPYING`` for details.
......@@ -3,8 +3,8 @@
# $Id$
SUBDIRS = tutorial beginner makefiles xml
include $(srcdir)/Makefile.doc
docdir = $(datadir)/doc/@PACKAGE_TARNAME@
dist_doc_DATA = ref.tar.gz
ref.tar.gz: doc.doxy.in
......@@ -13,3 +13,10 @@ ref.tar.gz: doc.doxy.in
$(TAR) -czf $@ `test -d ref || echo '$(srcdir)/'`ref
MAINTAINERCLEANFILES = ref
dist_doc_DATA += README.pdf README.tex README.html \
INSTALL.pdf INSTALL.tex INSTALL.html \
FAQ.pdf FAQ.tex FAQ.html
EXTRA_DIST = README.txt INSTALL.txt FAQ.txt
MAINTAINERCLEANFILES += $(dist_doc_DATA)
# -*- Makefile -*-
TEXI2PDF = $(TEXI2DVI) --pdf
.txt.tex:
$(RST2TEX) --input-encoding=iso-8859-1 $< >$@
.txt.html:
$(RST2HTML) --input-encoding=iso-8859-1 $< >$@
.tex.pdf:
$(TEXI2PDF) -o $@ $<
.tex.dvi:
$(TEXI2DVI) -o $@ $<
docdir = $(datadir)/doc/$(PACKAGE_TARNAME)
CLEANFILES = *.dvi *.aux *blg *.out *.toc *.lot *.tmp *.log
===========================
Introduction to Vaucanson
===========================
:Date: 2005-01-15
Vaucanson_, a C++ generic library for weighted finite state machine.
.. _Vaucanson: http://www.lrde.epita.fr/vaucanson
.. contents::
Overview
========
Firstly initiated by Jacques Sakarovitch in 2000, Vaucanson is a
project developed by the Ecole Nationale Supérieure des
Télécommunications [1] and the EPITA Research and Development Laboratory
(LRDE) [2].
.. [1] http://www.enst.fr
.. [2] http://www.lrde.epita.fr
The goal of this library is to enable the development of C++ programs
in an abstract and general way with, at the same time, a large
specialization power. Indeed, on the one hand, we can write algorithms
working on every automaton with weights over any semirings and with
words from any free monoids. And on the other hand, a particular
algorithm can be specialized for a particular data structure
implementing only a pseudo behaviour.
Yet, Vaucanson is still in a fundamental development phase and
algorithms, data structures and global architecture are not totally
stable and well tested. In the ``doc/help`` directory, you can find a
short howto to start programming with Vaucanson. The ``src`` directory
contains several demonstrations, but you can also look at the
``include/vaucanson/algorithms`` to be introduced to the basics of
Vaucanson.
Please send any question or comments to ``vaucanson@lrde.epita.fr``,
and bug reports to ``vaucanson-bugs@lrde.epita.fr``.
Installation
============
See the documentation file ``INSTALL.txt`` for installation
instructions.
Licence
=======
Vaucanson is released under the GNU Lesser General Public Licence.
See the file ``COPYING`` for details.
Contacts
========
The team can be reached by mail at ``vaucanson@lrde.epita.fr``. Snail
mail addresses follow.
* Vaucanson - ENST
| Jacques Sakarovitch
| 46, rue Barrault
| F-75013 Paris
| France
* Vaucanson - LIAFA
| Sylvain Lombardy
| 175, rue du Chevaleret
| F-75013 Paris
| France
* Vaucanson - LRDE
| 24,rue Pasteur
| Paristalie, batiment X, aile Mistral
| F-94270 Le Kremlin Bicêtre cedex
| France
......@@ -2,18 +2,13 @@
#
# $Id$
TEXI2PDF = $(TEXI2DVI) --pdf
include $(srcdir)/../Makefile.doc
tex_TEX = help.tex
dist_doc_DATA = help.tex macros.tex packages.tex
help_tex_TEX = macros.tex packages.tex
help.dvi: $(dist_tex_TEX) $(dist_help_tex_TEX)
help.pdf: $(dist_tex_TEX) $(dist_help_tex_TEX)
help.dvi: $(tex_TEX) $(help_tex_TEX)
$(TEXI2DVI) `test -f '$(tex_TEX)' || echo '$(srcdir)/'`$(tex_TEX)
help.pdf: $(tex_TEX) $(help_tex_TEX)
$(TEXI2PDF) `test -f '$(tex_TEX)' || echo '$(srcdir)/'`$(tex_TEX)
dist_doc_DATA += help.dvi help.pdf
docdir = $(datadir)/doc/$(PACKAGE_TARNAME)
dist_doc_DATA = help.dvi help.pdf help.tex macros.tex packages.tex
CLEANFILES = *.dvi *.aux *blg *.out *.toc *.lot *.tmp
MAINTAINERCLEAN = $(dist_doc_DATA)
TEXI2PDF = $(TEXI2DVI) --pdf
docdir = $(datadir)/doc/$(PACKAGE_TARNAME)
dist_tex_TEX = dev.tex format.tex
dist_doc_DATA = dev.txt dev.tex dev.pdf dev.dvi \
format.txt format.tex format.pdf format.dvi
include $(srcdir)/../Makefile.doc
.txt.tex:
$(RST2TEX) $< >$@
dist_doc_DATA = dev.tex dev.pdf dev.html \
format.tex format.pdf format.html
EXTRA_DIST = dev.txt format.txt
MAINTAINERCLEANFILES = $(dist_doc_DATA)
.tex.pdf:
$(TEXI2PDF) -o $@ $<
.tex.dvi:
$(TEXI2DVI) -o $@ $<
CLEANFILES = *.dvi *.aux *blg *.out *.toc *.lot *.tmp *.log
==================================
Vaucanson XML format description
==================================
===================================
Vaucanson_ XML format description
===================================
:Author: Valentin David
:Contact: valentin@lrde.epita.fr
:Date: December 2003
This document describe the Vaucanson XML format.
This document describes the Vaucanson_ XML format.
.. _Vaucanson: http://www.lrde.epita.fr/vaucanson
.. contents::
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment