Fix markup to allow clean man pages.
authorThomas G. Lockhart
Fri, 6 Aug 1999 13:50:31 +0000 (13:50 +0000)
committerThomas G. Lockhart
Fri, 6 Aug 1999 13:50:31 +0000 (13:50 +0000)
Add new pages for programming languages and tcl shells.

14 files changed:
doc/src/sgml/ref/allfiles.sgml
doc/src/sgml/ref/commands.sgml
doc/src/sgml/ref/create_type.sgml
doc/src/sgml/ref/createdb.sgml
doc/src/sgml/ref/createlang.sgml [new file with mode: 0644]
doc/src/sgml/ref/destroylang.sgml [new file with mode: 0644]
doc/src/sgml/ref/drop_database.sgml
doc/src/sgml/ref/pgaccess-ref.sgml
doc/src/sgml/ref/pgadmin-ref.sgml
doc/src/sgml/ref/pgtclsh.sgml [new file with mode: 0644]
doc/src/sgml/ref/pgtksh.sgml [new file with mode: 0644]
doc/src/sgml/ref/postgres-ref.sgml
doc/src/sgml/ref/postmaster.sgml
doc/src/sgml/ref/select.sgml

index a0558440d7298a6d98d71ab40f363fba44ddbb8a..50e8c89490dfcb806b6a82549258b792fb53a4a2 100644 (file)
@@ -1,5 +1,5 @@
 
@@ -99,8 +99,10 @@ Complete list of usable sgml source files in this directory.
 
 
 
+
 
 
+
 
 
 
@@ -111,6 +113,8 @@ Complete list of usable sgml source files in this directory.
 
 
 
+
+
 
 
 
index 6ed2873c3876966c86594a417b98b70899ad6484..bc16b4cf2a9abac478e155b76fbfaacd3fa1ca55 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -106,8 +106,10 @@ functions supported by Postgres.
   
 
    &createdb;
+   &createlang;
    &createuser;
    &destroydb;
+   &destroylang;
    &destroyuser;
    &ecpgRef;
    &pgAccess;
@@ -115,6 +117,8 @@ functions supported by Postgres.
    &pgDump;
    &pgDumpall;
    &psqlRef;
+   &pgTclSh;
+   &pgTkSh;
    &vacuumdb;
 
  
index 91a8b7d15dab1a2ea5be1a068d7312b2a5338529..07c2617bf0bf2030eac640d316b7dcd125cdfbe7 100644 (file)
@@ -1,11 +1,11 @@
 
 
 
  
-  
+   id="sql-createtype-title">
    CREATE TYPE
   
   SQL - Language Statements
index 906e2dbf6e4ae40bd171f714dd8ed28f7b8a2e4d..8d36e805d633059dea236202c096ca781e9b5421 100644 (file)
@@ -1,9 +1,9 @@
 
 
-
+ xreflabel="createdb">
  
   
    createdb
@@ -229,7 +229,8 @@ createdb: database creation failed on dbname
    PGREALM
    environment variables will be passed on to
    psql
-   and processed as described in .
+   and processed as described in
+   .
   
  
 
diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml
new file mode 100644 (file)
index 0000000..8da1cda
--- /dev/null
@@ -0,0 +1,172 @@
+
+
+
+  
+   createlang
+  
+  Application
+  
+   createlang
+  
+  
+   Add a new programming language to a Postgres database
+  
+  
+   1999-08-05
+  
+  
+createlang [ langname ]
+createlang [ -h host ] [ -p port ]
+        [ langname ]
+  
+
+  
+   </div> <div class="diff add">+    Inputs</div> <div class="diff add">+   
+   
+    createlang accepts the following command line arguments:
+    
+    
+     
+      langname
+      
+       
+   Specifies the name of the backend programming language to be defined.
+   createlang will prompt for
+   langname
+   if it is not specified on the command line.
+       
+      
+     
+    
+   
+
+   
+    createlang also accepts 
+    the following command line arguments for connection parameters:
+    
+    
+     
+      -h host
+      
+       
+   Specifies the hostname of the machine on which the 
+   postmaster
+   is running.  Defaults to using a local Unix domain socket
+   rather than an IP connection.
+       
+      
+     
+
+     
+      -p port
+      
+       
+   Specifies the Internet TCP/IP port or local Unix domain socket file 
+   extension on which the postmaster
+   is listening for connections.  The port number defaults to 5432,
+   or the value of the PGPORT
+   environment variable (if set).
+       
+      
+     
+     
+    
+   
+  
+
+  
+   
+    1998-10-04
+   
+   </div> <div class="diff add">+    Outputs</div> <div class="diff add">+   
+   
+    createlang installs a new programming
+    language into a Postgres server,
+    so has not explicit external output.
+   
+  
+  
+   1998-10-04
+  
+  </div> <div class="diff add">+   Description</div> <div class="diff add">+  
+
+  
+   createlang is a utility for adding a new 
+   programming language to a
+   Postgres database.
+   createlang currently accepts two
+   languages, plsql and pltcl.
+  
+
+  </div> <div class="diff add">+   Notes</div> <div class="diff add">+  
+
+  
+   See 
+   
+   for more details.
+  
+  </div> <div class="diff add">+   Usage</div> <div class="diff add">+  
+  
+   To install pltcl:
+   
+   
+% createlang pltcl
+   
+  
+
+
+
diff --git a/doc/src/sgml/ref/destroylang.sgml b/doc/src/sgml/ref/destroylang.sgml
new file mode 100644 (file)
index 0000000..3b30714
--- /dev/null
@@ -0,0 +1,172 @@
+
+
+
+  
+   destroylang
+  
+  Application
+  
+   destroylang
+  
+  
+   Add a programming language to a Postgres database
+  
+  
+   1999-08-05
+  
+  
+destroylang [ langname ]
+destroylang [ -h host ] [ -p port ]
+        [ langname ]
+  
+
+  
+   </div> <div class="diff add">+    Inputs</div> <div class="diff add">+   
+   
+    destroylang accepts the following command line arguments:
+    
+    
+     
+      langname
+      
+       
+   Specifies the name of the backend programming language to be destroyed.
+   destroylang will prompt for
+   langname
+   if it is not specified on the command line.
+       
+      
+     
+    
+   
+
+   
+    destroylang also accepts 
+    the following command line arguments for connection parameters:
+    
+    
+     
+      -h host
+      
+       
+   Specifies the hostname of the machine on which the 
+   postmaster
+   is running.  Defaults to using a local Unix domain socket
+   rather than an IP connection.
+       
+      
+     
+
+     
+      -p port
+      
+       
+   Specifies the Internet TCP/IP port or local Unix domain socket file 
+   extension on which the postmaster
+   is listening for connections.  The port number defaults to 5432,
+   or the value of the PGPORT
+   environment variable (if set).
+       
+      
+     
+     
+    
+   
+  
+
+  
+   
+    1998-10-04
+   
+   </div> <div class="diff add">+    Outputs</div> <div class="diff add">+   
+   
+    destroylang removes an existing programming
+    language from a Postgres server,
+    so has not explicit external output.
+   
+  
+  
+   1998-10-04
+  
+  </div> <div class="diff add">+   Description</div> <div class="diff add">+  
+
+  
+   destroylang is a utility for removing an 
+   existing programming language from a
+   Postgres database.
+   destroylang currently accepts two
+   languages, plsql and pltcl.
+  
+
+  </div> <div class="diff add">+   Notes</div> <div class="diff add">+  
+
+  
+   See 
+   
+   for more details.
+  
+  </div> <div class="diff add">+   Usage</div> <div class="diff add">+  
+  
+   To remove pltcl:
+   
+   
+% destroylang pltcl
+   
+  
+
+
+
index a60cd7f5f6914f0d61a7daeb7a2f491233129736..0dc1db2a614a2f4f42b7d8624495fc703048c896 100644 (file)
@@ -1,9 +1,9 @@
 
 
-
+ xreflabel="drop_database">
  
   
    DROP DATABASE
@@ -117,14 +117,14 @@ WARN: destroydb: database "name" do
    
     This query cannot be executed while connected to the target
     database. It is usually preferable to use
-    -title" endterm="app-destroydb-title">
+    
     instead.
    
 
    
     Refer to
-    -title" endterm="app-createdb-title"> and
-    -title" endterm="sql-createdatabase-title">
+     and
+    
     for information on how to create a database.
    
   
