Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   44335 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

POSTGRESQL_AUTODOC(1)					 POSTGRESQL_AUTODOC(1)

NAME
       postgresql_autodoc - creates postgresql tables overview

SYNOPSIS
       postgresql_autodoc [options]

DESCRIPTION
       This  is	 a utility which will run through PostgreSQL system tables and
       returns HTML, DOT, and 2 styles of XML which describes the database.

       The HTML is human readable (via webbrowser). The first style of XML  is
       actually	 the fileformat of Dia, a UML diagram tool. The second type of
       XML is similar to the HTML but in the Docbook 4 format. It enables yous
       to  mix	in other docbook documentation via the XREFs, generating PDFs,
       HTML, RTF, or  other  formatted	documents.  Between  these  tools  and
       JavaDoc	with  the appropriate XREFs, documentation about a project can
       be generated quickly and be easily updatable yet have  a	 very  profes‐
       sional look with some DSSSL work.

OPTIONS
       -d <dbname>
	      Specify database name to connect to (default: current user)

       -f <file>
	      Specify output file prefix (default: current user)

       -h <host>
	      Specify database server host (default: localhost)

       -p <port>
	      Specify database server port (default: 5432)

       -u <username>
	      Specify database username (default: current user)

       --password=<pw>
	      Specify database password (default: blank)

	      If no password is specified, one is prompted for.

       -l <path>
	      Path   to	  the	templates   (default:	/usr/local/share/post‐
	      gresql_autodoc)

       -t <output>
	      Type of output wanted (default: All in template library)

       -s <schema>
	      Specify a specific schema to match. Technically this is a	 regu‐
	      lar  expression but anything other than a specific name may have
	      unusual results.

       -m <regexp>
	      Show only tables/objects with names matching the specified regu‐
	      lar expression.

       --table=<args>
	      Tables to export. Multiple tables may be provided using a comma-
	      separated list, i.e. table,table2,table3.

       --statistics
	      In 7.4 and later, with the contrib module pgstattuple  installed
	      we  can gather statistics on the tables in the database (average
	      size, free space, disk space  used,  dead	 tuple	counts,	 etc.)
	      This  is	disk intensive on large databases as all pages must be
	      visited.

AUTHOR
       Rod Taylor <autodoc@rbt.ca>

				 19 July 2009		 POSTGRESQL_AUTODOC(1)

Vote for polarhome