components/pgadmin/files/pgadmin3.1

   1 '\" t
   2 .\"
   3 .\" CDDL HEADER START
   4 .\"
   5 .\" The contents of this file are subject to the terms of the
   6 .\" Common Development and Distribution License (the "License").
   7 .\" You may not use this file except in compliance with the License.
   8 .\"
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10 .\" or http://www.opensolaris.org/os/licensing.
  11 .\" See the License for the specific language governing permissions
  12 .\" and limitations under the License.
  13 .\"
  14 .\" When distributing Covered Code, include this CDDL HEADER in each
  15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16 .\" If applicable, add the following below this CDDL HEADER, with the
  17 .\" fields enclosed by brackets "[]" replaced with your own identifying
  18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  19 .\"
  20 .\" CDDL HEADER END
  21 .\"
  22 .\" Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
  23 .\" Use is subject to license terms.
  24 .\"
  25 .\" #ident      "@(#)pgadmin3.1 1.2     10/03/16 SMI"
  26 .\"
  27 .TH "pgadmin3" "1" "" "" "User Commands"
  28 .SH NAME
  29 pgAdmin III \- administration and development GUI for PostgreSQL
  30 .SH SYNOPSIS
  31 .sp
  32 \fBpgadmin3\fR [ \fB\fIoption\fB\fR\fI...\fR ]
  33
  34 .SH DESCRIPTION
  35 pgAdmin III is the most popular and feature rich Open Source administration
  36 and development platform for PostgreSQL, the most advanced Open Source
  37 database in the world. pgAdmin III is designed to answer the needs of most
  38 users, from writing simple SQL queries to developing complex databases.
  39 It includes a graphical administration interface, an SQL query tool,
  40 a procedural code editor and much more.
  41
  42 This program is a graphical application and the binary file is available
  43 in /usr/bin. Simply type "pgadmin3" on a command line to launch the GUI.
  44 However, some of the features can be accessed through command line.
  45
  46 .SH "OPTIONS"
  47
  48 The following options are supported:
  49 .TP
  50 \fB-h\fR
  51 .TP
  52 \fB--help\fR
  53 Display command line option help
  54 .TP
  55 \fB-s \fIserver\fB\fR
  56 .TP
  57 \fB--server=\fIserver\fB\fR
  58 Auto connect to the specified server. \fIserver\fR is the description
  59 entered when you added the server to the treeview in pgAdmin,
  60 quoted if required. If multiple servers are registered with the same
  61 description, the first found will be auto-connected.
  62 .TP
  63 \fB-q\fR
  64 .TP
  65 \fB--query\fR
  66 Open a Query Tool window upon connection. If used together with the
  67 -s \fIserver\fR option, the query tool will automatically be
  68 connected to this server. If used alone, a dialog box will appear
  69 prompting for the connection information. This switch cannot be used
  70 together with the -qc \fIconnection\fR option.
  71 .TP
  72 \fB-qc \fIconnection\fB\fR
  73 .TP
  74 \fB--queryconnect=\fIconnection\fB\fR
  75 Open a Query Tool window upon connection. The query tool will
  76 automatically be connected to the server specified in the connection
  77 string. This option cannot be used together with the -q switch.
  78 .TP
  79 \fB-cm \fIfile\fB\fR
  80 .TP
  81 \fB--configfile=\fIfile\fB\fR
  82 Edit the specified postgresql.conf config file.
  83 .TP
  84 \fB-ch \fIfile\fB\fR
  85 .TP
  86 \fB--hbafile=file\fR
  87 Edit the specified pg_hba.conf config file.
  88 .TP
  89 \fB-c \fIfile\fB\fR
  90 .TP
  91 \fB-file=\fIfile\fB\fR
  92 Edit the config files in specified cluster directory.
  93 .TP
  94 \fB-t\fR
  95 .TP
  96 \fB--testmode\fR
  97 Start in dialogue translation test mode. This mode allows each dialogue
  98 to be viewed without running the application to assist with string
  99 translation.
 100 .PP
 101
 102 .\" Begin Sun update
 103 .SH ATTRIBUTES
 104 See
 105 .BR attributes (5)
 106 for descriptions of the following attributes:
 107 .sp
 108 .TS
 109 box;
 110 cbp-1 | cbp-1
 111 l | l .
 112 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 113 =
 114 Availability    database/postgres/pgadmin
 115 =
 116 Interface Stability     Committed
 117 .TE
 118
 119 .SH NOTES
 120 You may find useful informations in the help menu of pgadmin3.
 121 You may also find Solaris specific PostgreSQL informations in "postgres_82"
 122 man page. Source for pgAdmin3 is available on http://opensolaris.org.
 123 .\" End Sun update
 124
 125
 126 .SH SEE ALSO
 127 .PP
 128 pgagent(1), postgres_82(1), initdb(1), pg_ctl(1), postgres(1), postmaster(1)
 129
 130 .SH REFERENCES
 131 .PP
 132 http://www.pgadmin.org