From c87955678013b43c8ea0a69d3ff5303a649aecdc Mon Sep 17 00:00:00 2001 From: "Thomas G. Lockhart" Date: Fri, 6 Aug 1999 13:50:31 +0000 Subject: [PATCH] Fix markup to allow clean man pages. Add new pages for programming languages and tcl shells. --- doc/src/sgml/ref/allfiles.sgml | 6 +- doc/src/sgml/ref/commands.sgml | 6 +- doc/src/sgml/ref/create_type.sgml | 4 +- doc/src/sgml/ref/createdb.sgml | 7 +- doc/src/sgml/ref/createlang.sgml | 172 ++++++++++++++ doc/src/sgml/ref/destroylang.sgml | 172 ++++++++++++++ doc/src/sgml/ref/drop_database.sgml | 10 +- doc/src/sgml/ref/pgaccess-ref.sgml | 357 ++++++++++++++++++++++++++-- doc/src/sgml/ref/pgadmin-ref.sgml | 4 +- doc/src/sgml/ref/pgtclsh.sgml | 91 +++++++ doc/src/sgml/ref/pgtksh.sgml | 91 +++++++ doc/src/sgml/ref/postgres-ref.sgml | 8 +- doc/src/sgml/ref/postmaster.sgml | 4 +- doc/src/sgml/ref/select.sgml | 44 ++-- 14 files changed, 916 insertions(+), 60 deletions(-) create mode 100644 doc/src/sgml/ref/createlang.sgml create mode 100644 doc/src/sgml/ref/destroylang.sgml create mode 100644 doc/src/sgml/ref/pgtclsh.sgml create mode 100644 doc/src/sgml/ref/pgtksh.sgml diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml index a0558440d7..50e8c89490 100644 --- a/doc/src/sgml/ref/allfiles.sgml +++ b/doc/src/sgml/ref/allfiles.sgml @@ -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. + + diff --git a/doc/src/sgml/ref/commands.sgml b/doc/src/sgml/ref/commands.sgml index 6ed2873c38..bc16b4cf2a 100644 --- a/doc/src/sgml/ref/commands.sgml +++ b/doc/src/sgml/ref/commands.sgml @@ -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; diff --git a/doc/src/sgml/ref/create_type.sgml b/doc/src/sgml/ref/create_type.sgml index 91a8b7d15d..07c2617bf0 100644 --- a/doc/src/sgml/ref/create_type.sgml +++ b/doc/src/sgml/ref/create_type.sgml @@ -1,11 +1,11 @@ - + CREATE TYPE SQL - Language Statements diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index 906e2dbf6e..8d36e805d6 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -1,9 +1,9 @@ - + createdb @@ -229,7 +229,8 @@ createdb: database creation failed on dbnamePGREALM 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 index 0000000000..8da1cdaa1e --- /dev/null +++ b/doc/src/sgml/ref/createlang.sgml @@ -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 ] + + + + + Inputs + + + 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 + + + Outputs + + + createlang installs a new programming + language into a Postgres server, + so has not explicit external output. + + + + + + + 1998-10-04 + + + Description + + + + createlang is a utility for adding a new + programming language to a + Postgres database. + createlang currently accepts two + languages, plsql and pltcl. + + + + + + Notes + + + + See + + for more details. + + + + + + Usage + + + 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 index 0000000000..3b30714248 --- /dev/null +++ b/doc/src/sgml/ref/destroylang.sgml @@ -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 ] + + + + + Inputs + + + 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 + + + Outputs + + + destroylang removes an existing programming + language from a Postgres server, + so has not explicit external output. + + + + + + + 1998-10-04 + + + Description + + + + destroylang is a utility for removing an + existing programming language from a + Postgres database. + destroylang currently accepts two + languages, plsql and pltcl. + + + + + + Notes + + + + See + + for more details. + + + + + + Usage + + + To remove pltcl: + + +% destroylang pltcl + + + + + + diff --git a/doc/src/sgml/ref/drop_database.sgml b/doc/src/sgml/ref/drop_database.sgml index a60cd7f5f6..0dc1db2a61 100644 --- a/doc/src/sgml/ref/drop_database.sgml +++ b/doc/src/sgml/ref/drop_database.sgml @@ -1,9 +1,9 @@ - + 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 - + instead. Refer to - and - + and + for information on how to create a database. diff --git a/doc/src/sgml/ref/pgaccess-ref.sgml b/doc/src/sgml/ref/pgaccess-ref.sgml index 469f8100f5..7fc553fea7 100644 --- a/doc/src/sgml/ref/pgaccess-ref.sgml +++ b/doc/src/sgml/ref/pgaccess-ref.sgml @@ -1,11 +1,11 @@ - + pgaccess Application @@ -20,16 +20,13 @@ Postgres documentation - 1999-05-19 + 1999-08-03 pgaccess [ dbname ] - - 1999-05-19 - Inputs @@ -49,9 +46,6 @@ pgaccess [ dbname ] - - 1999-05-19 - Outputs @@ -61,19 +55,346 @@ pgaccess [ dbname ] - - 1999-05-19 - Description - - 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. + + + diff --git a/doc/src/sgml/ref/pgadmin-ref.sgml b/doc/src/sgml/ref/pgadmin-ref.sgml index 1ffd705673..2fa53745ef 100644 --- a/doc/src/sgml/ref/pgadmin-ref.sgml +++ b/doc/src/sgml/ref/pgadmin-ref.sgml @@ -1,11 +1,11 @@ - + pgadmin Application diff --git a/doc/src/sgml/ref/pgtclsh.sgml b/doc/src/sgml/ref/pgtclsh.sgml new file mode 100644 index 0000000000..ac947ed3b3 --- /dev/null +++ b/doc/src/sgml/ref/pgtclsh.sgml @@ -0,0 +1,91 @@ + + + + + + pgtclsh + + Application + + + + pgtclsh + + + Postgres TCL shell client + + + + + 1999-08-03 + + +pgtclsh [ dbname ] + + + + + Inputs + + + + + + dbname + + + The name of an existing database to access. + + + + + + + + + + Outputs + + + + + + + + + Description + + + 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 index 0000000000..9900225f04 --- /dev/null +++ b/doc/src/sgml/ref/pgtksh.sgml @@ -0,0 +1,91 @@ + + + + + + pgtksh + + Application + + + + pgtksh + + + Postgres graphical TCL/TK shell + + + + + 1999-08-03 + + +pgtksh [ dbname ] + + + + + Inputs + + + + + + dbname + + + The name of an existing database to access. + + + + + + + + + + Outputs + + + + + + + + + Description + + + pgtksh provides a graphical TCL/TK shell interface + for Postgres. + + + + Another way of accessing Postgres + through TCL is to use + + or + . + + + + + diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index add30e27e4..96f9e64644 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -1,5 +1,5 @@ @@ -11,7 +11,7 @@ Postgres documentation Application - + 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 + See 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 . + See also . diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index 7b249d17e2..e3587d3097 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ @@ -460,7 +460,7 @@ or its alternative form % setenv PGPORT 1234 % psql - . + diff --git a/doc/src/sgml/ref/select.sgml b/doc/src/sgml/ref/select.sgml index 0e17cc1c8b..f2afa38b7c 100644 --- a/doc/src/sgml/ref/select.sgml +++ b/doc/src/sgml/ref/select.sgml @@ -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 .) + (See .) @@ -214,37 +214,37 @@ SELECT [ ALL | DISTINCT [ ON column The GROUP BY clause allows a user to divide a table conceptually into groups. - (See .) + (See .) The HAVING clause specifies a grouped table derived by the elimination of groups from the result of the previously specified clause. - (See .) + (See .) 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 .) + (See .) The UNION clause allows the result to be the collection of rows returned by the queries involved. - (See .) + (See .) The INTERSECT give you the rows that are common to both queries. - (See .) + (See .) The EXCEPT give you the rows in the upper query not in the lower query. - (See .) + (See .) @@ -262,11 +262,11 @@ SELECT [ ALL | DISTINCT [ ON column (See the GRANT/REVOKE statements). - + 1998-09-24 - + <title id="sql-where-title"> WHERE Clause @@ -303,11 +303,11 @@ WHERE boolean_expr - + 1998-09-24 - + <title id="sql-groupby-title"> GROUP BY Clause @@ -328,11 +328,11 @@ GROUP BY column [, ...] - + 1998-09-24 - + <title id="sql-having-title"> HAVING Clause @@ -358,11 +358,11 @@ HAVING cond_expr - + 1998-09-24 - + <title id="sql-orderby-title"> ORDER BY Clause @@ -401,11 +401,11 @@ SELECT name FROM distributors ORDER BY code; - + 1998-09-24 - + <title id="sql-union-title"> UNION Clause @@ -441,11 +441,11 @@ SELECT name FROM distributors ORDER BY code; - + 1998-09-24 - + <title id="sql-intersect-title"> INTERSECT Clause @@ -473,11 +473,11 @@ SELECT name FROM distributors ORDER BY code; - + 1998-09-24 - + <title id="sql-except-title"> EXCEPT Clause -- 2.40.0