From fa46f3f56207a5edc5c6d56a58768b34c1a4c212 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Sun, 12 Sep 2010 15:12:35 +0200
Subject: Add odb man and html pages generation

---
 doc/odb-prologue.1 | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 doc/odb-prologue.1

(limited to 'doc/odb-prologue.1')

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
+.\"--------------------------------------------------------------------
-- 
cgit v1.1