• Antelope Release 5.5 Linux 2.6.32-220.el6.x86_64 2015-04-21

 

NAME

dbdoc - generate troff formatted document describing flat file database

SYNOPSIS

dbdoc database

SUPPORT


Contributed code: NO BRTT support.
THIS PIECE OF SOFTWARE WAS CONTRIBUTED BY THE ANTELOPE USER COMMUNITY. BRTT DISCLAIMS ALL OWNERSHIP, LIABILITY, AND SUPPORT FOR THIS PIECE OF SOFTWARE.

FOR HELP WITH THIS PIECE OF SOFTWARE, PLEASE CONTACT THE CONTRIBUTING AUTHOR.

DESCRIPTION

Dbdoc combines a set of introductory files with the the information from the schema files to create a (troff) formatted document describing a database.

Basically, dbdoc creates three sections :

PARAMETER FILE

EXAMPLE

% cat dbdoc.pf
tables  &Tbl{
    affiliation
    arrival
    assoc
    event
    instrument
    lastid
    netmag
    network
    origerr
    origin
    remark
    sensor
    site
    sitechan
    stamag
    stassoc
    wfdisc
    }

intro                   fluff/intro
relation_tables_intro   fluff/reltables
relation_desc_intro     fluff/reldesc
attribute_desc_intro    fluff/attrdesc

% dbdoc example > dbdoc.out2
% tbl dbdoc.out2 | troff -ms | \
     /usr/lib/lp/postscript/dpost > dbdoc.ps 

DIAGNOSTICS

SEE ALSO

dbintro(3)
dbschema(5)

BUGS AND CAVEATS

The introductory files are the glue between pages of the printed documentation. However, usually you will need to edit them for your own work -- most macros must be left in, but most of the verbiage removed or changed.

AUTHOR

Daniel Quinlan
Antelope User Group Contributed Software
Printer icon