.TH PGBROWSE 1L "Pgbrowse" ""
.SH NAME
pgbrowse - a database browser for the postgres database
.SH SYNOPSIS
.B pgbrowse
[
.B \-debug
] [
.B \-showlog
] [
.B \-query
] [
[
.B \-host
.I "postgres host"
] [
.B \-db
.I "database name"
] [
.B \-class
.I "class name"
] [
.B \-logfile
.I "filename"
]
.PP
.SH DESCRIPTION
.I Pgbrowse\^
is a 
.I tk
based graphical user interface which allows a user to
browse any
.I postgres
database and the classes within that database.
.PP
The key features of pgbrowse are:
.sp
1.
Allows a postgres user to peruse what databases exist under a postgres
server and all classes underneath those databases.
.sp
2.
Allows a postgres user to generate a simple graphical user interface
for
.B ANY
class in
.B ANY
postgres database providing the following functionality:
.IP
simple queries
.IP
editing instances of a class
.IP 
entering data into the database
.IP 
retrieving all instances in the database
.IP 
miscellaneous postgres queries
.IP 
Simple, powerful, and extensible framework for performing
actions on the results of a query
.IP
Ability to save the query tool as a standalone application.
.PP
To fully realize the power of this pgbrowse and the query tool,
database users have to
write their own actions to analyze/process the results of the query.
This tool provides a framework to talk to postgres easily,
and a mechanism to pass data from the results
of the query to an action.  The guidelines for developing actions
will be documented in a future release.  See /usr/local/pgbrowse/actions
for examples.
.PP
Options are:
.TP 1.0i
.B " -debug"
Provides three additional utilities: an option to source TCL scripts
(handy when developing pgbrowse),
a prototype of an additional query tool,
a prototype of a utility
to fill a class with tabular data from a file, allowing the user to change the
order of the fields
(this utility will be implemented in the next release).
.TP
.B "  -showlog"
Opens the log window on startup.
.TP
.B "  -query"
Automatically starts up the query tool, requires the -db and -class options
to be specified, i.e.
.br
pgbrowse -db miley -class aviris -query.
.TP
.B "  -host \fIpostgres_host\fR  "
Start up pgbrowse, using postgres_host as the postgres server.
.TP
.B "  -db \fIdatabase_name\fR  "
Start up pgbrowse preselecting a database.
.TP
.B "  -class \fIclass_name\fR  "
Start up pgbrowse preselecting a class, requires the -db option to be specified.
.TP
.B "  -logfile \fIlogfile_name\fR  "
Start up pgbrowse preselecting the name of the logfile.
.SH AUTHORS
Jim Davidson, Terry Figel, Steve Miley,  UCSB Computer System Laboratory/
Center for Remote Sensing and Environmental Optics.
.SH SEE ALSO
.I
Online Help
.br
.I
Postgres Users Guide
.br
pgbrowse postscript documents: $PGBROWSE/docs
.sp 
monitor(1), createdb(1), tk related man pages 
.SH FILES
/usr/local/pgbrowse/man     man pages
.br
/usr/local/pgbrowse/help     location for online help files
.br
/usr/local/pgbrowse/lib     tcl scripts
.br
/usr/local/pgbrowse/scripts     collection of handy ksh scripts to talk to postgres
.br
/usr/local/pgbrowse/actions     Directory of actions
.br
$TMPDIR/PGBrowse.xxxxx     temporary log file
.br
.SH DIAGNOSTICS
Diagnostics's are logged to a file from the pgbrowse tool.
The query tool doesn't save as much log information as it can, it will
in the future.  Tk/tcl messages will go to the originating screen.
.br
.SH ENVIRONMENT VARIABLES
.B "PGHOST"
Hostname which pgbrowse will connect to a postgres server.
.br
.B "PGBROWSE"
Location of pgbrowse installation.
.br
.B "PGBACTIONS"
Location of a user's specific pgbrowse action directory.
.br
.B "TMPDIR"
An environment variable used by some actions to determine location
for large object copies.
.br
.SH BUG REPORTS TO
Terry Figel	pgbrowse@crseo.ucsb.edu