caosdb.texi

@c This file is a part of the CaosDB Project.
@c
@c Copyright (C) 2021 IndiScale GmbH <info@indiscale.com>
@c Copyright (C) 2021 Daniel Hornung <d.hornung@indiscale.com>
@c
@c This program is free software: you can redistribute it and/or modify
@c it under the terms of the GNU Affero General Public License as
@c published by the Free Software Foundation, either version 3 of the
@c License, or (at your option) any later version.
@c
@c This program is distributed in the hope that it will be useful,
@c but WITHOUT ANY WARRANTY; without even the implied warranty of
@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@c GNU Affero General Public License for more details.
@c
@c You should have received a copy of the GNU Affero General Public License
@c along with this program. If not, see <https://www.gnu.org/licenses/>.

@node top
@top CaosDB library for Octave/Matlab

This package contains utility functions to interact with CaosDB, the
flexible semantic data management platform.

It makes use of @url{https://gitlab.com/caosdb/caosdb-cpplib, libcaosdb}
which must be installed on the system.

Full documentation how to install this package and a short tutorial for
first steps with the Octave CaosDB library can be found on
@url{https://docs.indiscale.com/caosdb-octavelib}, the source code for
this library is freely available at
@url{https://gitlab.com/caosdb/caosdb-octavelib}.

If you are interested in the documentation of the functions and classes
provided by this library, follow this link to the @url{../overview.html,
API overview}.

@deftypefn {Class} {} Caosdb ()
This is the main class of the CaosDB client for Octave.

Print usage help and return:
@example
caosdb --help;
@end example

Print the version and return:
@example
caosdb --version;
@end example

Test the default connection, print the server's version and return.
@example
caosdb --test-connection;
@end example

@end deftypefn