diff options
author | Boris Kolpackov <boris@codesynthesis.com> | 2010-09-12 15:12:35 +0200 |
---|---|---|
committer | Boris Kolpackov <boris@codesynthesis.com> | 2010-09-12 15:12:35 +0200 |
commit | fa46f3f56207a5edc5c6d56a58768b34c1a4c212 (patch) | |
tree | a294e7cafe97e4a6fab9790b9361dfd8ea9d3bc4 /doc/odb-prologue.1 | |
parent | 93a7d00f000427aab95e0d5fe5aa712e46b36301 (diff) |
Add odb man and html pages generation
Diffstat (limited to 'doc/odb-prologue.1')
-rw-r--r-- | doc/odb-prologue.1 | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/odb-prologue.1 b/doc/odb-prologue.1 new file mode 100644 index 0000000..01c933f --- /dev/null +++ b/doc/odb-prologue.1 @@ -0,0 +1,60 @@ +.\" Process this file with +.\" groff -man -Tascii odb.1 +.\" +.TH ODB 1 "September 2010" "ODB 1.0.0" +.SH NAME +odb \- object-relational mapping (ORM) compiler for C++ +.\" +.\" +.\" +.\"-------------------------------------------------------------------- +.SH SYNOPSIS +.\"-------------------------------------------------------------------- +.B odb +.B [ +.I options +.B ] +.I file +.B [ +.IR file... +.B ] +.\" +.\" +.\" +.\"-------------------------------------------------------------------- +.SH DESCRIPTION +.\"-------------------------------------------------------------------- +Given a set of C++ classes in a header file, +.B 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 +.B --database +option (see below). + + +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: +.B name-odb.hxx +(header file), +.B name-odb.ixx +(inline file, generated unless +the +.B --suppress-inline +option is specified), and +.B name-odb.cxx +(source file). Additionally, if the +.B --generate-schema +option is specified and the target database supports it, the +.B name.sql +database schema file is generated. +.\" +.\" +.\" +.\"-------------------------------------------------------------------- +.SH OPTIONS +.\"-------------------------------------------------------------------- |