aboutsummaryrefslogtreecommitdiff
path: root/doc/odb-prologue.xhtml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/odb-prologue.xhtml')
-rw-r--r--doc/odb-prologue.xhtml25
1 files changed, 19 insertions, 6 deletions
diff --git a/doc/odb-prologue.xhtml b/doc/odb-prologue.xhtml
index d610b2b..7acd11d 100644
--- a/doc/odb-prologue.xhtml
+++ b/doc/odb-prologue.xhtml
@@ -67,17 +67,30 @@
<p>For an input file in the form <code><b>name.hxx</b></code> (other
file extensions can be used instead of <code><b>.hxx</b></code>),
- the following C++ files are generated:
+ in the single-database mode (the default), the generated C++ files
+ by default have the following names:
<code><b>name-odb.hxx</b></code> (header file),
<code><b>name-odb.ixx</b></code> (inline file, generated unless
the <code><b>--suppress-inline</b></code> option is specified), and
<code><b>name-odb.cxx</b></code> (source file).
Additionally, if the <code><b>--generate-schema</b></code> option is
- specified and the <code><b>sql</b></code> schema format is requested,
- the <code><b>name.sql</b></code> database schema file is generated. If
- the <code><b>separate</b></code> schema format is requested, the database
- creation code is generated into the separate
- <code><b>name-schema.cxx</b></code> file.</p>
+ specified and the <code><b>sql</b></code> schema format is requested (see
+ <code><b>--schema-format</b></code>), the <code><b>name.sql</b></code>
+ database schema file is generated. If the <code><b>separate</b></code>
+ schema format is requested, the database creation code is generated
+ into the separate <code><b>name-schema.cxx</b></code> file.</p>
+
+ <p>In the multi-database mode (see the <code><b>--multi-database</b></code>
+ option below), the generated files corresponding to the
+ <code><b>common</b></code> database have the same names as in the
+ single-database mode. For other databases, the file names include
+ the database name:
+ <code><b>name-odb-</b><i>db</i><b>.hxx</b></code>,
+ <code><b>name-odb-</b><i>db</i><b>.ixx</b></code>,
+ <code><b>name-odb-</b><i>db</i><b>.cxx</b></code>,
+ <code><b>name-</b><i>db</i><b>.sql</b></code>, and
+ <code><b>name-schema-</b><i>db</i><b>.cxx</b></code>
+ (where <code><i>db</i></code> is the database name).</p>
<h1>OPTIONS</h1>