index 469f8100f58a6a734285699106afc9573b277773..7fc553fea70ba7c4eb5b39f503588f9cd62eb7e0 100644 (file)
@@ -1,11 +1,11 @@
 
 
 
  
-  pgaccess-ref">
+  app-pgaccess-title">
    pgaccess
   
   Application
@@ -20,16 +20,13 @@ Postgres documentation
  
  
   
-   1999-05-19
+   1999-08-03
   
   
 pgaccess [ dbname ]
   
 
   
-   
-    1999-05-19
-   
    </div> <div class="diff ctx">     Inputs</div> <div class="diff ctx">    
@@ -49,9 +46,6 @@ pgaccess [ dbname ]
   
 
   
-   
-    1999-05-19
-   
    </div> <div class="diff ctx">     Outputs</div> <div class="diff ctx">    
@@ -61,19 +55,346 @@ pgaccess [ dbname ]
  
 
  
-  
-   1999-05-19
-  
   </div> <div class="diff ctx">    Description</div> <div class="diff ctx">   
   
-   
-    Editor's Note
-    
-     This should be transcribed from other pgaccess info. Volunteers?
-    
-   
+   pgaccess provides a graphical interface
+   for Postgres
+   where you
+   can manage your tables, edit them, define queries, sequences and
+   functions.
+  
+
+  
+   Another way of accessing Postgres
+   through tcl is to use
+   
+   or
+   .
+  
+
+  
+   pgaccess can:
+
+   
+    
+     
+      Opens any database on a specified host at the specified port,
+      username and password.
+     
+    
+
+    
+     
+      Execute .
+     
+    
+
+    
+     
+      Saves preferences in ~/.pgaccessrc file.
+     
+    
+   
+  
+
+  
+   For tables, pgaccess can:
+
+   
+    
+     
+      Open multiple tables for viewing, max n records (configurable).
+     
+    
+
+    
+     
+      Resize columns by dragging the vertical grid lines.
+     
+    
+
+    
+     
+      Wrap text in cells.
+     
+    
+
+    
+     
+      Dynamically adjust row height when editing.
+     
+    
+
+    
+     
+      Save table layout for every table.
+     
+    
+
+    
+     
+      Import/export to external files (SDF,CSV).
+     
+    
+
+    
+     
+      Use filter capabilities; enter filter like price>3.14.
+     
+    
+
+    
+     
+      Specify sort order; enter manually the sort field(s).
+     
+    
+
+    
+     
+      Edit in place; double click the text you want to change.
+     
+    
+
+    
+     
+      Delete records; point to the record, press Del key.
+     
+    
+
+    
+     
+      Add new records; save new row with right-button-click.
+     
+    
+
+    
+     
+      Create tables with an assistant.
+     
+    
+
+    
+     
+      Rename and delete (drop) tables.
+     
+    
+
+    
+     
+      Retrieve information on tables, including owner, field information, indices.
+     
+    
+   
+  
+
+  
+   For queries, pgaccess can:
+
+   
+    
+     
+      Define, edit and store user defined queries.
+     
+    
+
+    
+     
+      Save view layouts.
+     
+    
+
+    
+     
+      Store queries as views.
+     
+    
+
+    
+     
+      Execute with optional user input parameters; e.g.
+      
+select * from invoices where year=[parameter "Year of selection"]
+      
+     
+    
+
+    
+     
+      View any select query result.
+     
+    
+
+    
+     
+      Run action queries (insert, update, delete).
+     
+    
+
+    
+     
+      Construct queries using a visual query builder
+      with drag & drop support, table aliasing.
+     
+    
+   
+  
+
+  
+   For sequences, pgaccess can:
+
+   
+    
+     
+      Define new instances.
+     
+    
+
+    
+     
+      Inspect existing instances.
+     
+    
+
+    
+     
+      Delete.
+     
+    
+   
+  
+
+  
+   For views, pgaccess can:
+
+   
+    
+     
+      Define them by saving queries as views.
+     
+    
+
+    
+     
+      View them, with filtering and sorting capabilities.
+     
+    
+
+    
+     
+      Design new views.
+     
+    
+
+    
+     
+      Delete (drop) existing views.
+     
+    
+   
+  
+
+  
+   For functions, pgaccess can:
+
+   
+    
+     
+      Define.
+     
+    
+
+    
+     
+      Inspect.
+     
+    
+
+    
+     
+      Delete.
+     
+    
+   
+  
+
+  
+   For reports, pgaccess can:
+
+   
+    
+     
+      Generate simple reports from a table (beta stage).
+     
+    
+
+    
+     
+      Change font, size and style of fields and labels.
+     
+    
+
+    
+     
+      Load and save reports from the database.
+     
+    
+
+    
+     
+      Preview tables, sample postscript print.
+     
+    
+   
+  
+
+  
+   For forms, pgaccess can:
+
+   
+    
+     
+      Open user defined forms.
+     
+    
+
+    
+     
+      Use a form design module.
+     
+    
+
+    
+     
+      Access record sets using a query widget.
+     
+    
+   
+  
+
+  
+   For scripts, pgaccess can:
+
+   
+    
+     
+      Define.
+     
+    
+
+    
+     
+      Modify.
+     
+    
+
+    
+     
+      Call user defined scripts.
+     
+    
+   
   
  
 
