From 2ad2e5500dd075db421a516502c9e522fdc34ee0 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Wed, 5 Dec 2012 17:37:46 +0200 Subject: Documentation for multi-database support --- doc/odb-prologue.1 | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) (limited to 'doc/odb-prologue.1') diff --git a/doc/odb-prologue.1 b/doc/odb-prologue.1 index 2e667d0..23d7d5c 100644 --- a/doc/odb-prologue.1 +++ b/doc/odb-prologue.1 @@ -38,7 +38,8 @@ For an input file in the form .B name.hxx (other file extensions can be used instead of .BR .hxx ), -the following C++ files are generated: +in the single-database mode (the default), the generated C++ files by +default have the following names: .B name-odb.hxx (header file), .B name-odb.ixx @@ -51,7 +52,9 @@ option is specified), and .B --generate-schema option is specified and the .B sql -schema format is requested, the +schema format is requested (see +.BR --schema-format ), +the .B name.sql database schema file is generated. If the .B separate @@ -59,6 +62,23 @@ schema format is requested, the database creation code is generated into the separate .B name-schema.cxx file. + + +In the multi-database mode (see the +.B --multi-database +option below), the generated files corresponding to the +.B common +database have the same names as in the single-database mode. For other +databases, the file names include the database name: +.BR name-odb-\fIdb\fB.hxx , +.BR name-odb-\fIdb\fB.ixx , +.BR name-odb-\fIdb\fB.cxx , +.BR name-\fIdb\fB.sql , +and +.B name-schema-\fIdb\fB.cxx +(where +.I db +is the database name). .\" .\" .\" -- cgit v1.1