From fa46f3f56207a5edc5c6d56a58768b34c1a4c212 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Sun, 12 Sep 2010 15:12:35 +0200 Subject: Add odb man and html pages generation --- doc/odb-prologue.xhtml | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 doc/odb-prologue.xhtml (limited to 'doc/odb-prologue.xhtml') diff --git a/doc/odb-prologue.xhtml b/doc/odb-prologue.xhtml new file mode 100644 index 0000000..b1efb70 --- /dev/null +++ b/doc/odb-prologue.xhtml @@ -0,0 +1,80 @@ + + + + + ODB 1.0.0 Compiler Command Line Manual + + + + + + + + + + + +
+
+ +

NAME

+ +

odb - object-relational mapping (ORM) compiler for C++

+ +

SYNOPSIS

+ +
+
odb [options] file [file...]
+
+ +

DESCRIPTION

+ +

Given a set of C++ classes in a header file, odb + generates C++ code that allows you to persist, query, and update objects + of these classes in a relational database (RDBMS). The relational + database that the generated code should target is specified with the + required --database option (see below).

+ +

For an input file in the form name.hxx (other + file extensions can be used instead of .hxx), + the following C++ files are generated: + name-odb.hxx (header file), + name-odb.ixx (inline file, generated unless + the --suppress-inline option is specified), and + name-odb.cxx (source file). + + Additionally, if the --generate-schema option is + specified and the target database supports it, the name.sql database + schema file is generated.

+ +

OPTIONS

-- cgit v1.1