index 1ffd70567321574f55079181d5d1a878a18eff7e..2fa53745ef7a2ba8d78a6ffaed0665551f8211ee 100644 (file)
@@ -1,11 +1,11 @@
 
 
 
  
-  pgadmin-ref">
+  app-pgadmin-title">
    pgadmin
   
   Application
diff --git a/doc/src/sgml/ref/pgtclsh.sgml b/doc/src/sgml/ref/pgtclsh.sgml
new file mode 100644 (file)
index 0000000..ac947ed
--- /dev/null
@@ -0,0 +1,91 @@
+
+
+
+  
+   pgtclsh
+  
+  Application
+  
+   pgtclsh
+  
+  
+   Postgres TCL shell client
+  
+  
+   1999-08-03
+  
+  
+pgtclsh [ dbname ]
+  
+
+  
+   </div> <div class="diff add">+    Inputs</div> <div class="diff add">+   
+   
+
+    
+     
+      dbname
+      
+       
+   The name of an existing database to access.
+       
+      
+     
+    
+   
+  
+
+  
+   </div> <div class="diff add">+    Outputs</div> <div class="diff add">+   
+   
+   
+  
+
+  </div> <div class="diff add">+   Description</div> <div class="diff add">+  
+  
+   pgtclsh provides a TCL shell interface
+   for Postgres.
+  
+
+  
+   Another way of accessing Postgres
+   through tcl is to use
+   
+   or
+   .
+  
+
+
+
diff --git a/doc/src/sgml/ref/pgtksh.sgml b/doc/src/sgml/ref/pgtksh.sgml
new file mode 100644 (file)
index 0000000..9900225
--- /dev/null
@@ -0,0 +1,91 @@
+
+
+
+  
+   pgtksh
+  
+  Application
+  
+   pgtksh
+  
+  
+   Postgres graphical TCL/TK shell
+  
+  
+   1999-08-03
+  
+  
+pgtksh [ dbname ]
+  
+
+  
+   </div> <div class="diff add">+    Inputs</div> <div class="diff add">+   
+   
+
+    
+     
+      dbname
+      
+       
+   The name of an existing database to access.
+       
+      
+     
+    
+   
+  
+
+  
+   </div> <div class="diff add">+    Outputs</div> <div class="diff add">+   
+   
+   
+  
+
+  </div> <div class="diff add">+   Description</div> <div class="diff add">+  
+  
+   pgtksh provides a graphical TCL/TK shell interface
+   for Postgres.
+  
+
+  
+   Another way of accessing Postgres
+   through TCL is to use
+   
+   or
+   .
+  
+
+
+
index add30e27e424236af0c676304e13a550e72f1be1..96f9e64644df074bc8f01cc84a264b6d93d2ecc3 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -11,7 +11,7 @@ Postgres documentation
   Application
  
  
-   id="postgres-ref">
+  
    postgres
   
   
