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 :
-
1)
a set of figures which describe each relation (table) including
each attribute (field) and its character
position, format and brief description.
-
2)
A set of descriptions of each relation (table) in the database,
including the primary, alternate, and foreign keys, and a description
of the table's purpose.
-
3)
A set of descriptions of all the attributes used in the tables,
including the tables in which they appear, their format, legal
values, null values and description.
PARAMETER FILE
-
tables
This is a list of the tables from the schema to
include in the output.
-
intro
-
relation_tables_intro
-
relation_desc_intro
-
attribute_desc_intro
These parameters should describe files which are
included in the output at the beginning (intro), and
before the corresponding section.
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
-
Can't open file.
One of the introductory files can't be opened.
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