From: Craig Date: Tue, 1 Nov 2016 17:42:24 +0000 (-0400) Subject: Adding installation and requirements to README X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=fb7ca111bea134cac8b0b7e9b376246c28ef0605;p=postgresql-autodoc Adding installation and requirements to README --- diff --git a/README.org b/README.org index a9a74a2..55fc6a5 100644 --- a/README.org +++ b/README.org @@ -4,22 +4,30 @@ This is a utility which will run through PostgreSQL system tables and returns HTML, DOT, and several styles of XML which describe the database. - - html :: The HTML is human readable (via webbrowser). - - xml :: The second type of XML is similar to HTML, but is in DocBook - 4 format. It enables you to mix schema documentation with - other DocBook documentation via the XREFs, generating PDFs, - HTML, RTF, or other formatted documents. Between these tools - and JavaDoc with the appropriate XREFs. - - neato :: This generates the schema in the form accepted by GraphViz - ~neato~, which draws the schema as an undirected graph - - dia :: This remaps the schema into XML using the XML schema of Dia, - an interactive diagramming tool. - - zigzag.dia :: This generates a diagram for Dia in another form - As a result, documentation about a project can be generated quickly and be automatically updatable, yet have a quite professional look if you do some DSSSL/CSS work. +** Requirements + +This program requires the following perl modules: +- DBI +- HTML::Templates +- Term::ReadKey +- DBD::Pg + +** Installation + +*** Ubuntu + +Install the require perl modules + +~$ sudo apt-get install libdbi-perl libhtml-templates-perl libterm-readkey-perl libdbd-pg-perl~ + +Once you have installed the requirements, browse to the autodoc directory and run: + +~$ sudo make install~ + ** Usage ~postgresql_autodoc [options]~ @@ -35,6 +43,17 @@ you do some DSSSL/CSS work. - ~−w~ :: Use ~/.pgpass for authentication (overrides all other password options) - ~−l~ :: Path to the templates (default: @@TEMPLATE-DIR@@) - ~−t~ :: Type of output wanted (default: All in template library) + + _html_ :: The HTML is human readable (via webbrowser). + + _xml_ :: The second type of XML is similar to HTML, but is in DocBook + 4 format. It enables you to mix schema documentation with + other DocBook documentation via the XREFs, generating PDFs, + HTML, RTF, or other formatted documents. Between these tools + and JavaDoc with the appropriate XREFs. + + _neato_ :: This generates the schema in the form accepted by GraphViz + ~neato~, which draws the schema as an undirected graph + + _dia_ :: This remaps the schema into XML using the XML schema of Dia, + an interactive diagramming tool. + + _zigzag.dia_ :: This generates a diagram for Dia in another form - ~−s~ :: Specify a specific schema to match. Technically this is a regular expression but anything other than a specific name may have unusual results. - ~−m~ :: Show only tables/objects with names matching the specified regular expression. - ~−−table=~ :: Tables to export. Multiple tables may be provided using a comma-separated list, i.e. table,table2,table3.