@@ -190,7 +190,7 @@ postgres [ -B nBuffers ] [ -C ] [ -
    Dates are accepted by the backend in a wide variety of formats,
    and for input dates this switch mostly affects the interpretation
    for ambiguous cases.
-   See <xref linkend="datatype-title" endterm="datatype-title">
+   See <citetitle>The PostgreSQL User's Guide>
    for more information.
        
       
@@ -420,7 +420,7 @@ semget: No space left on device
    ipcs(1),
    ipcrm(1), and
    ipcclean(1).
-   See also postmaster-ref" endterm="postmaster-ref">.
+   See also app-postmaster" endterm="app-postmaster-title">.
   
  
 
index 7b249d17e23abcc6446c2ccf8561224bb39a4517..e3587d30973efcc6bab4af8fd9471aadb4fa51b9 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -460,7 +460,7 @@ or its alternative form
    
 % setenv PGPORT 1234
 % psql
-   .
+   
   
  
 
index 0e17cc1c8b3beb9f55897fea727ae48ed000973a..f2afa38b7c9a4c9e92eec508e2c5bdb77e9aa3da 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -197,7 +197,7 @@ SELECT [ ALL | DISTINCT [ ON column
    SELECT will return rows from one or more tables.
    Candidates for selection are rows which satisfy the WHERE condition;
    if WHERE is omitted, all rows are candidates.
-   (See where-title" endterm="where-title">.)
+   (See sql-where" endterm="sql-where-title">.)
   
 
   
@@ -214,37 +214,37 @@ SELECT [ ALL | DISTINCT [ ON column
   
    The GROUP BY clause allows a user to divide a table
    conceptually into groups.
-   (See group-by-title" endterm="group-by-title">.)
+   (See sql-groupby" endterm="sql-groupby-title">.)
   
 
   
    The HAVING clause specifies a grouped table derived by the
    elimination of groups from the result of the previously
    specified clause.
-   (See having-title" endterm="having-title">.)
+   (See sql-having" endterm="sql-having-title">.)
   
    
   
    The ORDER BY clause allows a user to specify that he/she
    wishes the rows sorted according to the ASCending or 
    DESCending mode operator.
-   (See order-by-title" endterm="order-by-title">.)
+   (See sql-orderby-title" endterm="sql-orderby-title">.)
   
    
   
    The UNION clause allows the result to be the collection of rows
    returned by the queries involved.
-   (See union-title" endterm="union-title">.)
+   (See sql-union" endterm="sql-union-title">.)
   
    
   
    The INTERSECT give you the rows that are common to both queries.
-   (See intersect-title" endterm="intersect-title">.)
+   (See sql-intersect" endterm="sql-intersect-title">.)
   
    
   
    The EXCEPT give you the rows in the upper query not in the lower query.
-   (See except-title" endterm="except-title">.)
+   (See sql-except" endterm="sql-except-title">.)
   
    
   
@@ -262,11 +262,11 @@ SELECT [ ALL | DISTINCT [ ON column
    (See the GRANT/REVOKE statements).
   
    
-  R2-SQL-WHERE-2">
+  SQL-WHERE">
    
     1998-09-24
    
-   
+   sql-where-title">
     WHERE Clause
    
 
@@ -303,11 +303,11 @@ WHERE boolean_expr
    
   
   
-  R2-SQL-GROUPBY-2">
+  SQL-GROUPBY">
    
     1998-09-24
    
-   group-by-title">
+   sql-groupby-title">
     GROUP BY Clause
    
    
@@ -328,11 +328,11 @@ GROUP BY column [, ...]
    
   
 
-  R2-SQL-HAVING-2">
+  SQL-HAVING">
    
     1998-09-24
    
-   
+   sql-having-title">
     HAVING Clause
    
    
@@ -358,11 +358,11 @@ HAVING cond_expr
    
   
   
-  R2-SQL-ORDERBYCLAUSE-2">
+  SQL-ORDERBY">
    
     1998-09-24
    
-   order-by-title">
+   sql-orderby-title">
     ORDER BY Clause
    
    
@@ -401,11 +401,11 @@ SELECT name FROM distributors ORDER BY code;
    
   
   
-  R2-SQL-UNION-2">
+  SQL-UNION">
    
     1998-09-24
    
-   
+   sql-union-title">
     UNION Clause
    
    
@@ -441,11 +441,11 @@ SELECT name FROM distributors ORDER BY code;
 
   
 
-  R2-SQL-INTERSECT-2">
+  SQL-INTERSECT">
    
     1998-09-24
    
-   
+   sql-intersect-title">
     INTERSECT Clause
    
    
@@ -473,11 +473,11 @@ SELECT name FROM distributors ORDER BY code;
    
   
 
-  R2-SQL-EXCEPT-2">
+  SQL-EXCEPT">
    
     1998-09-24
    
-   
+   sql-except-title">
     EXCEPT Clause