SVN Commit by dpage: r4934 - branches/REL-1_4_0_PATCHES/pgadmin3/docs/en_US - Mailing list pgadmin-hackers

Author: dpage
Date: 2006-01-19 14:03:54 +0000 (Thu, 19 Jan 2006)
New Revision: 4934

Modified:
   branches/REL-1_4_0_PATCHES/pgadmin3/docs/en_US/extend.html
Log:
Improve adminpack documentation

Modified: branches/REL-1_4_0_PATCHES/pgadmin3/docs/en_US/extend.html
===================================================================
--- branches/REL-1_4_0_PATCHES/pgadmin3/docs/en_US/extend.html    2006-01-19 13:59:07 UTC (rev 4933)
+++ branches/REL-1_4_0_PATCHES/pgadmin3/docs/en_US/extend.html    2006-01-19 14:03:54 UTC (rev 4934)
@@ -10,7 +10,7 @@

 <h3>Extended features</h3>

-<p>pgAdmin III's functionality can be further enhanced using the <I>admin</I> contrib
+<p>pgAdmin III's functionality can be further enhanced using the <I>adminpack</I> contrib
 module for PostgreSQL. This is a library of additional functions that may be installed
 on your server which allows pgAdmin to offer additional features, such as:</p>

@@ -20,7 +20,7 @@
 displayed on the Statistics tab in the <a href="main.html">main window</a>.<br> </li>

 <li>The <a href="status.html">Status dialogue</A> will have the logfile
-tab and can display the server logfiles if it is configured.<br> </li>
+tab and can display the server logfiles (if logging is appropriately configured).<br> </li>

 <li>Running queries from other users may be cancelled from the
 <a href="status.html">Status dialogue</A>.<br> </li>
@@ -30,12 +30,17 @@

 </ul>

-<p>The <I>admin</I> module is installed and activated by default if you are running the
+<p>The adminpack is installed and activated by default if you are running the
 'official' pgInstaller distribution of PostgreSQL for Windows, however, if you are running
-any other version of PostgreSQL you will need to manually install the module. To do so,
-simply copy the /xtra/admin directory from the pgAdmin source distribution to the /contrib
-directory of your pre-configured PostgreSQL source tree. Run the following commands:</p>
+any other version of PostgreSQL you will need to manually install it. To do so,
+simply copy the <i>/xtra/admin</i> or <i>/xtra/admin81</i> (for PostgreSQL 8.1 and above) directory
+from the pgAdmin source distribution to the /contrib directory of your pre-configured PostgreSQL
+source tree. If you don't have the pgAdmin source code, you can download the adminpacks
+<a href="http://www.pgadmin.org/download/adminpacks.php">here</a>.</p>

+<p>Run the following commands (substituting <i>admin</i> for <i>admin81</i>
+if required):</p>
+
 <pre>
     # cd $PGSRC/contrib/admin
     # make all
@@ -43,18 +48,18 @@
 </pre>

 <p>The module should now be built, and installed into your existing PostgreSQL installation.
-to be used, you must now install the module into the database you use as pgAdmin's <I>Initial
-DB</I> (normally template1, though you may wish to use a different database). To do so,
-locate the admin.sql file installed in the previous step - normally this may be found in
-/usr/local/pgsql/share/contrib/ and run it against your database. You will normally need to do
-this as the PostgreSQL superuser:</p>
+to be used, you must now install the module into the database you use as pgAdmin's <I>Maintenance
+DB</I> (normally <i>postgres</i>, though you may wish to use a different database). To do so,
+locate the <i>admin.sql</i> or <i>admin81.sql</i> file installed in the previous step - normally
+this may be found in /usr/local/pgsql/share/contrib/ and run it against your database. You will
+normally need to do this as the PostgreSQL superuser:</p>

 <pre>
-    $ psql template1 < /usr/local/pgsql/share/contrib/admin.sql
+    $ psql postgres < /usr/local/pgsql/share/contrib/admin.sql
 </pre>

-<p>The next time you connect to the server with pgAdmin, it will detect the presence of the <I>admin</I>
-module and offer full functionality.</p>
+<p>The next time you connect to the server with pgAdmin, it will detect the presence of the adminpack
+and offer full functionality.</p>

 </body>